Bots Stages

Used to present and filter information from devices that meet the specified criteria. The output and context from this query stage can be passed through subsequent stages in the bot.
For example, show devices with less than 10% free disk space.

• Teams call quality stage: The Teams call quality stage fetches call records with quality information for targeted devices or users. It assesses network performance, device compatibility, and overall call experience before or during live meetings, helping to identify potential issues.

  To configure the Teams call quality stage:

  1. Select the Teams call quality stage and go to Stage settings.

  2. In the Select connector for credentials field, use the drop-down to select the connector to connect to Microsoft Entra ID.

  3. From date and To date are optional fields; you can select the Custom value or Date now options. If you select the custom value option, enter the value, and if you select the date now, toggle the Add time to date to enter the Time unit and Duration.

     This retrieves data from the last 30 days and a maximum of 60 calls per user.

• Inventory Query: This stage retrieves values from the inventory based on user-selected filters and columns, which can then be used later in a Bot workflow. The retrievable attributes are limited to those with a single value (1:1 relationship); array-based attributes are not supported.
  This stage exists in all Bot contexts, with dedicated stages also available within Universal context for both Device and People Inventory.

  When using the “to People context” or “to Device context” stage, failing to place the correct inventory query within the stage will result in an “invalid context” error.
  

• Inventory Query (Advanced): This stage works in the same way as the Inventory Query stage but also allows the retrieval of array-based inventory attributes (1: many relationship). It exists in all Bot contexts, with dedicated stages also available within Universal context for both Device and People Inventory.

  When using the “to People context” or “to Device context” stage, failing to place the correct inventory query within the stage will result in an “invalid context” error.

Action stages leverage Automation Fabric to perform actions. Use of variables is available for some actions. Learn more about Stage variables.

• Filter Results: You can filter query results based on customizable properties. Once you connect a built-in Query Stage to a Filter, the Property drop-down lists all available properties that can be selected. To view details of the properties, go to the query Stage Settings panel and select Stage Information.
• You can also use the Preview Query functionality to assess all targeted devices, and use the results table to view the format and range of values that can be filtered.
• You have the ability to join multiple queries together in sequence. If this is done, all results are combined and available to filter on, or use in Action Stages. You can change the comparison behavior of the connected filter so that it either applies either AND or the OR logic to determine the results.
• Join: Use this stage to re-merge a bot that has split down separate branches. In the Stage settings, select the join behavior; Any state, All succeeded, At least one succeeded.
• Set Variable: Use this stage to provide a consistent reference point that can be configured with default values and updated by stages based on results. This is useful when you want to use a single variable to reference a field which might be updated from queries across different branches. The variables that you can set are defined in Define variables.

• Delay: Use this stage to set the workflow on hold for a predetermined amount of time. It delays the execution of the upcoming stage based on the time configured in the delay stage. In the stage settings, select the delay duration time in minutes, hours, and days. The maximum possible delay you can set is for seven days, and the minimum delay is one minute. This stage is helpful for waiting for a user to reply to a message or for a process to finish.

• To device context stage: This stage is available when you choose Universal as a bot target type. Use this stage to switch from the people context or universal context to device context. In the stage settings, you can either create an input and then bind that to the Device name, or you can toggle it to List input mode. When you click the device context resizable stage, the stage library will dynamically change to the device context library. You can drag and drop a required stage from the stage library in the device context stage to gather data that can be used further outside of this device context. This format is useful for orchestration workflows when you want to sequence different actions across different devices as part of the same workflow.

• Map List to List variable: This stage allows you to map data from a source list to a list variable. The Device Inventory Query stage, for instance, returns its results as a list. Use the Map List to List Variable stage to store these results in a list variable for later use within the bot or as an output for external processing.
  

  To use this stage, select the destination variable of type, List. Next, select the source list also of a List type. The destination field appears after both the variables are selected. The available tokens represent only the values contained within the source list. This is useful when a previous stage returns a list of objects that can be stored as a variable for use later in the bot.

  Prerequisites

  • You must have a list variable defined. See Bots editor for define bot variables.

  • The source data must be a list type output from a previous stage.

• Append to List variable: The Append to List Variable stage adds a new value to the end of an existing list variable. This is useful when you want to build a list dynamically as the bot runs, such as collecting values from a loop or storing results from multiple stages.

  Prerequisites

  • A List variable must be defined. See Bots editor for define bot variables.

  • The value being added should be compatible with the list's data type.

• Cast to Type stage: The Cast to Type stage allows you to convert input values into a specific data type. This stage is useful when downstream stages or filters require values of a particular type, such as String, Number, Boolean, or Date.
  For example, after extracting a number from a log message string, you can cast the output to an Integer and perform mathematical operations in downstream stages.

  If you need to convert an object to a string, use the To JSON stage instead.

  Key capabilities are:

  • Boolean Conversation

    • Converts values such as 'true', 'TRUE', or '1' to the Boolean value true.

    • Only the exact value 1 is treated as true; decimal values such as 1.5 are not.

  • Date Conversation

    • Use the JavaScript Date constructor to convert supported string values into date objects.

  • Number Conversation

    • Performs a direct numeric conversion.
      Example:

      • Input: '23'

      • Output: 23

  • String Conversation

    • Converts values into their string representations because the input supports tokens. Multiple values can be combined into a single string.
      

• JavaScript AI stage: The JavaScript AI stage combines the flexibility of the JavaScript stage with AI-assisted code generation, enabling users to create data transformations and business logic through prompts rather than manually writing code. The generated code can be reviewed, edited, tested, and reused within workflows.
  The Stage settings include a prompt field used to generate the JavaScript code. It supports user-defined inputs, which can be referenced directly in the prompt. You can modify the prompt using the Open stage editor option. The changes must be applied and saved before testing in Test and get outputs.
  When saving the bot for the first time, you must accept the terms and conditions for the JavaScript AI stage, located at the bottom of the Stage Settings panel.
  As with all AI-related stages, this stage remains unavailable until the AI Powered Stages option has been enabled in Admin > Settings and users have been assigned an RBAC role that includes the Artificial Intelligence > Bots Generative AI Stages permission.

• JavaScript stage: The JavaScript stage allows you to execute JavaScript code as part of a workflow and does not run on an endpoint device. It is useful for manipulating data, performing calculations, formatting values, and generating structured outputs. This enables workflows to perform processing even when the target device is offline.
  In Stage Settings, you can define one or more inputs for the stage. Input values are automatically available within the JavaScript code and do not require explicit variable declarations.
  After entering your code in the JavaScript Editor field, click Test and get output to execute the code and view the output. The output is generated from the returned JSON and can be used as structured output by downstream stages in the workflow. The generated JavaScript can be modified using the Open stage editor option. The changes must be applied and saved before testing.

  This stage runs in isolation; therefore, its functionality is limited. For example, the ability to use JavaScript to call a web service would result in a connection failure.

Stages for early access are available here. Beta stages are offered to enable Ivanti to gather feedback and data around upcoming features.

Custom stages allow you to execute a custom script. You can choose from the following scripting templates:

• osquery: an open source SQL based language that can be used to query and retrieve information from devices and supports Windows and macOS devices.
• PowerShell Query: can be used to query Windows and macOS devices. It can run as system or logged-on user, or using specified credentials.
• PowerShell AI: can be used to generate and execute PowerShell scripts within Bot's workflow. It can run as system or logged-on user or using specified credentials.
• Bash Action: can be used to perform actions on macOS devices.
• Bash Action AI: can be used to generate and execute custom Bash scripts within Bot's workflow. It can run as system or logged-on user.
• Command Action: executes Windows command prompt commands on the target endpoint. It can run as system or the logged-in user.
• Command Action AI: can be used to generate and execute custom command scripts within Bot's workflow. It can run as system or logged-on user.
• Powershell Action: can be used to perform actions on Windows devices.

AI functionality is not available in the FRU landscape.

Learn more about Custom Stages

List function stages allow you to perform actions on stage results that are a list. You can, for example, filter, sort, count, or sum the list.
If the result of a List function stage is again a list, you can add another List function to further refine the result.

In the work area, you can recognize a stage that (is expected to) return a list result by the List tag.

To apply a List function stage in your workflow:

1. Add a stage that has a list result.

2. Add the desired List function.

3. Using , connect the stages from step 2 and 3.
   This will populate the value(s) for Select List on the List function stage.

4. Select the List on which you want to perform the List function.

5. Depending on the List function, complete the remaining configuration of the stage.

6. Complete the rest of your bot workflow and save your changes.

The string manipulation stages allow you to transform, clean, validate, and extract information from string data as part of an automated workflow. They are intended to be used wherever a workflow requires working with data, such as checking string formats, extracting data from log messages, or building strings dynamically. Some of the stages include:

• Extract String: Uses regex to match and extract strings from a block of text, returning the matched strings for use later in the workflow.

• Replace String: Allows replacing one value with another inside a string. The match can be done by explicit value or regex.

• String Matches: Uses regex to match within a string, returning a true or false condition.

Interaction stages allow a bot to interact with and collect input from end users using Microsoft Teams. You can choose from the following interaction stages:

• MS Teams Interaction: Allows a bot to interact and collect input from an end user through Microsoft Teams. The message comprises a title, a message, and a choice of interaction: buttons or free text input.
• MS Teams Message: Allows a bot to send one-way messages to end users using Microsoft Teams. The message comprises a title and a message.
• MS Teams Rating: Allows a bot to interact and collect ratings from an end user through Microsoft Teams. The message comprises a title, a question, and a rating.
• MS Teams Sentiment: Allows a bot to interact and collect input from an end user through Microsoft Teams. The message comprises a title, a message, and a choice of interaction: buttons or free text input.

To learn more, refer to MS Teams Stages.

User stages are custom scripted stages. They are saved and made available in this User section for multiple reuse in bot creation.

Learn more about User Stages.

Microsoft Active Directory stages

The following stages manage user accounts in Microsoft Active Directory via the Microsoft Active Directory connector:

• AD Update User: Modify user attributes.

• AD Assign Groups: Add a user to one or more AD groups.

• AD Delete Account: Remove a user account.

• AD Disable Account: Disable a user account.

• AD Enable Account: Enable a user account.

• AD Unlock Account: Unlock a user account.

These stages are currently available in the Universal and People context.

Prerequisites

Before using Active Directory actions, ensure the following:

• A Microsoft Active Directory connector must be configured.

• The connector must:

  • Have valid credentials for the target AD instance.

  • Support retrieving and managing users.

• A connector must be selected for every AD action.

Configuration

When configuring an AD action:

1. Select Connector:

   • Choose a configured Microsoft Active Directory connector.

2. Specify Identification Type:

   • Define how the target user is identified (for example, SID (Security Identifier) or SAM (Security Account Manager) account name).

3. Provide Required Inputs:

   • Depending on the action, specify attributes such as:

     • Select optional fields to update (optional).

     • Groups to assign.

     • Edit Account Options.

All AD actions require both a connector and a user identification method to execute successfully.

Microsoft Entra ID stages

The following stages manage user accounts in Microsoft Entra ID via the Microsoft Entra ID connector:

• Entra ID Enable User: Enable one or more Entra ID user accounts using the selected Neurons Entra connector, the same connector used to import the users into Ivanti Neurons.

• Entra ID Disable User: Disable one or more Entra ID user accounts using the selected Neurons Entra connector, the same connector used to import the users into Ivanti Neurons.

• Entra ID Delete User: Deletes one or more Entra ID user accounts.

• Entra ID Update User: Updates one or more user attributes in Entra ID.

• Entra ID Get User: Retrieves one or more user attributes from Entra ID.

• Entra ID Get User Manager: Retrieves the manager details for one or more Entra ID users.

• Entra ID Get User’s Groups: Retrieves the group memberships for one or more Entra ID users.

• Entra ID Get Group Members: Retrieves the members of a specified Entra ID group. This stage is available in Universal context.

• Entra ID Get Group Owners: Retrieves the owners of a specified Entra ID group. This stage is available in Universal context.

• Entra ID Restore User: Restores one or more deleted Entra ID user accounts. Provided the accounts are within the 30-day soft-delete retention period.

• Entra ID Set User Group: Adds or removes one or more users from a specified Entra ID group.

  These stages may not make changes immediately available to subsequent stages. If a later stage depends on the updated data, consider adding a Delay stage to allow sufficient time for synchronization.

Prerequisites

Before using Entra ID stages, ensure that:

• A Microsoft Entra ID connector is configured.

• The connector is configured with valid credentials and the required permissions based on the action to access and manage Microsoft Entra ID resources.

• The bot has access to the configured connector.

Configuration

When configuring an Entra ID action:

1. Select a Connector for credentials
   Choose a configured Microsoft Entra ID connector as a credentials.

2. Configure Stage-Specific Inputs
   Enter any additional information required for the selected stage, such as:

   • User (UPN or Entra ID)

   • Group (Names or Entra ID)

   • Additional Fields

   • Attributes

   • Additional User Fields

   • Entra ID

Bot Name: Name of the current bot.

Initiation User: Name of the user who initiated the bot. This will either be a user, or a Neurons service.

Initiation User ID: User ID of the initiating user. This will either be a user ID, or a Neurons service.

Timestamp (ISO): Current timestamp in ISO format.

Device Name: Gets the device name for current device within the current stage. Device names returned are separated by commas.

All Device Data: Gets all data for current device within the current stage. This will be a JSON object.

Given Name: Name of the logged on end user.

Display Name: Full name of the end user.

Email: Email for the end user.