Adding Custom Components to the Catalog

Access through:

Configuration menu > Self-Service > Catalog tab

Available to:

Commander Role of Superuser, Enterprise Admin

Custom components include both non-virtual assets (such as a phone) and tasks that modify existing assets (such as the installation of a database instance on an existing server). Creating custom component types allows you to add the same custom component to multiple Service Catalog entries, as well as centrally manage the cost of these components.

To add a custom component type to a service:

  1. Do one of the following:
    • to add a new service, click Add Service.
    • to copy an existing service, click the Copy link on a listed service.

      This option reduces some configuration time because much of the configuration is copied.

    • to add a component to an existing service, click the Edit link on a listed service.
  2. On the Service Description page, set the following display options for the service, then click Next:
    • Name — The service name to display in the service catalog.

      This name is used as the label for the service portion of the Request New Service form. Choose a distinctive service name to help requesters fill out the form.

    • Description — An optional description of the service to display in the Service Catalog.

      Along with the service name, the service description is used in Service Catalog searches, so a good description can help users find service catalog entries.

    • Icon — An icon to identify the service.

      To add a custom icon, click Manage Icons. See Managing icons for the service catalog for more details.

    • Categories — An identifying category to help users find this service in a long list.

      To add a category, click Manage Categories. See Managing categories for the service catalog for more details.

    • If the service-level form elements such as Quantity and Expiry Date don't make sense for this service, you can hide the service portion of the service request form by clearing the Display service form when this service is requested checkbox.
  3. Do one of the following:
    • To add a new custom component type to the service, click Add > New Component Type. In the Create New Component Type dialog, provide a name, a description and the annual cost, then click Add to Service.
    • To add an existing custom component type to the service, click Add and select the component type from the drop-down menu.

      If more than five custom component types already exist, you must select Custom Type from the drop-down menu, and in the Select Custom Component Type dialog, select a component from the list.

    • The added components are listed under the Component Blueprints.

  4. Repeat the step above for each additional component you want to add.
  5. For each custom component, a blueprint page is added, displaying the following tabs.

    When you have completed configuring the added components, click Next to continue editing the service catalog entry.

  6. On the Deployment page, specify deployment options for the entire service, then click Next.

    If your service only includes one or more custom components, many of these options won't be present.

    • Deploy Service As — Choose one of the following options:
      • Virtual Service — The service will be deployed as a vApp; you can manage the service as a whole after the service request has been completed, but Service Portal users will still be able to see and manage individual VMs within the vApp.
      • Individual Components — The service will be deployed as individual VMs.

        When creating a service that contains a single virtual service component, choose Individual Components. Otherwise, the service will be deployed as a virtual service within a virtual service.

    • Deployed Name — If you deploy the service as a virtual service, you can specify a customized name for deployed instances of the service. Select Use default naming format to use the default virtual service naming convention, or specify a customized deployed name.

      Click Configure global text replacement rules to shorten your service names. See also Setting up text replacement rules for service names.

    • Deployment/Startup Order or Deployment Order — Applies only to VM and virtual service components. Some components in a multi-tier service may require other components to be started and running before they can start.
      • If you deploy the service as a virtual service, you specify both the order in which the components are deployed and the order in which the components are started.
      • If you deploy the service as individual components, you specify the order in which the components are deployed. The reverse order is used for shutdown.

      There is a 120 second delay between startup and shutdown of each component. There is no delay for deployment, but components are deployed serially, not in parallel.

      An administrator can override the deployment order by manually deploying components in a different order. It is also possible for Commander and Service Portal users with permissions can edit the start order for a deployed vApp.

    • Completion Workflow — If you have set up one or more service-level completion workflows, you can select one from the drop-down. Completion workflows allow you to specify actions to be carried out after deployment.
      • Click Add Workflow to create a new workflow.
      • Click Edit Workflow to edit the workflow that is currently selected in the drop-down list. Note that when you edit the workflow using this link, you're editing the workflow for all of the components or services it's assigned to.
    • Start Deployed Components — By default, VMs are powered on during deployment. If you want to deploy VMs in this service in a powered-off state, clear this option.

      When this option isn't enabled and a customization spec is assigned to a component in the service, if the VM is migrated to a different datastore before its first power on, the customization spec won't run.

  7. On the Placement page, you can configure placement attributes to define the Intelligent Placement requirements for the service.

    When you assign a placement attribute value to a published service, you're identifying the requirements of that published service to help ensure that services are deployed to the best destination. See Configuring Attributes for Intelligent Placement to learn more.

    To configure placement attributes:

    1. Click Edit Placement Attributes.
    2. In the Edit Placement Attributes dialog, in the Not Required pane, select an attribute value that's provided by this destination and click Add to move it to the Required pane.
    3. You can click Create Placement Attributes to create a new placement attribute. See Creating placement attributes for more information.

    4. Click OK to close the Edit Placement Attributes dialog.

      The placement attribute values you've assigned to this service are displayed on the Placement page.

    5. For a placement attribute with selectable values, use the Up and Down arrow buttons to order the attribute values by preference if necessary. For example, if a service can be deployed on either private or public cloud, but private cloud is preferable, make sure the Private Cloud attribute value is first in the list.
  8. On the Visibility page, select one of the following options to set which users and groups can request this service, then click Next:
    • Do not publish — The service is in the catalog but isn't available for selection (temporarily disabled). See also Permanently removing a service from the service catalog.
    • Publish - Global — The service is available to all organizations, users and groups.
    • Publish - Specific organizations, users and groups — The service is available to the specified organizations, users and groups. If you select this option, you can assign a single service to both organizations and users/groups.

      • On the Organizations tab, select an organization from the drop-down menu. On the Users/Groups tab, enter the login or email address for one or more users or groups.

        When an organization member requests this service, the deployed service will automatically be assigned to the organization, with the requester as primary owner.

  9. On the Summary page, review the service's configuration details.

    If necessary, go back to the appropriate pages and make changes.

  10. Click Finish when you're done.

    Notes:

    • You can edit a listed service at any time — select it in the list and click Edit.
    • After a service is added to the Service Catalog, you can click Show Details to quickly view information about it.