Dynamic Workflow Buttons

The Dynamic Workflows Button subtab supports the legacy method of creating dynamic workflow buttons for display on the Session Manager toolbar. If you are new to Session Manager and workflows, refer to the topics below to get started using our recommended method of creating or modifying workflows.

• Workflows

• Workflow Families

• Editor Client Workflows

If you are ready to create a custom workflow, or modify an out-of-the-box workflow, refer to the Editor XI – Developer Guide.

The Dynamic Workflows Buttons subtab provides a way to customize the buttons found on the Session Manager ribbon in Editor XI. By default, three buttons are included on the Session Manager ribbon: Send, Approve, and Reject. Dynamic Workflows Buttons allows organizations to add or remove buttons, in addition to creating buttons that allow for custom session workflows that best fit their organization’s needs.

To add a new Dynamic Workflow Button, follow the steps below:

1. Click the Add New button.

2. Type a name in the Display Name field. The button name also populates in the button list on the left as you type the name.

3. Type a key title in the Key field. The key needs to be unique from other Workflow Button keys.

4. If you want users to include a reason when using this Workflow Button, turn the Prompt for input toggle on (so it is green). This enables the reason window in Editor XI to display and require the users to provide input before the workflow step is completed.

   Leave the toggle turned off if you don’t want users to be prompted to provide a reason.

5. The Close session toggle defaults in the off position. Turn the toggle to the on position if you want the session to close when the Workflow Button is clicked.

   1. If the Close session toggle is turned off (disabled), then the Watch for Assignment field is required. Type the name of the next step in the workflow.

6. Select the status you want from the Acceptance status drop-down. This status is what is displayed in the history on the adaptive card used for sessions. The options are approved, rejected, or a blank option. The blank option displays as completed in the history list.

7. The Show User Pick List toggle enables the Roles edit button found directly under the toggle. Turning the toggle on means that users are presented with a list of users by name, according to the roles selected. This gives users the ability to assign a session to a certain user for the next step in the workflow.

   1. After you turn on the Show User Pick List toggle, click on the pencil button underneath Roles.

   2. Then check the box in front of the roles you want to be included in the User Pick List. Then click Apply.

      

8. The Visibility Function box is where code is kept that allows the button to appear in the Session Manager ribbon in Editor XI at only certain states. The default code displays the button at all times.

   Use the Sample Visibility Functions to auto populate the Visibility Function with code according to the selected item.

   • Edit Assignment displays the button when the session is assigned to Edit.

   • Review Assignment displays the button when the session is assigned to Review.

   • Approval Assignment displays the button when the session is assigned to Approval.

   • Session Custom Property allows you to insert a custom property your organization uses by replacing the MyValue variable with your custom property value.

   • User has role displays the button for the defined role. This sample defaults to the GIS Editor role.

   

   Use the Test Function button to test your Visibility Function code. Click the button to open the Test Visibility Function dialog. If it displays True under Test Result, the code has passed. If it instead displays Failed, there is an error in the code that needs to be fixed.

   The Test Visibility Function dialog also includes additional sample code that you can edit and test as you wish. The Assignment, Session, and User tabs contain sample code that allows you to control visibility based upon these parameters. Set your chosen parameters within the sample code on the Assignment, Session, or User tab. To test the code, click the Evaluate Test Function button in the top right corner. When the Test Result displays as True, the code is ready to copy and paste from the Test Visibility Function dialog into the Visibility Function box.

   TIP: If you make a mistake while editing the sample code in the Test Visibility Function dialog on any of the Assignment, Session, or User tabs, and want to go back to the original sample code, close out the dialog and reopen it to go back to the original code.

   

9. At the top, next to Display Name, is a place to select an icon for the Dynamic Workflow Button. There are three default icons included out of the box to select from, or you can click the pencil button and select your own image file as the button icon.
10. When you have finished filling out the Dynamic Workflow Buttons dialog, click the Save Button.

Now that you have added new Dynamic Workflow Buttons, you can learn more about how they can be implemented in a workflow on the Workflows plugin documentation.