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.
| Name | Type | Mandatory | Default Value |
|---|---|---|---|
| templateName | String | N | N |
Example:
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
const template = new SimpleTemplate('Standard task template'); |
applyTo(SimpleRecord)
This method applies the current template to the given object.
| Note |
|---|
When applying a template and inserting a record, please take into account server validation for the SimpleRecord table. |
Parameter(s):
| Name | Type | Mandatory | Default Value |
|---|---|---|---|
| SimpleRecord | SimpleRecord | Y | N |
Return:
| Type | Description |
|---|---|
| Void | This method does not return a value. |
Example:
| Code Block | ||||||
|---|---|---|---|---|---|---|
|
...
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:
| Code Block | ||||||
|---|---|---|---|---|---|---|
|
...
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:
| Code Block | ||||||
|---|---|---|---|---|---|---|
|
...
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 to which the object template belongs; 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:
| Code Block | ||||||
|---|---|---|---|---|---|---|
|
...
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 table to which the template object belongs.
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:
| Code Block | |||||
|---|---|---|---|---|---|
|
...
|
...
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 the 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:
| Code Block | ||||||
|---|---|---|---|---|---|---|
|
...
const template = new SimpleTemplate(); template.get(' |
...
Record template'); |
| Table of Contents | ||||
|---|---|---|---|---|
|