Workflow Security Definitions
In the Workflow Security Definitions application, you can configure workflow security profiles so that a state/state type controls who can access specific workflow attributes, such as:
- Control who can access a record with workflow by securing read, update, delete, and insert actions based on the record's workflow state/state type.
- Define restricted field profiles to identify fields on a record that you want to restrict or grant access to based on that record’s workflow state/state type.
Workflow Restricted Field Definitions
In the Workflow Security Definitions application there is a table lookup to profiles in the Workflow Restricted Field Definitions application. If you create a workflow restricted field profile, it does not initially restrict any of the fields. To restrict the fields, the workflow restricted field profile must be added to the workflow security profile in the Workflow Security Definitions application. Once the restricted field has been added, then the fields in that workflow restricted field profile are unable to be updated by the user at the state(s) specified in the workflow security profile.
Once the workflow security profile is complete, it needs to be added to a permission definition.
Permission Definitions
In the Permission Definitions application, the Workflow Data Security page controls a user’s ability to see and interact with data based on the workflow state or state type combination. In a permission profile, the workflow data security record serves as a pointer to the workflow security profile that is defined through the Workflow Security Definitions application.
The Workflow Secured Transition Access subtable in Permission Definitions allows you to make secured state transitions available to users. In the Workflow Builder application there is the Secured checkbox to make specific transitions secured. This ensures that if someone is trying to access a transition that is marked as secure, they must have an administrator grant access if they want to see the transition.
When you define a workflow and table on the Workflow Transition Security page, a user then has full access to all secured transitions on that workflow. If a workflow does not have the Secured checkbox selected for any transitions, then you do not need to configure anything on the Workflow Secured Transition Access subtable.
Configure workflow security
Configure workflow security to restrict permissions to read, update, and delete records based on workflow values using the Workflow Security Definitions, Permission Definitions, and Role Definitions applications. Security can also be used to configure restrictions on inserting records on detail tables.
Create a workflow security profile
In the Workflow Security Definitions application, create a new record. There are several considerations, such as:
- The Name is used to identify the workflow security profile in the Permission Definitions application.
- The name of the table that contains the workflow this security profile is associated with should be entered in the Table field.
Create access rules
In the Access Rules subtable, select the Add Access Rules button to create each access rule needed for the security profile.
The table below explains what each field and their corresponding values define as filter criteria for the access rules. All of the fields are optional. If you leave one of these fields empty, the access rule applies to all possible values for this field. If you leave all of the fields empty, you can select the Read or Update checkboxes to allow users to read and/or update the record regardless of the workflow selected, or the Type, State, or State Type, the record is in.
| Fields | Values in this field define... |
|---|---|
| Workflow | The name of a workflow that is built over the table specified above. |
| Workflow Type | The name of a workflow type that is configured for the workflow. |
| From State | A state. The access rule applies only to records with this state. |
| From State Type | A state type. The access rule applies only to records with this state type. |
There are different access levels for user interactions with records that you can set. The table below explains what each field and their corresponding values define for user access.
| Fields | Values in this field define... |
|---|---|
| Allow Delete | Whether users are allowed to delete records. For Header Detail applications, the State and State Type defined in the access rule refer to the Detail table. |
| Allow Insert | Whether users are allowed to insert records into the detail table. This checkbox is only present for Header Detail applications. For Header Detail applications, the State and State Type defined in the access rule refer to the Header table. If the state and state type defined in the access rule aren't in the header table, users cannot insert records into the detail table, even if the checkbox is selected. If you have a blank access rule with no fields defined and the checkbox selected, a user can add records to the detail table no matter what state or state type the header or detail is in. |
| Allow Update | Whether users are allowed to make changes to records. For Header Detail applications, the State and State Type defined in the access rule refer to the Detail table. |
| Allow Read | Whether users are allowed to view records. For Header Detail applications, the State and State Type defined in the access rule refer to the Detail table. |
If you created a restricted fields profile in the Workflow Restricted Field Definitions application, enter the name in the Workflow Restricted Fields Definition.
When a profile is entered, users are prevented from making changes to the fields defined in the profile even when the Allow Update checkbox is selected for the access rule. Learn more in the Create or customize workflow restricted fields topic.
Permission Definitions
In the Permission Definitions application, create a new record and add the workflow security profile on the Workflow Security page.
Role Definitions
If the permission isn't already being used in a role, navigate to the Role Definitions application and assign the permissions to a role.
Create or customize workflow restricted fields
Define or customize lists of restricted fields for workflow with the Workflow Restricted Field Definitions and Workflow Security Definitions applications. Workflow restricted field profiles are added to access rules in workflow security to prevent users from making changes to the specified fields.
Customize an existing workflow restricted field profile if you want to change or limit access to fields based on a workflow state which was delivered to you. This allows you to prevent users from making changes to tenant owned custom fields. Only definitions which have the AllowAdditions value selected in the Customization Pattern field are allowed to be customized.
Create a new workflow restricted field profile if you need to create a new workflow state and limit access to the fields, or if your delivered workflow restricted field profile does not allow customization.
Customize a workflow restricted field profile
To customize a restricted field profile, in the Workflow Restricted Field Definitions application, you must:
- Open the definition.
- In the Restricted Fields subtable, select the Add button to create an entry for each additional field that should be restricted. Only tenant owned fields can be added.
Create a workflow restricted field profile
To create a new restricted field profile, in the Workflow Restricted Field Definitions application, you must:
- Create a new record.
- In the Restricted Fields subtable, select the Add button to create an entry for each field that should be restricted.
- In the Field field, select the name of the data item associated with the field.
In the Workflow Security application, you must:
- Create a new record.
- Select the table the workflow is built over.
- In the Access Rules subtable, enter the name of the restricted field definition.
Learn more in the Configure workflow security topic.