Bots are the objects you create and configure to automate data processes within Openprise. With bots, you can configure the frequency and start date/time of a set of data processes and let Openprise automate it without human intervention. The actions available for bots include:
- purging data sources
- importing data sources
- purging jobs
- running jobs
- adding a wait step
Note: Bot times are set in UTC.
To access Bots, navigate to Automation - Bots
The main Bots page will show existing bots and allow you to add additional bots.
There are 2 sections: Active Bots and Inactive Bots
The header of each bot tile contains details about the type of bot.
- Active Bots shown with a green header
- Inactive Bots shown with a blue header
- API in the header indicates this is an API enabled Bot
- App Action in the header indicates this bot runs an app
Add a Bot
Select Add bot
On the left side of the screen, configure the Bot
- Bot name: Create a name for your bot
- Toggle: Select the toggle to automate the bot on a schedule (green indicates the bot is on)
- Bot description: Set a description for your bot to provide more detail
- Bot Administrators: Select the users that have edit rights to this bot
- Labels: Select labels for the bot
- Bot execution type: Options are: Scheduled bot run (execute at scheduled times only), Scheduled bot run (execute at scheduled times except missed runs execute immediately), Continuous bot run, or Scheduled bot run - Execute from upstream bot.
- Start at: Set the date and time for the bot start run (Time is UTC)
- Repeat every: Set the schedule (options are minutes, hours, days, weeks, months, quarters, years)
- Bot execution failure options: Options are: ignore failure and execute or stop execution and cancel recurrence
- Email bot administrators: Check this box to notify administrators via email (defined in the bot administrators sections) of bot failures
Bot action steps
On the right hand side of the screen, set up your bot steps using the canvas
- Reset Layout: Select this to view the default view (e.g. If you've maximized the view, it will reset to the default size)
- Expand: Select this option to see the canvas setup in a full screen view
- Switch to horizontal: Select this to view the setup in horizontal view (default is vertical view). You can toggle between these options at any time.
- Zoom In/Zoom Out: Select these options to make objects in the canvas larger or smaller (you can also use your mouse to zoom in/zoom out)
- Create first step: Select the object type that you'd like to create for the first step of the bot. Options are: Data Source, Job, or Sleep.
Selecting a Data Source
- Object: Select the specific data source to include in the bot
- Action: Select the action. Options are: Import, Purge, Purge with filter, Re-sync full re-sync (available for Salesforce and Marketo), Re-sync Deleted record detection only (available for Salesforce and Marketo)
- Retry after (mins): Set the time to wait before retrying from this step onwards (in minutes).
- No. retries: Set the number of retries.
Selecting a Job
- Object: Select the specific job to include in the bot
- Action: Select the action. Options are: Run, Purge
Selecting a Sleep step
- Set the length of the Sleep step. Options are minutes or hours.
Adding parallel or sequential steps to the bot
- Plus symbol to the right: Select the plus symbol to the right to create a step that runs in parallel (at the same time). NOTE: Only 5 steps can run in parallel per bot.
- Plus symbol below: Select the plus symbol below a previous step to add a sequential step to the bot. (will run after the previous step has completed).
- Configure downstream bot: Select the downstream bot. The downstream bot will initiate a run after this bot has completed.
- Objects: You can also grab an object from the toolbar on the left and drag to the position in the bot where you'd like to add it.
NOTE: It is best practice to configure no more than 20 steps in a bot.
Click HERE to learn more about Bot to Bot Linking.
Bot run steps
Run the bot and review the run status directly from the bot configuration page.
- Click Run to run the bot manually.
- Click Run Report to review how the bot performed.
You can also access the Run and Run Report buttons from inside the bot configuration page in a Project.
Bot Tile - Options
- Select the API option to make this an API enabled bot
- Select the pencil Icon to edit the configuration of the bot
- Select to Run the bot
- Select to Run the bot from a given step
- Delete Bot
- Cancel Recurrence
- View Run Report
**Hover over each option to see what each does (image below shows a hover over the trash can icon)