Table Description
Agreement Role : The role a client plays on an agreement. This entity links a case participant role to an agreement.

A client can play multiple roles on an agreement i.e client governed by the agreement and a signatory.

Example

James Smith's strengths and needs were assessed and an outcome plan was created to address these needs. Multiple activities were added to the outcome plan. An agreement is created which ensures that James agrees to participate in all of the activities outlined in the outcome plan. The agreement is completed and issued to James for signing. This entity links James Smith to the agreement.

Technical Notes

Optimistic locking is not required for this entity as the only modify operation allowed is cancel, which has it's own validations. The field dateSigned should only be populated when the agreement role represents a signatory.

Relationship Diagram
Click the diagram to manipulate and zoom. Traverse the diagram using Click-and-Drag motions.
Model Details
Location in Model: Logical View::MetaModel::Curam::OutcomePlanning::OutcomePlan::Entity::Delivery::Agreement::AgreementRole
Controlling File: AssessmentPlanning\model\Packages\OutcomePlanning\Entity\Delivery\Agreement.efx
Table Options
ALLOW_OPTIMISTIC_LOCKINGyes
Attributes (6)
AttributeStereotypeNullableDescriptionDomain DefinitionCodetableDDL Type
agreementRoleIDkeynoUnique identifier of the agreement roleINTERNAL_ID SVR_INT64
caseParticipantRoleIDdetailsnoUnique identifier for the case participant role.CASE_PARTICIPANT_ROLE_ID SVR_INT64
agreementIDdetailsnoUnique identifier of the agreement the agreement role exists onCASE_ID SVR_INT64
recordStatusdetailsnoThe record status of the agreement roleRECORD_STATUS_CODERecordStatusSVR_STRING<10>
agreementRoleTypedetailsnoThe type of agreement role the case participant role is being stored as in relation to the agreement. For example, a client.AGREEMENT_ROLE_RELATED_TYPEAgreementRoleRelatedTypeSVR_STRING<10>
dateSigneddetailsyesThe date the signatory the agreement role represents signed the agreement. This field should only be populated when the agreement role represents a signatory.CURAM_DATE SVR_DATE
Foreign Keys (2)
ChildParent
AgreementRole.agreementIDAgreement.agreementID
AgreementRole.caseParticipantRoleIDCaseParticipantRole.caseParticipantRoleID
Indices (3)
Index NameAttributes
AgreementAgreementRoleIdxrecordStatus, agreementID
AgreementAgreementRoleTwoIdxrecordStatus, agreementID, agreementRoleType
IND__444614059caseParticipantRoleID
Operations (6)
OperationStereotypeOptionsDescriptionSQL
insertinsertAUTO_ID: agreementRoleID
Standard Operation 
modifymodifyOPTIMISTIC_LOCKING: yes
Standard Operation 
readread Standard Operation 
searchByAgreementAndRecordStatusreadmulti Returns a list of all agreement roles for the given agreement and status 
searchByAgreementTypeAndRecordStatusreadmulti Returns a list of all agreement roles for the given agreement, agreement role type, and status 
readByAgreementIDCaseParticipantRoleIDRoleTypeAndStatusnsread Reads an agreement role record based on the given agreement identifier, case participant roleidentifier, role type and record status. 
Related Pages (18)