Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
This class provides methods that allow importing data from external parties.
SimpleImport()
Instantiates a new SimpleImport class object.
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
letconst imp = new SimpleImport(); |
getErrorMessage()
This method returns the current error message.
Return:
Type | Description |
---|---|
String | The error message text |
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
const imp = new SimpleImport(); if (imp.transform(current)) { ss.addInfoMessage('Import succeeded'); } else { ss.addErrorMessage(imp.getErrorMessage()); } |
import(record, testMode)
The method takes the a record from the the Import Sources (sys_import_source) tables and imports the entries from the attachment to the table created via the import_set_table_name field of the the Import Set Table Name field of the Import Sources (sys_import_source table) table. As a result, we get a table with temporary records - – an Importsetimport set, from which the system will import records import to any other table will be performed.
The record parameter must should be the a record from the the Import Sources (sys_import_source) table.
The testmode parameter is a Boolean parameter. If its value is TRUE'true', then it will perform the test import and indicate operation status as "test".
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
record | SimpleRecord | Y | N |
testMode | Boolean | NFALSE | 'false' |
Return:
Type | Description |
---|---|
VoidBoolean | This method does not return a valuereturns '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()) constvar 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)
This method is used for the automatic scheduled import.
The record parameter must be the record from the the Scheduled Imports (sys_schedule_import table) table.
Method gets the record from the the Scheduled Imports (sys_schedule_import table ) table and performs import and transform in one time.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
record | SimpleRecord | Y | N |
Return:
Type | Description |
---|---|
Void | This method does not return a value. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
constvar imp = new SimpleImport(); imp.importTransform(current); |
testLdapConnection(record)
This method checks the connection to the LDAP server and alerts about the successful connection, or about an error.
The record parameter must be the filled with the sys_id of the LDAP server (The record parameter must be the record from the sys_ldap_server or sys_ldap_definition tables.) table element related with this connection.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
record | SimpleRecord (object of the LDAP server (sys_ldap_server) table) | Y | N |
Return:
Type | Description |
---|---|
Object | Returns an object containing LDAP server connection status or connection error message (in case of connectivity issues). |
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)
This method checks all connections This method checks the connection to the LDAP server and alerts about the successful connection, or about an error.
The record parameter must be the filled with the sys_id of the LDAP server (sys_ldap_server) table element related with this connection.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
record | SimpleRecord (object of the LDAP server (sys_ldap_server) table) | Y | N |
Return:
Type | Description |
---|---|
ArrayObject | Returns array containing description of connection statusan object containing LDAP server connections statuses or connection error messages (in case of connectivity issues). |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
varconst imp = new SimpleImport(); varconst result = imp.testLdapConnectiontestLdapConnections(current); if (result.flash.type === "success") { ss.addInfoMessage(result.flash.message); return; } if (result.flash.type === "error") { ss.addErrorMessage(result.flash.message); } |
transform(record)
This method transposes entries from the import set to the table. It uses the active transform map, which is located in the the Transform Maps (sys_map_transform tabletransform_map) table.
- source - the current import set table
- target - the destination import set table.
The record parameter must be the entry from the the Import Set (sys_import_set) table.
A transform map is a set of field maps that determine the relationships between fields in an import set and fields in an existing table.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
record | SimpleRecord | Y | N |
Return:
Type | Description |
---|---|
Void | This method does not return a value. |
Example:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
constvar imp = new SimpleImport(); imp.transform(current); |
Table of Contents | ||||
---|---|---|---|---|
|