| Table of Contents |
|---|
...
| Field/Column Name | Description |
|---|---|
| userId | The unique user id used for login. Required |
| tenant | The tenant identifier is optional. If not supplied, it defaults to the current tenant. Attempts to upload users for another tenant shows a validation error. |
| firstName | User's first name. |
| lastName | User's last name. |
| User's email address. Required | |
| enabled | Set to 'true' to enable the user |
| reportsTo | The userId of the user that the user reports to, if any. |
| roles | A list of the user's roles, separated by the '|' character. Roles are inserted as necessary. Spaces are not allowed in role names. Role names cannot contain more than 100 characters. |
| taskNotification | The user's task notification preference. The options are "OFF" or "Email"; if left blank or if this column is not used, this will default to "Email". |
| transaction | Either blank or 'DELETE'. If DELETE then the user will be removed. Otherwise, the user is updated if it exists or inserted as necessary. |
| notifyIfNewUser | A value of 'true' will send an email to users prompting them to create a new password. A value of 'false' will not notify users. |
| Info |
|---|
| To include a ',' (comma) in a field, escape it with a leading '\' character. To include a '|' (bar) in a role name, escape it with a leading '\' char. notifyIfNewUser determines when a password reset notification is sent to a user.
|
| Info |
|---|
|
- Although csv files can be opened in other programs, they are best viewed through some kind of spreadsheet program. Here is the file when it is opened with Excel:
Upload Users csv file
Downloading the user csv file will provide you with the format needed to import users and their associated roles into frevvo. Once you have your csv file ready, follow these steps to upload it:
...
Make sure you are logged in as the tenant admin. Click the Manage Users link.
...
| Info |
|---|
notifyIfNewUser determines when a password reset notification is sent to a user.
|
- Click the Load button, the system uploads the same data again from the file. Another validation is performed and if still no error, the users are loaded individually or deleted if specified in the transaction column of the file. Roles are also inserted as necessary.
...
- program. Here is the file when it is opened with Excel:
Upload Users csv file
Downloading the user csv file will provide you with the format needed to import users and their associated roles into frevvo. Once you have your csv file ready, follow these steps to upload it:
Make sure you are logged in as the tenant admin. Click the Manage Users link.
- Click the
upload users csv icon. - Browse to your users csv file and then click Validate and Load. User data is validated prior to successful import. You will see "Loading..." until the validation and loading process is completed.
The image shows the result of a validation that resulted in errors. User data cannot be uploaded until the errors are corrected. The table showing the validation data is scrollable vertically when loading a large csv file. Uploading an empty users file displays the message "Users file is empty".
Upon successful upload, you will see this message with the number of roles and users that were created: "Users Loaded successfully. 3 1 Added, 1 3 Updated, 0 Deleted, 4 1 Roles Added." Uploading an empty users file displays the message "Users file is empty".
Updating Users and Roles using a CSV file
...
| Tip |
|---|
|
CSV Upload Considerations
...
- The CSV upload can handle up to 1,000 rows in a given upload action. If you need to upload a large number of users, we recommend breaking them up into multiple CSVs of 1,000 users or fewer.
- Return to the Manage Users page and click Upload Users again after each successful upload operation.
- Return to the Manage Users page and click
- The "Reports To" column can only contain existing users. You should upload all of your users first, then re-upload the CSV(s) with the Reports To column filled.
- If you have a large number of users, the Manage Users page users list may display a user count of -1. This is a known issue we plan to resolve in a future release.
...
If there are spaces in the role names in your csv file, the message "role [the name of the role that contains the space for example: V P] - format not permitted (must start with a letter or _, max 16 chars from the set: a-zA-Z0-9_- ). Remove the spaces then upload the file again.
Validate Hangs After Re-Upload CSV
When using Chrome, if you re-upload your CSV (for example, after you noticed errors on your first upload validation), you may notice that the validation does not complete.
This is a Chrome issue, and is resolved by refreshing the browser page, uploading the CSV and clicking Validate ). Remove the spaces then upload the file again.
View User List
Click on a capital letter (A to Z) to display a list of users whose name begins with that letter. Click All to display all current users.
...
- Click
at the top of the user list to add a new user.
- Click
- Click
- Click
Click
- Click
- Click
- Click
...
The tenant admin can add/manage signature images for frevvo users that are applied to all forms/workflows this user signs in place of his or her first and last name. Signature images are supported in the Default Security Manager only at this time. Signature images can be a max size of 64kb.
To upload a signature image for a user:
...
- The default maximum size for attachments in the frevvo Cloud is 25 MB or 26214400 bytes. On Premise customers can use the frevvo.attachment.maxsize property to configure the maximum size for attachments.
- The Reports To field is a ComboBox. Begin typing the userid of the person this user reports to and a list of matching users displays.
- Select the Role and 1069272634field values from the Dropdown choices from the dropdown, and add additional roles by using the green + icon. Remove roles using the red - icon.
- Disable a user by setting Enabled to false.
- To save changes, click Submit. To cancel changes, click "Return to Manage Users" at the top of the page.
...