Data transformation for the patch orchestration integration with HCL BigFix
Summarize
Summary of Data transformation for the patch orchestration integration with HCL BigFix
This integration enables ServiceNow customers to import, process, and transform data from HCL BigFix into their ServiceNow AI Platform® instance. The data includes assets, fixlets, device fixlets, and deployment actions, which are loaded into specific import tables and processed through dedicated transform maps with embedded scripts. This process ensures that patch orchestration data is accurately reflected and integrated within ServiceNow’s vulnerability response workflows.
Show less
Key Features
- BigFix Collection Import: Imports asset data (computers and groups) into the
snvulbigfixcollectionimporttable and transforms it using the “BigFix Computer and Computer Groups Import TM.” This transform map manages creation and updates of configuration items (CIs) and their relationships based on CI Lookup Rules. - BigFix Fixlet Import: Loads fixlet data into the
snvulbigfixpatchupdateimporttable and uses the “BigFix Fixlet Import TM” for transformation. Key fixlet attributes such as unique IDs, titles, source, severity, categories, release dates, and applicability counts are mapped and scripted for internal processing. - BigFix Device Fixlet Import: Imports fixlet data relevant to computers into
snvulbigfixdevicepatchimportand uses the “BigFix Device Fixlet TM” transform map to create and update CIs and their relationships. - BigFix Actions Import: Imports deployment action data into
snvulbigfixdeploymentimportand transforms it with the “BigFix Actions Import TM.” It captures details such as action IDs, status, success counts, retries, deployment times, and references to patches and discovered items.
Transformation Process and Script Usage
- Each transform map uses scripts executed at three stages: OnStart (initializes integration scope variables), onBefore (performs creation and updates of CIs or related records, modifies scope variables), and onComplete (records counts of created, updated, and ignored records).
- These scripts are for internal use to maintain data integrity and should not be modified or deleted.
- Changes to transform maps directly affect how imported BigFix data is processed and integrated into ServiceNow.
Practical Implications for ServiceNow Customers
- Customers can leverage this integration to automate and synchronize patch-related data from HCL BigFix within ServiceNow, enabling more effective vulnerability management and patch orchestration.
- Understanding the import tables and transform maps helps in troubleshooting data import issues and customizing integration behavior if necessary (with caution regarding script modifications).
- Access to transform maps is through ServiceNow’s System Import Sets > Transform Maps module, allowing visibility into how external BigFix data maps into ServiceNow tables.
Data is retrieved from the Vulnerability Response patch orchestration with HCL BigFix integration, processed through a set of data sources, and transformed in your ServiceNow AI Platform® instance.
BigFix Collection import
| Script | Description |
|---|---|
| OnStart (when an import set has created transformation). | Script used to initialize the values in the scope variable [sn_vul_bigfix] for the integration process. This script is for internal use and should not be modified or deleted. |
| onBefore (before an import set has completed transformation). | Script used to create and update CIs based on CI Lookup Rules and collections as well as relation between them. Based on the results, this script modifies the values in the scope variable [sn_vul_bigfix]. This script is for internal use and should not be modified or deleted. |
| onComplete (when an import set has completed transformation). | Script that is used to set the number of CIs created, updated, and ignored. This script is for internal use and should not be modified or deleted. |
BigFix Fixlet import
The data from the imported fixlets are loaded into BigFix Fixlet Import [sn_vul_bigfix_patch_update_import] table.
BigFix Fixlet Import TM is used to transform the imported information.
To access this transform map, navigate to and locate the BigFix Fixlet Import TM.
The following table lists the transform map fields by integration.
| Source field | Target field | Description |
|---|---|---|
| u_id | article_id | Unique Id of a fixlet in a site. |
| u_id | source_id | Unique Id of a fixlet in a site. |
| U_site_name | Sn_vul_bigfix_site_name | Site name in BigFix where the Fixlet relies. |
| U_display_name | Title | Title of the Fixlet. |
| [Script] | Bulletin_id | Source id of the solution. |
| [Script] | Sn_vul_solution | Solution based on the source id. |
| U_source | bulletin_source | Source vendor of the solution. |
| [Script] | Date_release | Release date of the fixlet. |
| U_category | Update_category | Category of the fixlet. |
| [Script] | Is_highest_supersedence | Boolean for if the fixlet is highest supersedence or not. |
| [Script] | Is_downloaded | Boolean of if the fixlet is downloaded or not. |
| [Script] | Integration_instance | Name of the instance from which the fixlet is imported. |
| U_source_severity | Source_severity | Severity of the fixlet. |
| U_applicable_count | Num_total | Total number of devices with missing fixlets. |
| [Script] | Last_modified | Last modified date of fixlet. |
| Script | Description |
|---|---|
| OnStart (when an import set has created transformation). | Script that is used to initialize the values in the scope variable [sn_vul_bigfix] for the integration process. This script is for internal use and should not be modified or deleted. |
| onBefore (before an import set has completed transformation). | The script that is used to update the values in the scope variable [sn_vul_bigfix]. This script is for internal use and should not be modified or deleted. |
| onComplete (when an import set has completed transformation). | Script that is used to set the number of fixlets created, updated, and ignored. This script is for internal use and should not be modified or deleted. |
BigFix Device Fixlet Import
The data from the imported relevent fixlets on computers are loaded into the BigFix Device Fixlet Import [sn_vul_bigfix_device_patch_import] table.
BigFix Device Fixlet TM is used to transform the imported information.
To access this transform map, navigate to and locate the BigFix Device Fixlet TM.
The following table lists the transform map fields by integration.
| Script | Description |
|---|---|
| OnStart (when an import set has created transformation). | Script that is used to initialize the values in the scope variable [sn_vul_bigfix] for the integration process. This script is for internal use and should not be modified or deleted. |
| onBefore (before an import set has completed transformation). | Script that is used to Create and Update CIs based on CI Lookup Rules and collections as well as relation between them. Based on the results, this script modifies the values in the scope variable [sn_vul_bigfix]. This script is for internal use and should not be modified or deleted. |
| onComplete (when an import set has completed transformation). | Script that is used to set the number of CIs created, updated, and ignored. This script is for internal use and should not be modified or deleted. |
BigFix Actions Import
The data from the imported actions are loaded into the BigFix Actions Import [sn_vul_bigfix_deployment_import] table.
The BigFix Actions Import TM is used to transform the imported information.
To access this transform map, navigate to and locate the BigFix Fixlet Import TM.
The following table lists the transform map fields by integration.
| Source field | Target field | Description |
|---|---|---|
| u_id | source_id | Unique Id of an action. |
| U_name | name | Name of the action |
| [Script] | Sn_vul_bigfix_discovered_item | Reference of the discovered item on which the patch is deployed |
| U_status | status | Status of the action |
| [Script] | Sn_vul_patch_orch_update | Reference of the patch |
| U_apply_count | Count_success | Success count of action. |
| U_retry_count | retry | Retry count of the action. |
| [Script] | Deployment_time | Start time of the action. |
| [Script] | deadline | End time of the action. |
| [Script] | Source_created | Creation time of the action. |
| [Script] | Integration_instance | Name of the instance from which the action is imported. |
| Script | Description |
|---|---|
| OnStart (when an import set has created transformation). | Script that is used to initialize the values in the scope variable [sn_vul_bigfix] for the integration process. This script is for internal use and should not be modified or deleted. |
| onBefore (before an import set has completed transformation). | The script that is used to update the values in the scope variable [sn_vul_bigfix]. This script is for internal use and should not be modified or deleted. |
| onComplete (when an import set has completed transformation). | Script that is used to set the number of actions created, updated, and ignored. This script is for internal use and should not be modified or deleted. |