D:Goal

Table Description

Goal: The primary objective of a service plan.

This entity is focused on the administration of a goal within the Service Planning Administration component. A goal can be associated with one or more service plans. A goal can also have one or more associated sub-goals.

Example

A case worker creates a Return to Work service plan for participant Linda Smith as she has recently become unemployed. A goal of Sustainable Employment is selected for this service plan.

Linda Smith is cannot afford to pay for transport to work, therefore a Transportation sub-goal is added to the service plan. A Mileage Reimbursement plan item is added to the service plan to allow Linda to overcome the barrier that she's currently facing.

The following has been set up in the Administration component to achieve to this:

An administrator creates a Return to Work service plan.
A Sustainable Employment goal is then added.
A Transportation sub-goal is linked to the goal, and a Mileage Reimbursement plan item to the Transportation sub-goal.

This setup ensures that the Sustainable Employment goal is available for selection when delivering a Return to Work service plan.

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::ServicePlans::Administration::Goal::Entity::Goal
Controlling File:	ServicePlans\model\Packages\Service Layer\Administration\Goal\Entity\Entity_cat.efx

Table Options

ALLOW_OPTIMISTIC_LOCKING

yes

Attributes (7)

Attribute	Stereotype	Nullable	Description	Domain Definition	Codetable	DDL Type
goalID	key	no	Unique reference number assigned by the system to a goal record.	GOAL_ID		SVR_INT64
goalReference	details		User entered reference number to represent this type of goal. This can be used to reference this type of plan item from other areas of the system, e.g. the rules engine.	REFERENCE_NUMBER		SVR_STRING<20>
name	details	no	Name of the goal. This is a code table value for translation purposes.	GOAL_NAME_CODE	GoalName	SVR_STRING<10>
dateCreated	details		Date on which the goal definition was created.	CURAM_DATE		SVR_DATE
description	details		Textual description of the goal.	DESCRIPTION		SVR_STRING<300>
recordStatus	details		Status of the goal record. The values are Active or Canceled. Logical deletion is supported.	RECORD_STATUS_CODE	RecordStatus	SVR_STRING<10>
descriptionTextID	details	yes	Unique Identifier corresponding to localized description of Goal.	LOCALIZABLE_TEXT_ID		SVR_INT64

Foreign Keys (7)

Child	Parent
Goal.descriptionTextID	LocalizableText.localizableTextID
GoalContractText.goalID	Goal.goalID
GoalOutcomeLink.goalID	Goal.goalID
GoalSubGoalLink.goalID	Goal.goalID
PlanTemplate.goalID	Goal.goalID
PlannedGoal.goalID	Goal.goalID
ServicePlanGoalLink.goalID	Goal.goalID

Indices (3)

Index Name	Attributes
RecordStatusNameIndex	recordStatus, name
GoalDescriptionTextIDIndex	descriptionTextID
RefNoIndex	goalReference

Operations (27)

Operation	Stereotype	Options	Description	SQL
cancel	nsmodify	OPTIMISTIC_LOCKING: yes PRE_DATA_ACCESS: yes	Cancels Goal.
countByNameAndStatus	ns		Counts goals by name and status.	SQL
countByReference	ns		Count goals by goal reference.	SQL
countByLanguageAndStatus	ns	PRE_DATA_ACCESS: no	Counts active contract text records in specified language for a goal.	SQL
countSubGoalBySubGoalID	ns		Counts sub goals with specified sub goal ID.	SQL
countOutcomeByOutcomeID	ns		Counts outcomes with specified outcome ID	SQL
countTemplatesByGoalAndStatus	ns		Counts plan templates assigned to the goal.	SQL
insert	insert	AUTO_ID: goalID AUTO_ID_KEY: SERCPLANBO PRE_DATA_ACCESS: yes	Standard Operation
readAll	nkreadmulti		Returns a list of all Goal records.
modify	modify	OPTIMISTIC_LOCKING: yes PRE_DATA_ACCESS: yes	Standard Operation
read	read		Standard Operation
readNameAndReference	nsread		Reads goal name and reference.
readStatus	nsread		Reads record status for the specified goal.
searchContractText	nsmulti		Lists all contract text details for a goal.	SQL
searchSubGoal	nsmulti		Lists all sub goals for the specified goal.	SQL
searchOutcome	nsmulti		Lists all outcomes for the specified goal.	SQL
searchUnassociatedSubGoalsByStatus	nsmulti		Lists all sub goals that are not associated with goal specified, having a specific record status.	SQL
searchUnassociatedOutcomesByStatus	nsmulti		Lists all outcomes that are not associated with the goal specified, having a specific record status.	SQL
validateCancel			This method validates goal canceling.
validateInsert			This method validates goal details.
validateModify			This method validates goal modifying.
readName	nsread		Reads goal name.
listGoalDetailsByStatus	nsmulti		Returns name and ID of all existing goals of specified status.	SQL
countServicePlansByGoalAndStatus	ns		Counts service plans that the goal is associated with.	SQL
insertGoal	insert		<p class="MsoNormal"> <span style="COLOR: #002060">Inserts goal record. This method expects the goalIDto be set. It is preferred to call insertGoal method only in scenarios where calling method wants to set the value of primary key by itself.</span> </p>
modifyDescriptionTextID	nsmodify	OPTIMISTIC_LOCKING: yes	Modifies descriptionTextID.
modifyGoal	modify	OPTIMISTIC_LOCKING: yes	This modify operation will be called while re-applying a change set in the target system. Entity level validations that will happen during a standard modify operation will not be applicable in this case. This modify operation will update all the attributes defined for this entity.

Related Pages (33)

Integrated Service Plan Home (IntegratedServicePlan_home)
Integrated Service Plan Home (IntegratedServicePlan_homeActiveOnly)
- (IntegratedServicePlan_tabDetails)
Add Existing Goal to Service Plan (ServicePlanAdmin_addExistingGoalToServicePlan)
Add Existing Expected Outcome to Goal (ServicePlanAdmin_addOutcomesToGoal)
New Text Translation (ServicePlanAdmin_addServicePlanGoalDescriptionTextTranslation)
Add Existing Sub Goal (ServicePlanAdmin_addSubGoalsToGoal)
Delete Goal (ServicePlanAdmin_cancelGoal)
View Goal Contract Text (ServicePlanAdmin_contractTextForGoalHome)
New Contract (ServicePlanAdmin_createContractTextForGoal)
New Goal (ServicePlanAdmin_createGoal)
New Goal (ServicePlanAdmin_createGoalForServicePlan)
New Template (ServicePlanAdmin_createServicePlanTemplate)
New Sub Goal (ServicePlanAdmin_createSubGoalForGoal)
New Template (ServicePlanAdmin_createTemplate)
Goal Home (ServicePlanAdmin_goalHome)
Contract Text for Goal (ServicePlanAdmin_listContractTextForGoal)
Goals (ServicePlanAdmin_listGoals)
View Localizable Text (ServicePlanAdmin_listLocalizablePlanTemplateDescriptionText)
View Localizable Text (ServicePlanAdmin_listLocalizablePlanTemplateNameText)
View Localizable Text (ServicePlanAdmin_listLocalizableServicePlanGoalDescriptionText)
Expected Outcomes for Goal (ServicePlanAdmin_listOutcomesForGoal)
Sub Goals for Goal (ServicePlanAdmin_listSubGoalsForGoal)
Edit Contract Text (ServicePlanAdmin_modifyContractTextForGoal)
Edit Goal (ServicePlanAdmin_modifyGoal)
Edit Text Translation (ServicePlanAdmin_modifyLocalizablePlanTemplateDescriptionTextTranslation)
Edit Text Translation (ServicePlanAdmin_modifyLocalizablePlanTemplateNameTextTranslation)
Edit Text Translation (ServicePlanAdmin_modifyLocalizableServicePlanGoalDescriptionTextTranslation)
Modify Service Plan Template (ServicePlanAdmin_modifyTemplate)
Service Plan Template Home (ServicePlanAdmin_templateHome)
ServicePlanAdmin_templateTreeWindow
Template (ServicePlanAdmin_templateTreeWindowTabDetails)
Milestones (ServicePlanDelivery_listISPMilestones)

Database Table: Goal