Tenjin Icon

Flow Output Actions

Message

Use the Message flow action to send text to the user.

The Message action supports Markdown, which allows you to style text with headings, bullet points, italics, etc. There is a help icon (question mark) on the editor that will provide examples and guides for Markdown. Images and Links can be added to your message.

Examples are available within the inline help.

Question

The Question flow action gives you the ability to ask the user a question and store the response in a variable. The Question action supports Markdown, which allows you to style text with headings, bullet points, italics, etc. There is a help icon (question mark) on the editor that will provide examples and guides for Markdown. Images and Links can be added to your message.

The following topics are covered by the inline help guide:

  • Expected Responses
  • Adding Choices to Files Prompts
  • Expression Choice Prompts
  • Data Driven Choice Prompts
  • Utterances
  • Choices are Suggestions for the User
  • More Information About JSONPath
  • Is Interruptible

Adaptive Cards

Adaptive Cards allow the design of simple forms or cards that can be displayed inside the assistant. Adaptive cards are written in JSON and can be designed using the Microsoft Adaptive Card Designer; we recommend a target version of 1.5 or lower is selected from the drop-down in the top-right of the designer window.

You can substitute data within adaptive cards, making the content dynamic. Flow supports two mechanisms for substituting data:

  1. Template data using JSONPath
  2. Interpolate flow variables

Adaptive cards also support actions - completing an activity after a button is clicked. Adaptive cards can be configured to:

  1. Create a measurement
  2. Call a project flow

The remainder of this document describes these advanced capabilities in more detail.

The following topics are covered by the inline help guide:

  • Template Data Using JSONPath
  • Interpolate Flow Variables
  • Format Numbers
  • Make a Measurement
  • Call a Project Flow

Get Forms

The Get Forms action will get a list of custom forms for the specified skill. Skills that currently suppport custom forms are ServiceNow, Front Office, and Tenjin Forms

The below are examples of the different Get Forms results. The format is the same for each skill with the SkillType value identifying the source.

The following form examples are available within the inline help:

  • ServiceNow
  • Front Office
  • Tenjin Forms

Display Form

Forms are used to capture user input and send it to a remote system for processing. Select the skill type to set the type of remote system you are contacting:

  1. ServiceNow
    • To use a ServiceNow form, you must first configure the ServiceNow skill.
    • The forms are imported from the ServiceNow system, as part of skill configuration.
    • You must set the user variable, which you get from the Verify ServiceNow Email Address flow action.
  2. Front Office
    • To use a Front Office form, you must first configure the Front Office skill.
    • A Front Office form must be configured in Tenjin (there is no import functionality).
    • You must set the user variable, which you get from the Verify Front Office Email Address flow action.
  3. Tenjin Forms
    • To use Tenjin Forms, you must first configure the Tenjin Forms skill.
    • Tenjin Forms allows you to call an arbitrary remote system (subscriber).
    • The Tenjin forms must be configured in Tenjin.
    • You do not need to set the user variable.

I just want to capture data with a form - I don't want to send it to a remote system

You can setup a Tenjin Form without a subscriber. When the form is submitted the form data will be captured in the result variable, but no remote system will be contacted. You can then process the data in flow yourself.

Result Variable

The result variable is optional. The behaviour of the action varies based on whether the variable is set:

  • If the variable is not set when the form is successfully submitted, the action sends the user a message: 'Form successfully submitted'.
  • If the variable is set the action does not send a submit message and the result is captured in the variable.

The result object will be dependent upon the form being submitted; the general structure is summarised below with two examples supplied.

The properties in the result object are:

  • Submitted - true if the form was submitted, false if the form was cancelled.
  • CreatedFormId (optional) - unique identifier for the submission, defined by the remote system. If the remote system does not return this data, CreatedFormId will be null.
  • ReferenceIdentifier (optional) - user friendly identifier, defined by the remote system. If the remote system does not return this data, ReferenceIdentifier will be null.
  • SuccessMessage - message which would have been displayed if the result were not captured in a variable.
  • SubmitFields - list of the fields and their values, which were sent to the remote system.

The following form examples are available within in the inline help:

  • ServiceNow
  • Tenjin Forms
  • Tenjin Forms - Cancelled

Link to Content

The Link to Content flow action gives you the ability to upload content to Tenjin, which is then made available via a public URL everyone can access; the output of this action is the URL.

This flow action can be useful when you have large amounts of information you'd like to share with people, more information than what should be outputted in your assistant / chat client. By entering the URL in a message action, it will open a new browser window and display the content outside of your assistant.

Note: The URL provided is a public-facing website address, which means anyone with the URL can access it. Although the content will only be available for a short period of time, please consider the sensitivity of the information you provide to the flow action.

Share this article

Comments

0 comments

Article is closed for comments.