| Section | ||||||||
|---|---|---|---|---|---|---|---|---|
|
Add New User
Create new tenant users on the Manage Users page.
Click add new user icon at the top of the user list.
- Complete the new user form.
User names can contain characters, numbers, dot (.), hyphen (-) and the underscore (_) and cannot start with a number. Max length is 50 characters.
- Assign roles to the user. NOTE: Assign the special role frevvo.Designer to any user who needs permission to create forms and workflows.
- You can assign multiple roles to any user by clicking the "+" icon
- Assign a reports to for any user who needs to route a form they fill in to their manager. For example a PTO request.
- Submit the form
Add Tenant Admin
You can add additional tenant admins by click the icon. This creates a new user with the special permission required to login and manage the tenant. You cannot add this special tenant admin to an existing user. This is the only way to to grant this special tenant admin permission.
If you want to disable a tenant admin, edit that user by clicking the button and add the frevvo.ReadOnly role. You can also delete all tenant admin except the initial tenant admin created while creating the tenant. One common case is that you need to remove admin access to a person who initially had that permission via the initial tenant admin. To do this:
- Create a new tenant admin
- Edit the original tenant admin and add the role frevvo.ReadOnly
Edit Admin Users
There is also a short-cut to edit the initial tenant admin – click the button above the alphabet list to go directly to the initial tenant admin's edit page. You can also distinguish the initial tenant admin from non-admins because the initial tenant admin cannot be deleted so it does not have the
button. If you added additional tenant admins, the user list does not make it readily apparent that a user has that special admin access permission. Currently the way to distinguish an admin is click on each user's
button and see if the user has the Manage Tenant functions.
CSV Upload of Users and Roles
customers that have a large number of users with assigned roles, may need to import these (userids/roles) into . provides the ability to perform a bulk import of user data.
Only tenant admins may import user data and associated roles. The upload/download users links are available for tenants using all security managers. This feature is useful when creating/migrating a tenant that uses the LDAP or SAML Security managers.
| Section | ||||||||
|---|---|---|---|---|---|---|---|---|
|
Add New User
Create new tenant users on the Manage Users page.
Click add new user icon at the top of the user list.
- Complete the new user form.
User names can contain characters, numbers, dot (.), hyphen (-) and the underscore (_) and cannot start with a number. Max length is 75 characters. Userids that contain single quotes are supported.
- Assign roles to the user. NOTE: Assign the special role frevvo.Designer to any user who needs permission to create forms and workflows.
- You can assign multiple roles to any user by clicking the "+" icon
- Assign a reports to for any user who needs to route a workflow step they fill in to their manager. For example a PTO request.
- Submit the form
Add Tenant Admin
You can add additional tenant admins by click the icon. This creates a new user with the special permission required to login and manage the tenant. You cannot add this special tenant admin to an existing user. This is the only way to to grant this special tenant admin permission.
If you want to disable a tenant admin, edit that user by clicking the button and add the frevvo.ReadOnly role. You can also delete all tenant admin except the initial tenant admin created while creating the tenant. One common case is that you need to remove admin access to a person who initially had that permission via the initial tenant admin. To do this:
- Create a new tenant admin
- Edit the original tenant admin and add the role frevvo.ReadOnly
Edit Admin Users
There is also a short-cut to edit the initial tenant admin – click the button above the alphabet list to go directly to the initial tenant admin's edit page. You can also distinguish the initial tenant admin from non-admins because the initial tenant admin cannot be deleted so it does not have the
button. If you added additional tenant admins, the user list does not make it readily apparent that a user has that special admin access permission. Currently the way to distinguish an admin is click on each user's
button and see if the user has the Manage Tenant functions.
CSV Upload of Users and Roles
customers that have a large number of users with assigned roles, may need to import these (userids/roles) into . provides the ability to perform a bulk import of user data.
Only tenant admins may import user data and associated roles. The upload/download users links are available for tenants using all security managers. This feature is useful when creating/migrating a tenant that uses the LDAP or SAML Security managers.
Once you have more than a few thousand users, we recommend using the API because it is programmatic and can be automated. This is a more resilient way to bulk load lots of users. There is a limit of 150,000 users per upload.
Maximum Number of Users in CSV Upload
If you are not using the API, the maximum number of users that can be validated and uploaded with a csv file is controlled by the context parameter frevvo.userloader.maxUserLoadSize The default value is 10,000 and is configured in the web.xml file in the frevvo war. In-house customers can increase the maximum number by adding a parameter in <frevvo-home>\tomcat\conf\catalina\localhost\frevvo.xml. Refer to Configuring Batch Size for CSV Uploads for the details.
Download Users and Roles
- Make sure you are logged in as the tenant admin. Click the Manage Users link.
- Click the
download users csv file icon.
- This downloads a complete comma separated file that includes the list of the users and their assigned roles in the current tenant. Roles that exist in the tenant but are not assigned to any users will not be included in the file.The fields are comma separated. The following is an example:
...
| Field/Column Name | Description |
|---|---|
| userId | The unique user id used for login. Required. The maximum length of a user id is 75 characters. Userids that contain single quotes are supported. |
| 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. |
| password | For newly inserted users, the plain text password. Always blank on download. Default passwords should be provided especially if you are using a tenant configured with the SAML Security Manager. If you are using the Default Security Manager, users can then be instructed to change the password on first login using the Manage Personal Information option. |
| 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. |
| 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. |
| 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:
Notice the password column is blank.
...
You will see this message with the number of roles and users that were created: "Users Loaded successfully. 3 Added, 1 Updated, 0 Deleted, 4 Roles Added." Uploading an empty users file displays the message "Users file is empty".
...
| Tip |
|---|
|
...