...
Below are explanations for the attributes used by an Integration.
create_internal_from_external: When integrating devices from the external system, if the device doesn't exist in Open-AudIT should we create it?update_internal_from_external: When integrating devices from the external system, if the device has been updated in the external system should we update it in Open-AudIT?discovery_run: When retrieve an external device, should we run discovery upon it?
select_internal_type: How should we select devices to be integrated (using an Attribute, Query or a Group).select_internal_attribute: The attribute to test (from the 'system' table).select_internal_value: This item must match the value of the attribute selected.
create_external_from_internal: If an Open-AudIT device is not on the external system, should we create it.update_external_from_internal: If an Open-AudIT device has been changed, should we update the external system.delete_external_from_internal: If a remote device does not exist in the Open-AudIT selected devices, should we delete it from the remote system.
select_external_type: Which devices should Open-AudIT create from the remote system (if any). Using All, None or a given Attribute.select_external_attribute: The attribute to test (must match an external field name from below).select_external_value: This item must match the value of the attribute selected.
fields:
...
A
...
JSON
...
array
...
of
...
objects,
...
as
...
below.
Fields
The fields associated with an Integration are stored in the database as a JSON array of objects. Each field has the following attributes:
internal_field_name: This should be the fully qualified field name in the database. Currently columns from the system, fields and credentials tables are supported. EG: system.nmis_role.
external_field_name: The fully qualified name returned by the external system. EG: for NMIS we use configuration.roleType.
priority: When combining devices, which system is the authoritative source for information.
default_value: If no value is present, supply this value. EG: for system.nmis_group / configuraion.group we use Open-AudIT.
matching_attribute: Should we use this value to match external and internal devices. Our default Integration uses IP and UUID here. If either of these match between external and internal device, we consider them to be the same device.
external_field_type: When we are converting an internally selected device to an object for the external system, what should the external data be. EG: integer, string, etc.
External Field Types
text: a text field
integer: a number
bool: true or false (in JSON context)
bool_one_zero: If the local field is true (bool) or y (string) or Y (string) or 1 (integer) then set the external data to 1.
bool_y_n: If the local field is true (bool) or y (string) or Y (string) or 1 (integer) then set the external data to y.
capitalize: Set the external text to capitalized version of the internal data.
lower: Set the external text to lowercase.
upper: Set the external text to uppercase.
datetime_now: The current date and time in the format "Y-m-d H:i:s".
datetime_Y-m-d H:i:s: The internal value, reformatted in this format.
date_now: The current date in "Y-m-d" format.
date_Y-m-d: The internal value, reformatted in this format.
date_m-d-Y: The internal value, reformatted in this format.
date_d-m-Y: The internal value, reformatted in this format.
...