Skip to main content
Version: 0.18.3

Save and Reuse with Workflows

Save a Workflow

To save your current session as a workflow:

  1. Click the Save button.
  2. Click the Workflow option.
  3. Enter a name for your new workflow.
  4. Optionally, select the force overwrite checkbox to overwrite an existing workflow with the same name.
  5. Click Submit.

save a workflow

This saves your session as a workflow (.dcw) file, which you can access from the Workflows section on the homepage. Make sure to give the workflow a descriptive name you'll use it to make edits to the file or replay the workflow. Refer to Edit a Workflow for information on editing workflows.

To improve workflow replays, some skills are not included in saved workflows:

  • Collaborate on this workflow with <user>
  • Connect to the view <view name>
  • Create a new alert <alert>
  • Create a new API <api name>
  • Export the current workflow to <file name>
  • Export the saved workflow <workflow name> to <file name>
  • Forget the alert <alert>
  • Help me
  • List all alerts
  • Publish the <object>
  • Replay the workflow <workflow name>
  • Save the current chart as <name>
  • Save the current session as
  • Save the defined expressions to <file>
  • Share the connection <connection name>
  • Share the file <file name>
  • Share the workflow <workflow name>
  • Subscribe to the alert <alert name>
  • Unsubscribe from alert <alert name>

Save a Trimmed Workflow

If you've spent a lot of time exploring your data, calculating different values, and plotting charts, you might want to save a workflow that creates only the tables and charts you actually need.

To save a trimmed workflow:

  1. Select each of the tables, charts, and notes you want to keep using the checkbox in the header.
  2. Click the Save button in the toolbar.
  3. Give your workflow a name.
  4. Click Submit.

saving a trimmed workflow

The resulting workflow contains only the necessary utterances to create the selected charts, tables, and notes.

Save a Copy of a Workflow

  1. From the homescreen, click the Workflows page.
  2. Select the workflow to copy.
  3. Click the Save As button, then enter a new name for the copy.

saving a copy of a workflow

Tag and Describe a Workflow

You can add tags and a description to your saved workflows to make them easier to search for and to remind yourself, and anybody else with access to the workflow, what the workflow does.

To add tags and a description:

  1. From the homescreen, click the Workflows page.
  2. Select the workflow to tag and describe.
  3. Click the Edit Metadata button, and enter a new name.

the metadata editor button

  1. Add a description of the workflow.
  2. Add keywords in the Keywords field and then click the + button to save it. Repeat this step to add as many keywords as you need.

the metadata editor

  1. Close the Metadata Editor to save your changes.

Replay a Workflow

After you've saved your workflow, you can replay your workflows either from the homepage or from within a session.

From the homepage:

  1. Click the Workflows page.
  2. Select the workflow to replay.
  3. Click the Replay Workflow button.

Replay Workflow

For example, if you will receive a new version of your dataset next month, upload your new dataset to replace the older one, click the Replay Workflow button next to the workflow to open a new session and perform the same analysis on your updated data.

If you'd like to use a different dataset name with the same analysis, you can also click the Step-by-Step Replay button.

Step-by-step replay

From the homepage, click the Replay Workflow button next to the workflow to automatically re-run the workflow.

If you'd prefer to minimize the outputs in the display panel except the last three, click the Replay with Outputs Minimized button from the Workflows page.

outputs minimized replay

You can also replay workflows in a sessionin the chat boxwith Replay

note

Replay the workflow as the first utterance of the session or it won't be automatically saved and verified.

Enter Replay the workflow <workflow name> one step at a time and use the toolbar to step through the workflow with the following options:

  • Execute the action. Perform the next action.
  • Continue the replay. Continue the workflow without pausing.
  • Add an action. Add a new action to execute before the next action.
  • Skip an action. Move to the next action.
  • Cancel the replay. Stop replaying the workflow.

If the workflow encounters an error while replaying (such as a database or column name that has changed), the replay pauses and switches to a stepwise replay (if it isn't already in one). Adjust the utterance that generated the error and continue the replay.

You can also enter Replay the workflow <workflow name> with outputs minimized in the chat box to run the entire workflow at once, with all but the last three utterance outputs minimized in the display panel.

Schedule a Workflow to Replay Later

You can schedule a workflow to run on certain days and at certain times:

  1. Make sure you've saved your workflow.
  2. Enter Schedule the workflow replay for <your workflow> on <days> at <time> <time zone> where:
    • days is a comma-separated list of days on which the workflow should replay.
    • time is the time (in 24-hour format) at which the workflow should replay.
    • time zone is the time zone to use.

Reschedule a Workflow

To reschedule a scheduled workflow replay, enter Reschedule the workflow replay for <your workflkow> on <days> at <time> <time zone> to <new days> at <new time> <new time zone>.

Delete a Scheduled Replay

To delete a scheduled replay, enter Delete the scheduled workflow replay for <your workflow> on <days> at <time> <time zone>.

View All Scheduled Replays

To view all of the scheduled replays, enter either List all the scheduled workflow replays to see only the workflow replays, or List all the events to see both workflow replays and Insights Boards refresh schedules.

Display a Workflow

You can also view a workflow as a workflow diagram. The workflow diagram shows a top-to-bottom flow of utterances used in your session. To view a workflow diagram, enter Display the workflow <workflow name> in the chat box.

display workflow

Workflow Editor

The Editor allows you to edit and test your workflows without leaving DataChat.

Open the Editor

To edit a saved workflow with the Editor, first find your saved workflow file and open it:

  1. From the homepage, click the Workflows tab.
  2. Select the workflow to edit.
  3. Click the Edit Workflow button.

Workflow Editor button

Edit Your Workflow

With the Editor open, you can use the textbox on the left side to make changes to your workflow. You can:

  • Change pieces of individual utterances, such as values or column names.
  • Add or remove utterances.
  • Manage workflow versions.
  • Save the workflow as a new workflow with a different name.

Update Utterances

To add an utterance:

  1. Select the line that you'd like to add the utterance after.
  2. Press Enter to create a new line beneath the previous.
  3. Enter the additional utterance you'd like to add.

To delete an utterance:

  1. Use the checkbox to select the lines that you'd like to delete.
  2. Click the Cut button.

Editor delete lines

You can also click the utterance line, select the text, then delete it.

Be careful and make sure you test your edits before using an edited workflow or snapshot.

When you're done making your changes, click Save.

Undo and Redo Edits

To undo an edit, click Command + Z.

To redo an edit, click Shift + Command + Z.

note

Changes cannot be undone or redone if the utterance that the change targets has been replayed.

Create a Replay Breakpoint

When hovering over an utterance, a red dot will appear to the left of the line number. To create an utterance breakpoint, click the red dot. When replaying a workflow continuously, it will pause before running that utterance.

workflow breakpoint

Verify Edited Workflows

If you edit a verified workflow, it changes to unverified. An unverified workflow is preceded by a red icon and is followed by a yellow icon noting unsaved changes have been made.

Workflow Editor - verify workflows

To verify a workflow to ensure it works as expected in a session, click the Restart button from the sidebar to see that the edited workflow doesn't run into any errors. If no errors are encountered the workflow will automatically verify and save. If the workflow fails, you must make the necessary changes before you are able to save the workflow.

Workflow Editor - verify workflows

note

It's recommended that workflows that haven't been verified in the Editor before (such as older workflows) need to be verified when they're next opened in the Editor.

Manage Workflow Versions

When you save a workflow with the same name as an existing workflow, or make a change and save it, a new version of that workflow is created. To review previous versions or revert back to a previous version in the Editor, you can:

  1. Click the Version Manager button to view each version of the workflow.

Workflow version manager

  1. Click the row for the version you want to review or revert to. The contents of that version appear in the main pane of the Editor.

Workflow Versions

  1. You can make desired edits or reversions to the most recent version, or you can select an older version to Restore.
  2. Click Save As to save this version as a new workflow. Give your new workflow a name, then click Submit.

restore or save changes

Test Your Edits

To test that your changes work the way you intended, click the Replay button from the sidebar. You can select to have the workflow replay stepwise or continuously. Chat responses and and visualizations will appear on the right side of the Editor.

test edits

Use a Text Editor

You can use a text editor, such as Notepad, Notepad++, or TextEdit, to make changes directly to the workflow (.dcw) file on your computer.

To do so, you must first Export your workflow to your computer. Then, complete the sections below to make and test your edits

Edit Your Workflow

To edit your workflow file:

  1. Open the file with your preferred text editor. Note that you might need to right-click the file and click Open with to select your text editor.
  2. Make your edits to the file.
  3. Save your changes.

Test Your Edits

To test your edits:

  1. In DataChat, go to the menu > My Files.
  2. Drag and drop your edited workflow file into the File Manager.
  3. Click Yes to overwrite the old version of this workflow on the server.
  4. Open a new session.
  5. Enter Replay the workflow called <name> and check that the workflow runs correctly and produces the expected output.

Rename a Workflow

To rename a workflow:

  1. From the homescreen, click the Workflows page.
  2. Select the workflow to rename.
  3. Click the Rename Workflow button, and enter a new name.

rename a workflow

Export a Workflow

Use Export to export your current workflow or a saved workflow to your computer as a DataChat Workflow file:

  • To export your current workflow (without saving it on the sever), enter Export the current workflow to <name>.
  • To export a saved workflow, enter Export the saved workflow called <name>.

Share a Workflow

You can share a saved workflow with another user with the Share skill, or you can:

  1. From the homescreen, click the Workflows page.
  2. Select the workflow to share.
  3. Click the Share button.

share a workflow

  1. Select the users to share the workflow with.
  2. Select whether they are an editor or viewer of the workflow.
  3. Click Save.

share a workflow form