Chat now with support
Chat with Support

GPOADmin 5.15 - User Guide

Introducing Quest GPOADmin Configuring GPOADmin Using GPOADmin
Connecting to the Version Control system Navigating the GPOADmin console Search folders Accessing the GPMC extension Configuring user preferences Working with the live environment Working with controlled objects (version control root) Checking compliance Editing objects Synchronizing GPOs Exporting and importing
Creating Reports Working with the GPOADmin Dashboard Appendix: Windows PowerShell Commands Appendix: GPOADmin Event Log Appendix: GPOADmin Backup and Recovery Procedures Appendix: Customizing your workflow Appendix: GPOADmin Silent Installation Commands Appendix: Configuring Gmail for Notifications Appendix: Registering GPOADmin for Office 365 Exchange Online Appendix: GPOADmin with SQL Replication About Us

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.

2
Select Options | General | Enable the processing of custom workflow actions, and select Launch Editor.
4
Select the Request approval | Pre-Action to view the sample.
2
Select Options | General | Enable the processing of custom workflow actions, and select Launch Editor.
5
If desired, select the Stop on error option. This will instruct the service to stop all processing for the current object when an error occurs.
7
8
If required, select the Post-Actions tab and configure its options.
9
Click Add.
11
When you are ready to deploy the workflow, select Enable the processing of custom workflow actions.
2
Select Options | General | Enable the processing of custom workflow actions, and select Launch Editor.
2
Select Options | General | Enable the processing of custom workflow actions, and select Launch Editor.

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

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:

The PreActions and PostActions are defined as follows:

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

Table 22. Properties

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:

Each action also contains the following nodes:

Table 23. Nodes

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.

The nodes are defined as follows:

Predefined Tags

Tags are typically replaced with their corresponding values by the service. However, there are cases where the tags will not be converted. For example, if a comment is not specified during the version control action then the [COMMENT] tag will be empty; or if the object is not checked out then the [TRUSTEENAME] and [TRUSTEESID] will be empty.

Keep in mind that in some cases the tags will always be empty as is the case of a pre-action for the Register version control action. At the time the pre-action is processed, the corresponding version control information would not exist.

Parameters and conditions support the following predefined tags:

Table 24. Available tags

[ACTION]

The currently executing version control action.

[VCID]

The version control identifier of the current object.

[DOMAINNAME]

The name of the domain for the current object.

[FULLPATH]

The full path of the current object in the version control system.

[ID]

The identifier for the current object.

[LASTBACKUPID]

The identifier of the last backup for the current object.

[NAME]

The name of the current object.

[STATUS]

The version control status for the current object. See Status values for more information.

[SUBSTATUS]

The version control sub status for the current object.See Sub status values for more information.

[TRUSTEENAME]

The name of the user the current object is checked out to.

[TRUSTEESID]

The SID of the user the current object is checked out to.

[TYPE]

The version control type of the current object.

[VERSION]

The version of the current object.

[COMMENT]

The comment associated with the version control action.

The possible values of a registered object's sub status include the following:

None

Default.

Register

Registers objects with the version control system.

Unregister

Unregisters objects from the version control system.

CheckIn

Save edits made to an object in the version control system.

CheckOut

Prepares an object in the version control system for editing.

UndoCheckOut

Discards change made to an object in the version control system.

RollBack

Restores an object in the version control system to a previous known state.

Restore

Restores an object in the version control system to a previous known state.

Get

 

Overwrites the current settings of an object in the version control system with settings from a previous known sate.

Import

 

Overwrites the current settings of an object in the version control system with settings from a previous backup.

IncorporateLive

 

Overwrites the current settings of an object in the version control system with those from the live environment.

Create

Creates a new object in the version control system.

Branch

Branch on object.

Edit

Edits an object in the version control system.

Delete

Marks an object in the version control system as deleted.

Approve

Approves changes made to an object in the version control system.

Reject

Rejects changes made to an object in the version control system.

RequestApproval

Request approval for changes made to an object in the version control system.

ApplyPolicyTemplate

Applies a template to a policy in the version control system.

Label

Labels objects in the version control system.

Lock

Locks an object in the version control system.

Unlock

Unlocks an object in the version control system.

Cloak

Cloaks an object in the version control system.

Uncloak

Uncloaks an object in the version control system.

EnableWorkflow

Forces the object to follow version control workflow.

DisableWorkflow

Allows the object to not follow version control workflow.

Move

Moves an object from one container to another in the version control system.

WithdrawApproval

Withdraws approval of changes for an object in the version control system.

WithdrawApprovalRequest

Withdraws an approval request for changes to an object in the version control system.

Rename

Renames an object in the version control system.

SubmitScheduledApproval

Submits approval for scheduled deployment of an object in the version control system.

CancelScheduledApproval

Cancels a scheduled deployment of an object in the version control system.

Deploy

Deploys an object in the version control system to the live environment.

Link

Links a policy object to a scope of management in the version control system.

LinkUpdate

Updates the links on a scope of management.

ComplianceAction

An action which affects the compliance of an object in the version control system.

ModifySecurity

Modifies the security of an object in the version control system.

UnauthorizedModifications

A backup of a noncompliant object. This is intended to be done by the Watcher Service.

MigrationAction

Indicates an import from NetPro GPOADmin. This is intended to be done by the Migration Wizard.

Synchronization

Synchronizes a source object to one or more targets of the same type.

ToggleApprovalWorkflow

Toggles the order of approval workflow processing.

FailedDeployment

A deployment has failed.

The possible values of a version controlled object’s status include the following:

Table 26.  

Unregistered

The object is unregistered.

Available

The version controlled object is available.

CheckedOut

The version controlled object is checked out.

Pending

 

The version controlled object is in a pending state. Check the substatus for more information.

PendingDeployment

The version controlled object is pending deployment.

Deleted

The version controlled object is flagged as deleted.

Error

The version controlled object is in error.

ErrorNoWorkingCopy

The version controlled object does not have an associated working copy.

Cloaked

The version controlled object is cloaked

Locked

The version controlled object is locked.

Noncompliant

The version controlled object is noncompliant.

Noncompliant_Deleted

The version controlled object is noncompliant because it was deleted.

Noncompliant_Moved

The version controlled object is noncompliant because it was moved.

Moved

The version controlled object has been moved. This status only applies to OUs.

Unknown

The version controlled objects status is unknown.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating