Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This class provides methods for operating with templates.

SimpleTemplate(templateName)


This method instantiates a new SimpleTemplate class object.

NameTypeMandatoryDefault Value
templateNameStringNN

Example:

Code Block
languagejs
themeEclipse
titleSimpleTemplate
linenumberstrue
let template = new SimpleTemplate('incident template')



applyTo(SimpleRecord)


This method applies the current template to the given object.


Parameter(s):

NameTypeMandatoryDefault Value
SimpleRecordSimpleRecordYN


Return:

TypeDescription
VoidThis method does not return a value.


Example:

Code Block
languagejs
themeEclipse
titleapplyTo
let record = new SimpleRecord('itsm_incident');
let template = new SimpleTemplate('incident template');
template.applyTo(record);
ss.info(record.getAttributes());


applyToByTemplateField(SimpleRecord, template)


This method applies the value from the Template type field to the object given.


Parameter(s):

NameTypeMandatoryDefault Value
SimpleRecordSimpleRecordYN
templateArrayYN


Return:

TypeDescription
VoidThis method does not return a value.


Example:

Code Block
languagejs
themeEclipse
titleapplyToByTemplateField
let record = new SimpleRecord('task');
let task = new SimpleRecord('task');
task.get('156837247306928785');
let template = new SimpleTemplate();
template.applyToByTemplateField(record, task.template);
ss.info(record.getAttributes());


createBySimpleRecord(SimpleRecord, templateName)


This method creates a new template from a SimpleRecord object with a specified name and returns the ID of the template created.


Parameter(s):

NameTypeMandatoryDefault Value
SimpleRecordSimpleRecordYN
templateNameStringYN


Return:

TypeDescription
Big IntegerThe template ID.


Example:

Code Block
languagejs
themeEclipse
titlecreateBySimpleRecord
let record = new SimpleRecord('itsm_incident');
record.get('156837247306928785');
let template = new SimpleTemplate();
ss.info(JSON.stringify(template.createBySimpleRecord(record, 'new incident template')));


createByTemplateData(templateData, tableName, templateName, templateTableName)


This method creates a new template out of the "key → value" array with a specified name and a table to which the object template belongs; in this array, the attribute name is a key, and the key value is a value.


Parameter(s):

NameTypeMandatoryDefault Value
templateDataArrayYN
tableNameStringYN
templateNameStringYN
templateTableNameStringNN


Return:

TypeDescription
Big IntegerThe ID of the template created.


Example:

Code Block
languagejs
themeEclipse
titlecreateByTemplateData
let template = new SimpleTemplate();
ss.info(JSON.stringify(template.createByTemplateData({'subject': 'New subject'}, 'itsm_incident', 'new incident template')));


createByTemplateField(template, tableName, templateName)


This method creates a new template with the specified name and table to which the template object belongs.


Parameter(s):

NameTypeMandatoryDefault Value
templateArrayYN
tableNameStringYN
templateNameStringYN


Return:

TypeDescription
Big IntegerThe ID of the template created.


Example:

Code Block
languagejs
themeEclipse
titlecreateByTemplateField
let template = new SimpleTemplate();
ss.info(JSON.stringify(template.createByTemplateField({'subject': 'New subject'}, 'itsm_incident', 'new incident template')));


get(templateName)


This method gets a template from the template storage by the unique name.


Parameter(s):

NameTypeMandatoryDefault Value
templateNameStringYN


Return:

TypeDescription
VoidThis method does not return a value.


Example:

Code Block
languagejs
themeEclipse
titleget
let template = new SimpleTemplate();
template.get('test template');


Table of Contents
absoluteUrltrue
classfixedPosition