Skip to main content

Welcome to the Cyara Knowledge Center

Search

Creating a New Custom Activity

Updated: tech writers Edited:

To define a new Custom Activity, follow the steps below:

  1. From the main menu on the Cyara Portal, select the Build menu, and then click Custom Activities underneath the Cyara Virtual Agent heading. The Custom Activities screen will be displayed showing a list of existing Custom Activities:

  2. Click the New Activity button located in the top right corner. The New Custom Activity page will be displayed as below:

  3. Select the Usage field from the drop-down list. The choices are:
    • Activity script: any activity step in a Behavior.
    • Script used for startup: to be used when a Campaign is starting. For example, to log in a user.
    • Script used for shutdown: to be used when a Campaign is stopping. For example, to log out a user.
  4. Select the Script Type from the drop-down list.
  5. Enter the name for the Custom Activity in the Name field.
  6. Enter a Description for this Custom Activity.
  7. Browse to the Folder Path where you would like to save this Custom Activity and select it.
  8. Enter the Parameters as specified below. Parameters define the values a Custom Activity can receive from a Behavior and use them in the Custom Activity script.
    • Name: Enter the name of the parameter to be used in a script.
    • Description: Enter the description to be displayed in a Behavior.
    • Default Value: Enter the default value to be pre-populated in a Behavior.
    • Click the icon to add these fields.
    Fo example, to find the correct window with a title specified as a parameter, enter the Name as “LoginWindow”, “AccountNumber”, and the Description as “What is the title of the login window?”
  9. Enter the Variables as specified below. The Variables define information that can be retrieved from call context, such as agent name currently executing the activity, or call line number.
    • Key: Enter the variable name. For example, AgentLogin.

    • Value: Enter the reference to the data structure. For example, Agent.Dn.

    • Click the icon to add these fields.
    For a complete list of Variables that can be used with Custom Activities, refer to the Virtual Agent Variables topic.
  10. Enter the Resources as specified below:
    • Name: Enter the name of the resource reference to be used in the script.
    • Resource: Click the Resource button and then select the reference to an image from the resource library and click OK.
    • Click the icon to add these fields.
  11. After entering the Scripts as described in Script/Error Script, click the Save Details button.
Was this article helpful?
0 out of 0 found this helpful
Return to top

Related articles

Comments

0 comments

Please sign in to leave a comment.