Loading RA Solutions using REST API

Products

• Automic SaaS
• CA Automic One Automation
• CA Automic Workload Automation - Automation Engine

Issue/Introduction

An RA Solution like Oracle EBS needs to be loaded into a system and the preferred method is using the REST API. 

How can this be accomplished?

Environment

Automic SaaS
AAKE (Automic Automation Kubernetes Edition)
On-prem (traditional On-Premise Automic Automation)
Versions: 21.0 and higher

Resolution

For SaaS, loading the solution is something that must be done with a curl command which will use the system's REST endpoint.  AAKE and On-premise can use the db load utility as well (traditional method).  Here are the steps to load the solution via the REST endpoint (Note: all versions suppose the use of TLS/SSL for the REST endpoint):

1. Download the RA solution from downloads.automic.com
2. Identify the REST API endpoint URL.
          SaaS
               This was sent in the initial email and should have a URL like https://rest-[tenant_id].example.com
               This can also be found in Client 0 - UC_SYSTEM_SETTINGS - REST_ENDPOINT
              
          AAKE
               This might be found in client 0 -> UC_SYSTEM_SETTINGS - REST_ENDPOINT, the same as in SaaS above
          On-premise
               This might be found by looking in client 0 -> UC_SYSTEM_SETTINGS as above, or might be in the Administration Perspective -> Automation Engine Management looking at the REST process Host and port
3. Unzip the zip file and move the [agent_type]Agent_solution.jar file to a server that meets the following requirements:
          SaaS
              Has a white-listed IP
          All types
              Can reach the REST API endpoint
4. From the server where the *_solution.jar file now resides, run a curl command like:

For Windows:

curl --request POST --data-binary "@[agent_type]Agent_solution.jar" -v -u "0/{Client 0 username}/{Client 0 user department}" --header "Content-Type:application/octet-stream" --cacert "C:\{path to JCP cert}" https://{REST API URL}/ae/api/v1/0/system/ra-solutions/upload

For Linux:

curl --request POST --data-binary '@[agent_type]Agent_solution.jar' -v -u '0/{Client 0 username}/{Client 0 user department}' --header 'Content-Type:application/octet-stream' --cacert '/{path to JCP cert}' https://{REST API URL}/ae/api/v1/0/system/ra-solutions/upload

Please note that you will need to replace:

• • {Client 0 username}/{Client 0 user department} with the username and department used to log in to client 0 like: USERNAME/SAAS
  • {path to JCP cert} with the path to the certificate to connect to the REST JCP
  • {REST API URL} with the REST URL from step 2 above

This should load the solution into client 0 and allow for that type of agent to be created.  Keep in mind that users may have to log out and back in before they see the updated agent information and/or objects.

Success can be confirmed by logging into client 0 and looking for the plugin matching the agent type in UC_ECC_PLUGINS or looking in the TEMPLATES folder for templates that fit the agent.

Additional Information

IMPORTANT: Make sure to use https and the --cacert option to connect to the REST endpoint! Note that if you don't use TLS your user/password is only base64 encoded, which is readable by any attacker.