How to kick start a Scenario externally with options to hand over parameters
Q. Can you kick start a Scenario from another app? Can you give parameters too?
A. Yes to both questions --- please see below. (Also, refer to ARGOS API plugin help)
There are two ways - one is to use Supervisor's Open API and two is to use the command prompt.
Example below is how you can kick start an ARGOS Scenario from the command prompt.
Firstly, there are 2 new items you must know.
1) Scenario ID: For all ARGOS Low-code Scenarios, ARGOS Supervisor gives a unique ID when saved. This is called the Scenario ID. You must save the Scenario to Supervisor by using either Save to Supervisor or Save to Supervisor as New Bot menu on STU.
2) System Variable: {{sys.argv(n)}} has been implemented as system variable (array) for hand-overs of parameters when executing a scenario from outside
Now, from a command line prompt below command will kick start a Scenario externally with parameters
“C:\Program Files (x86)\ARGOS\AgentForRPA\Win\ArgosRPAUxRobotAgent.V3.exe” shortcut scenario_id param1 param2 … paramN
The PAM(.exe) file full path above is the default path for PAM(.exe) to be installed but if you have changed the folder, change the path accordingly.
“shortcut” is a house command that PAM only understands.
Scenario ID can be found when you open the scenario with STU at the title bar (upper left corner of STU)
In this case, 774 is the Scenario ID for the bot below (you must save your bot to Supervisor to obtain Scenario ID.
For hand-over of parameters, you must design your Scenairo with {{sys.argv(n)}} variables.
{{sys.argv(1)}}
{{sys.argv(2)}}
...
{{sys.argv(N)}}