RTE transforms template scripts included within the Integration Commons for CMDB app

The Robust Transform Engine (RTE) transforms are templated operations included within the Integration Commons for CMDB (sn_cmdb_int_util) store app.

The following script-based RTE transforms are available in the Integration Commons for CMDB app.

CI Lookup Operation

Use to get the value of a field on an existing configuration item (CI) in the CMDB by the source native key.

The Source [sys_object_source] table is queried using the discovery source and source native key ordering by the last scan. The table iterates through the results of the query and queries the target table by the target sys ID until a valid CI is found. After a valid CI is found, the operation returns the value of the CI Field on the matching CI.

Cleanse Company

Use to cleanse hardware manufacturer name and add the record to the Company [core_company] table to populate a reference, when the manufacturer is not linked to a model or software (cpu_manufacturer).

If a matching record does not exist, then a new record is created in core_company so the return always includes a sys_id and name (unless the input is empty or invalid). The name is cleansed and a fuzzy lookup is done via the CmdbIntegrationCompanyModelUtil script include before the MakeAndModelJS platform API is called.

Cleanse Hardware Model

Use to create, cleanse, or lookup a hardware model to create a reference (model_id).

For either the manufacturer or model, if a matching record does not exist then a new record is created so the return always includes sys_ids and names for both records (unless the input is empty or invalid).

The manufacturer name is processed like the Cleanse Company transform and then the manufacturer name and model name are sent to the MakeAndModelJS platform API.

Cleanse Hardware Model with Model Number

Use to create, cleanse, or lookup a hardware model to create a reference (model_id).

For either the manufacturer or model, if a matching record does not exist then a new record is created so the return always includes sys_ids and names for both records (unless the input is empty or invalid).

The manufacturer name is processed like the Cleanse Company transform and then the manufacturer name, model name, and model number are sent to the MakeAndModelJS platform API.

Cleanse IP Address

Use when a field provides an IP address.

The IP address is tested for both IPv4 and IPv6 structures along with some known derivations (an IPv4 with spaces instead of periods). If a result is found, then it is formatted and returned.

Cleanse IP Version

Use when the source of data does not provide an IP version or when the IP version might be unreliable.

The input IP address value is checked for either proper IPv4 or IPv6 structure, otherwise the return is empty. This function provides no IP cleansing.

Cleanse MAC Address

Use when a field provides a MAC address.

The MAC address is tested for proper structure along with some known derivations (for example, a MAC address with spaces instead of colons). If a result is found, then it is formatted and returned.

Cleanse Operating System

Use to extract, cleanse, and format an operating system name, when the source provides an operating system value.

Most of the current cleansing is centered on Microsoft operating system values aside from common cleansing such as fixing casing.

Cleanse Serial Number

Use to cleanse and remove invalid serial numbers.

Cleanse Serial Number With Alternate Value Return if Invalid

Use to cleanse Serial Number and verify the length of the cleansed serial number. Returns the alternate value if the length of serial number is invalid.

The operation cleanses the serial number and checks If the cleansed serial number length is greater than or equal to the value specified in the sn_cmdb_int_util.minimum_valid_serial_number_length system property. The default value of the property is set to 7.

Cleanse IMEI Number With Alternate Value Return if Invalid

Use to cleanse the IMEI number and verify the length of the cleansed IMEI number. Returns the alternate value if the length of IMEI number is invalid.

The operation cleanses the IMEI number and checks If the cleansed IMEI number length is equal to the value specified in the sn_cmdb_int_util.valid_imei_number_length system property. The default value of the property is set to 15.

Cleanse Software Model

Use to cleanse and create a software model. Also, to create manufacturer and software model if they do not exist and follow with a split operation.

If a matching manufacturer record does not exist, then a new record is created so the return always includes the sys_id and name for the manufacturer (if the manufacturer is not empty or invalid).

The manufacturer name is processed the same as in the Cleanse Company transform and then the manufacturer name is sent to the MakeAndModelJS platform API.

The software name and version are cleansed and formatted and returned. The version is removed from the software name if present.

Create Software Instance Name

Use when a hardware name, software name, and software version is provided, to create a new software instance name.

Derive CI Class from Model

Use when processing a computer record and a model is provided but the class of the computer is ambiguous otherwise. Can be used along with other Derive CI Class transforms.

Does not return a value of a class which is higher in the class hierarchy (a parent class) than the provided input class. For example, does not return cmdb_ci_computer if the input is cmdb_ci_server. Looks only at the cmdb_ci_computer hierarchy, going through cmdb_ci_server (cmdb_ci_computer, cmdb_ci_server, children of cmdb_ci_server).

Currently looks for Server, Windows Server, and Linux Server indicators in the model.

Derive CI Class from Native Class Identifier

Use when processing a computer record and a native class indicator is provided but the class of the computer is ambiguous otherwise. Can be used along with other Derive CI Class transforms.

Does not return a value of a class which is higher in the class hierarchy (a parent class) than the provided input class. For example, does not return cmdb_ci_computer if the input is cmdb_ci_server. Looks only at the cmdb_ci_computer hierarchy, going through cmdb_ci_server (cmdb_ci_computer, cmdb_ci_server, children of cmdb_ci_server).

Currently looks for Server, Windows Server, and Linux Server indicators in the native identifier.

Derive CI Class from Operating System

Use when processing a computer record and an operating system is provided but the class of the computer is ambiguous otherwise. Can be used along with other Derive CI Class transforms.

Does not return a value of a class which is higher in the class hierarchy (a parent class) than the provided input class. For example, does not return cmdb_ci_computer if the input is cmdb_ci_server. Looks only at the cmdb_ci_computer hierarchy, going through cmdb_ci_server (cmdb_ci_computer, cmdb_ci_server, children of cmdb_ci_server).

Currently looks for Server, Windows Server, and Linux Server indicators in the operating system name.

Derive Virtual From Hardware Model

Use when processing a computer record that may be virtual, a hardware model is provided, and the virtual status is ambiguous. Can be used along with other Derive Virtual From transforms.

Looks for indicators in the model name for a virtual device (VMware).

Derive Virtual From Native Indicator

Use when processing a computer record that may be virtual, a virtual indicator is provided by the source, and the virtual status is ambiguous. Can be used along with other Derive Virtual From transforms.

Tests native indicator against a list of common values and looks for a ‘true’ boolean indicator.

Derive Virtual From Serial Number

Use when processing a computer record that may be virtual, a serial number is provided by the source, and the virtual status is ambiguous. Can be used along with other Derive Virtual From transforms.

Looks for indicators in the serial number for a virtual device (VMware).

Extract and Scale by Units

Use when the source has numerical values that need to be scaled and numerical value with an input such as 2048Mb. The source does not always provide the units so it may be required to calculate or guess the units being provided. The target units depend on the target field in the CMDB. If not specified, the decimal place field is set at 2 by default.

Note: This field is case sensitive.

First Non Null Value

Use when you have a list of fields providing similar information that must map to a single field and you want to rank the order in which they can provide those values.

For Example Internally in SolarWinds, there is a hierarchy of tables that are join. In one example, a computer’s name could come from the child most table or any of that tables parents but each of those is a separate field in the pull. Starting with the most specific table, the values are searched for the first instance of a name value.

Process Name, Domain, FQDN, DNS set

Use when the source provides name, domain, FQDN, or DNS information. Can be used for only a subset of these (if for example, the source only provides name and domain). In the case that a source only provides fields that are lower in the input list (FQDN) the CmdbIntegrationHardwareNameUtil script include can be called from a script operation to minimize having to create empty dummy fields.

FQDN and DNS are first processed to see if their formats are correct. FQDN has an additional discovery regex it must pass (via properties): glide.discovery.fqdn.regex – default : ^([^.]+)\\.((?:[^.]+\\.)+[^.]+)$

Possible name and domain values are extracted if possible. When name and domain are processed, if there is no FQDN, a value is generated if possible. A resulting name value is also modified using the following discovery flags:

1. glide.discovery.hostname.case – default: No change. Can be set to ‘Lower case’, ‘Upper case’, ‘No change’
2. glide.discovery.hostname.include_domain – default: false. If ‘true’ the domain is added to the final name value

Process FQDN

Use when the source provides a suspected FQDN value but no other naming fields such as name, domain, or DNS.

The processing follows the same logic as the ‘Process Name, Domain, FQDN, DNS set’ transform except that only FQDN is used as an input.

Scale Unit

Use when the source has numerical inputs that must be scaled. The source does not always provide the current units so it may be required to calculate or guess the units being provided. The target units depend on the field being targeted in the CMDB.

Software Bundle ID Lookup

Use when a source, such as Jamf, does not provide the software publisher but does provide a Mac software bundle ID. Software Bundle ID Lookup looks up records in the Bundleid Lookup [sn-cmdb_int_util_bundleid_lookup] table by bundle_id. If a record with the specified bundle_id exists, it extracts the respective software publisher. Otherwise, it creates a new record which will be queried the next time the Lookup Mac Software Bundle IDs data source runs.

User Lookup

Use to look up a user in the User [sys_user] table by user name or email, attempting to match in the following order:

1. The User Name matching the user_name attribute.
2. The Email matching the email attribute.
3. If nothing is matching, it returns empty.