Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
This class provides methods for importing data from external sources.
SimpleImport()
Use this constructor to instantiate a new SimpleImport class object.
Example:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
const imp = new SimpleImport(); |
getErrorMessage()
Use this method to get an error message.
Return:
Type | Description |
---|---|
String | The This method returns the error message text |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
const imp = new SimpleImport(); if (imp.transform(current)) { ss.addInfoMessage('Import succeeded'); } else { ss.addErrorMessage(imp.getErrorMessage()); } |
import(record, testMode)
Use this method to import records. The method takes a record from the Import Sources (sys_import_source) table and imports the records from the attachment to the table created via the Import set table name field. As a result, there is a table with temporary records: an import set, from which the system imports the records to the target table.
The record parameter should be a record from the Import Sources (sys_import_source) table.
The testmode parameter is a Boolean parameter. If its value is true, the test import is performed and the operation status as "test" is displayed.
Parameter(s):
Name | Type | Mandatory | Default value |
---|---|---|---|
record | SimpleRecord object | Y | N |
testMode | Boolean | N | false |
Return:
Type | Description |
---|---|
Boolean | This method returns true if the import has been completed successfully; otherwise, it returns false. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
const current = new SimpleRecord('sys_import_source'); current.name='Test Imp JSON' current.format='JSON' current.import_set_table_name = 'c_imp_text_json2'; current.import_text = '{"token":"example_Token","user":"zabix_user","title":"Problem: Agent is not available (for 3m)","message":"Problemverity: Average","url":"/tr_events.php","url_title":"ZabbixUrlTitle","priority":"0"}'; current.type = 'Text'; current.insert(); ss.info("RecordImp: " + current.getErrors()) const imp = new SimpleImport(); const result = imp.import(current); if (result) { ss.addInfoMessage("Import successful"); return; } else { ss.info("Errors Import: " + imp.getErrorMessage()); ss.addErrorMessage("Import failed"); } |
importTransform(record)
Use this method to initiate a scheduled import.
The record parameter must be the record from the Scheduled Imports (sys_schedule_import) table.
The method gets a record from the Scheduled Imports (sys_schedule_import)table, imports, and transforms it at the same time.
Parameter(s):
Name | Type | Mandatory | Default value |
---|---|---|---|
record | SimpleRecord object | Y | N |
Return:
Type | Description |
---|---|
Void | This method does not return a value. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
const imp = new SimpleImport(); imp.importTransform(current); |
testLdapConnection(record)
Use this method to verify the connection to the LDAP server. The method contains a message about a successful connection or error.
The record parameter must be the filled with the ID of the LDAP Server (sys_ldap_server)table record related to this connection.
Parameter(s):
Name | Type | Mandatory | Default value |
---|---|---|---|
record | SimpleRecord object | Y | N |
Return:
Type | Description |
---|---|
Object | The method returns an object containing an LDAP server connection status or a connection error message. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
const imp = new SimpleImport(); const result = imp.testLdapConnection(current); if (result.flash.type === "success") { ss.addInfoMessage(result.flash.message); return; } if (result.flash.type === "error") { ss.addErrorMessage(result.flash.message); } |
testLdapConnections(record)
Use this method to verify all connections to the LDAP server. The method contains a message about a successful connection or error.
The record parameter must be the filled with the ID of the LDAP Server (sys_ldap_server)table record related to this connection.
Parameter(s):
Name | Type | Mandatory | Default value |
---|---|---|---|
record | SimpleRecord object | Y | N |
Return:
Type | Description |
---|---|
Object | The method returns an object containing LDAP server connections statuses or connection error messages. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
const imp = new SimpleImport(); const result = imp.testLdapConnections(current); if (result.flash.type === "success") { ss.addInfoMessage(result.flash.message); return; } if (result.flash.type === "error") { ss.addErrorMessage(result.flash.message); } |
transform(record)
Use this method to transfer the records from the source Import Set table to the target table. It uses the active transform map, which is located in the Transform Maps (sys_transform_map) table.
The record parameter must be the entry from the Import Set (sys_import_set) table.
A transform map is a set of records that determine how the fields of the import table correspond to the fields of the target table.
Parameter(s):
Name | Type | Mandatory | Default value |
---|---|---|---|
record | SimpleRecord object | Y | N |
Return:
Type | Description |
---|---|
Boolean | This method returns true when the transformation is successful; otherwise, it returns false. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
const imp = new SimpleImport(); imp.transform(current); |
Table of Contents | ||||
---|---|---|---|---|
|