Automate

The integration with Automate Plus/Ultimate lets you run Workflows in Automate from JAMS. The Job can then be monitored from the Monitor view within JAMS. This integration does not require enabling it in the JAMS installer. The Workflow in Automate can contain variables. Any available input variables for the Workflow appear as Parameters on the Job.

NOTE: When JAMS matches its Parameters to the Automate Workflow Variables, only the Variables at the Workflow level (Shared Variables) are matched. JAMS does not display Variables on the individual Tasks inside the Workflow.
NOTE: The Variables from Automate will overwrite all parameters on the JAMS Job. If you want to include parameters in JAMS, it is recommended that you add them at the folder-level so the Job inherits them.

Before You Begin

  • Ensure the Automate REST API has been enabled within the Automate application. See Automate API documentation in the Community Portal for more information.
  • Ensure you have the correct port number for accessing the REST API. Otherwise, the default port, 9708, is used.
  • Ensure you have the name or Id of the Automate Workflow.
  • Install the JAMS Windows Agent if the JAMS Scheduler will not be running the Workflow. See JAMS Agent for Windows.

Creating a Credential

Create a Credential in JAMS that will be used to connect to the Automate server. This Credential contains the Username and Password for authenticating to the Automate REST API. Users must have Inquire and Get Password permissions to this Credential to retrieve Workflows from Automate.

See Working with User Credential Definitions for more information.

Creating an Automate Job in JAMS

Ensure the user creating the definition has permissions to the Credential that is referenced in the Job. If you change the Automate Server or Port fields, the Automate User and Workflow fields will be cleared.

NOTE: If you change the Automate Server or Port fields, the Automate User and Workflow fields as well as the Job parameters will be cleared. Any inherited parameters from the folder-level are still displayed.
  1. Click Definitions from the JAMS Shortcuts menu.
  2. Click a folder where the Job will be saved.
  3. Click +.
  4. In the Name field, enter a name for the Job.
  5. In the Execution Method field, select Automate.
  6. Click Ok.
  7. Click the Source tab.
  8. In the Automate Server field, enter the IP address or server name of the Automate server.
  9. In the Port field, enter the port for the Automate server. The default is 9708.
  10. In the Automate User field, select the JAMS Credential that you previously created.
  11. In the Workflow Name, select or type the Workflow name or Id in Automate that you want to run. If there are Workflows with the same name in different folders, enter the Workflow Id.
  12. Click the Schedule tab to add schedule items to set when the Job will run.
  13. Click the Parameters tab to view any variables that are defined on the Automate Workflow. You can override these values, if needed.
  14. Click the Properties tab.
  15. In the Execute As field, select a credential to run the Job.
  16. In the Agent field, select the Agent if the Job will not run on the Scheduler.
  17. Click Save and Close.

Related Topics