A downloadable PDF version is available at the bottom of the page together with the Excel import template.
Rules. (Required fields are marked with a Red background colour)
Field Name | Description | Rules | Exception Handling | Values to be placed | Default Values | Field Type |
Active | This contains confirmation if the user account should be activated immediately after creation | This needs to be a True/False value | N/A | True/False | False | Boolean |
FullName | This field contains the full name of the user. | Alphanumeric value | N/A | N/A | N/A | Variable Character (100) |
UserName | This field contains the username, which the user will use to log into PIPware. | Usernames must be unique. This field is used to determine whether to update an existing user or create a new user. | If the username already exists, the existing user/person will be updated rather than creating a new user. if left blank the record will not be imported | N/A | N/A | Variable Character (100) |
Password | This field contains the password for the user. | If no password is specified, a "Create Password" email will be sent out to the user to allow them to choose an initial password. | N/A | N/A | N/A | Variable Character (100) |
EmailAddress | This field contains the email address of the user. | Must be a valid email address. | N/A | N/A | N/A | Variable Character (250) |
PhoneNumber | This field contains the phone number of the user. | Alphanumeric value | N/A | N/A | N/A | Variable Character (30) |
MobileNumber | This field contains the mobile number of the user. | Alphanumeric value | N/A | N/A | N/A | Variable Character (30) |
Language | This field contains the primary Language for the user. | This value must be valid in the system. The language selected must match up with the name of a Language saved on the system. | If there is a spelling mistake or the language selected on the import does not meet the Languages saved on the system, the record will still be allowed to be imported onto the system. However, the Language field will be empty. | N/A | N/A | Lookup (Language) |
Structure Level 1 | This value must be valid in the system. The Structure Level 1 (Department) selected must match up with the name of a Structure Level 1 (Department) saved on the system. | If there is a spelling mistake or the Structure Level 1 (Department) selected on the import does not meet the Structure Level 1 (Department) saved on the system, the record will still be allowed to be imported onto the system. However, the Structure Level 1 (Department) field will be empty. | N/A | N/A | Lookup (Department) | |
Structure Level 2 | This field contains the Structure Level 2 (Sub Department) to which the user belongs. | This value must be valid in the system. The Structure Level 2 (Sub Department) selected must match up with the name of a Sub Department saved on the system. | If there is a spelling mistake or the Structure Level 2 (Sub Department) selected on the import does not meet the Structure Level 2 (Sub Department) saved on the system, the record will still be allowed to be imported onto the system. However, the Structure Level 2 (Sub Department) field will be empty. | N/A | N/A | Lookup (Sub Department) |
Structure Level 3 | This field contains the Structure Level 3 (Team) that the user belongs to. | This value must be valid in the system. The Structure Level 3 (Team) selected must match up with the name of a Team saved on the system. | If there is a spelling mistake or the Structure Level 3 (Team) selected on the import does not meet the Structure Level 3 (Team) saved on the system, the record will still be allowed to be imported onto the system. However, the Structure Level 3 (Team) field will be empty. | N/A | N/A | Lookup (Team) |
PersonPosition | This field contains the Person Position assigned to the user. | This value must be valid in the system. The Person Position selected must match up with the name of a Person Position saved on the system. | If there is a spelling mistake or the Person Position selected on the import does not meet the Person Positions saved on the system, the record will NOT be imported onto the system. | N/A | N/A | Lookup (Person Position) |
Role | This field contains the Role(s) assigned to the user. | This value must be valid in the system. The Role(s) selected must match up with the name of a Role saved on the system. | If there is a spelling mistake or the Role selected on the import does not meet the Roles saved on the system, the record will NOT be imported onto the system. | N/A | N/A | Lookup (Role) |
Help Tours | This field determines if the Help Tours should be activated for the user | This needs to be a True/False value | N/A | True/False | False | Boolean |
SupportWidget | This field determines if the Support Widget should be activated for the user | This needs to be a True/False value | N/A | True/False | False | Boolean |