Neurons Bots editor
Once you have selected the Neurons Bots trigger type on the Create Bot page, the Neurons Bots editor page displays. Use the editor to create the bot by building up the stages. Stages can be a combination of queries, with filters and actions, for the query outcomes. Learn more about Neurons Bots Stages.
- The bot will always start with the trigger that you selected on the Neurons Bots creation page.
You can update the Trigger settings when you set the bot from Inactive (default) to Active. You can do this now or once you have built the bot. You can also change the Trigger type from within the Trigger settings.
- To build the bot, add stages to the work area. You can look for stages using the search, or by expanding the Stage category to see what is available. Learn more about Stage categories.
- Click and drag the required stage on to the work area. Once the stage is on the work area, the following functionality is available:
- Click to display the view Stage Information panel. This panel provides a description of the stage and a list of all properties it will return, for example device name, device model, event Id, event date.
- Click to connect the stage to another stage. This is how you connect the stages to build up the bot. Stages can have multiple connections to multiple other stages, depending on how complex you want the bot to be. Once a connector is drawn, click on the connector line to open the Connection settings.
- Click to disconnect the stage from another stage.
- Click to delete the stage from the bot.
You can copy (CTRL+C) any part of the workflow and paste (CTRL+V) in the work area, or between browser tabs (Chrome only).
- Click on a Stage to see the Stage settings. Complete the stage properties to customize the bot. Any mandatory properties are indicated by a red asterisk.
- Click and drag the connector icon to connect one stage to another.
- Once you have completed the bot by connecting all required stages, filters and actions. Select Save and publish.
You can save the bot as a draft at anytime, click Save draft. If you exit the editor without saving, a save prompt dialog displays, you can select to save a draft, or discard any changes you have made.
When you save a draft, the bot name displays with my draft next to it, to indicate the draft status.
A Trigger stage is the type of bot, i.e. Schedule or Custom action. It is always the first stage in the bot editor.
To edit the Trigger settings, click on the Trigger stage in the work area to open the Trigger settings panel.
You must enable the Trigger to edit the settings. Switch the Trigger status toggle from Inactive to Active.
Once active, the settings available depends on the trigger type:
- Target group(s): Select the target groups to run the bot against.
- Target scope: Select a percentage, in 10 unit intervals, between 10% to 100%. The scope randomly selects a number of devices within the target group, it does not detect whether the devices are online or offline.
Note: A minimum of one device will always be selected, regardless of the percentage threshold.
- Repeat: Select whether the schedule is to repeat; daily or weekly.
- Frequency: Select the schedule frequency unit; minutes or hours.
- Interval: Select the interval from 30 to 55, in 5 unit intervals.
- Start: Select the start date and time of the first scheduled run.
- End: Select the end date and time of the last scheduled run.
Bot inputs: If any bot inputs have been defined for this bot they will appear here for you to set.
- Single device: Toggle On to enable the custom action for a single device in Devices. Once enabled the bot can be run on a single selected device in Devices. This is the default setting.
The Perform Custom Actions Permission, in Access Control > Roles, must be enabled for the user.
- Multiple devices: Toggle On to enable the custom action for multiple devices in Devices. Once enabled the bots can be run on multiple selected devices in Devices.
The Perform Custom Actions on Multiple Devices Permission, in Access Control > Roles, must be enabled for the user.
One of the published options must be enabled, otherwise the bot will not be published as a custom action in Devices.
Device view user access
- Limit user access: Specify a list of users that can view and run the bot as a Custom action in Devices. Non-specified users will be unable to access the bot.
If no users are added, then All users have access to the bot in Devices.
- In the Trigger settings, set the Trigger status toggle to Active.
- Select Limit user access. The User access page displays.
- On the User access page, select Add user. The Add users panel displays.
- On the Add users panel, select all of the users that you want to allow access to the bot as a Custom action in Devices. This restricts all other users from accessing the bot.
- Select OK to confirm your selection and close the panel.
- The users you selected are listed on the User access page. Select Apply and close to save the changes and return to the Trigger settings.
The Custom action stage on the work area, displays Visible to which is the number of users that have access, or displays All users if no users have been specified.
Custom action name and description
- Custom action display name: Enter a display name for the custom action. This displays in Ivanti Neurons Devices > Actions.
- Description (optional): Enter some descriptive text for the action.
Click on a connector line to open the Connection settings panel.
A connector condition can help to filter endpoints as they progress through the stages. For multiple type stages the connector condition does not remove result elements so no data is modified.
- Has condition: Select to use a condition to determine what endpoints continue to the next bot stage.
- Has automatic description: Select to display the condition parameters on the connector line. Displays in the language as configured in the Ivanti Neurons logged in profile.
- How many must be true?: Select All (and), or, One (or). Only applicable if you Add more than one condition.
- Pick value: Select the condition value.
- Results match: Select All or One. Only applicable if connected to a multiple type stage.
- Select operator: Select the condition operator. Dependent on the selected value.
- Custom value: Select the custom value for the selected operator. Dependent on the selected operator.
You can customize the connector line type, style, line thickness, link style, and color.
Labels can be added to the connector lines. Select Add Label to create a new label. You can customize the label by position, fill, outline, and text color. Select Remove Label to delete the label from the connector line.
Bot inputs are created in the bot editor for use in a bot if you have a choice of action that can be taken. So you could have a general bot, but allow the analyst to select what action to take at time of running.
For example, on a Disk Clean Action you could have reclaim disk space field with options such as; delete temp files and make onedrive content cloud only, or, delete temp files and perform cleanmgr, or, do both.
You can configure the name, type, and default value of the input field, and whether it is optional or mandatory.
The bot inputs can be used when you select to manually run the custom action from the devices view or through Run Now. The inputs can also be used for a schedule bot, in this case, any bot inputs that have been created will display in the Trigger settings
- In the Neurons Bots editor page, select Define inputs to open the Define inputs panel.
- Select Add input to display the fields to create a new input.
- Name: The display name of the input field.
- Type: The type of input required for the field. Select from:
- Text/String: Select to create a free text field.
- Number: Select to create a numeric value field.
- True/False: Select to create a True or False selection field.
- Date: Select to create a Date field, uses the date picker.
- Text Options: Select to create Option fields. If selected, you need to define what the choices are, enter a Choice Name and Choice Value, the name is the friendly display name and the value is the string passed through the bot. You can add multiple choices.
- Optional: Select whether the field is to be optional or not.
- Default Value: Set the default value for the input. The options you have in the default value are dependent on the Type of input you selected.
Define a variable at bot level. This variable is then updated when using the Set Variable, Common stage.
- In the Neurons Bots editor page, select Define variables.
- Select Add variable to display the variable fields.
- Name: Enter a name for the variable. When using the Set variable stage this is the name listed in the Pick variable drop-down.
- Type: Select the type of variable from the following:
- Text Options
Initial Value: Set the initial value for the variable. The entry will be dependent on the Type of variable you selected.