This program is hosted and managed on GitHub by Basico P/S.
The Automation Orchestrator is the recommended solution to set up triggering and scheduling of Foxtrot and FoxBot. The Automation Orchestrator allows you to run a local Django Web Application to administrate and orchestrate automation scripts such as Nintex RPA botflows but you may also orchestrate other automation such as Python scripts, batch files, and other RPA tools. The Automation Orchestrator is tested with and supports Nintex RPA version <= 15.1.
As described on the official Django project site, it "is a high-level Python Web framework that encourages rapid development and clean, pragmatic design. Built by experienced developers, it takes care of much of the hassle of Web development, so you can focus on writing your app without needing to reinvent the wheel. It’s free and open source."
Some of the biggest web platforms and brands like Instagram and Pinterest use the Django Framework due to its leading security features and ability to scale.
The purpose of the Automation Orchestrator is to offer a well-functioning, fully customizable web server application to trigger and schedule scripts. The Automation Orchestrator can run as a fully local server only available on the local host accessible via a browser or as a server available in your protected internal network accessible via a browser.
Feature highlights out-of-the-box:
- Authentication & Authorization
- SMTP accounts
- API Triggers
- Email IMAP Triggers
- Email Outlook Triggers
- File Triggers
- Schedule Triggers
- Botflow Execution Log
- Queue Functionality with License Awareness and Botflow Priorities
- Native Script Support
- Nintex Foxtrot RPA
- Any other tools that can be executed as a command with: "application_path.exe" "file_path.abc"
- Graphic Execution Overview
- Calendar View of Execution History
We highly recommend that the Automation Orchestrator is installed and setup only by people experienced with both Python and Nintex RPA. You are always welcome to contact us for assistance via: email@example.com
Out-of-the-box, the Automation Orchestrator can trigger and schedule scripts on the same machine and user running the server. In case you wish to do either of the following two things, you need to utilize the Automation Orchestrator Executor add-on:
- Run the Automation Orchestrator on one machine but execute the scripts on a different machine, or
- Run the Automation Orchestrator on a machine (for example, a Windows Terminal Server) with multiple users that are supposed to execute scripts
For the Automation Orchestrator to work, you need to install Python. Make sure to install the latest 64-bit version. If you are in any doubts on how to correctly install Python, follow this guide or contact us.
After installing Python, you are now ready to install the Automation Orchestrator. Follow these steps precisely:
Create a folder called "AutomationOrchestrator" on your machine, for example, directly on the C: drive or in the "Program Files" folder. So, your path should be similar to "C:\AutomationOrchestrator" or "C:\Program Files\AutomationOrchestrator".
Navigate to the list of releases and download the source code (ZIP) of the latest version.
Unzip the folder in your created "AutomationOrchestrator" folder. So, your path could be similar to "C:\AutomationOrchestrator\AutomationOrchestrator-0.3.0" or "C:\Program Files\AutomationOrchestrator\AutomationOrchestrator-0.3.0".
After unzipping the folder, run the "INSTALL.bat" file for an automated installation process. Remember to run the batch file (or commands manually) as an administrator.
The last command of the installation process will prompt you to create an account, a super user with full permissions to the Automation Orchestrator. After creating the super user, the installation process is complete.
After a successful installation, you are now ready to run the Automation Orchestrator, the web server. You can run the Automation Orchestrator either locally or in your protected internal network. Which of the two options to choose depends on whether you intend to use and access the Automation Orchestrator only on the host machine or not. You can always switch between the two options.
Run the "SETUP_RUN_SERVER.bat" file, which will create a scheduled job called AutomationOrchestratorRunServer in the Windows Task Scheduler. The created job will run every minute to make sure that the Automation Orchestrator is always running. Remember to run the batch file (or commands manually) as an administrator.
As long as you see this window running, the Automation Orchestrator is actively running on your machine. You can always minimize it.
IMPORTANT: If you wish to stop the server, you MUST click the shortcut ctrl+c in the server window to see the confirmation that the server is stopped before closing the window. Make sure to NOT close the server while any executions are running. Sometimes you need to hit the keys a couple of times before it is registered by the server. Also, remember to disable the job AutomationOrchestratorRunServer in the Windows Task Scheduler if you wish to make sure that it does not restart after one minute.
You are now ready to access the Automation Orchestrator via a browser and get started. As long as the Automation Orchestrator is running, you can access it in your browser. The URL is specified in the window of the server running. Begin by signing in to the Automation Orchestrator using the super user that you created during the installation process. You should now see the home page.
After signing in, you can begin to set up the Automation Orchestrator. This is the order of the setup:
- Add a Bot: This is the computer name and username to run the automation. Begin by adding the current computer and user, which will be the default values of the first Bot you add.
- Add an App: This is the Apps you wish to use for automation. The path of the App must be the path on the computer and user to run the automation. For example, this could be name "Foxtrot" and path "C:\Program Files (x86)\Foxtrot Suite\Foxtrot\Foxtrot.exe"
- Add a Botflow: This is the Botflows you wish to run with your Apps. The path of the Botflow must be the path on the computer and user to run the automation. For example, this could be name "Invoicing Process" and path "C:\Users\mbalslow\Downloads\Invoicing Process.rpa"
- Set up Triggers: The Triggers will be what is activating the automation. The simplest Triggers are File Triggers and Schedule Triggers.
For testing purposes, and if you ever need to start an automation manually, you can always manually activate the Triggers by selecting them in the list and use the action in the dropdown to activate them.
- Follow the Botflow Executions: When Triggers are activated, a record is added to Botflow Executions. The different statusses are:
- Get Email Notifications: If you wish to receive Email Notifications, you can set up an SMTP Account.
After setting up the SMTP Account, you can test it to make sure that the settings are correct by selecting it in the list and use the action in the dropdown to test it.
Now, go to your Botflows and add the recipients for each of the Botflow Execution events.
You have now set up the Automation Orchestrator!
The Automation Orchestrator runs with the "DEBUG" flag set to "True", which is not recommended in a cloud production environment, since the Automation Orchestrator should only be used to run fully locally or shared in your protected internal network. If you wish to deploy the Automation Orchestrator in the open cloud, there are many additional steps to consider and implement.
Starting from v0.0.17 Basico P/S - Automation Orchestrator is distributed under the BSD 3-clause license. Basico P/S - Automation Orchestrator v0.0.16 and before was distributed under the MIT license.
(c) Basico P/S, Mathias Balsløw 2019-2020