Skip to main content

How to create and configure a new User Table

Use the Configuration Search to access the User Table Configuration screen. The User Tables grid displays the user tables that have already been created. These tables are system-wide, meaning that use

Updated over 2 weeks ago

Use the Configuration Search to access the User Table Configuration screen. The User Tables grid displays the user tables that have already been created. These tables are system-wide, meaning that user tables created by any user will display here. The Display Name of a table can be modified by selecting the edit pencil icon, but the Physical Name cannot be modified. The Table Type is also shown and cannot be modified. Click the

mceclip3.png

icon to add a new User Table.

user_table_config_screen.png

This will open the User Tables Details screen:

user_table_details.png

The following fields are available to populate. All are mandatory fields:

Physical Name - Determines what your new user table will be called in the Equus Platform database. In order to avoid potential confusion, all user tables have the UT_ (User Table) prefix added before the physical name when creating the new table. Users do not need to add this prefix manually. The physical name cannot contain spaces or special characters, but may contain any combination of letters, numbers, and underscores. Physical names will be automatically capitalized. A user table cannot have the same physical name as another table. The sum of the characters in a table’s physical name and any field’s physical name in that table cannot exceed 90. Note - You should not include ‘UT_’ anywhere in the Physical Name of your table as this will cause issues if using the User Table in Authorizations.

Display Name - Determines how your new table will display in any parts of the Equus Platform that list tables by their display names. A display name can include spaces, special characters, and lowercase. A user table cannot have the same display name as another table. Note, it is recommended to minimize the use of special characters as some characters may generate errors when running User Reports.

Level - Determines at which level of the Equus Platform the user table exists or which table in the system is the user table’s parent table. The options are:

  • Assignment

  • Company

  • System

  • Other - when this is selected, the specific parent table must be selected to associate with the user table. Certain features have prerequisites on specific user table parent configuration. For example, for the user table to appear as a table on the Request Type Details screen, Request must be selected as the Parent Table.

Table Type - Is either Single-Record meaning a one-to-one relationship with its parent table or Multi-Record meaning a one-to-many relationship between its parent table and itself. System-level single record table types are not supported by the Equus Platform. The default option is Multi-Record. Select Single Record if creating a user table for it to appear as a table on the Request Type Details screen.

Duplicate at Authorization Level – This checkbox will only display when the Level is Assignment. When this box is checked and

save.png

is clicked, a duplicate table will be created at the Authorization Level. This field will be the same as configured in the Assignment Level table. The authorization tables created as a duplicate of an assignment table will not be visible in the User Table grid.

When configuring Employee Self-Initiated Moves using the Authorization Template, for User Tables to appear in the drop-down list on the Employee Self-Start tab, user tables must have one of the following configurations:

  • Level = <Other>, Parent Table = <Authorization>, Table Type = <Single-Record>

  • Level = <Assignment>, Table Type = <Single-Record>, Duplication at Authorization Level = checkbox ticked.

Once the

save.png

button is clicked, only the Display Name can be modified all the other fields remain fixed.

Table Fields

New user tables will have some fields by default:

  • a standard hidden identity field

  • the standard audit fields (Create By, Create Date, Last Update By, Last Update Date)

  • an identity column linking the table to parent table assigned in the Level field.

Note, you cannot create a Field Name and Display Name values that match a hidden field value.

Additional fields can also be added and doing so can significantly enhance the functionality of the user table.

To add new fields, click

new_button

in the Table Fields grid to add the specified number of empty rows to the grid for field configuration.

user_table_details_add_table_field.png

For each field, populate the following fields:

Field Name - Determines what the new field of the user table will be called in the database. The field name cannot contain spaces, special characters, or start with a number, but may contain any combination of letters, numbers, and underscores. Field names will be automatically capitalized. A user table cannot have multiple fields with the same name. The sum of the characters in a field’s physical name and the table’s physical name cannot exceed 90.

Display Name – This field determines how the new field of the user table will display. A display name can include spaces, special characters, and lowercase. A user table cannot have multiple fields with the same display name.

Field Type - Identifies the data type of the new field. A field must have a type. Standard data types include:

  • Account - allows users to select an account from chart of accounts

  • Boolean - allows users to select a boolean value (i.e. yes/no)

  • City - has a hierarchical dependency on the State field to select a specific City from a State and Country

  • Classification Lookup - provides a list of values from the selected Lookup Group

  • Country - allows users to select a Country

  • Currency - allows users to select a currency and return the currency code

  • Date - allows users to select a specific date in the date picker

  • Document - allows users to upload a document either a new or from existing list

  • Email - allows users to input valid email address

  • Hierarchical Lookup - provides a list of values configured in the Hierarchical Lookup Maintenance Details screen

  • Money - allows users to input money value paired with currency value

  • Multi-line Text - allows users to input text in multiple lines, users are able to resize the text field

  • Number - allows users to enter a numeric value

  • Percentage - allows users to enter a numeric value in percentage format

  • Resource - allows users to select a resource available in the system

  • Rich Text - allows users to enter text and configure the text format

  • State/Province - has a hierarchical dependency on the Country to select a specific State and/or Province

  • Text - allows users to input a value in plain text

  • Vendor - allows users to select a vendor configured in the system

  • Whole Number - allows users to enter a whole number

Note, for fields indicating a status, select a Boolean type rather than a Classification Lookup type.

Under the Additional Info column of the Table Fields grid, certain fields may be required to be populated depending on selected field type value, additional fields which appear in the Additional Info column in the grid:

Length - Becomes enabled once the <Text>, <Multi-line Text>, or <Email> type is selected for a new user field and corresponds with the maximum allowed number of characters for this field. This value is set at 100 by default but can be changed to any whole number between 1 and 4000. Fields that support length must have a value for this field.

Lookup Group - Becomes enabled once the <Classification Lookup Field> type is selected for a new user field. This drop-down list corresponds with the Lookup Fields available in Lookup Maintenance, the values available on the User page will correspond to the Lookup Values configured for that Classification Lookup Field. A <Classification Lookup> type field must have a Lookup Group selected.

Parent Hierarchical Field - Becomes enabled once the <Hierarchical Lookup> type is selected for a new user field. This drop-down list corresponds with other <Hierarchical Lookup> type fields within the existing user table configured. This field is used to identify a preceding field in a hierarchy. If the field is the first field in a hierarchy, this field would not be selected.

Hierarchical Lookup Group - Becomes enabled once the <Hierarchical Lookup> type is selected for a new user field. This drop-down list corresponds with Hierarchical Lookup Groups configured on the system and company Hierarchical Lookup Maintenance pages. This field identifies the corresponding hierarchical group to represent in the field. This field must always be chosen for <Hierarchical Lookup> field types.

Parent Country Field - Becomes enabled once the <State/Province> or <City> type is selected for a new user field. For <State/Province> type, the Parent Country Field is enabled and the available options are the fields from the <Country> type. For <City> type, the Parent Country Field and the Parent State Lookup Field are enabled and the available values are the fields from the <Country> type and from <State/Province> type respectively.

Parent State Lookup Field - Becomes enabled together with Parent Country Field once the <City> type is selected for a new user field. The available city values are from the combination of Country and State/Province. Note that the Parent State Lookup Field is a mandatory field but the Parent State Lookup Field is not.

Resource Role - Becomes enabled once the Resource type is selected for a new user field. This drop down list corresponds with the list of active resource roles on the Resource Roles screen.

Things to note

  • The user table screen should block Field Name and Display Name values that match auto-generated Foreign Key values used in other Equus Platform tables. The user should get an error message and the table should not save. This should happen regardless of whether it is the initial creation of the User Table or an update. These include:

    • Create By

    • Create Date

    • Last Update Date

    • Last Update By

    • Id

    • Parent Id (e.g. Assignment ID if it is an Assignment Level User Table).

  • It is best practice not to use the same Field Name as standard Equus fields names, (e.g. EMPLOYEE_ID, ASSIGNMENT_ID, COMPANY_ID, AUTHORIZATION_ID, etc). Using these names might block users from being able to save the User Table record as well as may cause errors in downstream processes.

  • If your User Table/s contains these violations prior to Equus Platform 22.6, you may experience difficulties working with this existing User Table/s. Contact your Equus representative for assistance.

Did this answer your question?