Skip to main content

Automation ManagementAutomation Management Guide

Create an Automation Management Service

To integrate your own custom service with Automation Management, you must first create a service.

1. Enter Information About the Service

  1. In the Services tab, click +Create Service.

  2. Under Service name, enter a unique name between one and 100 characters. You can use numbers, letters, and underscores only. You can't rename the service after it's created.

  3. (Optional) Under Service description, enter a description of the service.

  4. Under How would you like to create your service?, select how you're creating the service:

    • To import an existing API, select Import from File or URL, then upload a API specification file from your file system or enter a link to the API specification file. The file must be a JSON or YAML file and adhere to version 3.0 or above of the OpenAPI specification.

      To upload a API definition file from your file system, browse your file system or drag and drop the file from your file system. To browse your file system, click SELECT A FILE, then select the file from your file system. To drag and drop a specific file, drag the file onto the outlined box from your file system, then drop the file. When you upload the file, Automation Management automatically validates the the file to ensure it meets the requirements. If the file doesn't meet the requirements, you receive an error. To remove a file you uploaded, click the trash A red outline of a trash can..

      To enter a link to the API specification file, under URL, enter the link. To ensure the file meets the requirements, click Confirm and Validate. If the file doesn't meet the requirements, you receive an error.

    • To develop actions from scratch in Automation Management, select Create Manually.

  5. Click Import and Next. Your service is created and appears in the list of services. If you imported an existing API, the service actions are automatically created in Draft Only status.

2. (Optional) Define Parameters

Instead of hard coding values into your API specification file, you can declare common or reusable parameters and reference them across API operations, like creating an instance or action. The values for these parameters are often ones that change or vary across environments and therefore require your input for the service to run. Some parameters you may consider declaring here are ones you use for authentication, like API keys, tokens, usernames or passwords; or other API path or query parameters.

If a parameter value is hard coded into your API specification file, the hard-coded parameter value is what's used instead of the parameter you define here.

  1. Under Schema, in Field name, enter the parameter name, then click + Add field.

  2. Next to the parameter you added, define its properties in JSON. There are two ways to define the parameter properties: using the predefined settings or a JSON editor.

    • To define properties using the settings, ensure the JSON Editor is toggled off, then configure the settings.Automation Management Parameter Properties

    • To define properties using the source JSON, toggle the JSON Editor on, then define the parameter properties using the editor.

    • To remove a parameter, click A gray X centered inside a white circle..

      The delete button next to the parameter field highlighted in a red rectangle.

    As you define the parameter, the parameter updates how it's displayed so you can preview how the parameter looks in other API operations.

3. Save the Service

Click Save. Your service appears in the list of services. You can now create instances and actions for the service.