The operation configuration file is required for menu operation workflows. It specifies the aspects of the custom menu option in the vRealize Automation console such as the display text, which roles have access to the option, and the machine states for which the option is available.

About this task

Procedure

  1. Create a new XML file.
    <?xml version="1.0" encoding="utf-8"?>
  2. Create the root element customOperations.
    <customOperations xmlns="http://www.dynamicops.com/schemas/2009/OperationConfig/">
    </customOperations>

    The element must specify the XML namespace http://www.dynamicops.com/schemas/2009/OperationConfig/.

  3. For each operation you want to define, add an operation element within customOperations.
    <operation name="WFMachineMenu1" displayName="Execute Machine Menu task">
    </operation>

    The operation element takes the following attributes:

    Attribute

    Description

    name

    The name of the workflow that this operation executes.

    displayName

    A descriptive label for the option in the machine menu.

  4. Specify the roles to grant access to the menu operation.
    1. Add the authorizedTasks element.
      <operation name="WFMachineMenu1" displayName="Execute Machine Menu task">
        <authorizedTasks>
        </authorizedTasks>
      </operation>
    2. For each role that you want to grant access to the operation, add a task element, for example:
      <authorizedTasks>
        <task>VRM User Custom Event</task>
        <task>VRM Support Custom Event</task>  
        <task>Group Administrator Custom Event</task>
        <task>Enterprise Administrator Custom Event</task>
        <task>VRM Administrator Custom Event</task>
      </authorizedTasks>

      The valid contents of the task element are as follows:

      Element content

      Description

      VRM User Custom Event

      Grants access to the operation for all users.

      VRM Support Custom Event

      Grants access to the operation for support users.

      Group Administrator Custom Event

      Grants access to the operation for business group managers.

      Enterprise Administrator Custom Event

      Grants access to the operation for fabric administrators.

      VRM Administrator Custom Event

      Grants access to the operation for IaaS administrators only.

  5. (Optional) : Specify the machine states for which the operation is available.
    1. Add the machineStates element.
      <operation name="WFMachineMenu1" displayName="Execute Machine Menu task">
        <machineStates>
        </machineStates>
      </operation>
    2. For each state in which the operation should be available, add a state element.
      <machineStates>
        <state>On</state>
        <state>Off</state>
      </machineStates>

      The value may be any of the possible machine states. For a full list of machine states, see IaaS Configuration for Virtual Platforms, IaaS Configuration for Physical Machines, or IaaS Configuration for Cloud Platforms.

    If the element is omitted, the operation is available for all machine states.

Example

The following is an example of a complete operation configuration file:

<?xml version="1.0" encoding="utf-8" ?>
<customOperations xmlns="http://www.dynamicops.com/schemas/2009/OperationConfig/">
  <operation name="WFMachineMenu1" displayName="Execute Machine Menu task">
    <authorizedTasks>
      <task>VRM User Custom Event</task>
      <task>VRM Support Custom Event</task>
      <task>Group Administrator Custom Event</task>
      <task>Enterprise Administrator Custom Event</task>
      <task>VRM Administrator Custom Event</task>
    </authorizedTasks>
    <machineStates>
      <state>On</state>
      <state>Off</state>
    </machineStates>
  </operation>
</customOperations>