Import run details

  • Release version: Xanadu
  • Updated August 1, 2024
  • 4 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 Import run details

    This documentation explains how to view detailed information about import set runs, individual rows in the import set, and import logs within ServiceNow. It covers two methods for processing import sets: using robust import set transformers and transform maps. After running an import, you can examine the import history through related tabs that provide comprehensive details to monitor and troubleshoot your import processes.

    Show full answer Show less

    Import Methods

    • Robust import set transformers: A modern, flexible approach that separates data transformation and processing. Data is extracted into an intermediary structure, transformed as needed, and then loaded into one or more target tables. Records are processed in batches to improve performance.
    • Transform maps: A legacy method that combines transformation and processing in a single step. It maps data from an import set staging table to a single target table and requires loading, transforming, and inserting data each time it runs.

    Import Set Runs

    The Import Set Runs tab details individual import executions including:

    • Started/Completed: Date and time of import start and finish in the user’s time zone.
    • State: Status of the import (Cancelled, Complete, Complete with errors, Did not complete, Running).
    • Run time: Total duration of the import process.
    • Totals: Number of rows processed, inserted, updated, ignored, skipped, and errors encountered—varying slightly by import method.
    • Associated map or transformer: Shows which transform map or robust transformer was used for the import.

    Import Set Rows

    The Import Set Rows tab provides details of each row included in the import, including:

    • Created: Timestamp of the row’s creation.
    • Row number and state: Position and status of the row import.
    • Target record: The updated record for transform map imports; for robust transformers, target records are viewed via the Transform Target Rows tab.
    • Error and comments: Any error details or comments generated by transform scripts.

    Target Records for Robust Import Set Transformers

    When using robust import set transformers, enabling verbose mode provides enhanced logging and detailed transform target row information for each import row. This mode helps track the state (Inserted, Updated, Error), target records, import association, and error messages, improving debugging and traceability.

    Import Log

    The Import Log tab displays chronological logs of the import process, including timestamps, log levels, messages, and sources. This log aids in diagnosing issues and understanding the import flow in detail.

    View detailed information about import set runs, individual rows in the import set, and import logs.

    There are two ways to run or process an import set. The data displayed after the run varies slightly depending on which way you choose.
    Robust import set transformers
    Separate the transform and processing functions, providing a more flexible alternative to transform maps. Robust import set transformers enable you to extract data from a source table into an intermediary data structure. You can transform the data as desired and then load that data to one or more target tables. Records are processed as batches to enhance performance. For more information, see Robust Import Set Transformers.
    Transform maps
    Legacy method to map data from an import set staging table to a single target table. Transform maps combine the transform and processing functions into a single process. Each time you run a transform map, the system must load data from the import set staging table, transform it, and then insert it into a single target table. You can define multiple table mappings with multiple transform maps. For more information, see Transform maps.

    After running the import, you can view the import history by navigating to the Import Set record and checking the tabs below the Related Links section. They cover the import set runs, import set rows, and import log.

    Import Set Runs

    The Import Set Runs tab provides details about individual imports.
    Figure 1. Sample data for a completed import done with a robust import set transformer
    An Import Set record showing the Import Set Runs tab.
    The following table provides more details about the fields in the image.
    Field Description
    Started Date and time the import started. Given in the time zone of the logged-in user.
    State State of the import. Options are:
    • Cancelled
    • Cancel requested
    • Complete
    • Complete with errors
    • Did not complete
    • Running
    Completed Date and time the import finished. Given in the time zone of the logged-in user.
    Run time Total amount of time the import required to run.
    Total

    Total number of import set rows.

    For an import using a robust import set transformer, this field is the total number processed, ignored, skipped, and with errors.

    For an import using a transform map, this field is the total number inserted, updated, ignored, skipped, and with errors.
    Inserts Number of records inserted.
    Updates Number of records updated.
    Processed Number of records processed.
    Ignored

    Number of records ignored.

    An ignored record is one the user has specified should be ignored during an import. For example, you can identify records to ignore with the ignore variable in an onBefore script. For more information, see Create Extract Transform Load (ETL) definitions.
    Skipped

    Number of records skipped.

    A skipped record is one that has been skipped by the system, due to an internal issue.
    Errors Number of errors encountered during the import.
    Transform Map If data is imported using a transform map, the associated map is shown here.
    Robust Transformer If data is imported using a robust import set transformer, the associated transformer is shown here.

    Import Set Rows

    The Import Set Rows tab provides details about rows included in the import set run.
    Figure 2. Sample data for the three rows included in the import
    An Import Set record showing the Import Set Rows tab.
    The following table provides more details about the fields in the image.
    Field Description
    Created Date and time the import set row was created. Given in the time zone of the logged-in user.
    Row Number for the row. Numbering starts at zero.
    State State of the row import.
    Target record

    Record updated with the row.

    This field displays the target record only when the import is run with a transform map.

    For imports run with a robust import set transformer, you can view the target records by clicking the row record and checking the Target record field in the Transform Target Rows tab. For more information and an example, see the following section on Target records for robust import set transformers.
    Error Details for any errors encountered during the row import.
    Comment Comments from the transform script.
    Transform Map If data is imported using a transform map, the associated map is shown here.

    Target records for robust import set transformers

    For imports using a robust import set transformer, you can view additional details by running the import in verbose mode. Verbose mode enables the following.
    • Greater detail in the import log. With verbose mode, the import log includes transform logs that show how transform operations are applied to records.
    • More information about each row's transform target rows. For each row in the Import Set Rows tab, clicking the row record opens the row in the import set table. In this view, you can see the transform target rows, import log, and import set row errors.
    The Transform Target Rows tab displays the state, target record, import set run, and any error messages for each row. The first three fields are all links to the associated records, making it easier to find and track information for improved debugging. For more information on enabling verbose mode, see Create a robust import set transformer.
    Figure 3. Sample data showing the transform target row details for a row in the Computers import set table
    A row record showing the Transform Target Rows tab.
    The following table provides more details about the fields in the image.
    Field Description
    State State of the transform target row. Options are:
    • Inserted
    • Updated
    • Error
    Target record Record updated with the row.
    Import set run Import Set record associated with the transform target row.
    Error message Text describing any errors encountered by the transform target row.

    Import Log

    The Import Log tab displays the logs for the import set. It shows when each log was created, its level, the log message, and the source of the log. For details, see Import logs.