Dual Pane Script Editor
    • 05 Sep 2024
    • 8 Minutes to read

    Dual Pane Script Editor


    Article summary

    Unleash the power of efficiency with our newly redesigned Dual Pane Script Editor, now available for both Life Cycle Action (LCA) scripts and Automatic Based Activity (ABA) scripts. This modern layout features a convenient information and configuration panel on the left, paired with a robust script editor on the right. Plus, enjoy the flexibility of resizable areas, tailored to fit your workflow.

    Best Practices for using the Dual Pane Script Editor

    To make the most of the Dual Pane Script Editor, follow these best practices:

    • Adjust the Focus Pane Size: Utilize the draggable divider to resize the pane as needed. Use the Expander icon to maximize the script pane while editing, and the Collapse icon to revert to the default view with a 30% width for the Info Pane and 70% width for the Script Pane.

    • Name Your Scripts Clearly: Automated Activities can contain multiple scripts. It's important to give each script a meaningful name that is easily identifiable.

    • Add Script Descriptions and Instructions: For readability and consistency, add a script Description and How to Use this Script section with relevant information.

    • Configure Your Script Settings: Ensure that the Configuration and Settings areas are properly set up. This includes the appropriate script target, language, scoring, and activity outcomes (ABA only) information.

    • Save Your Script to be Able to Publish to Script Library: Ensure that the scripts are saved, to be able to have the Publish Script option show up in the Command Options menu.

    • Use Multiple Prompts when Using AI Copilot: It is advisable to use multiple prompts to describe the script to be build via AI Copilot, this will make it easier to edit and manage.

    Dual Pane Script Editor

    Dual Pane Script Editor Details

    Field

    Description

    (1) Script Name Edit

    Select the Edit icon, to be able to adjust the name of the Automated Activity Script.

    (2)) Script Mover

    Select this icon to move automated activity scripts either up or down depending on the icon direction.

    (3) Command Options Menu

    The Command Options menu is where additional script commands are located.  These include Delete Script and Publish Script.
    Note: Delete Script is only available for Automated Activities.

    (4) Script Pane Expander/Collapser

    The Script Pane expander will expand the Script pane to full width view.  The Script Pane collapser will collapse the Script pane back to it's default of 70% width with the Info pane visible on the left with 30% width.

    (5) Maximize Script

    Select this icon to expand the editor to full heigth and width of the modal window.

    (6) Info Pane Tab Strip

    The tab strip will allow the info pane to change to the appropriate context panel as selected.

    1. Read Me: This is the panel that contains the Description and How to Use this Script information fields.
    2. Source: The Source tab is only visible when a script has been selected from the Script Library or when created using the AI Copilot.
    3. Settings: The Settings tab is where the scoring settings are set.  Use this area to enable output to be sent to the user, enable scoring, set the score value,  and retry attempts value.
    4. Outcomes: The Outcomes tab is only visible when On-demand evaluation is selected for the Automated Activity. The Outcomes tab is where all of the outcome settings get configured and is only available to Automated Activities, Life Cycle Actions do not use Outcomes.

    (7) Information Fields Edit

    Select this icon to be able to edit the script information fields (Description, and How to Use this Script).

    (8) Resize Handle

    The resize handle is a user-friendly feature that allows you to adjust the size of the Info Pane and the Script Pane, according to your preference. Located between the two panes, you can click and drag this handle to resize the panes. Moving it to the right will increase the size of the Info Pane and decrease the size of the Script Pane, and vice versa. This gives you the flexibility to customize the layout of the Dual Pane Script Editor to best suit your workflow.

    (9) Script Configuration Panel

    The Script Configuration Panel is a dedicated section located at the bottom of the Info Pane. It provides a centralized location for all the configuration settings related to your script. By clicking on the panel, it will expand to reveal various settings that you can modify according to your script’s requirements. These may include the script target, language, special custom packages. When not in use, you can easily collapse the panel to maximize your workspace. This feature ensures a clean and efficient scripting environment, tailored to your needs.

    Dual Pane Script Editor Usage

    Creating Scripts from Scratch

    In the process of creating scripts from scratch, users are presented with a dual pane view. On the left is the info pane, and on the right is the script pane.

    DualDisplay Script from Scratch

    The dual pane view greatly enhances script creation by providing a more unified and simplified UI design.  This provides two panes that assist Lab builders and Script Authors by keeping all of the relevant information right at your fingertips.  The Script view now has an Info pane on the left and the Script pane on the right.

    1. Info Pane (Left)
      The info pane on the left is the area that contains all the Information and settings for the script and provides the ability to make modifications through two main tabs: the Read Me tab and the Settings tab.

      1. Read Me Tab
        The Read Me tab allows users to outline a meaningful description for the particular script. It also provides details on how to use the script. This area supports Markdown, enhancing the section and providing more definition for others who might be using the script.

        DualDisplay Script from Scratch - ReadMe

      2. Settings Tab
        The Settings tab contains the options for the specific settings for current script.  These settings are scoring settings, script retries, and any Task List field settings if selected.

        DualDisplay Script from Scratch - Settings

    2. Script Pane (Right)
      The script pane on the right is where the script is written and viewed.  The script pane is designed for writing scripts and has the ability to collapse or expand the Info Pane as needed and also the ability to make the script editor go to full screen mode.

      DualDisplay Script from Scratch - Script Pane

    Creating Scripts from the Script Library

    For those choosing scripts from the script library, once a script is selected, users are presented with a dual pane view of the script.  All the same functionality is provided as found in the Creating a Script from Scratch with the added Source info tab.

    DualDisplay Script from Script Library

    1. Info Pane (Left)
      The info pane on the left includes a Source tab, which indicates the origin of the script from the script library.

      1. Read Me Tab
        The Read Me tab will be prepopulated with the script information fields that are retrieved from the Script Libary for the selected script.

      2. Source Tab
        The Source Tab provides a read-only view of the selected script template as pulled from the script library. This gives users the capability to change the source script if the one pulled from the Script Library is not the correct script. If the user has the appropriate permission to edit Script Templates, then there is a direct link to the Edit Script Template form to simplify the process of making modifications to the script template.

        DualDisplay Script from Script Library - Source

      3. Settings Tab
        The Settings tab contains the options for the specific settings for current script.  These settings are scoring settings, script retries, and any Task List field settings if selected.

    2. Script Pane (Right)
      The script pane on the right displays the script from the script template library. The script is now local for this automated activity or life cyclke action where users can make modifications to the script.

      NOTE:

      Selecting the Change Source button to replace the Script Source will also replace the script in the Edit pane.

    Creating Scripts using AI Copilot

    When creating scripts using AI Copilot, the Source tab is where the AI uses prompts to request input from the user to create and generate the script.

    1. Info Pane (Left)
      The info pane on the left includes an AI generated Read Me as well as a Source tab, which preserves all the prompts used for AI to generate/regenerate the script.

      1. Read Me Tab
        Once the AI has completed generating the script and the user has decided to use this suggested script, the AI will generate the appropriate Read Me tab Description and How to Use this Script details.  This is super powerful and reduces tremendous time!

        DualDisplay Script from AI Copilot - ReadMe

        Tip

        The more descriptive the prompts are the better the AI engine will give meaningful information in the Read Me information fields.

      2. Source Tab
        Once the AI has completed its task, the generated script appears in the script pane. The info pane shows the actual prompt, allowing users to modify the prompts to improve the output of the script.

        DualDisplay Script from AI Copilot - Source

        Tip

        Utilize multiple prompts to outline the item being evaluated, it is best to use multiple prompts than to put all the logic within a single prompt.  Expand the Info pane to be able to see the prompts without the line trimmed.

      3. Settings Tab
        The Settings tab contains the options for the specific settings for current script.  These settings are scoring settings, script retries, and any Task List field settings if selected.

    2. Script Pane (Right)
      The script pane on the right displays the AI generated script. The script is now local for this automated activity or life cycle action where users can make modifications to the script.

      Tip

      To make changes to the script using AI, it is best to update or add the prompts in the Source tab and then regenerate the script.  If the AI generation is good then updates can be made.  Remember that if regenerate is selected then the script will be replaced based on the prompt the user chooses in the AI response dialog.

    Related Topics


    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.