vRealize Automation Advanced Designer Service API

XaaS (Advanced Service Designer) Service API Specification

What Is the XaaS REST API?

The advanced service designer (XaaS) REST API enables creation of custom services by exposing any vRealize Orchestrator (vRO) workflow to vRA's Service Catalog to provide custom functionality.

Typical Use Cases

You can use the XaaS REST API to:

  • Create XaaS Custom Resources, Blueprints, Resource Mappings and Actions.

  • Import and export XaaS components, such as custom resources, blueprints, and so on, from one vRealize Automation system to another.

Administrative users use the advanced designer service as follows:

  • Tenant administrators create and manage the workflow subscriptions that are specific to their tenant.

  • System administrators create and manage system workflow subscriptions.

The created system workflow subscriptions are active for events in any tenant and for system events.

Key Concepts

The XaaS domain model includes four basic objects - resource types, resource mappings, service blueprints and resource actions.

Resource Type

A resource type provides an abstraction of a resource from the physical and virtual IT world - a virtual machine, a user, an account, a network card, and so on.

To enable ASD to use resources, you must create a resource type object in XaaS.

Service Blueprint

A service blueprint is a blueprint for a service. It is based on a vRO workflow, but its request form (used to get input from users of the service) can be customized.

The key feature of service blueprints is that, when you request them, they produce (provision) resources of a spcified resource type.

Resource Mapping

A resource mapping is a workflow that maps one resource type to another resource type. It allows resource actions to be performed over types that can be mapped.

Resource Actions

Like service blueprints, resource actions are built around a vRO workflow. They have a resource as an input, and usually are used to change the state of a resource. They are also referred as "2nd day operations."

Import and Export of Content

XaaS is a provider of content, and if CMS is present, XaaS objects can be registered as content. After an ASD object is registered, it can be exported/imported centrally from CMS. Note that this is not to be confused with ASD internal content management -- this feature is deprecated.

For more detailed usage information on importing and exporting content, see the "Import and Export Content" use case in the "Use Cases" chapter of the vRA Programming Guide.

Workflow Subscriptions

Workflow subscriptions use the event broker service to monitor the registered services for event messages in vRealize Automation, and then run a specified vRealize Orchestrator workflow when the conditions in the subscription are met.

To configure the subscription, you specify the event topic, the triggering conditions, and the workflow that runs when triggered.

Tenant administrators can create and manage the workflow subscriptions that are specific to their tenant. The system administrator can create and manage system workflow subscriptions. The created system workflow subscriptions are active for events in any tenant and for system events.

 

Related Documentation

;