 |
A lifecycle phase is a means to select transaction documents (the other means is through document autoselection). Lifecycle phases are intended to restrict document selection to only those documents that are applicable for the current phase (for example, an application or closing phase). Phases are grouped by Line of Business (LOB) and each line of business can have a unique set of lifecycle phases. This creates a LOB and phase combination that is useful in selecting documents in a request.
Like packages, LOBs and lifecycle phases are defined as XML documents and are referenced by name. The Line of Business Lifecycle Phase ultimately maps to a package, which contains the autoselection logic. Since a Line of Business Lifecycle Phase maps to a package, most ExpereAPI operations allow the package and Line of Business Lifecycle Phase to be used interchangeably.
The SelectAndGenerate and Select operations can be submitted with either a PackageID or LOBPhase object (you cannot submit both parameters on a single request) as a means to identify and generate documents based on the transaction data with document selection defined by the Line of Business Lifecyle Phase combination.
The ListLinesOfBusiness operation can be used to return a list of all lines of business associated to a given organization. The request takes an organization object and returns an array of objects for each identified LOB in the response. The ListPhase operation can be used to return a list of all phases associated to a given organization and LOB. The request takes an ID for a line of business and an organization object and returns an object containing information about the associated phase. The ListDocuments operation is similar to Select in that it can be used to return a list of documents based on document selection defined by the Line of Business Lifecyle Phase combination achieved by submitting either a PackageID or LOBPhase object on the request.
|
