Updating the Scheduler job that imports data from IBM Knowledge Catalog

If you use IBM Knowledge Catalog with OpenPages Data Privacy Management, update the Data Privacy WKC Import Scheduler job.

About this task

Do this task to update the Data Privacy WKC Import job to use a Zen API Key to connect to IBM Knowledge Catalog.

This task applies in the following cases:
  • You upgraded from 4.6.x to 4.8.
  • You upgraded from 4.7.x to 4.8.

Procedure

  1. Download the OpenPages General package from Passport Advantage.
  2. Locate the /addon_module/all.workflows-op-config.xml file. Put the file in a new directory called workflows-480.
  3. Open the all.workflows-op-config.xml file in a text editor.
  4. Copy the Data Privacy WKC Import jobDetails configuration into a new OpenPages loader file.
    Or, copy the following text into a new file:
    <?xml version="1.0" encoding="UTF-8"?>
    <openpagesConfiguration xmlFormatVersion="1.31">
    	<systemAdminMode enabled="false"/>
    	<jobDetails explicitListing="false">
    		<jobDetail name="Data Privacy WKC Import" description="Import data assets and projects that are classified as private in Watson Knowledge Catalog (WKC)" category="wkc" type="standard" class="com.ibm.openpages.integration.wkc.process.WKCDataPrivacyScheduledProcess" enabled="false">
    			<jobSchedules>
    				<jobSchedule name="Daily" description="Daily Schedule for importing data assets from Watson Knowledge Catalog" jsonDisplay="{&quot;definitionType&quot;:&quot;recurring&quot;,&quot;repeat&quot;:&quot;daily&quot;,&quot;timeOfDay&quot;:&quot;02:00&quot;}" triggerName="unused" triggerGroup="wkc" cronExpression="0 0 2 * * ?" startTime="2021-02-23 11:16:51.334" endTime="2286-11-19 23:59:59.0">
                    </jobSchedule>
    			</jobSchedules>
    			<jobConfiguration>
    				<jobConfigurationItem fieldName="API Key" fieldType="String" fieldValue="" encrypted="true">
                    </jobConfigurationItem>
    				<jobConfigurationItem fieldName="Base URL" fieldType="String" fieldValue="" encrypted="false">
                    </jobConfigurationItem>
    				<jobConfigurationItem fieldName="Base Display URL" fieldType="String" fieldValue="" encrypted="false">
                    </jobConfigurationItem>
    				<jobConfigurationItem fieldName="Parent Entity Path" fieldType="String" fieldValue="/Library/DPM/DPMLibrary/WKCLibrary/WKCLibrary" encrypted="false">
                    </jobConfigurationItem>
    				<jobConfigurationItem fieldName="Password" fieldType="String" fieldValue="" encrypted="true">
                    </jobConfigurationItem>
    				<jobConfigurationItem fieldName="Use Zen API Key Authorization" fieldType="String" fieldValue="false" encrypted="false">
    				</jobConfigurationItem>
    				<jobConfigurationItem fieldName="Reload All?" fieldType="String" fieldValue="false" encrypted="false">
                    </jobConfigurationItem>
    				<jobConfigurationItem fieldName="User Name" fieldType="String" fieldValue="" encrypted="false">
                    </jobConfigurationItem>
    				<jobConfigurationItem fieldName="WKC Classifications" fieldType="String" fieldValue="" encrypted="false">
                    </jobConfigurationItem>
    			</jobConfiguration>
    		</jobDetail>
    	</jobDetails>
    </openpagesConfiguration>
  5. Configure the authentication settings.
    • If OpenPages and IBM Knowledge Catalog are installed in the same Cloud Pak for Data instance, you can use either of the following options:
      • Set the User Name and Password, and set Use Zen API Key Authorization to false.
      • Set the User Name and API Key, and set Use Zen API Key Authorization to true.
    • If OpenPages and IBM Knowledge Catalog are installed in different Cloud Pak for Data instances, you must set the User Name and API Key, and set Use Zen API Key Authorization to true.
  6. Update the remaining settings with the values for your configuration.
  7. Save the file.
    For example, name the file dpm_wkc_update-op-config.xml.
  8. Import the loader file into OpenPages. You can use ObjectManager or Import Configuration.
    ObjectManager
    Run the following command. This command uses your Cloud Pak for Data username and your Cloud Pak for Data API key for authentication.
    ObjectManager l c admin <API-Key> <path_to_xml_file> <xml_file_prefix>

    If you encounter any errors, review the log file, <loader-file-path>/ObjectManager.log.

    You generate the API key in Cloud Pak for Data. For more information, see Generating API keys for authentication.

    For more information about ObjectManager, see Installing tools and utilities for OpenPages.

    Import Configuration
    Log in to OpenPages as an administrator. Click Administration menu > System Migration > Import Configuration. Validate the file and then import it.
    For more information, see Importing a migration file.