Data transformation for the patch orchestration integration with HCL BigFix

  • Release version: Yokohama
  • Updated January 30, 2025
  • 5 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of Data transformation for the patch orchestration integration with HCL BigFix

    This document explains how data is imported and transformed within ServiceNow's AI Platform® as part of the patch orchestration integration with HCL BigFix. Various imported data types—assets, fixlets, device fixlets, and actions—are processed through specific import tables and transform maps. These transform maps contain scripts that handle data initialization, transformation, and finalization to ensure accurate creation and updating of Configuration Items (CIs) and related records.

    Show full answer Show less

    Data Import and Transformation Components

    • BigFix Collection Import: Imported assets such as computers and groups are stored in the snvulbigfixcollectionimport table and transformed using the "BigFix Computer and Computer Groups Import TM" transform map. This map manages CI creation and relationships.
    • BigFix Fixlet Import: Imported fixlets are loaded into snvulbigfixpatchupdateimport and processed via the "BigFix Fixlet Import TM" transform map. Key fields include fixlet IDs, titles, severity, categories, and deployment counts.
    • BigFix Device Fixlet Import: Relevant fixlets linked to devices are imported into snvulbigfixdevicepatchimport and transformed by the "BigFix Device Fixlet TM" transform map, which updates CIs based on lookup rules and collections.
    • BigFix Actions Import: Imported patch deployment actions are stored in snvulbigfixdeploymentimport and transformed with the "BigFix Actions Import TM" transform map. It processes action IDs, status, success counts, retry counts, and timestamps.

    Transform Map Scripts and Their Roles

    Each transform map includes three main scripts that govern the transformation process:

    • OnStart: Initializes variables within the [snvulbigfix] scope for the integration process. This script is for internal use and should not be modified.
    • onBefore: Executes before transformation completion to create and update CIs, establish relations, and update scope variables. This is also for internal use without modification.
    • onComplete: Runs after transformation to record the count of created, updated, and ignored records. It is intended for internal use only.

    Practical Implications for ServiceNow Customers

    Understanding these import tables and transform maps is critical when managing or troubleshooting patch orchestration with HCL BigFix integration. Any modifications to transform maps directly affect how imported BigFix data is processed and represented in ServiceNow. Therefore, customers should avoid altering the provided scripts to maintain data integrity and consistent integration behavior.

    These processes enable customers to accurately track and manage patch deployment data, asset relationships, and update statuses within ServiceNow, supporting effective vulnerability response and patch management workflows.

    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

    The data from the imported assets (computers and computer groups) are loaded into the BigFix Collection Import [sn_vul_bigfix_collection_import] table. The BigFix Computer and Computer Groups Import TM (transform map?) is used to transform the imported information.
    Note:
    Changes to this transform map alter how data from the BigFix Collection import is processed.
    To access this transform map, navigate to System Import Sets > Transform Maps and locate BigFix Computer and Computer Groups Import TM. The following table lists the transform map fields by integration.
    Table 1. BigFix Computer and Computer Groups import transform map script timing
    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.

    Note:
    Changes to this transform map alter how data from the BigFix Fixlet import is processed.

    To access this transform map, navigate to System Import Sets > Transform Maps and locate the BigFix Fixlet Import TM.

    The following table lists the transform map fields by integration.

    Table 2. BigFix Fixlet import transform map fields
    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.
    Table 3. BigFix Fixlet import transform map script timing
    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.

    Note:
    Changes to this transform map alter how data from the BigFix Device Fixlet import is processed.

    To access this transform map, navigate to System Import Sets > Transform Maps and locate the BigFix Device Fixlet TM.

    The following table lists the transform map fields by integration.

    Table 4. BigFix Device Fixlet transform map script timing
    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.

    Note:
    Changes to this transform map alter how data from the BigFix Actions import is processed.

    To access this transform map, navigate to System Import Sets > Transform Maps and locate the BigFix Fixlet Import TM.

    The following table lists the transform map fields by integration.

    Table 5. BigFix Actions Import transform map fields
    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.
    Table 6. BigFix Actions import transform map script timing
    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.