Table Description
Document Template: A standard document used when creating concern role communications.

Document templates are used to create standardized communications issued to multiple correspondents. Examples of standard communications include application forms and registration acknowledgment letters. A communication template contains settings, formatting, and styles that are applied to frequently used communications to retain a similar look and feel.

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::Communications::DocumentTemplate::Entity::DocumentTemplate
Controlling File: core\model\Packages\Reference Model\Service Layer\Communications\Entity_cat.efx
Table Options
ALLOW_OPTIMISTIC_LOCKINGyes
Attributes (9)
AttributeStereotypeNullableDescriptionDomain DefinitionCodetableDDL Type
documentTemplateIDkeynoUnique reference number of the document template record.DOCUMENT_TEMPLATE_ID SVR_STRING<40>
namedetails Name of the template.DOCUMENT_TEMPLATE_NAME SVR_STRING<128>
contentsdetails Settings, formatting, and styles contained within the template.DOCUMENT_TEMPLATE_CONTENTS SVR_BLOB
dateAddedToSystemdetails Date the template was added to the system.CURAM_DATE SVR_DATE
categoryCodedetails Type of communication for which this template will be used i.e. email, pro forma, and Microsoft Word. DOCUMENT_CATEGORY_CODEDocumentCategoryCodeSVR_STRING<10>
commentsdetails General remarks entered by the user.COMMENTS SVR_STRING<300>
recordStatusdetails Status of the document template record i.e. active or canceled.RECORD_STATUS_CODERecordStatusSVR_STRING<10>
localeIdentifierdetails This attribute will store the locale information for each communication.LOCALE_CODELocaleSVR_STRING<10>
filenamedetailsyesThe filename of a template.DOCUMENT_TEMPLATE_FILENAME SVR_STRING<256>
Foreign Keys (1)
ChildParent
HomeStudyDocument.documentTemplateIDDocumentTemplate.documentTemplateID
Indices (1)
Index NameAttributes
catCodeIdxcategoryCode
Operations (19)
OperationStereotypeOptionsDescriptionSQL
insertinsertPRE_DATA_ACCESS: yes
Non modifiable user entered unique key value 
readread Standard Operation 
modifymodifyPRE_DATA_ACCESS: yes
Standard Operation 
readAllnkreadmulti Entity method to list document templates. 
cancelnsmodifyPRE_DATA_ACCESS: yes
Entity method to cancel a document template. 
countNameOverlapsns Entity operation to check if the template name already exists.SQL
countTemplateIDOverlapsns Entity method to check for documentTemplateID overlaps.SQL
validateName  Entity validation for Template name 
validateTemplateID  Entity method to validate the template id entered. 
validateCancel  Entity method to validate the cancel operation of a template. 
modifyDocumentTemplateContentsnsmodify Entity method to update the contents of the document template. 
list  @superseded - replaced by readAll 
checkNameOverlap  @superseded - replaced by countNameOverlaps 
checkTemplateIDOverlap  @superseded - replaced by countTemplateIDOverlaps 
searchSelectedFieldsnsmulti  SQL
searchListActivensmulti  SQL
searchByDocumentCategorynsreadmulti   
searchSelectedFieldsAndVersionNonsmulti  SQL
modifyDocumentTemplatemodifyOPTIMISTIC_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 (55)
Select Microsoft Word Template (Appeal_createMSWord)
Edit Document (Application_controlMSWord)
Edit Document (Application_controlMSWord1)
New MS Word Communication (Application_createMSWordCommunicationCaseMember)
View Communication (Application_viewMSWordCommunication)
Opening Microsoft Word Document (ApplicationParticipant_controlMSWord)
Edit Microsoft Word Communication (ApplicationParticipant_modifyDraftMSWordCommunication)
Edit Microsoft Word Communication (ApplicationParticipant_modifySentMSWordCommunication)
Edit Document (Case_controlMSWord)
New Microsoft Word Communication (Case_createMSWordCommunication)
New Microsoft Word Communication (Case_createMSWordCommunicationCaseMember)
View Communication: (Case_viewMSWordCommunicationTransaction)
View Communication (Case_viewMSWordCommunicationTransaction1)
Delete Communication (ExternalParty_deleteDraftEmailCommunication)
Delete External Party Communication (ExternalParty_deleteMSWordCommunication)
Delete External Party Communication (ExternalParty_deleteProFormaCommunication)
Delete External Party Communication (ExternalParty_deleteProFormaCommunication1)
Delete Communication (ExternalParty_deleteRecordedCommunication)
View External Party Communication (ExternalParty_viewMSWordCommunication)
New Document (HomeStudy_createHomeStudyDocument)
Edit Document (HomeStudy_modifyHomeStudyDocument)
View Home Study Document (HomeStudy_viewHomeStudyDocument)
New Microsoft Word Decision Attachment (LegalAction_createMSWord)
Opening Microsoft Word Document (Participant_controlMSWord)
New Microsoft Word Communication (Participant_createMSWordCommunication)
New Microsoft Word Communication (Participant_createMSWordCommunicationWithNoMandatoryAddress)
Delete Communication (Participant_deleteCommunicationWithAttach)
Delete Communication (Participant_deleteCommunicationWithAttach1)
Delete Communication (Participant_deleteDraftEmailCommunication)
Delete Communication (Participant_deleteDraftEmailCommunication1)
Delete Communication (Participant_deleteMSWordCommunication)
Delete Communication (Participant_deleteProFormaCommunication)
Edit Microsoft Word Communication (Participant_modifyDraftMSWordCommunication)
Edit Microsoft Word Communication (Participant_modifyMSWordCommunication)
Edit Microsoft Word Communication (Participant_modifySentMSWordCommunication)
Send Communication (Participant_sendCommunication)
View Communication (Participant_viewMSWordCommunication)
View Communication (Participant_viewMSWordCommunication1)
Delete Communication (SocialEnterpriseFolder_cancelCommunicationPopUp)
New MS Word Communication (SocialEnterpriseFolder_createMSWordCommunication)
MS Word Templates (SocialEnterpriseFolder_listMSWordTemplatesPopUp)
Edit MS Word Communication (SocialEnterpriseFolder_modifyMSWordCommunication)
Send Communication (SocialEnterpriseFolder_sendCommunication)
View Communication (SocialEnterpriseFolder_viewMSWordCommunication)
Delete Microsoft Word Template (System_cancelDocumentTemplate)
New Microsoft Word Template (System_createDocumentTemplate)
New Microsoft Word Template (System_createDocumentTemplate1)
Microsoft Word Templates (System_listDocumentTemplate)
System_listDocumentTemplate1
Microsoft Word Templates (System_listDocumentTemplatePopup)
Edit Microsoft Word Template (System_modifyDocumentTemplate)
Edit Microsoft Word Template (System_modifyDocumentTemplateFromList)
Edit Microsoft Word Template (System_modifyDocumentTemplateFromView)
Modify Template (System_modifyTemplateUsingMSWord)
View Microsoft Word Template Details (System_viewDocumentTemplateDetails)