Change Order Events

AddChangeOrder

EventNames:

AddChangeOrder_Restrictions
AddChangeOrder_Pre
AddChangeOrder_Post

Parameters

Type	Name	Description
ChangeOrder	changeOrder	The changeOrder which should get / is added. Restrictions and Pre: In Restrictions and Pre you have the all the properties available on the object like `_NewNumber`, `_NewTitle(Item,CO)`, `_NewDescription(Item,CO)`, `_NewApproveDeadline` and `NewRouting`. Post: In POST you have the full powerVaultChangeOrder object, because at this point the Change Order exists.
File[]	files	The Files to be tracked by the Change Order.
Item[]	items	The Items to be tracked by the Change Order. User Defined Link properties are added and removed directly on the items.
File[]	attachments	Files to be attached to the Change Order.
Comment[]	comments	Multiple comments for the ChangeOrder including there attached files.
Email[]	emails	Multiple emails to send out upon completion.
bool	successful	Post: The information whether the Web Service call was successful or not is only available in Post events.

Unexpected Behaviour

AddChangeOrder event is raised when clicking in Vault Client on New Change Order… -> Save.
Afterwards it fires EditChangeOrder.
No CommitChangeOrder is called.

The argument files contains only the files that are directly linked to the ChangeOrder, and not the primary-links of the linked Items!

The argument comments contains the newly added comments.
A negative Id value is returned in Pre events and even the values for all other properties except Subject (CO), Message and Attachments can only be retrieved in in Post events.

Examples:
AddChangeOrder_Restrictions:

Register-VaultEvent -EventName AddChangeOrder_Restrictions -Action 'RestrictAddChangeOrder'

function RestrictAddChangeOrder($changeOrder, $files, $items, $attachments, $comments, $emails) {
	#Write event code here
}

AddChangeOrder_Pre:

Register-VaultEvent -EventName AddChangeOrder_Pre -Action 'PreAddChangeOrder'

function PreAddChangeOrder($changeOrder, $files, $items, $attachments, $comments, $emails) {
	#Write event code here
}

AddChangeOrder_Post:

Register-VaultEvent -EventName AddChangeOrder_Post -Action 'PostAddChangeOrder'

function PostAddChangeOrder($changeOrder, $files, $items, $attachments, $comments, $emails, $successful) {
	#Write event code here
}

EditChangeOrder

EventNames:

EditChangeOrder_Restrictions
EditChangeOrder_Pre
EditChangeOrder_Post

Parameters

Type	Name	Description
ChangeOrder	changeOrder	The Change Order which should get / is in edit mode.
bool	successful	Post: The information whether the Web Service call was successful or not is only available in Post events.

Unexpected Behaviour

EditChangeOrder event is raised when selecting a Change Order within the Vault Client and cliching on Edit.

Examples:
EditChangeOrder_Restrictions:

Register-VaultEvent -EventName EditChangeOrder_Restrictions -Action 'RestrictEditChangeOrder'

function RestrictEditChangeOrder($changeOrder) {
	#Write event code here
}

EditChangeOrder_Pre:

Register-VaultEvent -EventName EditChangeOrder_Pre -Action 'PreEditChangeOrder'

function PreEditChangeOrder($changeOrder) {
	#Write event code here
}

EditChangeOrder_Post:

Register-VaultEvent -EventName EditChangeOrder_Post -Action 'PostEditChangeOrder'

function PostEditChangeOrder($changeOrder, $successful) {
	#Write event code here
}

CommitChangeOrder

EventNames:

CommitChangeOrder_Restrictions
CommitChangeOrder_Pre
CommitChangeOrder_Post

Parameters

Type	Name	Description
ChangeOrder	changeOrder	The changeOrder which should get / is commited. Restrictions and Pre: In Restrictions and Pre you have the future data set on this object like `_NewNumber`, `_NewTitle(Item,CO)`, `_NewDescription(Item,CO)`, `_NewApproveDeadline` and `NewRouting`. Post: In POST you have the previous properties available through `_OldNumber`, `_OldTitle(Item,CO)`, `_OldDescription(Item,CO)`, `_OldApproveDeadline` and `OldRouting`.
File[]	files	The Files to be tracked by the Change Order.
Item[]	items	The Items to be tracked by the Change Order. User Defined Link properties are added and removed directly on the items.
File[]	attachments	Files to be attached to the Change Order.
Comment[]	comments	Multiple comments for the ChangeOrder including there attached files.
User[]	routingUsers	All the users with the associated routing roles for this Change Order.
Email[]	emails	Multiple emails to send out upon completion.
bool	successful	Post: The information whether the Web Service call was successful or not is only available in Post events.

Unexpected Behaviour

CommitChangeOrder event is raised when clicking in the Change Order dialog on Save. Afterwards it fires EditChangeOrder.

The argument files contains only the files that are directly linked to the ChangeOrder, and not the primary-links of the linked Items!

The argument emails only contains the emails of the current commit, and not the once added before!

The argument comments contains the current comments and the newly added comments.
A negative Id value is returned in Pre events and even the values for all other properties except Subject (CO), Message and Attachments can only be retrieved in in Post events.

Examples:
CommitChangeOrder_Restrictions:

Register-VaultEvent -EventName CommitChangeOrder_Restrictions -Action 'RestrictCommitChangeOrder'

function RestrictCommitChangeOrder($changeOrder, $files, $items, $attachments, $comments, $routingUsers, $emails) {
	#Write event code here
}

CommitChangeOrder_Pre:

Register-VaultEvent -EventName CommitChangeOrder_Pre -Action 'PreCommitChangeOrder'

function PreCommitChangeOrder($changeOrder, $files, $items, $attachments, $comments, $routingUsers, $emails) {
	#Write event code here
}

CommitChangeOrder_Post:

Register-VaultEvent -EventName CommitChangeOrder_Post -Action 'PostCommitChangeOrder'

function PostCommitChangeOrder($changeOrder, $files, $items, $attachments, $comments, $routingUsers, $emails, $successful) {
	#Write event code here
}

DeleteChangeOrders

EventNames:

DeleteChangeOrders_Restrictions
DeleteChangeOrders_Pre
DeleteChangeOrders_Post

Parameters

Type	Name	Description
ChangeOrder[]	changeOrders (deletedChangeOrders in POST)	The changeOrders which should get / are deleted.
bool	successful	Post: The information whether the Web Service call was successful or not is only available in Post events.

Examples:
DeleteChangeOrders_Restrictions:

Register-VaultEvent -EventName DeleteChangeOrders_Restrictions -Action 'RestrictDeleteChangeOrders'

function RestrictDeleteChangeOrders($changeOrders) {
	#Write event code here
}

DeleteChangeOrders_Pre:

Register-VaultEvent -EventName DeleteChangeOrders_Pre -Action 'PreDeleteChangeOrders'

function PreDeleteChangeOrders($changeOrders) {
	#Write event code here
}

DeleteChangeOrders_Post:

Register-VaultEvent -EventName DeleteChangeOrders_Post -Action 'PostDeleteChangeOrders'

function PostDeleteChangeOrders($deletedChangeOrders, $successful) {
	#Write event code here
}

UpdateChangeOrderState

EventNames:

UpdateChangeOrderState_Restrictions
UpdateChangeOrderState_Pre
UpdateChangeOrderState_Post

Parameters

Type	Name	Description
ChangeOrder	changeOrder	The Change Order in Vault for which the lifefycle status changes/was changed.Restrictions and Pre: In these events you can get the future state changes through the special property `_NewStateEntered`. Post: In this event you can retrieve the information from previous events by using the properties `_OldState` and `_OldStateEntered`.
string	activity	The activity being completed.
Comment[]	comments	Multiple comments for the ChangeOrder including there attached files.
Email[]	emails	Multiple emails to send out upon completion.
bool	successful	Post: The information whether the Web Service call was successful or not is only available in the _Post event.

Unexpected Behaviour

UpdateChangeOrderState event is raised when clicking on Submit/Approve, in general when the State/Activity is changed.

When fired by Vault Client then the property _NewStateEntered from the argument changeOrder is the StateEntered of the current ChangeOrder!

Each comment in the argument comments provide negative Ids and only Subject (CO), Message and Attachments values can be retrieved. All other data is unavailable, even in Post events.

Examples:
UpdateChangeOrderState_Restrictions:

Register-VaultEvent -EventName UpdateChangeOrderState_Restrictions -Action 'RestrictUpdateChangeOrderState'

function RestrictUpdateChangeOrderState($changeOrder, $activity, $comments, $emails) {
	#Write event code here
}

UpdateChangeOrderState_Pre:

Register-VaultEvent -EventName UpdateChangeOrderState_Pre -Action 'PreUpdateChangeOrderState'

function PreUpdateChangeOrderState($changeOrder, $activity, $comments, $emails) {
	#Write event code here
}

UpdateChangeOrderState_Post:

Register-VaultEvent -EventName UpdateChangeOrderState_Post -Action 'PostUpdateChangeOrderState'

function PostUpdateChangeOrderState($changeOrder, $activity, $comments, $emails, $successful) {
	#Write event code here
}