vCommander™ 5.5.1 includes a significant improvement to how services
are managed by introducing service catalog blueprints. In previous
releases, request forms were assigned to users, groups or organizations,
which meant that the information collected on the forms had to be
relevant to all services those users could request. With blueprints, you
can now customize the request form for each service component in the
This means that you can set different infrastructure and metadata
configurations, as well as values applicable for each. Configuring this
information in the service catalog reduces the amount of information the
requester must provide, enables the creation of different services
based on the same template, and provide information to be used further
in the provisioning process.
The legacy model for forms (that used in all versions up to
vCommander 5.5.1) is deprecated and will be removed in a future release.
Until the legacy model is fully removed, both models are available for
upgrading users, but new installs will only support the blueprint model.
This article discusses how to transition between legacy forms and the improved blueprint forms.
Let’s take for example this form from vCommander 5.2.7:
Note that it includes a custom attribute pick list for SQL Version. Not every deployment needs a database, but because some do, a control must be provided with a Not Required option. Upgrading to vCommander 5.5.1 or later enables a changeover to the blueprint model so that each service includes a form that is relevant only to itself, so irrelevant choices are not imposed upon users.
Follow this process to change from legacy to blueprint models:
- Upgrade to vCommander 5.5.1 or later. Refer to our best practices to ensure a smooth upgrade.
- Once you have upgraded, login as an administrator and browse to Configuration > Service Request Configuration and switch to the Service Catalog tab.
- On an existing service, click Edit. Click Next.
- On the Components page, switch the forms from Legacy to Blueprint. Click Next.
- On the Resources tab, confirm no changes are required to the current configuration. Click Next.
- On the Resources tab, set the CPU, memory, disk and network configuration for the service. Click Next.
- On the Attributes tab, click Add Attributes and select the default value for each, where applicable. Click Next.
- On the Form tab, add the form controls relevant to
the component itself. Referring to our example above, this means that
you’d add the SQL Version custom attribute for applicable components.
- Repeat this process for each service in your catalog.
- Once you have set all services to use a blueprint you define, browse to Configuration > System Configuration and switch to the Advanced tab.
- Filter the list by the string legacy and then double-click the row embotics.allow.legacy.component.forms.
- Switch the value to false and click Save.
- Confirm that component forms no longer appear under Configuration > Service Request Configuration > Form Designer.
Important: Once you have completed this procedure, if you still see component forms it means that at least one service is still using legacy forms. If you are having difficulty locating the service, please contact Embotics Technical Support for assistance.