Permission

The Permission document allows you to create new permissions or edit existing ones. The Permission Lookup allows you to search for and view existing permissions. You can view summarized information about the permission detail values as well as the roles that are currently associated with this permission.

Only members of the KFS-SYS Technical Administrator or KFS-SYS Manager role can create or modify Permission documents. These documents do not route for approval.

Warning! Extreme caution should be exercised when modifying existing permissions or adding new ones. Even small changes can have application-wide consequences. Changes should be made only after sufficient testing with your local configuration.

Permission Lookup search criteria:

Title

Description

Template Namespace

Optional. To search for a permission based on its template namespace (that is, the name of the application and module to which its template belongs), select the appropriate namespace.

Template Name

Optional. To search for a permission based on the name of the template it is based on, enter the appropriate template name.

Permission Namespace

Optional. To search for a permission based on its namespace, select the appropriate permission namespace.

Permission Name

Optional. To search for a permission by name, enter its name.

Role Namespace

To search for a permission based on the namespace of the role to which it is assigned, enter the appropriate role namespace.

Role Name

Optional. To search for a permission based on the role to which it is assigned, enter the appropriate role name.

Principal Name

Optional. To search for a permission based on the principals that currently have this permission through their association with a role, enter an appropriate principal name.

Group Namespace

Optional. To search for a permission based on the namespace of groups that have this permission through the group's association with a role, enter an appropriate group namespace.

Group Name

Optional. To search for a permission based on the name of a group that has this permission through its association with a role, enter an appropriate group name.

Permission Detail Values

Optional. To find a permission based on a specific permission detail value associated with it, enter the value.

The Permission results display contains the fields described in the table below.

Permission Lookup results fields

Title

Description

Actions

Actions allow selection of edit or copy for each permission displayed.

Template Namespace

The code identifying the application and module the template pertains to. Because templates tend to be general categories, they are often associated with system-level namespaces.

Template Name

The template the permission is based on. A template usually defines, in a broad sense, what the permission controls. Similar types of permissions share the same template.

Permission Namespace

The code designating the application and module this permission is associated with.

Permission Name

The descriptive name for this permission. In most cases this will match the Template Name.

Permission Description

Display only. Detailed information that describes the permission and its purpose.

Permission Detail Values

Display only. Detailed information that, in combination with the permission name, defines the permission's function.

For example, if the permission name is 'Initiate Document,' the Permission Detail Values field indicates the specific type of document the initiate permission pertains to.

Permission detail values can include many different types of data. Some common types are defined below.

documentTypeName: The name of the document type associated with this permission.

routeNodeName: The point in a document's workflow routing at which this permission becomes relevant.

routeStatusCode: The routing status that a document must be in for this permission to apply.

propertyName: Often, a field or document element that the permission pertains to.

Granted to Roles

Lists the namespace and name of roles that have this permission. Click on the linked name to view the Role inquiry.

 

To view an Inquiry screen for a permission, select the Permission Name of the appropriate row in the search results. The Inquiry screen contains the same information as the Search Results in a slightly different format.

More:

Document Layout