Migration of search configurations from ITSM Agent Workspace to Service Operations Workspace for ITSM

  • Release version: Yokohama
  • Updated January 30, 2025
  • 3 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 Migration of search configurations from ITSM Agent Workspace to Service Operations Workspace for ITSM

    This guide details the process of migrating search configurations from ITSM Agent Workspace (ITSM AW) to Service Operations Workspace (SOW) within ServiceNow's Yokohama release. It explains how the migration utility identifies and transfers eligible search configuration records, ensuring continuity and consistency in search functionality when moving to SOW.

    Show full answer Show less

    How the Migration Utility Identifies Search Configurations

    • The utility filters application search source records linked to the ITSM AW master configuration.
    • It cross-checks these sources against those already mapped to SOW to identify unique ITSM AW search sources not yet migrated.
    • For unique ITSM AW search sources, the utility creates corresponding mappings to SOW context configuration.
    • If common search sources exist but have different order values in SOW, the utility updates SOW to match ITSM AW’s order.
    • The utility migrates the search view configuration values from ITSM AW to SOW.
    • It updates the SOW page property globalSearchDataConfigId to reference the correct SOW context configuration after migration.

    Migration Process Details

    • The utility starts by retrieving the Global Search Data Config and Global Search View Config from ITSM AW.
    • Migration proceeds only if the search engine type is “zing.”
    • Search sources are retrieved and compared between ITSM AW and SOW to identify unique and common sources.
    • The order of search sources in SOW is aligned to match ITSM AW where differences exist.
    • New mappings are created in SOW for any unique ITSM AW search sources.
    • Global Search View Config values are copied from ITSM AW to SOW’s configuration record.
    • The SOW page property globalSearchDataConfigId is updated to point to the out-of-the-box (OOB) SOW context configuration.

    Post-Migration Tasks

    • Verify that the migrated search configurations in SOW are consistent with those from ITSM AW.
    • Adjust and customize the search settings in SOW as needed to fit your operational requirements.

    Practical Impact for ServiceNow Customers

    This migration ensures that your customized search configurations from ITSM Agent Workspace are accurately transferred to Service Operations Workspace without losing settings or order of search sources. As a result, users experience a seamless transition with search functionality maintained and ready for immediate use. Customers can also fine-tune migrated configurations post-migration to optimize search performance within SOW.

    Migration of the search configuration from ITSM Agent Workspace to Service Operations Workspace (SOW) include identifying the eligible form header records and the migration process.

    How the migration utility identifies search configuration for migration

    The migration utility in SOW identifies the eligible set of search configuration records to be migrated based on the following sequence:
    1. Filters the application search sources records (sys_search_source) that are mapped to ITSM Agent Workspace master config record using the m2m_search_context_config_search_source table.
    2. Checks the application search sources that are mapped to SOW context config record.
    3. Searches each filtered record that are mapped to ITSM Agent Workspace master config record and checks if that record is not mapped to SOW context config record to identify the search sources which are unique to ITSM Agent Workspace only and not mapped to SOW context config record.
    4. For all those unique search records that are mapped to ITSM Agent Workspace, the SOW migration utility creates similar mapping to SOW context config record at m2m_search_context_config_search_source table.
    5. If common search sources mapped between ITSM Agent Workspace and SOW are found and the order of the mapping is differed in SOW from ITSM Agent Workspace, the SOW migration utility updates the order from ITSM Agent Workspace mapping to SOW mapping.
    6. Migrates the values of ITSM Agent Workspace search view config record to SOW search view config record.
    7. When both the search view config and the search sources are mapped to SOW from ITSM Agent Workspace, the SOW migration utility updates the globalSearchDataConfigIdSOW page property to reflect SOW context config record available in the base system.

    How the migration works

    The SOW migration utility uses the following sequence to migrate the search configuration records from ITSM Agent Workspace to SOW:
    1. Searches the reference record for Global Search Data Config and Global Search View Config using the sys_aw_master_config table in ITSM Agent Workspace.
    2. Determines the Search engine type in the Global Search Data Config record. If the search engine is zing then migration proceeds. Else, the migration process stops.
    3. Using the Global Search Data Config record, a query is run on the Application Search Sources (m2m_search_context_config_search_source) table to retrieve all the search sources.
    4. Using the SOW search context config available in the base system, a query is executed on the Application Search Sources (m2m_search_context_config_search_source) table to retrieve all the search sources.

      The SOW search context config exists as a record in the sys_search_context_config table and sys_id can be found at SOW page property called globalSearchDataConfigId.

    5. Compares between the search sources by executing a query on the Application Search Sources (m2m_search_context_config_search_source) table using Global Search Data Config record (ITSM Agent Workspace search sources) and SOW search context config record (SOW search sources), to find unique search sources mapped to ITSM Agent Workspace but not SOW.
    6. If the order value of a SOW search source is different than the order value of the ITSM Agent Workspace search source at the Application Search Sources table, the SOW migration utility updates the SOW search source with the same order value as in mapped in ITSM Agent Workspace.
    7. Creates record in the Application Search Sources (m2m_search_context_config_search_source) table with SOW context config record that is available in the base system and searches the unique sources that are found by comparing the ITSM Agent Workspace search sources and SOW search sources.
    8. Opens the Global Search View Config reference record that is retrieved using the sys_aw_master_config table in ITSM Agent Workspace and copy all the values to SOW view config record (SOW page property with name global_search_configurations). The SOW view config record is available in the base system.
    9. Updates the SOW page property globalSearchDataConfigId to have OOB SOW context config record.