Advanced Tab

The Advanced tab contains other high-level configurations.

Settings

The Advanced tab in the Editor plugin includes a Settings subtab that allows organizations to make changes to the way their application works.

Use Two-State Workflow

The Use Two-State Workflow toggle is where you can switch between using a three-state or two-state Session Manager workflow in your organization. A three-state Session Manager workflow includes the Review assignment, where as a two-state workflow does not.

The default position of the toggle is off (black and white toggle) and means it is set to use a three-state workflow. When switching this setting, the changes are visible on sessions created after you save the changes Solution Center.

TIP: When switching the Two-State Workflow toggle, the changes are visible on sessions created after you save the changes in Solution Center.

Show Detailed Session History

Your organization has the option to show detailed session history in Session Manager. These details include a record in the history showing when a session is created, assigned, opened, saved, approved, rejected, completed, and closed. Clicking on each event in the list provides detailed history.

The Show Detailed Session History toggle defaults in the off position (black dot on the left with the toggle displayed in white), which means that the additional details are not displayed in session history. The image below shows what the toggle looks like with Detailed Session History turned on; the white dot is on the right and a green background, and the additional session history details are displayed on session card.

When switching the Show Detailed Session History setting, the changes are visible on sessions created both before and after you save the changes in Solution Center.

Session Custom Properties

The Session Custom Properties tab is a place to create a specific user interface for Session Manager with the use of custom code. For Session Manager, it allows organizations to add metadata to session cards. The Session Custom Properties tab includes a Session Adaptive Card using Microsoft Adaptive Cards. On Microsoft’s Designer | Adaptive Cards website, users can use a WYSIWYG form to create adaptive cards that automatically creates the JSON code for it. Users copy and paste that code into the Session Adaptive Card.

After the JSON code is added to the Session Adaptive Card, and a user clicks the Save button, the code is automatically validated, and the code is saved at the tenant level. Only one Session Adaptive Card is available per tenant.

Once the edits on the Session Adaptive Card are saved, the updates are reflected in both Solution Center and Editor XI.

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

Dynamic Workflow Buttons

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.

TIP: Adding or removing buttons likely changes the way your workflow works. Anytime you make a change to the buttons, it’s wise to test all your workflow buttons to make sure they still work as desired.

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. but 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 session card. 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. There are four tabs each with different sample code to use. 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 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.

Filter and Sort Configurations

Customers may have hundreds or thousands of sessions existing at one time. In order to pare down the list of sessions to a manageable view, users may want to filter or sort their sessions list. The following topics instruct users on how to create filters and sorts to use on the sessions list.

Sort Sessions List

Within Session Manager, sessions are displayed using a sort method. Several out-of-the-box methods are provided: 

  • By Assignment – sorts sessions by their session assignment status

  • By Session Created – sorts sessions by the date they were created

  • By Session Modified – sorts sessions by the date they were modified

  • By Session Name – sorts sessions in alphabetical order by the session name

The first method found in alphabetical order is chosen as the default sort selection. With our out-of-the-box options, this is By Assignment. However, users may want to display sessions based on custom session properties. The following steps demonstrate how to configure a custom sort configuration. 

  1. Open Solution Center.

  2. Click on the Editor XI plugin.

  3. Select the Advanced tab. 

  4. Select the Filter and Sort Configurations tab. 

    This is the view before defining new sort configurations.

    Filter and Sort Configurations tab in the Editor plugin

    At the top of the page, there is a drop-down list of operational maps from the tenant to which you're connected. This list can be refreshed clicking the Refresh Refresh button button. If you refresh the list, the operational map selection persists.  

  5. Click the Add New Add New button button to begin configuring a custom sort configuration. 

    A new sort configuration with a view of fields to populate

  6. Provide the display name for the new sort configuration. By default it is populated with New Sort Configuration. This text field requires at least 1 character and is limited to 100 characters. 

  7. Choose an option for the Default Order By field. This field requires a selection from its drop-down menu of Ascending or Descending. This field displays in alphabetical order so ascending displays from A to Z order, and descending displays from Z to A order.  

  8. Choose a Property Name from a drop-down list of editor assignment, editor session, and custom properties to choose from. Custom properties reflect the properties configured in Session Custom Properties tab on the Advanced tab in the Editor XI plugin. The Property Name field is required and may be enclosed in a red box if it has no entry. 

  9. If you prefer to use a custom session property, choose CustomProperties from the drop-down. 

  10. Provide a Custom Property Name.  

    NOTE: To view the options, move two tabs to the left and click on Session Custom Properties. Within the session adaptive card, make note of the ID of your session property. That is the value to provide in the Custom Property Name field.

  11. Choose a value for the field named Is Default Sort. This is a drop-down field with options of True or False. This setting determines whether this is the default sort method for all sessions, and controls how you view sessions when you first open Session Manager. If multiple sort configurations are set to true, then the first sort method by alphabetical order is used. 

  12. Click the Execute Query Execute Query button button. This returns results on the first 50 sessions found. This allows you to test if your custom sort configuration is behaving as expected, and allows you to make any necessary changes. The list displays by session name, or a GUID, if the session name field is empty. When you are satisfied with the sort configuration, click the Save Save button button at the bottom of the page.  

  13. If you have multiple feature services on which you would like to propagate this custom sort configuration, click the Edit Edit button button next to the Selected Feature Services in the upper right corner of the form.  

    List of feature services from which to apply the sort configuration

  14. Select the feature services to which you'd like to apply this sort configuration. Click the Apply Apply button button. In the Notifications Notifications button button in the upper right, you get a notification after the creation or update of a sort configuration.

    Successful creation of sort configuration notification

    After creating a custom sort configuration, your window looks similar to the example below.

    View of sort configuration list after successful creation

    Clicking the refresh Refresh button button refreshes the list of custom sort configurations.

    Delete any custom sort configuration using the Delete Delete button button.

    QR Code is a registered trademark of DENSO WAVE INCORPORATED in Japan and other countries.

    Was this helpful?