Workflow Settings Reference

Each workflow has its own Settings that can be customized in many ways. This document outlines every setting and its purpose and function.

From the workflow editor, click on the Settings button.

1.png

Basic

basic.png
  • Workflow Name: A unique name for your workflow. This setting is required.
  • Description: An optional Description. End-users do not see the description of the workflow. It is for Authors reference only.
  • Return Node Behavior: Determines the workflow's behavior when returning to this workflow from a sub-workflow. See this article for more details.
  • Workflow ID: Displays the unique ID for this workflow.
  • Selected Node ID: The ID of the node that was selected in the editor when the Settings Tool was opened.
  • Authoring Permission: Your collaborator role for this workflow.
    • Administrator: Can invite others, edit the workflow, and change the permissions of any other Author on a workflow.
    • Editor: Can edit the workflow, but cannot delete it or change the permissions of any Author.
    • View-only: Can view and examine the workflow, but cannot edit it or manage Collaborators.

Style

style.png
  • Basic Theme: Choose a base theme for the workflow from the styles offered. Choose Custom from the drop-down if you'd like to add your own custom CSS URL.
  • Modify Colors: Some themes allow you to choose a Primary, Secondary, Compliment and Text color. See this article for more details.
  • Buttons Style: Choose a Horizontal or Vertical style for your Action Buttons. See this article for more details.
  • Buttons Position: By default, buttons are displayed below the Content and Question areas. Choose Top if you'd like them to display before the Content area.
  • Transition Effect: An optional transition effect/animation for the Action Buttons. See this article for more details.

Display

  • Top of Workflow Display:
    • Show History: When enabled, the history of the current session will be displayed at the top of the workflow. See this article for more details
    • Show Breadcrumbs: When enabled, the breadcrumbs of the current session will be displayed at the top of the workflow. See this article for more details
    • Show Workflow Name: When enabled, the Workflow Name will be displayed at the top of every workflow.
    • Show Node permalink (hosted only): For Zingtree hosted workflows. When enabled, a permalink icon will be displayed in the title bar. See this article for more details
       
  • Bottom of Workflow Display:
    • Show "Back" Button: When enabled, the "Back" button will be displayed at the bottom of the workflow. See this article for more details
    • Show "Restart" Button: When enabled, the "Restart" button will be displayed at the bottom of the workflow. See this article for more details
    • Show Session Notes option: When enabled, a Session Notes button will be displayed at the bottom of the workflow. This allows the user to enter notes during the session. See this article for more details
    • Show "Powered by Zingtree" icon: When enabled, the "Powered by Zingtree" icon will be displayed at the bottom of the workflow.
    • Show Feedback option: When enabled, a Feedback, a Feedback button will be displayed at the bottom of the workflow. See this article for more details
       
  • Persistent Buttons:
    • Display Persistent Buttons from current Sub-Workflow: When enabled and a session is started from this workflow and navigates into a sub-workflow, show both the persistent buttons of this workflow and those present in sub-workflows. See this article for more details
    • Label: When adding a persistent button, enter the label for the button here.
    • Go to Node: When adding a persistent button, enter the node number the button will navigate to here.

Tags

tags.png
  • Workflow Tags (for categorizing or searching): A tag or tags for this workflow to be used for search, filtering, or inclusion in the session history. Select tag or enter a new tag. When adding a new tag, be sure to submit it by pressing your Enter/Return key. See this article for more details
  • Add a large tag list here: You can use this area to paste a large list of tags, one per line. This is for adding new tags, not editing existing ones.

Rendering

rendering.png
  • Rendering Options:
    • Enable Responsive Videos: Makes any embedded YouTube or Vimeo videos responsive. Videos will scale to the width of the display - especially handy for mobile and tablet support.
    • Enable Browser Caching: Tell the browser to cache the contents of the workflow each time your workflow is loaded. This will make workflows load faster, but if you make changes to your workflow your end-users won't see them for approximately 60 minutes.
       
  • Options for Embedded Workflows:
    • Disable Automatic Scrolling: Disables the automatic scrolling that occurs when embedding workflows into web pages.
    • Scroll Containing Page to Top: Makes the page containing the embedded workflow scroll to the top on every button click.

Security

security.png
  • Access
    • Require login via Single-sign-on (SSO): You can configure and enable SSO via Account, Single sign-on. See this article for more details
    • Require login via user credentials or API key: When enabled, this workflow can only be accessed by logged in agents, or by launching with Authentication Headers. See this article for more details
    • Session Resume Timeout: When enabled, sessions for this Workflow cannot be resumed after the specified duration has passed since the session’s initial start. See this article for more details
    • Restrict Access to IP Ranges: Enter multiple IPv4 CIDR entries (one per line) for optional IP address filtering. Leave blank to allow access from everywhere. CIDR codes reference
    • Hide from Agent Portal and Workflow Search Results: When published, hide from Agent Portal and Workflow Search Results (draft workflows are always hidden from these locations).

Data

data.png
  • Verify:
  • Include these workflow variables in each session. See this article for more details
    • tree_name: The name of the starting workflow.
    • tree_id: The ID of the starting workflow.
    • last_tree_name: The name of the last workflow visited (via a Workflow Node).
    • last_tree_id: The ID of the last workflow visited (via a Workflow Node).
    • container_url: For embedded workflows, the URL of the page containing the embedded workflow.
       
  • CX Actions configuration:
    • Cache TTL (seconds): Time in seconds to retain CX Actions data in cache. Minimum: 300 sec.
    • Log Activity: Log CX Actions activity.
       
  • Additional options:
    • Collect location data variables: Include customer’s location, language and ISP information as session variables. See this article for more details
    • Preserve Variables when 'Back' is Clicked: Select to preserve any variables stored during a session when the Back or Reset buttons are clicked (default behavior is to erase variables from the session data).
    • Disable Auto-complete in Forms: Set this to disable the browser’s auto-complete option in data entry forms.
    • Initialize Data Entry Fields: Set this to give all data entry fields a default blank value when the workflow is started.
    • Include just these variables in the Form Data Report: This limits the variables shown in the form data report. Enter a list of variables to include, separated by commas. Leave this blank to include all variables.

Language

language.png

See this article for more details

  • Workflow Language: Select the language your workflow is authored in. This will improve how your workflows are displayed for non-English customers. This option does not translate your entire workflow. It's purpose is to translate only Zingtree hard-coded text like the "Back" and "Restart" buttons. Choosing the option called "other" will replace the Back and Restart text with icons only.
  • Languages for Google Translate: Include a Google Translate option in your workflow to automatically translate non-English foreign languages. Example: add fr,es,de to add French, Spanish, and German. You can add other 2 letter language codes to the list. Use * to support ALL language translations that Google offers. Language reference for Google Translate
  • Date Format for Date Picker: Customize the date format from the date picker used by data entry fields. Tip: If you specify MM/dd/yy (i.e. 09/30/20) or dd/MM/yy (i.e. 30/09/20), any date input will be validated against those formats.
  • Locale for Date Picker: Set the default locale for the date picker. This may need to be used in conjunction with date format (above). Date locale reference

Code

code.png
  • On Launch, Include this App: When this workflow is opened, run one of your installed apps. See App & Integrations > My Apps. 

  • Include this CSS/Style, JavaScript or jQuery code when rendering workflow: Include this code in your workflow at the bottom of the page. This will override any previous CSS or custom code. JavaScript code should be wrapped in a script tag:

    <script>
Your code here...
</script>

    CSS style code must be wrapped in a style tag:

    <style>
Your CSS here...
</style>

 

 

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request

Didn't find what you need?

Our friendly customer support team is here to help

Submit a Request

Looking for help or advice?

Reach out to our knowledgeable community of users.

Zingtree Community