getImagesByContract
- Description
- The purpose of this transaction is to provide the user with a view of specific data changes that have been made to a given contract over a specified period of time.
- Web Services
- Operation name: getImagesByContract
- Service name: ProductServices
- Example
- View all changes made to the contract component and contract relationship for a specific contract during the period September 1 2010 to December 31 2010.
- Usage information
- Users must specify a ViewImageInstance, which
is a list of business objects that the user wants to see changes for,
and the date range for those changes.
- inquireFromDate and inquireToDate are used to specify a date range; only images of contract details as they existed between those two dates are returned. For example, if the ContractComponent "PremiumAmount" was changed and processed on October 10 and the ContractRelationship description was changed and processed on October 20, performing a query using inquireFromDate = September 1 and inquireToDate = December 31, three images are retrieved: image1 of before the "PremiumAmount" change; image2 of after the "PremiumAmount" change but before the ContractRelationship description change; and image3 of after both the "PremiumAmount" and ContractRelationship change. Only InquireFromDate is mandatory input for this use. If InquireToDate is not provided, this date is defaulted to the end-of-day for InquireToDate. When providing InquireFromDate with or without InquireToDate, the InquireAsOfDate cannot be provided.
- TransactionLogInd indicator is a 'Y' or 'N' indicator used to specify whether transaction log details should be returned in the response transaction or not. If the indicator is set to 'Y', transaction audit information log objects are returned.
- ImageInstanceType or ImageInstanceValue identify the ViewImageInstance.
In order to run a getImagesByContract transaction, an ImageInstance
must have already been defined. Any number of ViewImageInstances can
be created, each with a unique type and value. Each ViewImageInstance
defines whether contract data has been changed over a specified period
of time.
For example, if imageInstanceType = 1 contains the set of objects = (ContractComponent, ContractPartyRole, ContractRelationship), then a getImagesByContract transaction will return one contract image each time any data associated with one of these three objects changes; however, a contract image will not be returned when any other object changes.
- ContractIdPK is the ContractIdPK of the Contract being queried
- Preconditions
- The getImagesByContract function requires the presence of historical
records in the history database in order to retrieve contract images.
If database triggers are altered, the getImagesByContract function
is affected.
ViewImageInstance must exist.
- Mandatory input
- InquireFromDate
- ImageInstanceType, ImageInstanceValue, or both
- InquiryRequestType, such as ContractId
- InquiryRequestValue, such as ContractIdPK
- ContractInquiryLevel
- Inquiry levels
- ContractInquiryLevel:
- Level 0 - returns basic contract information, contract admin native keys, and contract alerts.
- Level 1 - returns level 0 data plus all contract spec values, contract components, contract component values, holdings, and party roles.
- Level 2 - returns level 1 data plus all contract party
role alerts, contract party role locations, contract party role situations,
contract party role identifiers, and contract party role relationships.Note: Party information within the PartyRole object is based on the PartyInquiryLevel.
- Level 3 - returns level 2 data plus all contract relationships.
- Level 4 - returns level 3 data plus all product relationships and term conditions associated with the account.
Note: User-customizable inquiry levels are available for this transaction - Filter values
- Not applicable
- Transaction behavior
- Using the date range, the history tables associated with the objects
specified in the ViewImageInstance are queried to determine what changes
occurred during the time specified.
A point in time contract image, using a getContract transaction, is returned for each business object changed. Images are in a transactional context so if three of the specified business objects were changed in one transaction, only one contract image is returned.
The requested ContractInquiryLevel must include the business object defined in the requested ViewImageInstance. - Request message
- <TCRMTxType> getImagesByContract
<TCRMTxObject> TCRMImageRequestBObj
<TCRMObject> TCRMImageRequestBObj
<TransactionLogInd> "Y" or "N"
<ImageInstanceType> <user-defined>
<ImageInstanceValue> <user-defined>
<TCRMObject> TCRMImageRequestParamBObj
<InquiryRequestType> "ContractId"
<InquiryRequestValue> <contractIdPK>
<InquiryLevel> 0 - 3
- Allowable Business Objects
- The following business object drivers are allowed:
- ContractAlert
- ContractComponent
- ContractPartyRole
- ContractRelationship
- ContractRoleIdentifier
- ContractRoleLocation
- ContractRoleSituation
- Response objects
- TCRMImageListBObj
- Special note
- Not applicable