Useful Functions
The log object
info(message)
Use this function to display an info message.
Parameters:
| Name | Type | Mandatory | Default value |
|---|---|---|---|
| message | String | Y | N |
Return:
| Type | Description |
|---|---|
| Void | The function does not return a value. |
Example:
log.info("Import has been completed")
warn(message)
Use this function to display a warning message.
Parameters:
| Name | Type | Mandatory | Default value |
|---|---|---|---|
| message | String | Y | N |
Return:
| Type | Description |
|---|---|
| Void | The function does not return a value. |
Example:
log.warn("Unsolved collisions")
error(message)
Use this function to display an error message.
Parameters:
| Name | Type | Mandatory | Default value |
|---|---|---|---|
| message | String | Y | N |
Return:
| Type | Description |
|---|---|
| Void | The function does not return a value. |
Example:
log.error("The transformation script is completed")
The map object
When processing import, you can use the following functions with the map object, in addition to the SimpleImport class methods.
getId()
Use this function to get the current record ID of the Transform Map (sys_transform_map) table.
Return:
| Value | Description |
|---|---|
| String | The function returns the current record ID of the Transform Map (sys_transform_map) table. |
Example:
map.getId()
getScript()
Use the function to return the script of the current Transform Map(sys_transform_map) record.
Return:
| Type | Description |
|---|---|
| String | The function returns the script of the current Transform Map(sys_transform_map) record. |
Example:
map.getScript()
getSourceTableId()
Use this function to get the ID of the source table.
Return:
| Type | Description |
|---|---|
| String | The function returns the ID of the source table. |
Example:
map.getSourceTableId()
getSourceTableName()
Use this function to get the name of the source table.
Return:
| Type | Description |
|---|---|
| String | The function returns the name of the source table. |
Example:
map.getSourceTableName()
getTargetTableId()
Use this function to get the ID of the target table.
Return:
| Type | Description |
|---|---|
| String | The function returns the ID of the target table. |
Example:
map.getTargetTableId()
getTargetTableName()
Use this function to get the name of the target table.
Return:
| Type | Description |
|---|---|
| String | The function returns the name of the target table. |
Example:
map.getTargetTableName()
isActive()
Use this function to get the value of the Active checkbox in the current record of the Transform Map(sys_transform_map) table.
Return:
| Type | Description |
|---|---|
| Boolean | The function returns true if the checkbox is selected. |
Example:
map.isActive()
isIgnoreMandatoryFields()
Use this function to get the value of the Ignore Mandatory Fields checkbox in the current record of the Transform Map(sys_transform_map) table.
Return:
| Type | Description |
|---|---|
| Boolean | This function returns true if the checkbox is selected. |
Example:
map.isIgnoreMandatoryFields()
isSilentLoad()
Use this function to get the value of the Silent Load checkbox in the current record of the Transform Map(sys_transform_map) table.
Return:
| Type | Description |
|---|---|
| Boolean | This function returns true if the checkbox is selected. |
Example:
map.isSilentLoad()
isUseScript()
Use this function to get the value of the Use Script checkbox in the current record of the Transform Map(sys_transform_map) table.
Return:
| Type | Description |
|---|---|
| Boolean | This function returns true if the checkbox is selected. |
Example:
map.isUseScript()