Table Description
Milestone Configuration: Configuration details of a milestone.

This entity is focused on the administration of milestones within the Administration component. A milestone can be associated with one or more types of cases or service plans.

Example

A case worker creates an Assistance integrated case for participant Linda Smith who has recently become unemployed. He creates a Return to Work service plan for her so that she can achieve her goal of Sustainable Employment. A Review milestone is added so that a review takes places two weeks after the start of the service plan. A Transportation sub-goal is added to the service plan as she is unable to pay for transport to get to work. A Childcare Provision plan item is added to the service plan to achieve the service plan sub-goal.

Linda also requires assistance paying for dependent childcare and as such a Childcare sub-goal is added to the service plan. Plan item Childcare Provision is added to the Childcare sub-goal.

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

  • An administrator creates a Return to Work service plan.
  • This service plan is linked to an Assistance integrated case.
  • A milestone of type Review is created with an expected start day of 14. This milestone is associated with the Return to Work service plan.
  • A Sustainable Employment goal is then added.
  • Transportation and Childcare sub-goals are linked to the goal, and Mileage Reimbursement and Childcare Provision plan items are linked to the Transportation and Childcare sub-goals respectively.
This entity stores the configuration details of the Review milestone which can subsequently be associated with a 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::Core::Reference Model::Service Layer::MilestoneConfiguration::Entity::MilestoneConfiguration
Controlling File: core\model\Packages\Reference Model\Service Layer\MilestoneConfiguration\Entity\MilestoneConfiguration_cat.efx
Table Options
ALLOW_OPTIMISTIC_LOCKINGyes
LAST_UPDATED_FIELDyes
Attributes (19)
AttributeStereotypeNullableDescriptionDomain DefinitionCodetableDDL Type
milestoneConfigurationIDkeynoUnique reference number assigned by the system to the milestone configuration record.MILESTONE_CONFIGURATION_ID SVR_INT64
namedetails Name of the milestone.MILESTONE_NAME SVR_STRING<128>
typedetails Type of this milestone.MILESTONE_TYPE SVR_STRING<128>
earliestStartDaydetails The earliest number of days after the service plan or case start date that this milestone can start. NUMBER_OF_DAYS SVR_INT32
durationdetails Indicates how long this milestone should take to complete(this is used to calculate the expected end date of a milestone unless the milestone has been added as part of a service plan template in which case the duration on the template supersedes this value). NUMBER_OF_DAYS SVR_INT32
startDatedetails The date on which this milestone configuration becomes effective.CURAM_DATE SVR_DATE
endDatedetails The date on which this milestone configuration will expire.CURAM_DATE SVR_DATE
addedEventdetails Indicates the event to be raised when a milestone of this type is added to a case or service plan.PDT_EVENT_CLASS_AND_TYPE SVR_STRING<200>
expctdStDateEventdetails Indicates the event to be raised when the expected start date of the milestone has been reached and it's status is Not Started. PDT_EVENT_CLASS_AND_TYPE SVR_STRING<200>
expctdEndDateEventdetails Indicates the event to be raised when the expected end date of the milestone has been reached and it's status is Not Started or In Progress. PDT_EVENT_CLASS_AND_TYPE SVR_STRING<200>
completeEventdetails Indicates the event to be raised when the status of the milestone is Completed i.e. The actual end date has been entered and the status is Complete. PDT_EVENT_CLASS_AND_TYPE SVR_STRING<200>
creationDatedetails The date on which this milestone was created.CURAM_DATE SVR_DATE
commentsdetails Generate remarks entered by a user.COMMENTS SVR_STRING<300>
recordStatusdetails The status of the milestone i.e. Active or Cancelled. Logical deletion supported.RECORD_STATUS_CODERecordStatusSVR_STRING<10>
waiverRequireddetailsyesIndicates if an approved waiver is required in order to modify the automatically created milestone delivery by system.WAIVER_REQUIRED SVR_BOOLEAN
waiverAlloweddetails Indicates if a user can modify the Expected Start Date or Expected End Date of an milestone delivery that has been automatically created by the system.WAIVER_ALLOWED SVR_BOOLEAN
nameTextIDdetailsyesUnique Identifier correspoding to localized TextID of name.LOCALIZABLE_TEXT_ID SVR_INT64
typeTextIDdetailsyesUnique Identifier correspoding to localized TextID of Milestone typeLOCALIZABLE_TEXT_ID SVR_INT64
commentsTextIDdetailsyesUnique Identifier correspoding to localized TextID of milestone comments.LOCALIZABLE_TEXT_ID SVR_INT64
Foreign Keys (5)
ChildParent
MilestoneConfiguration.nameTextIDLocalizableText.localizableTextID
MilestoneConfiguration.typeTextIDLocalizableText.localizableTextID
MilestoneConfiguration.commentsTextIDLocalizableText.localizableTextID
MilestoneWaiverApprovalCheck.milestoneConfigurationIDMilestoneConfiguration.milestoneConfigurationID
ProgTypeMilestoneConfigLink.milestoneConfigurationIDMilestoneConfiguration.milestoneConfigurationID
Indices (3)
Index NameAttributes
MilestoneCommentsTxtIDIdxcommentsTextID
MilestoneNameTxtIDIdxnameTextID
MilestoneTypeTxtIDIdxtypeTextID
Operations (27)
OperationStereotypeOptionsDescriptionSQL
insertinsertAUTO_ID: milestoneConfigurationID
AUTO_ID_KEY: MLSTNECONF
PRE_DATA_ACCESS: yes
Standard Operation 
readread Standard Operation 
modifymodifyOPTIMISTIC_LOCKING: yes
PRE_DATA_ACCESS: yes
Standard Operation 
readAllnkreadmultiORDER_BY: recordStatus, startDate
Reads all of the attributes of all of the records on a database table. 
countDuplicatePeriodsns @Deprecated Since curam 6.0 replaced with {@link MilestoneConfiguration#countMilestoneDuplicatePeriods()} as part of implementing localization of MilestoneConfiguration attributes . See release note: CR00233651. This method checks for overlapping periods with other records of the same milestone type. SQL
validateInsert  Validates milestone configuration details before inserting a new record. 
validateDetails  Performs common validations before creating or modifying a milestone configuration record. 
validateModify  Validates the milestone configuration details before modifying the record. 
modifyStatusnsmodifyOPTIMISTIC_LOCKING: yes
PRE_DATA_ACCESS: yes
Changes the status of the milestone to Canceled 
validateCancel  Validates milestone details before updating to 'canceled'. 
readRecordStatusnsread Retrieves the current status of the milestone configuration record. 
countDuplicatePeriodForModifyns @Deprecated Since curam 6.0 replaced with {@link MilestoneConfiguration#countMilestoneDuplicatePeriodForModify()} as part of implementing localization of MilestoneConfiguration attributes . See release note: CR00233651. This method checks for overlapping periods with other records with the same issue name. The current record is excluded from the check.SQL
readEarliestStartDaynsread Reads the earliest start day configured for a milestone type. 
searchNameAndIDByRecordStatusnsmulti @deprecated since curam 6.0, replace by {@Link MilestoneConfiguration#searchNameDetailsAndIDByRecordStatus()}. See release note : CR00247170 Method to retrieve the names and id's of milestones in a certain state.SQL
readVersionNonsread Returns the version number for the milestone configuration record. 
readDurationnsread Reads the duration configured for a milestone type. 
readAddedEventns Method to read back the milestone added event for the specified milestone configuration.SQL
readWaiverIndicatorsDetailsns  SQL
insertMilestoneConfigurationinsert Inserts&nbsp;milestoneconfiguration&nbsp;record.&nbsp;This&nbsp;method&nbsp;expects&nbsp;the&nbsp;milestoneConfigurationID&nbsp;to&nbsp;be&nbsp;set.&nbsp;It<br /> is&nbsp;preferred&nbsp;to&nbsp;call&nbsp;insertMilestoneConfiguration&nbsp;method&nbsp;only&nbsp;in&nbsp;scenarios&nbsp;where&nbsp;calling&nbsp;method&nbsp;wants&nbsp;to&nbsp;set&nbsp;the&nbsp;value&nbsp;of<br /> primary&nbsp;key&nbsp;by&nbsp;itself. 
readCompletionEventns Method to read back the milestone completed event for the specified milestone configuration.SQL
modifyNameTextIDnsmodifyOPTIMISTIC_LOCKING: yes
Modifies NameTextID. 
modifyTypeTextIDnsmodifyOPTIMISTIC_LOCKING: yes
Modifies TypeTextID. 
modifyCommentsTextIDnsmodifyOPTIMISTIC_LOCKING: yes
Modifies CommentsTextID. 
countMilestoneDuplicatePeriodsns This method checks for overlapping periods with other records of the same milestone type.SQL
countMilestoneDuplicatePeriodForModifyns This method checks for overlapping periods with other records with the same issue name. The current record is excluded from the check.SQL
searchNameDetailsAndIDByRecordStatusnsmulti Method to retrieve the names and id's of milestones in a certain state.SQL
modifyMilestoneConfigurationmodifyOPTIMISTIC_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 (161)
Events (Appeal_listHearingCaseEvent)
Events (Appeal_listHearingCaseEventForIC)
Events (Appeal_listHearingCaseIssueEventForIC)
Events (Appeal_listHearingReviewEvent)
Events (Appeal_listHearingReviewEventForIC)
Events (Appeal_listHearingReviewIssueEventForIC)
Events (Appeal_listJudicialReviewEvent)
Events (Appeal_listJudicialReviewEventForIC)
Events (Appeal_listJudicialReviewIssueEventForIC)
Transfer Application (Application_transferApplicationToExistingCase)
Undo Transfer Application (Application_undoTransferApplicationToExistingCase)
Meetings (ApplicationCase_listEvent)
Home (ApplicationSummary)
Timers (ApplicationTimers)
Events (BenefitSample_listEvent)
Events (BenefitSampleOverpayment_listEvent)
CGISSApplicationContextPanel1
Edit Program (CitizenWorkspaceAdmin_modifyProgram)
Edit Program (CitizenWorkspaceAdmin_modifyProgramFromList)
Edit Program (CitizenWorkspaceAdmin_modifyProgramFromView)
New Program (CitizenWorkspaceAdmin_newProgram)
Approve Timer Extension (CommonIntake_approveTimerExtension)
Reopen Program (CommonIntake_createProgramReopening)
Deny Program (CommonIntake_denyProgram)
Edit And Approve Timer Extension (CommonIntake_editAndApproveTimerExtension)
Edit Application (CommonIntake_editApplicationCase)
Edit Date Program Added (CommonIntake_editProgramDateAdded)
Extend Timer (CommonIntake_extendTimers)
Edit Reopen Details (CommonIntake_modifyProgramReopenDetails)
Reject Timer Extension (CommonIntake_rejectTimerExtension)
Deny (CREOLEProgramRecommendation_confirmDenyProgramApplication)
Events (DecisionAssistApplication_listEventNoCOC)
Events (DecisionAssistApplication_listEventNoCOCMultiSourceAC)
Events (DecisionAssistApplication_listEventNoCOCMultiSourceMC)
Events (DecisionAssistApplication_listEventNoCOCSingleSource)
Events (DecisionAssistApplication_listEventWithCOC)
Events (DefaultIC_listEvent)
Events (DefaultICProduct_listEvent)
Events (ICBenefitUnderPayment_listEvent)
Approve Milestone Waiver Request: (ICInvestigationDelivery_approveWaiver)
Request Milestone Waiver (ICInvestigationDelivery_createWaiverForMilestone)
Edit And Approve Milestone Waiver Request (ICInvestigationDelivery_modifyAndApproveWaiver)
Reject Milestone Waiver Request (ICInvestigationDelivery_rejectWaiver)
Events (ICInvestigationSample_listEvent)
Milestones (ICInvestigationSample_listUncompletedMilestones)
Events (ICProductSample_listEvent)
Events (ICSample_listEvent)
Events (ICSampleSportingGrant_listEvent)
Events (ICSportingGrantSample_listEvent)
Events (IncomeScreening_listEvent)
Events: (IncomeSupportScreening_listEvent)
New Milestone (InsuranceAffordability_addMilestone)
Milestones (InsuranceAffordability_listAllMilestones)
Milestones (InsuranceAffordability_listUncompletedMilestones)
Edit Milestone (InsuranceAffordability_modifyMilestoneFromList)
Edit Milestone (InsuranceAffordability_modifyMilestoneFromListWaiver)
Milestone (InsuranceAffordability_viewMilestone)
Add Program (Intake_addProgramApplication)
Approve (Intake_approveTimerExtension)
Confirm Withdrawal Request (Intake_confirmProgramWithdrawalRequest)
Confirm Withdrawal Request (Intake_confirmProgramWithdrawalRequestFromTask)
Withdraw Program Request (Intake_createProgramWithdrawalRequest)
Withdraw Program Request (Intake_createProgramWithdrawalRequest1)
Reopen Program Application (Intake_createReopening)
Edit And Approve (Intake_editAndApproveTimerExtension)
Extend (Intake_extendTimers)
Reject (Intake_rejectTimerExtension)
Milestones (InvestigationSample_listAllMilestones)
Events (InvestigationSample_listEvent)
Milestones (InvestigationSample_listUncompletedMilestones)
Events (ISP_listEvent)
Application Details (ISPApplicationISCompletePreviewPanel)
Application Details (ISPApplicationISDisposedPreviewPanel)
Events (ISPProduct_listEvent)
Events (ISPSpendDownProduct_listEvent)
Events (IssueDelivery_listEvent)
Events (IssueDelivery_listEventForAppeal)
Events (LiabilityOverbilling_listEvent)
Events (LiabilitySample_listEvent)
Events (LIFCProduct_listEvent)
Events (LTCProduct_listEvent)
Events (MAMProduct_listEvent)
Milestone Approval Checks (Milestone_listMilestoneApproval)
Edit Milestone Waiver Approval Check (Milestone_modifyMilestoneApproval)
View Approval Check For Milestone (Milestone_viewApprovalCheckForMilestone)
Milestone Search (MilestoneWaiverApproval_listAllMilestones)
Edit Milestone Waiver Approval Check (Organization_modifyOrgUnitMilestoneApprovalFromList)
Edit Milestone Waiver Approval Check (Organization_modifyOrgUnitMilestoneApprovalFromView)
Edit Milestone Waiver Approval Check (Organization_modifyUserMilestoneApprovalFromList)
Edit Milestone Waiver Approval Check (Organization_modifyUserMilestoneApprovalFromView)
Milestone Waiver Approval Check Details (Organization_viewOrgUnitMilestoneApproval)
Milestone Waiver Approval Check Details (Organization_viewUserMilestoneApproval)
Meetings (OutcomePlan_listEvent)
Events (PaymentCorrection_listEvent)
Events (PDBenefitUnderPayment_listEvent)
New Text Translation (Product_addMilestoneCommentsTextTranslation)
New Text Translation (Product_addMilestoneNameTextTranslation)
New Text Translation (Product_addMilestoneTypeTextTranslation)
Delete Milestone (Product_cancelMilestoneConfiguration)
New Milestone (Product_createMilestoneConfiguration)
New Milestone (Product_createMilestoneForIntegratedCase)
New Milestone for Investigation Case (Product_createMilestoneForInvestigationCase)
New Milestone for Investigation Case (Product_createMilestoneForInvestigationCase1)
New Milestone (Product_createMilestoneForProductDelivery)
New Milestone (Product_createMilestoneForScreeningCase)
View Localizable Text (Product_listLocalizableMilestoneCommentsText)
View Localizable Text (Product_listLocalizableMilestoneNameText)
View Localizable Text (Product_listLocalizableMilestoneTypeText)
Product_listMilestoneConfiguration
Edit Text Translation (Product_modifyLocalizableMilestoneCommentsTextTranslation)
Edit Text Translation (Product_modifyLocalizableMilestoneNameTextTranslation)
Edit Text Translation (Product_modifyLocalizableMilestoneTypeTextTranslation)
Edit Milestone Association (Product_modifyMilestoneConfigAssociation)
Edit Milestone (Product_modifyMilestoneConfigurationForCaseView)
Edit Milestone (Product_modifyMilestoneConfigurationFromList)
Edit Milestone (Product_modifyMilestoneConfigurationFromView)
View Milestone Association (Product_viewMilestoneConfigAssociation)
View Milestone (Product_viewMilestoneConfiguration)
View Milestone (Product_viewMilestoneConfigurationFromCase)
View Milestone (Product_viewMilestoneConfigurationModal)
New Milestone (ProductDelivery_addMilestone)
Edit Milestone (ProductDelivery_modifyMilestoneFromList)
Edit Milestone (ProductDelivery_modifyMilestoneFromListWaiver)
Edit Milestone (ProductDelivery_modifyMilestoneFromView)
Edit Milestone (ProductDelivery_modifyMilestoneFromViewWaiver)
Milestone (ProductDelivery_viewMilestone)
Milestone (ProductDelivery_viewMilestoneModal)
View Milestone (ProductDelivery_viewMilestoneTransaction)
Milestone (ProductDelivery_viewMilestoneViewOnly)
Authorize (ProgramRecommendation_confirmAuthorize)
Deny (ProgramRecommendation_confirmDenyProgramApplication)
Decline (ProgramRecommendation_decline)
Authorize (ProgramRecommendation_listHouseholdMembersForMA)
Events: (ProviderInvestigation_listEvent)
Events (RefugeeProduct_listEvent)
Application (RightsAndResponsibilitiesForAdditionalCase)
Application (RightsAndResponsibilitiesForCase)
Application (RightsAndResponsibilitiesForCaseSubmit)
Add Milestone (ServicePlanAdmin_addTemplateMilestone)
New Milestone (ServicePlanAdmin_createMilestone)
Edit Milestone (ServicePlanAdmin_modifyTemplateMilestone)
View Milestone (ServicePlanAdmin_viewMilestoneConfigurationFromServicePlan)
Add Milestone (ServicePlanDelivery_addMilestone)
Approve Milestone Waiver Request (ServicePlanDelivery_approveWaiver)
Clone Service Plan (ServicePlanDelivery_clone)
Request Milestone Waiver (ServicePlanDelivery_createWaiverForMilestone)
Milestones (All) (ServicePlanDelivery_listAllMilestonesForServicePlan)
Events (ServicePlanDelivery_listEvent)
Milestones (Incomplete) (ServicePlanDelivery_listUncompletedMilestonesForServicePlan)
Edit And Approve Milestone Waiver Request (ServicePlanDelivery_modifyAndApproveWaiver)
Edit Milestone (ServicePlanDelivery_modifyMilestoneFromList)
Edit Milestone (ServicePlanDelivery_modifyMilestoneFromListWaiver)
Edit Milestone (ServicePlanDelivery_modifyMilestoneFromView)
Edit Milestone (ServicePlanDelivery_modifyMilestoneFromViewWaiver)
Reject Milestone Waiver Request (ServicePlanDelivery_rejectWaiver)
Use Service Plan Template (ServicePlanDelivery_useTemplate)
View Milestone (ServicePlanDelivery_viewBaselineMilestone)
View Milestone (ServicePlanDelivery_viewMilestone)
Milestone Details (ServicePlanDelivery_viewMilestoneFromGantt)
Calendar (SocialEnterpriseFolder_listEvent)
Events (TBBCC_listEvent)