ReviewContextTO

A complex data type that represents the unique identifier and other information for an instance of a review. Used with the Review, Commenting, and Approval building block, which is installed with the Managed Review & Approval Solution Accelerator.

For information about data that can be accessed using XPath Expressions, see Data items.

Data items

The data items that ReviewContextTO values contain.

additionalMetadata

A string value that represents additional information that initiators can provide when they create a review.

arsProcessName

A string value that represents the process that attaches an approval routing slip to the review document.

auditLevel

A string value that represents the audit level of the review. For workflows that involve regulatory compliance.

changeDescription

A string value that represents the revision status of the review. Used if a review has been revised.

commentServerPath

A string value that represents the server location where inline comments are stored.

commentVisibility

A string value that represents the type of comment visibility associated with the review.

complianceCode

A string value that represents the legislation that this review complies with.

currentRevision

A boolean value that indicates whether this instance is the current revision of the review. If true, the review is the current revision.

currentStage

An int value that represents the current stage number of the review (starts with 1).

customAttributes

A list of CustomAttributeTO values that represent a list of custom attributes associated with the review.

id

Internal use only.

initiator

An InitiatorTO value that represents the initiator of the review.

invocationId

A string value that represents the unique identifier of the invocation used to start the review process.

purpose

A string value that represents the purpose of the review.

reviewId

A string value that represents the unique identifier of the review.

reviewType

A string value that represents the type of review. Valid values are REGULATED or AD-HOC.

revision

An int value that represents the current revision of the review.

rtsProcessName

A string value that represents the process that generates a review tracking sheet for the review.

stageList

A list of ReviewStageTO values that represent the stage values for the review.

status

A string value that represents the status of the review. The following values are valid:

  • ONGOING

  • COMPLETED

  • EXPIRED

  • REVOKED

  • REVISED

stp

A boolean value that indicates whether straight-through processing (STP) is enabled. If true, STP is enabled.

supportingDocumentList

A list of DocumentTOvalues that represent the supporting documents associated with the review.

templateAuthor

A string value that represents the author of the template for the review.

templateDescription

A string value that represents a description of the template for the review.

templateName

A string value that represents the name of the template for the review.

title

A string value that represents the title of the review.