Contents x
    The Interface
    • 2 Minutes to read
    • Print
    • Dark
      Light
    • PDF
    Contents

    The Interface

    • 2 Minutes to read
    • Print
    • Dark
      Light
    • PDF
    Article summary

    Scripts Collection

    To access the scripts collection page, click on the top navigation bar’s additional pages button (hamburger menu) and select the “Scripts” menu item. It will be located directly underneath the “Reports” menu item.

    Don’t see the Scripts option in the menu?

    • You are on the pro subscription plan:
      If you aren’t on the enterprise subscription plan, you won’t be able create or run scripts within your workspaces. Contact your account manager if you are interested in upgrading to determine if it’s the right fit for your organization.

    • If you are on the enterprise subscription plan:
      Scripts are part of the automation scripting kit as a separately licensed module. Check with your account manager and make sure that your organization is licensed for the automation scripting kit. Additionally, make sure that if you aren’t an organization or workspace administrator that the permissions group you belong to has the proper permissions to access scripts. You need at least view rights on the “Script” permission to see and execute scripts. Contact support@sadiebluesoftware.com if you still have trouble locating or accessing the scripts page.

    After landing on the scripts collection page, you will be presented with the familiar Agility Blue grid system. From this page you can create, execute, edit and delete scripts. Clicking on the name of a script within the grid will take you to the details page of that script and each script entry on the grid contains a grid context menu that contains some some shortcut items you can use without having to navigate to the details page.

    Interface Components

    The scripting interface in Agility Blue is comprised of several pages and components:

    Page

    Description

    The scripts grid page

    • Displays a list of scripts in a familiar Agility Blue grid layout; complete with querying, sorting, and exporting. Scripts can be directly enabled/disabled or deleted from the row context menu. 

    • Navigate to the script details page by clicking on the name of the script.

    • New scripts can be created from here by using the "New Script" button.

    The script details page

    • Shows information about a script such as the body, when the script was last executed, and by whom.

    • The side panel allows the script to be executed manually and provides a short cut to adding an event trigger to the script.

    Script details tab sub page: Parameters

    • Grid page showing the list of parameters available for the script.

    • Add new parameters using the “New Parameter” button.

    Script details tab sub page: Event triggers

    • Grid page showing the list of triggers applied to the script.

    • Add new event triggers using the "New Trigger" button.

    Script details tab sub page: Execution results

    • Grid page showing the list of results each time the script was executed.

    Creating or Editing a Script

    The modal window for creating or editing a script:

    1. Name: The name of the script (Required)

    2. Description: The (optional) description of the script.

    3. Enabled?: Determines if the script is enabled or not. If the script is disabled, it will not be executed - even if there are event triggers attached to the script.

    4. Body: The contents of the script. Here is where you design the script that uses an embedded development-inspired editor that includes useful tools for writing your scripts.

    5. Save: Saves the script and closes the modal window.

    Executing the Script

    Note here that the modal window outlined above is simply for designing and editing the script and does not execute upon save. To execute the script, check out the executing a script help article.


    What's Next