GPOADmin 5.18 - User Guide


Action	Runs when...
Approve	A change to a version controlled object is approved.
CancelScheduledApproval	A version controlled object’s scheduled deployment has been canceled.
CheckIn	A version controlled object is checked in.
CheckOut	A version controlled object is checked out.
Cloak	A version controlled object has been cloaked.
ComplianceAction	Either a “Rollback” or “IncoporateLive“ compliance action is performed.
Create	A version controlled object has been created.
Delete	A version controlled object has been deleted.
Deploy	A version controlled object has been deployed into the live environment.
DisableWorkflow	A version controlled object has been workflow disabled.
Edit	A version controlled object has been modified.
EnableWorkflow	A version controlled object has been workflow enabled.
Label	A label has been applied to one or more version controlled objects.
Lock	A version controlled object has been locked.
ModifySecurity	The security has been modified on a version controlled object.
Move	A version controlled object is moved.
Register	An object is registered with the version control system.
Reject	A change to a version controlled object is rejected.
Rename	A version controlled object is renamed.
RequestApproval	An approval for a version controlled object is requested.
Restore	A version controlled object has been restored.
SubmitScheduledApproval	A version controlled object has been scheduled for deployment.
Synchronization	A version controlled Group Policy Object has been synchronized with another Group Policy Object.
ToggleApprovalWorkflow	Toggles a version controlled object between workflow enabled and disabled.
Uncloak	A version controlled object has been uncloaked.
UndoCheckOut	A version controlled object’s checkout is undone.
Unlock	A version controlled object has been unlocked.
Unregister	A version controlled object is unregistered.
WithdrawApproval	An approval on a version controlled object is withdrawn.
WithdrawApprovalRequest	A request for approval has been withdrawn.

Working with custom workflow actions in the Version Control system

GPOADmin provides an easy to use editor to help you set up and configure your custom actions.

Each custom workflow action has two phases; pre-actions (processed prior to the version control action being run), and post-actions (processed after the version control action has run.

Whether or not an action is processed can be controlled by the use of conditions. This must be set through the editing the xml file directly. For details see, Conditions .

GPOADmin includes a sample custom workflow to get you started that shows how to incorporate the creation of Help desk ticket with each approval request generated from the Version Control system.

To access the sample custom workflow template

Right-click the forest, and select Properties.

Select Options | General | Enable the processing of custom workflow actions, and select Launch Editor.

In the editor, select File \ Open and select the CustomWorkflowActions.xml file located in the installation directory. (C:\Program Files\Quest\GPOADmin\Examples)

Select the Request approval | Pre-Action to view the sample.

To create a new custom workflow action

Right-click the forest, and select Properties.

Select Options | General | Enable the processing of custom workflow actions, and select Launch Editor.

Select the required action and click the Pre-Actions option.

Enter a name and comment for the action.

If desired, select the Stop on error option, and optionally add a custom error message. This will instruct the service to stop all processing for the current object when an error occurs.

Enter the location or browse to the required application to run.

Enter the required parameters in the Parameters window. To insert a tag, right-click in the Parameters window, select Insert Tag, and choose the required tag. For details on the available options, see Predefined Tags .

If required, select the Post-Actions tab and configure its options.

Click Add.

Once you have entered all the required pre and post actions, save your workflow.


	NOTE: Because custom workflow actions are performed in the background by the GPOADmin service, they will not be visible from the interface and depending on the number and complexity of scripts defined for a given action, there may be a delay as the custom actions are being processed by the server. When required, you can suspended custom workflow actions through the Server options.

When you are ready to deploy the workflow, select Enable the processing of custom workflow actions.

To edit a custom workflow action

Right-click the forest, and select Options.

Select Options | General | Enable the processing of custom workflow actions, and select Launch Editor.

Select the required action and pre or post action.

Edit the action as required. You can:

Change the name, comment, executable, and parameters.

Right-click and add or remove actions.

Right-click and adjust the order in which they are performed.

Copy and past actions.

When you have made all your changes, click Update.

To pause or stop the custom workflow action

Right-click the forest, and select Options.

Select Options | General | Enable the processing of custom workflow actions, and select Launch Editor.

Click to disable the custom workflow actions option.

Working with the custom workflow actions xml file

Custom workflow actions are defined in an XML file (CustomWorkflowActions.xml) which must be located in the same directory as the GPOADmin Service executable.

•

Actions

•

Predefined Tags

•

Conditions

•

Example of a complete pre-action

Actions

For a list of available actions, see What is a custom workflow action? . Custom workflow actions are defined in the CustomWorkflowActions.xml file as follows:

<?xml version="1.0" encoding="utf-8"?>

</CheckIn>
</CustomWorkflowActions>


	NOTE: Actions names are case sensitive.

PreActions and PostActions

The PreActions and PostActions are defined as follows:

<?xml version="1.0" encoding="utf-8"?>

</CheckIn>

</CustomWorkflowActions>

Each phase may contain one or more actions with the following properties:

Table 23. Properties
Property	Description
Name	Identifies the action.
Comment	Describes the action.
StopOnErrors	Instructs the service to stop all processing for the current object when an error occurs.

The properties are defined as follows:

<?xml version="1.0" encoding="utf-8"?>

</CustomWorkflowActions>

Each action also contains the following nodes:

Table 24. Nodes
Action	Description
Executable	The full path to the executable.
Parameters	The list of parameters to pass to the executable.
Conditions	A list of conditions which determine whether or not to process the action.