Table Description
Plan Template: A predefined service plan.

A plan template is a predefined service plan containing a goal, sub-goal(s) and plan item(s). This table will provide the link between the template and the goal for which the template was created. This entity is focused on the administration of a template within the Service Planning Administration component.

Example

A case worker creates a Return to Work service plan for participant Linda Smith. Linda is unable to pay for transport to get to work and also needs assistance paying for childcare. The caseworker chooses to use a predefined template which consists of a Sustainable Employment goal, Transportation and Childcare sub-goals and Mileage Reimbursement and Childcare provision plan items. The following was performed in the administration component to achieve this:

This template is now selectable as above for Return to Work service plans.

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::Templates::PlanTemplate::Entity::PlanTemplate
Controlling File: ServicePlans\model\Packages\Service Layer\Templates\PlanTemplate\Entity\Entity_cat.efx
Table Options
ALLOW_OPTIMISTIC_LOCKINGyes
Attributes (9)
AttributeStereotypeNullableDescriptionDomain DefinitionCodetableDDL Type
planTemplateIDkeynoUnique reference number assigned by the system to a plan template record.PLAN_TEMPLATE_ID SVR_INT64
goalIDdetailsnoUnique reference number of the associated goal for which the template has been created. Links the plan template to the related goal.GOAL_ID SVR_INT64
namedetailsyesName of the plan template.PLAN_TEMPLATE_NAME SVR_STRING<128>
dateCreateddetails Date on which the plan template definition was created.CURAM_DATE SVR_DATE
descriptiondetailsyesTextual description of the plan template.DESCRIPTION SVR_STRING<300>
recordStatusdetails Status of the plan template record. The values are 'Active' or 'Canceled'. Logical deletion is supported.RECORD_STATUS_CODERecordStatusSVR_STRING<10>
daysToExpirydetails Expected duration of the plan template.NUMBER_OF_DAYS SVR_INT32
nameTextIDdetailsyes

Localized textID of name.

LOCALIZABLE_TEXT_ID SVR_INT64
descriptionTextIDdetailsyes

Localized textID of description.

LOCALIZABLE_TEXT_ID SVR_INT64
Foreign Keys (5)
ChildParent
PlanTemplate.goalIDGoal.goalID
PlanTemplate.nameTextIDLocalizableText.localizableTextID
PlanTemplate.descriptionTextIDLocalizableText.localizableTextID
PlanTemplateServicePlanLink.planTemplateIDPlanTemplate.planTemplateID
PlanTemplateSubGoal.planTemplateIDPlanTemplate.planTemplateID
Indices (4)
Index NameAttributes
PTGoalIDStatusIndexgoalID, recordStatus
PTNameStatusIndexname, recordStatus
IND__29152177nameTextID
IND_805709768descriptionTextID
Operations (25)
OperationStereotypeOptionsDescriptionSQL
insertinsertAUTO_ID: planTemplateID
AUTO_ID_KEY: SERCPLANBO
PRE_DATA_ACCESS: yes
Standard Operation 
readread Standard Operation 
modifymodifyOPTIMISTIC_LOCKING: yes
PRE_DATA_ACCESS: yes
Standard Operation 
readAllnkreadmulti List all the service plan templates. 
countByNameAndStatusns Counts the occurances of a given template name.SQL
readStatusnsread Gets the status of a particular plan template 
validateInsert  Validate that the details provided refer to a unique name. 
validateModify  Validate that the details provided refer to a unique name. 
readNamensread @Deprecated.Reads&nbsp;plan&nbsp;template&nbsp;name. 
cancelnsmodifyOPTIMISTIC_LOCKING: yes
PRE_DATA_ACCESS: yes
Cancels a plan template. 
validateCancel  Validates plan template to be canceled. 
countByGoalAndSubGoalns Counts plan templates created for the goal specified that have assigned plan template sub goals based on the given sub goal.SQL
countBySubGoalAndPlanItemns Counts plan templates created for the plan item and sub goal.SQL
readStatusByPlanTemplatePlanItemIDns Reads the status of the plan template this plan item is been assigned to.SQL
readStatusByPlanTemplateSubGoalIDns Reads the status of the plan template this sub goal is been assigned to.SQL
searchUnassociatedSubGoalsnsmulti Lists all sub goals associated with the selected goal of the service plan template.SQL
readGoalIDnsread Reads goal ID. 
readStatusByPlanTemplatePlanGroupIDns Reads the status of the plan template that this plan group is assigned to.SQL
readStatusByPlanTemplateMilestoneIDns Reads the status of the plan template that this milestone is assigned to.SQL
readStatusByPlanTemplatePlanItemApprCritIDns Reads the status of the plan template this approval criteria is been assigned to.SQL
insertPlanTemplateinsert <p class="MsoNormal"> <span style="COLOR: #002060">Inserts plan template record. This method expects the planTemplateID to be set. It is preferred to call <font color="#000000">insertPlanTemplate</font> method only in scenarios where calling method wants to set the value of primary key by itself.</span> </p> 
modifyNameTextIDnsmodifyOPTIMISTIC_LOCKING: yes
<p> Updates the nameTextID </p> 
modifyDescriptionTextIDnsmodifyOPTIMISTIC_LOCKING: yes
<p> Updates the descriptionTextID </p> 
readPlanTemplateNamens Reads the template name and nameTextID.SQL
modifyPlanTemplatemodifyOPTIMISTIC_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 (35)
Add Existing Template to Service Plan (ServicePlanAdmin_addExistingTemplateToServicePlan)
New Text Translation (ServicePlanAdmin_addPlanTemplateDescriptionTextTranslation)
New Text Translation (ServicePlanAdmin_addPlanTemplateNameTextTranslation)
Add Milestone (ServicePlanAdmin_addTemplateMilestone)
Add Plan Item (ServicePlanAdmin_addTemplatePlanItem)
Add Plan Item Approval Criteria (ServicePlanAdmin_addTemplatePlanItemApprovalCriteria)
Add Sub-Goal (ServicePlanAdmin_addTemplateSubGoal)
Delete Plan Item (ServicePlanAdmin_cancelPlanItem)
Delete Service Plan Template (ServicePlanAdmin_cancelTemplate)
Add Plan Item to Service Plan Template Sub Goal (ServicePlanAdmin_confirmAddTemplatePlanItem)
New Template (ServicePlanAdmin_createServicePlanTemplate)
New Template (ServicePlanAdmin_createTemplate)
Add Plan Group (ServicePlanAdmin_createTemplatePlanGroup)
View Localizable Text (ServicePlanAdmin_listLocalizablePlanTemplateDescriptionText)
View Localizable Text (ServicePlanAdmin_listLocalizablePlanTemplateNameText)
Templates (ServicePlanAdmin_listTemplates)
Edit Text Translation (ServicePlanAdmin_modifyLocalizablePlanTemplateDescriptionTextTranslation)
Edit Text Translation (ServicePlanAdmin_modifyLocalizablePlanTemplateNameTextTranslation)
Modify Service Plan Template (ServicePlanAdmin_modifyTemplate)
Edit Milestone (ServicePlanAdmin_modifyTemplateMilestone)
Edit Plan Group (ServicePlanAdmin_modifyTemplatePlanGroup)
Edit Plan Item Approval Criteria (ServicePlanAdmin_modifyTemplatePlanItemApprovalCriteria)
Edit Sub-Goal (ServicePlanAdmin_modifyTemplateSubGoal)
Remove Approval Criteria from Plan Item (ServicePlanAdmin_removeApprovalCriteriaFromPlanItem)
Remove Plan Item from Sub Goal (ServicePlanAdmin_removePlanItemFromSubGoal)
Remove Sub Goal (ServicePlanAdmin_removeSubGoalFromGoal)
Delete Milestone (ServicePlanAdmin_removeTemplateMilestone)
Delete Plan Group (ServicePlanAdmin_removeTemplatePlanGroup)
Delete Plan Item (ServicePlanAdmin_removeTemplatePlanItem)
Delete Plan Item Approval Criteria (ServicePlanAdmin_removeTemplatePlanItemApprovalCriteria)
Delete Sub-Goal (ServicePlanAdmin_removeTemplateSubGoal)
Service Plan Template Home (ServicePlanAdmin_templateHome)
ServicePlanAdmin_templateTreeWindow
Template (ServicePlanAdmin_templateTreeWindowTabDetails)
Use Service Plan Template (ServicePlanDelivery_useTemplate)