Test an exporter and export a snapshot

  • Release version: Washingtondc
  • Updated February 1, 2024
  • 3 minutes to read

    • Set and validate input settings to test an exporter before you export the config data in a snapshot.

    Before you begin

    Important:
    Starting with the Washington DC release, DevOps Config is being prepared for future deprecation. It will be hidden and no longer installed on new instances but will continue to be supported. For details, see the Deprecation Process [KB0867184] article in the Now Support Knowledge Base.
    Role required: cdm_exporter_editor or cdm_editor or cdm_admin
    • The cdm_secrets role is required to export snapshots that include encrypted data.
    • The cdm_viewer can export any snapshot that does not include encrypted data.
    • The cdm_exporter_editor can create, edit, publish and delete exporters.

    About this task

    Be sure to install the exporter content pack for DevOps Config. Exporters in the content pack are good starting points for your custom exporters. Some content pack exporters generate subsets of config data and others generate data for full applications. For example, to export updated config data for a database, you might select the returnAllDataforNodeName exporter. In the input arguments for the exporter, you would specify the database deployable as the node and then specify the updated settings as input arguments. After you determine that the settings generate the desired config data, you can export the data to the pipeline.

    • Exporters in the content pack have the Source value of ServiceNow. You can duplicate, but cannot delete or modify content pack exporters.
    • You can run only published exporters.
    • For export, snapshots cannot exceed 10,000 config data items (CDIs) per deployable or 100,000 CDIs per application.
    • For information on creating a custom exporter, see Create a custom exporter.
    • Records of exporter executions are deleted after a period of three years. For instructions on changing the default time period, see Set the purge period for records of exporter executions.

    Procedure

    1. Select the admin icon (Admin icon.) to open the Administration page.
    2. On the Exporters tab, select the name of the exporter.
      Tip:
      Add commonly used exporters to the My Exporters list for quick access.
    3. Select the exporter version on the Versions tab.
      The exporter opens on the Exporter builder tab. The text of the exporter script appears in a view-only panel. Use the Test playground panel to specify the snapshot to export and test settings before you export the config data.
    4. Specify the settings for the exporter execution on the Select inputs page.
      Table 1. Test playground settings
      Field Description
      Deployable and published snapshot to export

      Deployable for export and the particular published snapshot that you have validated and want to use.

      Deployables appear in the list using the format <AppName/DeployableName>. When you select a deployable, another field lists all published snapshots for the deployable. The most recently published snapshot appears first in the list. Select the snapshot to export.
      Input arguments

      The arguments that the exporter script uses to generate config data as output. The text box displays the default values for all arguments. Update values as needed.
      Output format

      Format in which to generate the config data.
      Additional deployables

      Deployables for which to generate config data in addition to the primary deployable that you specified in the Deployable and published snapshot to export field.

      Only the latest published snapshots appear for this optional setting.
    5. Select Evaluate.
      • The exporter script executes using the settings that you specified.
      • The Test playground panel displays the Review output page.
      • The config data that the exporter generates appears in the Output box.
      • The system lists information about the execution on the Executions tab.
    6. Review the results.
      1. To make changes, select Select inputs, specify new settings, and then select Evaluate.
      2. Repeat the previous step as often as needed.
      Note:
      When you are satisfied that the exporter generates complete config data and follows the required output format standards, you can publish it and activate it.
    7. Publish the exporter by selecting Publish on the Exporter builder tab.
      Note:
      You must set an exporter to active to enable it to be executed in a pipeline.