Overview
Navigate to Administrator
Click Request Workflow Configuration
The Following screen opens where you can customize the following operation:
View the added dialog list
Edit or update an existing dialog
Add new dialog
...
Table of Contents |
---|
Configuring Request Workflow
Configure the Request Workflows to match your needs. You can adjust the behavior of dialogs, approvers, unique metadata and other metadata, email templates, and security.
Table of Contents | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Configuring the Request Workflow
Navigate to Administration.
Click on Request Workflow Configuration. The following screen is displayed:
...
Expand | ||
---|---|---|
| ||
Filter |
...
The Filter button allows you to search the workspace configuration |
...
.
|
...
|
...
|
...
|
...
|
...
Click Filter to display the results and click Clear to rest the fields
Add New Dialog
...
Expand | ||
---|---|---|
| ||
Add a New DialogYou can add a dialog to create a workspace, team, channel, or OneDrive folder by using the request workflow.
|
...
|
...
|
...
|
...
|
...
Info |
---|
Tip: Based on system selection, the action type list value will change. |
Click Next to creates the new dialog.
...
Note: User can customize the dialog details in the provided accordion.
Customizing the dialog accordions -
Panel
You can view the configured panel with an information like panel type, Display Name, Description. Order, Hidden status, and Action
You can add new panel by clicking Add New, the following screen opens -
...
Field
...
Description
...
Panel
...
Specify the panel name
...
Display Name
...
Specify the display name
...
Description
...
Specify the description
...
Is Hidden
...
Select the hidden value
Click Save to add new panel and click Cancel to close the dialog
Under Action, click Edit to edit or update the panel details, the following screen opens:
...
Click Update to edited the detail and click Cancel to close the dialog
Access
Allows you to add users/groups that can access the workspace dialog created here.
Users who are not explicitly granted access to any dialog can still use the default dialog if they are allowed to create workspaces.
The following accordion opens
...
You can view created user name by default
Click Add New to add new user/group, the following dialog opens
...
Field
...
Descrption
...
Type
...
Select the type to add either User or Group
...
Select a User/Group
...
Select the user/ group from the drop-down. To select a user, either click the drop-down menu and select from the list or manually enter the name, which will auto-complete if the user is added in the Users & Groups tab.
...
Requires Approval
...
Select Yes to add an additional Approval step when creating the workspace. The workspace will be created only if approved.
...
Expiration Date
...
Specify the expiry date of access to the user/ group.
Click Save to add an user/group and click Cancel to close the dialog
Approvers
Allows you to add a users/groups that can approve the workspace dialog created here.
...
Click the Add New, the following dialog opens
...
Field
...
Descrption
...
Type
...
Select the type to add either User or Group
...
Select a User/Group
...
Select the user/ group from the drop-down. To select a user, either click the drop-down menu and select from the list or manually enter the name, which will auto-complete if the user is added in the Users & Groups tab.
...
Expiration Date
...
Specify the expiry date of access to the user/ group.
Click Save to add an approver in the approver list and click Cancel to close dialog
Note: The workspaces that require approvals are listed and can be approved in the Approvals tab.
Also, an email notification is sent to all the approvers and members of the approver group.
If one of the users reject/approve a request, it can not be edited by others
Unique Metadata
Allows you to add unique metadata to the workspace dialog created here. This metadata is displayed in the selected panel.
...
Click the Add New button in the far right column to assign unique metadata to the workspace. In the Add Unique Metadata window, the following dialog opens -
...
Field
...
Description
...
Metadata
...
Note: A Content Mover job is submitted automatically if a Team is created through Request Workflow. Note: The user can customize the dialog box details in the provided accordion.
When configuring Content Mover to move content from a DMS to Teams, CAM will warn users that syncing NetDocuments to Teams will not work.
When Advanced Mapping is set as True for DMS->Teams, the content is copied to the target according to the mapping. Note: When the Advanced Mapping is set to True, the Copy As field will be hidden. |
Expand | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
Customizing the dialog accordionsPanel
AccessAllows you to add users/groups that can access the workspace dialog box created here. Users who are not explicitly granted access to any dialog can still use the default dialog if they have permission to create workspaces. It is possible for the same Request Workflow to require approval for some requesters and not others. The following accordion opens:
|
...
|
...
|
...
Default Value
...
Select the default value to be assigned to the metadata. Manually enter a value for the field or the drop-down will display values if it is assigned in Administration>Metadata>Manage.
...
Display Label
...
Enter a display name for the metadata. Make this as specific as needed to differentiate between similar metadata names that may exist.
...
Help Text
...
Enter help text to be displayed as a tool-tip on the custom field.
...
Type
...
Select the type of metadata from the drop-down. Options include:
Date: Represents date value (e.g. 2018-10-10)
String: Alphanumeric characters (e.g. cam123)
Boolean: Represent logical values (e.g. True or False)
Number: Numeric data values (e.g. 1,2,3)
Currency: Represents integer format (e.g. 123.456)
...
Look Up
...
Select Yes to include the Metadata as a look up field.
Note: This option is disabled for selection, if the Lookup option is set as No when adding the Metadata in CAM.
...
Lookup Type
...
Internal - The values in the drop-down are populated from the CAM metadata. You can select the metadata values from the drop-down.
External - The values in the drop-down are populated from the configured external system. You can select the metadata values from the drop-down.
...
Create a new value?
...
Select value. Select Yes to add a new value to the look up field.
A sign is added next to the look up field in the panel.
...
Lookup new Option
...
Select one of the following option:
Generate New Number - CAM automatically generates a numeric value based on the Max digit and Metadata range specified in the dialog.
Use description as alias - CAM will auto add the metadata name as the alias metadata ID The Create a new value must be set to Yes.
Generate read only new number : Allows a read only field in the Workflow.
Generate new number and hide: (For hidden system fields like systemid)
Note: AutoGeneration is automatically done for the systemid column so that the references remain unique. Prefixes are also supported on top of the auto generated number.
...
Total digit for metadata
...
Only displayed if Generate New Number option selected
Enter the length of the metadata to be generated for the custom entry (e.g. 5)
...
Prefix
...
Enter the metadata prefix
...
Metadata Range From & To
...
Only displayed if Generate New Number option selected
Enter the lowest & highest value of the metadata range that can be accessed
...
Is ID field hidden
...
Only displayed if Use description as alias option selected
Select Yes to hide the field in the Create Workspace Wizard.
...
Order
...
Set the order of the metadata to be displayed on the panel.
...
Panel
...
Select the panel for the metadata to be displayed. Based on the selection here the fields will be displayed in the panel.
...
Editable
...
Select Yes to allow the metadata value to be edited in the workspace dialog.
...
Lock Existing Values
...
This option doesn't allow users to create a new workspace using previously added values of specific metadata, locking the existing metadata.
When a new Unique Metadata field in Configure Wizard is added, the option to Lock Existing Values displays. If Lock Existing Values is selected as Yes, Create a new value option should be automatically selected as Yes. The option No should be disabled. Also, the Default Value option is disabled.
If the Metadata with Lock Existing Values option is 'No', then users can only add values to Metadata by clicking the '+' button. After the user enters values for that Metadata, there is a validation to check if that value already exists. If the value already exists, the user should not be able to save that value.
E.g. Lock existing set to yes and is parent set to yes, means the unique metadata field matter will not allow inputting duplicate matters if any parent matters exist. If no for parent, and yes for lock, then if the metadata exists in entire system, then the value can't be added.
Click Save to add unique metadata and click Cancel to close the dialog
Note: The panels that have metadata specified here, will be displayed in the request workflow to enter information for the dialog.
For 'Grant Access' and 'Create Channel', Unique Metadata is not mandatory.
Other Metadata
Allows you to add metadata to the external system. This metadata is displayed in the panel selected. Select the external system from the drop-down in the other metadata panel.
...
Click Add New to add new other metadata, the following screen opens
...
Field
...
Description
...
Metadata
...
Select the metadata from the drop-down. To assign a metadata, either click the drop-down menu and select it from the list or manually enter the value, which will auto-complete if it is assigned in Administration>Metadata.
Info |
---|
Tip: To assign a template to the workspace, select the Template metadata here. The default value field will display a list of all the available templates for selection. |
...
Default Value
...
Displays a drop-down if a value is assigned in Administration>Metadata>Manage. Select the default value to be assigned to the metadata. If no values are available, you can enter a value for the field.
...
Is Hidden
...
Select Yes to hide the field. The field will not be displayed in the Workspace Wizard.
...
Conditional Display
...
Click Conditional Display, the following dialog opens:
...
You can set options for the system metadata to be displayed only if the condition criteria specified here is met.
Select the metadata and set the condition and value to be matched. The metadata will only be displayed if the condition entered here met.
Click Save to save the metadata and click Cancel to cancel the dialog
Click Delete to remove conditional metadata
...
Is Read Only?
...
Select the value for read only value.
...
Display Label
...
Enter a display name for the metadata. Make this as specific as needed to differentiate between similar metadata names that may exist.
...
Help Text
...
Enter help text to be displayed as a tool-tip on the custom field.
...
Type
...
Select the type of metadata from the drop-down. Options include:
Date - Represents date value (e.g. 2018-10-10)
String - Alphanumeric characters (e.g. cam123)
Boolean - Represent logical values (e.g. True or False)
Number - Numeric data values (e.g. 1,2,3)
Currency - Represents integer format (e.g. 123.456)
...
Look Up
...
Select Yes to include the Metadata in the look up search fields to be applied to the external systems.
...
Lookup Type
...
Internal - The values in the drop-down are populated from the CAM metadata. You can select the metadata values from the drop-down.
External - The values in the drop-down are populated from the configured external system. You can select the metadata values from the drop-down.
...
Create a new value?
...
Select the value for read only value. Select Yes to add a new value to the look up field.
...
Lookup Option
...
Generate New Number - CAM automatically generates a numeric value based on the Max digit and Metadata range specified in the dialog.
Use description as alias - CAM will auto add the metadata name as the alias metadata ID The Create a new value must be set to Yes.
...
Is Id Parent based?
...
Selects if the id is parent based, to look up the metadata only on parent level, or across the entire system. E.g. Setting yes would look at parent metadata if there exists a record.
...
Total digit for Metadata
...
Only displayed if Generate New Number option selected
Enter the length of the metadata to be generated for the custom entry (e.g. 5)
...
Metadata Range From & To
...
Only displayed if Generate New Number option selected
Enter the lowest & highest value of the metadata range that can be accessed
...
Order
...
Set the order of the metadata to be displayed on the panel.
...
Panel
...
Select the panel for the metadata to be applied.
...
Editable
...
Select Yes to allow the metadata value to be edited in the workspace dialog.
...
Required
...
Select Yes to set the metadata field as a mandatory field on the panel. A value must be specified for the field.
Note: If a field is Required and Hidden, a default value must be specified.
Default Security
Allows you to add default security to the workspace dialog created here.
...
Click the Add New to add the security details.
...
Field
...
Description
...
User/Group
...
Select if the default security is to be assigned to a user or group
...
Select a User/Group
...
Select the user/ group from the drop-down. To select a user, either click the drop-down menu and select it from the list or manually enter the name, which will auto-complete if the user name is added in the Users & Groups tab.
It allows to select multiple user at a time.
...
Permission
...
Select Allow to assign the security to the user/group. Select Deny to restrict access to the user/group.
Note: This option is not visible for Office365 workflow, by default sets to Allow.
...
Role
...
Select the user/group role from the drop-down.
Note: Editor and Watcher Roles are available for Office365.
...
Panel
...
Select the panel for the default security to be applied.
Note: By default the 'Security' option is selected.
...
Expiration Date
...
Specify the expiry date of access to the user/ group.
Click Save to add default security and click Cancel to close the dialog
...
|
Expand | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
ApproversAllows you to add users/groups/Role-Based Groups that can approve the workspace dialog that is created here.
Note:
Note: The workspaces that require approvals are listed and can be approved in the Approvals tab. Also, an email notification is sent to all the approvers and members of the approver group. If one of the users reject/approve a request, it can not be edited by others
|
Expand | ||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||
Unique MetadataThe Unique Metadata section requires the addition of the Unique ID metadata, which distinctly identifies each new workspace requested in the external system. This metadata is displayed in the selected panel.
Note: The panels that have metadata specified here, will be displayed in the request workflow to enter information for the dialog. For 'Grant Access' and 'Create Channel', Unique Metadata is not mandatory. |
Expand | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||
Other MetadataAllows you to add metadata to the external system. This metadata is displayed in the panel selected.
|
Expand | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||
SecurityAllows you to add default security to the workspace dialog created here.
Note: While submitting a job using a CSV file or a script, an error message is displayed “Failed to add security” if a user does not have permission to access a particular team. |
Default Templates
When enabling users to choose a template in a Request Workflow to create a workspace, limit the template choices for the workspace by adding the allowable templates to the Default Templates section. Note: You must also add the Template metadata field to the Other Metadata section so that the user can select a template from the templates added to the Default Templates section.
Allows you to add the template to the workspace dialog created here.
...
Click Add New to add the template
...
. the following dialog opens:
...
Field | Description |
---|---|
Select Template | Select the Template from the dropdown |
System | Select the System from the dropdown |
Order | Specify an order |
Click Save to add the Template
...
or Click Cancel to close the dialog.
Expand | ||
---|---|---|
| ||
Editing a Request Workflow
|
...
Expand | ||
---|---|---|
| ||
Deleting a Request Workflow
|
...
|
Configuring Request Workflow in Desksite
After installing the CAM Commands, the Workspace Wizard can be used in Desksite.
On a workspace or matter/client, right-click a matter.
Click CAM-> Create Workspace to create a workspace.
For My Matters, you can also use the wizard there. For example
...
:
Create a category from My Matters in Desksite.
...
Right-click and select CAM-> Create Workspace.
The category and workspace will be created in CAM. If the category id metadata is present in CAM.