| Database Definitions | |
The following is a description of the fields used for the Cleo VLNavigator applications and the storing of User login/access information.
The DashboardsOptions table is used to store options relating to Dashboards.
| Column/Field Name | Data Type | Length | Source |
|---|---|---|---|
| DashboardsOptionsID | INTEGER | Generated by Cleo VLNavigator and used as a "key" to the records | |
| ScorecardEnabled | TINYINT | Flag indicating if the scorecard is enabled (0 = disabled; 1 = enabled) |
The VLApplicationNum table is used to store Cleo VLNavigator application names and enabled/disabled flags for the application as a whole.
| Column Name | Data Type | Length | Description |
|---|---|---|---|
| VLApplicationNum | INTEGER | Number assigned by Cleo VLNavigator for each application | |
| Application | VARCHAR | 255 | Application name |
| IsEnabled | TINYINT | Flag indicating if the application is enabled (0 = disabled; 1 = enabled) |
The VLContact table is used to store various types of contact information for a user.
| Column Name | Data Type | Length | Description |
|---|---|---|---|
| VLContactID | INTEGER | Generated by Cleo VLNavigator and used as a "key" to the records | |
| VLEntityID | INTEGER | VLEntityID in VLEntity table | |
| VLContactNum | INTEGER | VLContactNum in VLContactNum table | |
| Value | VARCHAR | 255 | Depending on the value in VLContactNum, this is either an email address, phone number, or IP address. |
| IsPrimary | TINYINT | Set to 1 for the primary contact for a user and 0 otherwise. |
The VLContactNum table is used to store enumerated list of contact information types (Example: “Work Email”).
| Column Name | Data Type | Length | Description |
|---|---|---|---|
| VLContactNum | INTEGER | Number assigned by Cleo VLNavigator for each contact type. | |
| Description | VARCHAR | 255 | Description of contact information type |
The VLEntity table is used to store information on both the configured Users and User Groups.
| Column Name | Data Type | Length | Description |
|---|---|---|---|
| VLEntityID | INTEGER | Generated by Cleo VLNavigator and used as a "key" to the records | |
| Name | VARCHAR | 255 | For a group, the Group Name is stored here. For non-LDAP users, this contains the user’s Full Name. |
| VLEntityGroupID | INTEGER | VLEntityGroupID in VLEntityGroup table | |
| IsEnabled | TINYINT | Group/User enabled (1) or disabled (0) flag | |
| IsDefaultEntity | TINYINT | Set to 1 for User Groups and 0 otherwise | |
| IsSystemAdmin | TINYINT | Set to 1 for the System Administrator user and 0 otherwise. |
The VLEntityApplication table is used to store information on whether each VersaLex application is enabled or disabled for a specific User or User Group.
| Column Name | Data Type | Length | Description |
|---|---|---|---|
| VLEntityApplicationID | INTEGER | Generated by Cleo VLNavigator and used as a "key" to the records | |
| VLEntityID | INTEGER | VLEntityID in VLEntity table | |
| VLApplicationNum | INTEGER | VLApplicationNum in VLApplicationNum table | |
| IsEnabled | TINYINT | Set to 1 if the application is enabled and 0 if disabled for the user/group |
The VLEntityApplicationFile table is used to store file paths associated to a specific application.
| Column/Field Name | Data Type | Length | Source |
|---|---|---|---|
| VLEntityApplicationFileID | INTEGER | Generated by Cleo VLNavigator and used as a "key" to the records | |
| VLEntityID | INTEGER | VLEntityID in VLEntity table | |
| VLApplicationNum | INTEGER | VLApplicationNum in VLApplicationNum table | |
| Sequence | INTEGER | Sequence order of files | |
| Path | VARCHAR | 255 | Path to file for this application |
The VLEntityApplicationPrivilege table is used to store specific privileges that the VLEntity has for an application.
| Column/Field Name | Data Type | Length | Source |
|---|---|---|---|
| VLEntityApplicationPrivilegeID | INTEGER | Generated by Cleo VLNavigator and used as a "key" to the records | |
| VLEntityID | INTEGER | VLEntityID in VLEntity table | |
| VLApplicationNum | INTEGER | VLApplicationNum in VLApplicationNum table | |
| Privilege | VARCHAR | 255 | Privileged item name |
The VLEntityGroup table is used to store the type of group (VLNavigator Group, VLNavigator Admin Group, …) for each User Group configured.
| Column Name | Data Type | Length | Description |
|---|---|---|---|
| VLEntityGroupID | INTEGER | Generated by Cleo VLNavigator and used as a "key" to the records | |
| VLGroupNum | INTEGER | VLGroupNum in VLGroupNum table |
The VLEntityNum table is used to store the enumerated list of Entity types (Example: “VLNavigator Person”).
| Column Name | Data Type | Length | Description |
|---|---|---|---|
| VLEntityNum | INTEGER | Number assigned by Cleo VLNavigator for each Entity type | |
| Description | VARCHAR | 255 | Description of Entity type |
The VLGroupNum table is used to store the enumerated list of Group types (Examples: “VLNavigator Admin Group”, “VLNavigator Group”)
| Column Name | Data Type | Length | Description |
|---|---|---|---|
| VLGroupNum | INTEGER | Number assigned by Cleo VLNavigator for each Group type | |
| Description | VARCHAR | 255 | Description of Group type |
The VLOpAuditTrail table is used to store a trail of events of things the users have done through the VersaLex and Cleo VLNavigator user interfaces.
| Column Name | Data Type | Length | Description |
|---|---|---|---|
| VLOpAuditTrailID | INTEGER | Generated by Cleo VLNavigator and used as a "key" to the records | |
| ModDateTime | DATETIME | Date and time of the audit trail event | |
| ComputerName | VARCHAR | 255 | Computer name or IP address from where the modification was made |
| VLSerial | VARCHAR | 255 | Serial number of , , or from where the modification was made |
| Username | VARCHAR | 255 | Logged in user |
| UserFullName | VARCHAR | 255 | Full username of logged in user |
| ItemType | VARCHAR | 255 | Type item modified |
| ItemName | VARCHAR | 255 | Name of item modified |
| OldItemName | VARCHAR | 255 | Original name of item modified (in the case of a renamed item) |
| EventType | VARCHAR | 255 | Type of event that has occurred |
| PathName | VARCHAR | 255 | Relative path of file modified |
The VLOpAuditTrailOptions table is used to store information on if and when to purge old Operator Audit Trail events
| Column Name | Data Type | Length | Description |
|---|---|---|---|
| VLOpAuditTrailOptionsID | INTEGER | Generated by Cleo VLNavigator and used as a "key" to the records | |
| PurgeEventsEnabled | TINYINT | Set to 1 if purge of old events is desired. Set to 0 otherwise. | |
| PurgeAfterDays | INTEGER | Operator Audit Trail events will be purged after they are older than this number of days |
The VLUser table is used to store information on the users that can log into the VersaLex and Cleo VLNavigator applications. Note: The users in the Administrator group are also store in the encrypted Users.xml file so that administrators can log in even when the database is not functioning.
| Column Name | Data Type | Length | Description |
|---|---|---|---|
| VLUserID | INTEGER | Generated by Cleo VLNavigator and used as a key to the records. | |
| VLEntityID | INTEGER | VLEntityID in VLEntity table. | |
| FirstName | VARCHAR | 255 | User’s first name. |
| LastName | VARCHAR | 255 | User’s last name. |
| BuildFullName | TINYINT | True if the full name should be built from FirstName and LastName. | |
| UserName | VARCHAR | 255 | Log in user name. |
| Alias | VARCHAR | 255 | Optional user alias. |
| LDAPUser | TINYINT | Set to 1 for an LDAP user. Set to 0 otherwise. | |
| UserPassword | VARCHAR | 255 | Password for non-LDAP users. |
| UserUID | VARCHAR | 255 | Unique identifier for non-LDAP users. |
The VLUserEntityGroup table is used to store information related to VLNavigator user groups.
| Column Name | Data Type | Length | Description |
|---|---|---|---|
| VLUserEntityGroupID | INTEGER | Generated by Cleo VLNavigator and used as a "key" to the records | |
| VLEntityGroupID | INTEGER | VLEntityGroupID in VLEntityGroup table | |
| LdapUserGroup | TINYINT | True if this is an LDAP group | |
| OverrideDomain | TINYINT | True if overriding the base domain | |
| Domain | VARCHAR | 255 | Overriding base domain |
| OverrideFilter | TINYINT | True if overriding LDAP search filter | |
| Filter | VARCHAR | 255 | Overriding search filter |
| ExtendFilter | VARCHAR | 255 | Extension of search filter |
The VLUserEntityGroupAccess table is used to store User Group access to the various instances of the VersaLex application configured.
| Column Name | Data Type | Length | Description |
|---|---|---|---|
| VLUserEntityGroupAccessID | INTEGER | Generated by Cleo VLNavigator and used as a "key" to the records | |
| VLEntityGroupID | INTEGER | VLEntityGroupID in VLEntityGroup table | |
| VLPools | VARCHAR | 255 | List of VersaLex pools to which the user group has access |
| VLSerials | VARCHAR | 255 | List of , , or serial numbers to which the user group has access |
The VLUserEntityGroupPrivilege table is used to store access levels to various items within the VersaLexapplication.
| Column Name | Data Type | Length | Description |
|---|---|---|---|
| VLUserEntityGroupPrivilegeID | INTEGER | Generated by Cleo VLNavigator and used as a "key" to the records | |
| VLEntityGroupID | INTEGER | VLEntityGroupID in VLEntityGroup table | |
| VLPrivilegeItem | VARCHAR | 255 | List of specific items within , , or to which the user group has access |
| VLPrivilegeAccess | VARCHAR | 255 | Access restriction level for VLPrivilegeItem(s) |
The VLUserEntityGroupTRAccess table is used to store which file types the user group has access to within Transfer Report. If the user group does not have access to a file type, then users within that group will not be able to view or email the contents of the transferred file.
| Column Name | Data Type | Length | Description |
|---|---|---|---|
| VLUserEntityGroupTRAccessID | INTEGER | Generated by the Cleo VLNavigator application and used as a "key" to the records | |
| VLEntityGroupID | INTEGER | VLEntityGroupID in VLEntityGroup table | |
| AccessibleFileTypes | VARCHAR | 255 | List of specific file types (EDI, XML, Text), separated by commas, within the Transfer Report to which the user group has access. |
| TransactionsAccessible | Bit | ON if the transaction types in the VLUserEntityGroupTREDITypes table are accessible to the user group. OFF if the transaction types in the VLUserEntityGroupTREDITypes table are not accessible to the user group. |
The VLUserEntityGroupTRColumns table is used to store which Transfer Report columns are displayed and which order they are displayed. It also stores any custom column names configured.
| Column Name | Data Type | Length | Description |
|---|---|---|---|
| VLUserEntityGroupTRColumnsID | INTEGER | Generated by the Cleo VLNavigator application and used as a "key" to the records | |
| VLEntityGroupID | INTEGER | VLEntityGroupID in VLEntityGroup table | |
| ColumnName | VARCHAR | 255 | Either VLTransfers table column name or one of the items tracked through file tracking |
| CustomColumnName | VARCHAR | 255 | User-customized column name |
| Enabled | Bit | ON if this column is displayed in the Transfer Report table; Otherwise, OFF | |
| ColumnNumber | INTEGER | Order of the columns in the Transfer Report table (0-based) |
The VLUserEntityGroupTREDITypes table is used to store which EDI types the user group can/cannot access. Whether the user group can or cannot access the items in this table depends on the TransactionsAccessible flag in the VLUserEntityGroupTRAccess table.
| Column Name | Data Type | Length | Description |
|---|---|---|---|
| VLUserEntityGroupTREDITypesID | INTEGER | Generated by the Cleo VLNavigator applcation and used as a "key" to the records | |
| VLEntityGroupID | INTEGER | VLEntityGroupID in VLEntityGroup table | |
| EDIType | VARCHAR | 255 | Either ASC X12, EDIFACT, or TRADACOMS |
| TransactionType | VARCHAR | 255 | Specific transaction
type Example: 850 (for ASC X12) |
The VLUserEntityGroupTreeAccess table is used to store user group access to the VersaLex and Cleo VLNavigator applications
| Column Name | Data Type | Length | Description |
|---|---|---|---|
| VLUserEntityGroupTreeAccessID | INTEGER | Generated by Cleo VLNavigator and used as a "key" to the records | |
| VLEntityGroupID | INTEGER | VLEntityGroupID in VLEntityGroup table | |
| VLPoolTreeSubset | VARCHAR | 255 | List of VersaLex pools to which the user group has access |
| UserGroupTreeSubset | VARCHAR | 255 | List of , , or user groups to which the user group has access |
| HostFolderTreeSubset | VARCHAR | 255 | List of host folder tree to which the user group has access |
| ApplicationTreeSubset | VARCHAR | 255 | List of Cleo VLNavigator applications to which the user group has access |