AX2480

Axiom.Roles

The Axiom.Roles system table contains information about the defined security roles in your system.

Available columns

The following columns can be queried:

Column Description

RoleName

The name of the role.

RoleID

The database ID of the role.

Description

The description of the role.

AssignedSubsystem

The assigned subsystem for the role. Returns blank if the role is not assigned to a subsystem.

TableTypeReadFilter_TableTypeName

The role's configured read filter for the specified table type. This returns one of the following:

  • NotConfigured: The role has no configured access to the table type.

  • FullAccess: The role has been granted full read access to the table type.

  • A filter criteria statement: The role has a configured read filter for the table type.

  • Blank: The role has no read access to the table type. This is different than NotConfigured; in this case the role's read filter has been explicitly set to blank to indicate no read access.

TableTypeWriteFilter_TableTypeName

The role's configured write filter for the specified table type. This returns one of the following:

  • NotConfigured: The role has no configured access to the table type.

  • UseRead: The role's write access is the same level as the read access. This is the default setting when any access is configured to the table type. Any setting other than UseRead indicates that the role's write access has been separately configured from the read access.

  • FullAccess: The role has been granted full write access to the table type.

  • A filter criteria statement: The role has a configured write filter for the table type.

  • Blank: The role has no write access to the table type. This is different than NotConfigured; in this case the role's write filter has been explicitly set to blank to indicate no write access.

TableReadFilter_TableName

The role's configured read filter for the specified table. This property does not include any permissions inherited from a table type; it represents only what has been configured for the table itself. This returns one of the following:

  • NotConfigured: The role has no configured access to the table.

  • FullAccess: The role has been granted full read access to the table.

  • A filter criteria statement: The role has a configured read filter for the table.

  • Blank: The role has no read access to the table. This is different than NotConfigured; in this case the role's read filter has been explicitly set to blank to indicate no read access.

TableWriteFilter_TableName

The role's defined write filter for the specified tableThis property does not include any permissions inherited from a table type; it represents only what has been configured for the table itself. This returns one of the following:

  • NotConfigured: The role has no configured access to the table.

  • UseRead: The role's write access is the same level as their read access. This is the default setting when any access is configured to the table. Any setting other than UseRead indicates that the role's write access has been separately configured from the read access.

  • FullAccess: The role has been granted full write access to the table.

  • A filter criteria statement: The role has a configured write filter for the table.

  • Blank: The role has no write access to the table. This is different than NotConfigured; in this case the role's write filter has been explicitly set to blank to indicate no write access.

Table Type and Table permission columns

Each table type and table defined in the system result in two permission columns for the read filter and the write filter. If either of these settings become configured for a role for a particular table or table type, then both settings are considered configured.

For example, if you have a table type named GL and no settings have been configured for a role for that table type, then the columns will return data as follows:

Column   Value
TableTypeReadFilter_GL   NotConfigured
TableTypeWriteFilter_GL   NotConfigured

However, if you configure only the read access for that role and save it, then the write setting will become configured to the default values. In this example, the role was granted Full Access to the GL table type. Now the columns will return data as follows:

Column   Value
TableTypeReadFilter_GL   FullAccess
TableTypeWriteFilter_GL   UseRead

Where "use read access" is the default setting for write access.

If later the role's configured read access is removed, and the write setting remains at the default value, then both values will be returned to NotConfigured.

Save Type 4 support

Axiom.Roles can be modified using Save Type 4. See Managing roles in Axiom Security using Save Type 4.