Service Catalog

On this page:

User Guide

Service Catalog

Service Catalog and Service Catalog Builder are separate applications on the Itential Automation Platform (IAP) welcome page, but they work together. Service Catalog uses forms, NSO service models, and workflows to provision services in IAP. It allows you to pass form data into a workflow that is used for service instantiation. Service Catalog Builder is used to define the services that can be provisioned in a workflow. Authorization to provision services through Service Catalog is based on job groups and designated group memberships.

Figure 1: Service Catalog & Service Catalog Builder

IAP Welcome Page

When you access Service Catalog for the first time, an empty table list (shown below) may be presented. This indicates there are no existing services in which to start a job. To create a new service, follow the steps outlined in the next section.

Figure 2: Service Catalog UI

Service Catalog List

Create a New Service

To create a new service:

  1. Click the menu icon in the top toolbar and select Service Catalog Builder from the dropdown.

    Figure 3: Service Catalog Builder


  2. Click the Add Service button (upper-right). A service form displays.

    Figure 4: Add New Service


  3. Enter the required information for the service. All fields are mandatory. Use the reference table below.

    Figure 5: Create New Service


    Field Label Description
    Display Name The name that displays in the Service Catalog application list.
    Service Choose which service you want to create an instance on; a list of all service models can be found in the Service Manager application.
    Description Input a brief description of the service to display in the Service Catalog application list.
    Variable Name Input the name to be used in the workflow as the variable.
    Groups Used to indicate who has access to create and run an instance, and who can view the results; also indicates who can work the instance once it has run.
    Inherit Job Groups from Groups This checkbox option allows the user to set the Job Groups field for Service Catalog to be the same as what is set in the Groups field. By default, it is checked. You can uncheck the checkbox and select a customize list of groups for run permissions.
    Job Groups Used to designate which job groups can create a service instance and then initiate a workflow.
    Form Select a form from the dropdown list to pass through your workflow.
    Workflow Select a workflow to run from the dropdown list.

  4. Once all information has been entered, click Save. A confirmation banner will pop-up and display a success message, and Service Catalog Builder then displays the new service in a list.

    Figure 6: New Service Added


Delete a Service

From Service Catalog Builder, you can select the checkbox next to a service and click the delete icon (lower-right) to remove the service from Service Catalog.

Figure 7: Delete Service

Delete Service

Update an Existing Service

From Service Catalog Builder, you can make changes to an existing service or update job groups.

  1. Click the pencil icon under the Actions column. The service form displays.

    Figure 8: Edit Service


  2. Make all desired changes and click Update to save.

    Figure 9: Update Service


    When updating, you can use the Inherit Jobs Groups from Groups checkbox to specify the same set of users, or you can uncheck the checkbox and select a customized list of job groups with permissions to run a service instance and view the results.

  3. A confirmation banner will pop-up and display a message to verify the updates were successfully made.

    Figure 10: Update Confirmed

    Update Confirmed

  4. Click the exit button servicecatalog to close the updated service form.

Start a Job

Once the service is defined in Service Catalog Builder, you can input a job name and run the workflow.

  1. Click the menu icon (top toolbar) and select Service Catalog. The service list will display.

    Figure 11: Service Catalog

    Service Catalog

  2. Click the view icon in the Actions column for the desired service. A job form displays.

    Figure 12: View Service


  3. Input the job name and device. Click Submit.

    Figure 13: Run Service


  4. A confirmation dialog opens asking if you want to start the job. Click OK.

    Figure 14: Confirm Job Start


  5. The job results will display in Job Manager.

    Figure 15: Job Manager