Template Maintenance Function - Fields Description

At this function, user will come across various fields or columns that needs to be maintained with relevant data.

The descriptions of the respective field or column, are as follows:-

<Documents Search> (Panel)

Module Code

This is the unique code of the applicable area of the system of the respective document, e.g., CIF - Customer Information File or LN - Financing.

Document Name

This is the name of the respective document associated with a document identity or reference number in the system, e.g., Letter of Offer.

Document ID

This is the internal system generated identity, or reference number used to uniquely identify each required document type in the systen, e.g. LO01.

<Documents Listing> (Panel)

Module Code

This is the unique code of the applicable area of the system of the respective document, e.g., CIF - Customer Information File or LN - Financing.

Document ID

This is the internal system generated identity, or reference number used to uniquely identify each required document type in the systen, e.g. LO01.

Document Name

This is the name of the respective document associated with a document identity or reference number in the system, e.g., Letter of Offer.

Category

This is the group of the respective document, e.g., LOF Document.
Template Editor (Panel)

Document (Section)

<Document Main Details> (Sub-Section)

Name

This is the name of the respective document template file to be used for displaying a certain document’s content.

Eff date

This is the date of which the respective document template can be used for displaying a certain document’s content.

Language

This is the language applicable for the contents that will be displayed at the selected document template, e.g., E - English.

CUBA Template Defined

This is to indicate whether the system has defined its internal template for the document type.

The options, are as follows:-

  • Y - Yes

  • N - No

Actual File Name

This is the name of the document template file that user has uploaded.

<Document Template Details> (Sub-Section)

Output Type

This is the format of the document template.

The available options, are as follows:-

  • DOCX

  • XLSX

  • PDF

Eff date

This is the date of which the respective document template can be used for displaying a certain document’s content.

Name

This is the name of the respective document template file to be used for displaying a certain document’s content.

Language

This is the language applicable for the contents that will be displayed at the actual uploaded document template file, as displayed at the 'Upload' column, e.g., E - English.

View Existing Template

This is the hyperlink to be clicked once, in order to view the present document template set and in use.

Upload File

This is the column for user to add the relevant document template file to be used.

Note:

  • User can click once on the Upload button, to select the relevant file from his local machine, via the 'Open Directory' panel.

  • Alternatively, user can drag and drop the relevant template file from a folder of his local machine into the drop box.
SMS (Section)

<SMS Main Details> (Sub-Section)

Name

This is the subject matter related to a Short Message Service (SMS).

Eff date

This is the date of which record of a Short Message Service (SMS) will be displayed.

Body Content

This is the message sent via Short Message Service (SMS).

Language

This is the language applicable for the contents of the Short Message Service (SMS), e.g., E - English.

<SMS Template Details> (Sub-Section)

Name

This is the subject matter related to a Short Message Service (SMS).

Eff date

This is the date of which record of a Short Message Service (SMS) will be displayed.

Body Content

This is the message sent via Short Message Service (SMS).

Language

This is the language applicable for the contents of the Short Message Service (SMS), e.g., E - English.
Email (Section)

Email Main Details> (Sub-Section)

Name

This is the name for the template to be used for displaying a certain email’s content.

Eff date

This is the date of which record of an email template will be displayed.

Language

This is the language applicable for the contents of the email template, e.g., E - English.

CUBA Template Defined

This is to indicate whether the system has defined its internal template for the document type.

The options, are as follows:-

  • Y - Yes

  • N - No

<Email Template Details> (Sub-Section)

Name

This is the name for the template to be used for displaying a certain email’s content.

Eff date

This is the date of which record of an email template will be displayed.

Language

This is the language applicable for the contents of the email template, e.g., E - English.

Description

This is the brief details of the email template.
Keywords (Panel)

Keyword Code

This is the word used as a key to a code or any significant word or phrase, especially to describe the contents of a document, e.g., $CUSTOMER_ID$ and $ADDR$.

Description

This is the description of the word used as a key to a code or any significant word or phrase, especially to describe the contents of a document, e.g., $CUSTOMER_ID$ - Customer Identity Numbers and $ADDR$ - Corresponding Addresses.
Email Template (Panel)

This panel basically allows user to maintain the email template layout, contents and attachments.

Main (Section)

<Upload> (Sub-Section)

Note: This is the button to be clicked once, to display the selected template file from the 'Open' pop-up window, for upload into system.

<HTML file and format Handling> (Sub-Section)

Note: This part is Not Applicable in System.

<View> (Sub-Section)

Note: This is the button to be clicked once, to display the selected template file to be opened for preview, via the default internet browser.

<Report> (Sub-Section)

Note: This is the button to be clicked once, to display the Report Structure panel, for data input.

Template Details (Sub-Section)

Name

This is the 'Document ID' in system, which indicates the purpose of the document’s template that will be mapped, e.g., RD001.

Code

This is the system generated template code name, which take the following format:-

(User defined email template name)(Language Code)(YYYYMMDD)(system generated unique number)_

For example: REDEEMNOTICE_E_20230511_5dljH0NDcQ

Group

This is referring to the email template group.

Note: This field is Not Applicable and Not in Used

Default Addresses (Sub-Section)

Subject

This is the subject matter related to a message sent via email.

Note: If there is no value inputted into this field, the default value will be the user defined code name of an email template, e.g., RedeemNotice.

From

This is the default sender’s email address of each generated email.

To

This is the default recipients' email addresses to be sent, with each generated email.

Note: Use a separator either ',' or ';' as separators for more than one email address.

CC

This is the default 'other' recipients' email address to be sent with each generated email.

Note:

  • CC refers to Carbon Copy, which refers to the duplicate copy of something. The CC’s email addresses will be displayed in the email content.

  • Use a separator either ',' or ';' as separators for more than one email address.

BCC

This is the default 'other' recipients' email address to be sent with each generated email.

Note:

  • BCC refers to Blind Carbon Copy, which also refers to the duplicate copy of something that is sent out to several other parties, however, the parties that have been 'BCC' will not be revealed to the recipients under the 'To' and 'CC' fields.

  • Use a separator either ',' or ';' as separators for more than one email address.

Body

This is the pattern or layout of the contents that is required for the respective type of document, that has been or will be uploaded (via the document template file) into system for use.

<Possible Design Layout for Adoption to the Template> (Sub-Section)

This sub-section contains the possible layout parts to be dragged into the 'Body' field for the entire template layout to appear.

Parameters and Formats (Section)

Parameters (Sub-Section)

This sub-section basically allows user to do the following:-

  • Add keywords to be used in the template by data input (Click once on the EmailKeywordsEditor CreateRecord button and input data into the 'Parameter Editor' pop-up window)

  • Add keywords to be used in the template by copying from other templates (Click once on the EmailKeywordsEditor CreateFrmTemplate button and select the relevant template’s keywords)

  • View details of existing keywords (Click once on the EmailKeywordsEditor Details button, where details will be displayed at the 'Parameter Editor' pop-up window)

  • Remove no longer required keywords from the template (Click once on the EmailKeywordsEditor Remove button, upon selection by clicking once on a row of keyword records)

  • Scroll up and down of the list of keywords display (Clicking on the EmailKeywordsEditor ScrollUp icon to scroll up the list and click once on the EmailKeywordsEditor ScrollDown icon to scroll down the list)

Caption

This is the keyword of a document’s field value to be retrieved for display via a template.

Parameter Alias

This is the other name to associate the keyword of a document’s field value to be retrieved for display via a template.

Note: The value of this column is usually same as the column value displayed at the 'Caption' column, unless there are some reasons, e.g., to have another name to associate with a group of keywords for a certain purpose in a template.

Parameter Type

This is the 'data type' of the respective keyword value (also referring to a document’s field value).

Some options, are as follows:-

  • Date (Date value)

  • String (Variable characters value, e.g., numbers, letters and special characters)

  • Number (Numerical value)

Required Parameter

This is to indicate whether the keyword or field is mandatory in the document’s template.

Note: Checked check box indicates that the keyword is mandatory.

Validation Is On

This is to indicate whether the keyword is subject to a certain kind of data validation.

Note: Checked check box indicates that the keyword is subject to a certain kind of data validation.

Value Format (Sub-Section)

This sub-section will only be used depending on the design of the data retrieval of the designated document generated in system. However, presently this sub-section is not applicable for documents in system.

Value Name

This is the document’s field name where related keyword value will be displayed.

Format String

This is the document’s keyword or field value’s type, e.g., dd/MM/yyyy HH:mm.

Cross Parameters Validation (Sub-Section)

The sub-section allows user to maintain a form of program script to ensure the related values of keywords or fields' values are logical in relative to each other to be displayed in the designated document, and if not to prompt a certain invalid message.

This sub-section will only be applicable, dependent on the design of the data retrieval of the designated document generated in system. However, presently this sub-section is not applicable for the available types of documents in system.

Validate

This is to indicate whether the related keywords or fields' values are to be validated, to ensure they are logical relative to each value that will be displayed in the designated 'document', and if not to prompt a certain invalid message.

Note: Checked check box indicates that the program script(s) are required, for the return of a final field value as display at the designated document.

Groovy Script

This is the related cross parameter validation program script (used for user interface) at the designated document.

Attachments (Section)

This section basically allows user to maintain the reports or files to be attached to the email template. This section is not applicable, presently.

Report Attachments (Sub-Section)

This section basically allows user to select report(s) from system to be attached to the email template.

Click once on the 'Add' button, where the 'Reports' panel will be displayed for report selection to be attached to the email template.

Click once on the 'Remove' button upon mousing over a record for report, in order to remove the report as attachment from the email template.

Name

This is the applicable system’s report code that is to be attached or already attached to the email template.

System Code

This is the development platform’s other report code to be mapped to the system’s report code as displayed at the 'Name' column for report’s content generation purpose.

Note: The value of this column defaults to the same value as the system’s report code value in the 'Name' column.

Output Type

This is the report content’s file format, e.g., XLSX, HTML and DOCX.

Description

This is the report name in system.

Default Parameters (Sub-Section)

File Name

This is the attachment name of the report selected as attachment to the email template.

<Filter Parameters>

This is the parameter to be inputted with relevant value in order to filter the report data or content, that will be generated as attachment to the email template.

Note: Different reports will have different sets of parameters for report data or content filtration purpose.

File Attachments (Sub-Section)

This section basically allows user to select file(s) to be attached to the email template.

  • Click once on the Upload Button button, to select the relevant file via the 'Open Directory to Search for File Panel'.

  • Click once on the EmailKeywordsEditor Details button, upon mousing over a record for attached file in order to replace the file as attachment from the email template.

  • Click once on the EmailKeywordsEditor Remove button, upon mousing over a file record, in order to remove the file as attachment from the email template.

  • Click once on the Download Icon icon, upon mousing over a file record, in order to download the file.

Name

This is the applicable file name that is to be attached or already attached to the email template.

Create Date

This is the date with time, that the file has been attached to the email template.

Extension

This is the file content’s format, e.g., TXT, XLSX and DOCX.

Size

This is the file size.
Parameter Editor (Pop-Up Window)

Properties (Section)

This section allows user to define the keywords to be used in the email template.

Caption

This is the keyword of a document’s field value to be retrieved for display via a template.

Parameter Alias

This is the other name to associate the keyword of a document’s field value to be retrieved for display via a template.

Note: The value of this column defaults to the same as the column value displayed at the 'Caption' column, unless there are some reasons, e.g., to have another name to associate with a group of keywords for a certain purpose in a template.

Parameter Type

This is the 'data type' of the respective keyword value (also referring to a document’s field value).

Some available options, are as follows:-

  • Date (Date value)

  • String (Variable characters value, e.g., numbers, letters and special characters)

  • Number (Numerical value)

  • Boolean (binary variable that can be 1 of a 2 possible values, e.g., true or false)

Note: The list of options that can be selected for use in this field is dependent on the design of the system.

Hidden

This is to indicate whether the keyword or field is to be hidden in the document’s template.

Note: Checked check box indicates that the keyword is to be hidden.

Required Parameter

This is to indicate whether the keyword or field is mandatory in the document’s template.

Note: Checked check box indicates that the keyword is mandatory.

Default Value

This is the default value of the keyword or field.

Localization (Section)

This section allows user to set the document name displayed in the language of which the user has logged in.

Groovy Script

This is the program script (used for user interface) to display the document name in the language of which the user logged in.

Transformation (Section)

This section allows user to maintain a further program script in order to return the final keywords or field values.

Groovy Script

This is the program script (used for user interface) to be applied for the return of the final keywords or field values.

Validation (Section)

This section allows user to validate the value of the respective keyword or field, to ensure it is logical in relation to each other field value. Otherwise, a certain invalid message will be displayed.

Validate

This indicates whether the list of keywords or fields in the email template will be subjected to the validation via the program script below.

Note: Checked check box indicates that the list of keywords or fields in the email template will be subjected to the validation program script.

Groovy Script

This is the program script (used for user interface) to be applied for keywords or field values' validation, to ensure it is logical in relation to each other field value. Otherwise, a certain invalid message will be displayed.
Formatter (Pop-Up Window)

This pop-up window allows user to define the format of the respective keyword or field value.

Value Name

This is the document’s field name where related keyword value will be displayed.

Format String

This is the document’s keyword or field value’s type, e.g., dd/MM/yyyy HH:mm.

Groovy Script

This is to indicate whether the document’s field value is to subject to a form of program script (used for user interface) before returning the value for display at the designated document.

Note: Checked check box indicates that the program script(s) are required for the return of a final field value for display at the designated document.

Groovy Script

This is the program script (used for user interface) to be applied for keywords or field values, to be converted before returning the value for display at the designated document.
Reports (Panel)

This panel allows user to select the relevant system’s report as attachment to a email template.

Filter (Sub-Panel)

System Code

This is the development platform’s other report code that has been mapped to the system’s report code as displayed at the 'Name' column at the '<Reports Listing>' for report’s content generation purpose.

<Reports Listing> (Sub-Panel)

Group

This is the report category, e.g., Common Admin, General and Customer Information File, appended with the available numbers of reports.

Name

This is the available system’s report code.

Description

This is the report name in system.

System Code

This is the development platform’s other report code that has been mapped to the system’s report code as display at the 'Name' column at the '<Reports Listing>' for report’s content generation purpose.
Edit File Descriptor (Pop-up Window)

This pop-up window allows user to select the relevant file, as attachment to the email template.

Click once on the Up load button, to select the relevant file via the 'Open Directory to Search for File Panel'.

Name

This is the applicable file name that is to be attached or already attached to the email template.

Extension

This is the file content’s format, e.g., TXT, XLSX and DOCX.

Size

This is the file size.

Create Date

This is the date with time, that the file has been attached to the email template.

ID

This is the internal system generated identity, or reference number used to uniquely identify each document template record, e.g., 9d0f9086-09d1-ac56-b603-9e81012e7ac0.