You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

This class contains methods for importing data from external parties.

SimpleImport()


Use this constructor to instantiate a new SimpleImport class object.

Example:

SimpleImport
const imp = new SimpleImport();

getErrorMessage()


Use this method to get an error message.

Return:

TypeDescription
StringThe error message text

Example:

getErrorMessage()
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):

NameTypeMandatoryDefault value
recordSimpleRecordYN
testModeBooleanNfalse

Return:

TypeDescription
BooleanThis method returns true if the import has been completed successfully; otherwise, it returns false.

Example:

import()
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):

NameTypeMandatoryDefault value
recordSimpleRecordYN

Return:

TypeDescription
Void

This method does not return a value.

Example:

importTransform()
const imp = new SimpleImport();
imp.importTransform(current);

testLdapConnection(record)


This method verifies the connection to the LDAP server and alerts about a 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 record related to this connection.  

Parameter(s):

NameTypeMandatoryDefault value
record

SimpleRecord

(object of the LDAP server (sys_ldap_server) table)

YN

Return:

TypeDescription
ObjectThe method returns an object containing an LDAP server connection status or a connection error message (in case of connectivity issues).

Example:

testLdapConnection()
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 verifies all connections to the LDAP server and alerts about a 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 record related to this connection. 

Parameter(s):

NameTypeMandatoryDefault value
record

SimpleRecord

(object of the LDAP server (sys_ldap_server) table)

YN

Return:

TypeDescription
ObjectThe method returns an object containing LDAP server connections statuses or connection error messages (in case of connectivity issues).

Example:

testLdapConnection()
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)


This method transfers the records from the Import set (sys_import_set) table to the target table. It uses the active transform map, which is located in the Transform Maps (sys_transform_map) table.

  • source – the current import table
  • target – the destination import 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):

NameTypeMandatoryDefault value
recordSimpleRecordYN

Return:

TypeDescription
BooleanThis method returns true when the transformation is successful; otherwise, it returns false.

Example:

transform()
const imp = new SimpleImport();
imp.transform(current);

  • No labels