Table Description
Agreement : An agreement between the agency and the client to take part in the activities (services, referrals,actions outlined in the outcome plan agreement.

An outcome plan can be associated with multiple agreements. An agreement can include multiple clients, multiple signatories, and multiple activities.

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.

Technical Notes

An agreement can not be created for an outcome plan that is closed. The creation date and created by fields should be populated by the system using the current program user and current date on creation of a new agreement. The creation date and created by fields should be populated by the system using the current program user and current date on creation of a new agreement. An agreement can only be issued once it has been completed. An agreement can only be signed once it has been completed or issued. An agreement can only be reissued if it has been issued. When reissuing an agreement, a reason must be specified. If an activity exists on an agreement, the activity cannot be cancelled until the activity is removed from the agreement or the agreement is cancelled. It is not permitted to remove a client from an activity if the activity exists as part of an agreement. To achieve this one must either remove the client/activity from the agreement or cancel the agreement. A client cannot be removed where an activity exists for that client on the agreement and no other agreement clients exist on the activity. The user must first remove the activity before they can remove the client. It is possible to cancel an agreement at any stage during its lifecycle, and no constraints exist surrounding the cancellation of an agreement.

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::Agreement
Controlling File: AssessmentPlanning\model\Packages\OutcomePlanning\Entity\Delivery\Agreement.efx
Table Options
ALLOW_OPTIMISTIC_LOCKINGyes
Attributes (7)
AttributeStereotypeNullableDescriptionDomain DefinitionCodetableDDL Type
agreementIDkeynoUnique identifier of the agreementINTERNAL_ID SVR_INT64
caseIDdetailsnoUnique identifier of the OutcomePlan the agreement exists onCASE_ID SVR_INT64
creationDatedetailsnoThe date the agreement was createdCURAM_DATE SVR_DATE
createdBydetailsnoThe username of the user who created the agreementUSER_NAME SVR_STRING<64>
commentsdetailsyesComments added by a user to the agreementCOMMENTS SVR_STRING<300>
statusdetailsnoThe status of the agreementAGREEMENT_STATUSAgreementStatusSVR_STRING<10>
agreementCancellationIDdetailsyesUnique identifier of the OutcomePlan the agreement exists onINTERNAL_ID SVR_INT64
Foreign Keys (7)
ChildParent
Agreement.agreementCancellationIDAgreementCancellation.agreementCancellationID
Agreement.caseIDCaseHeader.caseID
Agreement.createdByUsers.userName
AgreementActivityLink.agreementIDAgreement.agreementID
AgreementIssueHistory.agreementIDAgreement.agreementID
AgreementRole.agreementIDAgreement.agreementID
AgreementStatusHistory.agreementIDAgreement.agreementID
Indices (3)
Index NameAttributes
AgreementCaseIdxcaseID
IND_2077227699agreementCancellationID
IND__2101805750createdBy
Operations (4)
OperationStereotypeOptionsDescriptionSQL
insertinsertAUTO_ID: agreementID
Standard Operation 
modifymodifyOPTIMISTIC_LOCKING: yes
Standard Operation 
searchByCasereadmultiORDER_BY: creationDate
Retrieves a list of all agreement records that are related to the given case identifier. The list is order by creation date. 
readread Standard Operation 
Related Pages (38)
New Agreement (AddAgreementWizard_activities)
ATOutcomePlan_listByOwner
Outcome Plans (Case_listOutcomePlans)
New Outcome Plan (IntegratedCase_createOutcomePlan)
Plans (IntegratedCase_listExistingOutcomePlan)
Participation (IntegratedCase_participationHours)
OutcomePlan_applicationSearch
Agreements (OutcomePlan_listAgreements)
My Outcome Plans (OutcomePlan_listByOwner)
Outcome Plans (OutcomePlan_listByParticipant)
Add Activities (OutcomePlanAgreement_addActivity)
Add Attachment (OutcomePlanAgreement_addAttachment)
Add Clients (OutcomePlanAgreement_addClient)
Edit Comments (OutcomePlanAgreement_addComment)
Add Signatories (OutcomePlanAgreement_addSignatory)
Approve Agreement (OutcomePlanAgreement_approve)
Cancel Agreement (OutcomePlanAgreement_cancel)
Complete Agreement (OutcomePlanAgreement_complete)
OutcomePlanAgreement_details
Issue Agreement (OutcomePlanAgreement_issueEmail)
Issue Agreement (OutcomePlanAgreement_issueEmailOrPost)
Issue Agreement (OutcomePlanAgreement_issuePost)
OutcomePlanAgreement_listIssueHistory
OutcomePlanAgreement_listSignatories
OutcomePlanAgreement_listStatusHistory
Issue Agreement (OutcomePlanAgreement_reissueEmail)
Issue Agreement (OutcomePlanAgreement_reissueEmailOrPost)
Issue Agreement (OutcomePlanAgreement_reissuePost)
Reject Agreement (OutcomePlanAgreement_reject)
Remove Activities (OutcomePlanAgreement_removeActivity)
Remove Clients (OutcomePlanAgreement_removeClient)
Remove Signatories (OutcomePlanAgreement_removeSignatory)
Specify Date Signed (OutcomePlanAgreement_specifyDateSigned)
Specify Date Signed (OutcomePlanAgreement_specifyDateSignedForIndividual)
OutcomesPlan_agreementDetails
) (OutcomesWorker_unassignedReferrals)
) (Search_referrals)
) (Search_referrals1)