View Source

This class provides methods for operating with the templates.

SimpleTemplate(templateName)

This method instantiates a new SimpleTemplate class object.

Name	Type	Mandatory	Default value
templateName	String	N	N

Example:

const template = new SimpleTemplate('Standard task template');

applyTo(SimpleRecord)

This method applies the current template to the given object.

When applying a template and inserting a record, remember that the template should match the record form regarding its content and mandatory fields, as the differences with the SimpleRecord table may lead to the server validation failure. As a result, an error message “Current template doesn't match to this record” or a log appear.

Parameter(s):

Name	Type	Mandatory	Default value
SimpleRecord	SimpleRecord	Y	N

Return:

Type	Description
Void	This method does not return a value.

Example:

const task = new SimpleRecord('task');
const template = new SimpleTemplate('Standard task template');
template.applyTo(task);
task.subject = 'From template Task';
ss.info('Created Task ID: ' + task.insert());
ss.info(task.getErrors());
// Info: Created Task ID: 163777658710999477
// Info: []

applyToByTemplateField(SimpleRecord, template)

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

Parameter(s):

Name	Type	Mandatory	Default value
SimpleRecord	SimpleRecord	Y	N
template	Array	Y	N

Return:

Type	Description
Void	This method does not return a value.

Example:

const templateRecord = new SimpleRecord('some_template_dict');
templateRecord.get('156837247306928785');
const task = new SimpleRecord('task');
const template = new SimpleTemplate();
template.applyToByTemplateField(task, templateRecord.template);
ss.info(task.getAttributes());
task.insert();

createBySimpleRecord(SimpleRecord, templateName)

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

Parameter(s):

Name	Type	Mandatory	Default value
SimpleRecord	SimpleRecord	Y	N
templateName	String	Y	N

Return:

Type	Description
Big Integer	The template ID.

Example:

const task = new SimpleRecord('task');
task.get('156837247306928785');
const template = new SimpleTemplate();
ss.info(JSON.stringify(template.createBySimpleRecord(task, 'New task 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, which the object template belongs to; in this array, the attribute name is a key, and the key value is a value.

Parameter(s):

Name	Type	Mandatory	Default value
templateData	Array	Y	N
tableName	String	Y	N
templateName	String	Y	N
templateTableName	String	N	N

Return:

Type	Description
Big Integer	The ID of the created template.

Example:

const template = new SimpleTemplate();
ss.info(JSON.stringify(template.createByTemplateData({'subject': 'New subject'}, 'task', 'new task template')));

createByTemplateField(template, tableName, templateName)

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

Parameter(s):

Name	Type	Mandatory	Default value
template	Array	Y	N
tableName	String	Y	N
templateName	String	Y	N

Return:

Type	Description
Big Integer	The ID of the created template.

Example:

const template = new SimpleTemplate();
ss.info(JSON.stringify(template.createByTemplateField({'subject': 'New subject'}, 'task', 'New task template')));

get(templateName)

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

Parameter(s):

Name	Type	Mandatory	Default value
templateName	String	Y	N

Return:

Type	Description
Void	This method does not return a value.

Example:

const template = new SimpleTemplate();
template.get('Record template');