Enrichment

The following table lists the optional parameters that can be used for each enrichment plug-in:
Table 1. Optional Enrichment Parameters

In addition to the optional parameter above, you can define and pass additional parameters to use in your plug-in.

To implement the EnrichmentPlugin interface, you will need to copy the following JAR file to your development environment:

a) up to Primo version 4.5 –
$primo_dev/ng/primo/home/system/publish/client/primo_common-api.jar

b) from Primo version 4.5 and on –
$primo_dev/ng/primo/home/system/tomcat/publish/webapps/primo_publishing#admin/WEB-INF/
lib/primo-common-api-<version>.jar

From this JAR file, you will need the following objects to implement Enrichment plugins:

•     EnrichmentPlugin Interface
•     IEnrichmentDocUtils Interface
•     IPrimoLogger Interface
•     IMappingTablesFetcher Interface

As the pipe process enters the NEP stage, the system will create the plugin’s object once and call the init() function to initialize the plugin. The system expects the enrichment object to process all enrichment requests for all of the PNX records that the pipe processes.

To implement an enrichment plugin, you will need to implement the following functions in the EnrichmentPlugin interface:

•     init()
•     enrich()
•     shouldSkipFailedRecord()

This function initializes your enrichment plugin and provides the plugin with access to utilities and the parameters defined in the Plugins Parameters mapping table.

In addition, you can open or store any needed data for the plugin.

public void init(IPrimoLogger logger,
                 IMappingTablesFetcher mtFetcher,
                 Map<String, Object> params);

The system will call this function once for every different pipe run and pass the following parameters:

IPrimoLogger – an object that allows you to write information concerning the execution of your
plugin to the Primo log files.
When executed on the Back Office server for RTA tests, the system sends the output to the
publishing_server.log in the BO machine.
When executed on the Front End server, the system sends the output to the
library_server.log in the FE machine.

public interface IPrimoLogger {
   
                public void setClass(Class<?> clazz);
                public void info(String msg);
                public void warn(String msg);
                public void warn(String msg, Exception e);
                public void error(String msg);
                public void error(String msg, Exception e);
}

IMappingTablesFetcher – An object that allows you to retrieve values from any mapping or
code table by specifying a table name.
The object returned is a List<Map<String, String>> object,
where each object in the List represents a row in the mapping or code
table and each row is a Map object,
where the key is the column name and the value is the value of that column’s
entry in the mapping or code table.

public interface IMappingTablesFetcher {
   
              public List<Map<String, String>> getTableRows(String tableName);
  }

Map<String, Object> – An object that contains all of the parameters configured for your plugin in the
Plugins Parameters mapping table. The key is the parameter name and the
value is a string containing the parameter’s value.

The system calls the enrich() function for every PNX record that is created during a pipe run in order
to enrich the PNX before it is saved to the database.
public Document enrich(Document xmlDoc, IEnrichmentDocUtils docUtil);

The function will receive 2 parameters:

xmlDoc – The XML document representing the PNX

docUtil – A convenient utility to retrieve and store data from the xmlDoc.
You can achieve the retrieving and storing without using this utility by using the
exposed functionality from the Document object.

Depending on the type of enrichment you are planning to implement,
this function will need to extract whichever values it wants from the given XML document and then
update back the XML document with the added/modified values.
For example, a snippet of this function may appear as follows
(this code will cause all titles in the display section to be in lower case under lds50):

public void enrich(Document xmlDoc, IEnrichmentDocUtils docUtil) throws Exception {
 
       String[] titles =
           docUtil.getValuesBySectionAndTag(xmlDoc, "display", "title");
 
       //no value found
       if (titles == null || titles.length == 0) {
           return xmlDoc;
       }
 
       for (int i = 0; i < titles.length; i++) {
          titles[i] = titles[i].toLowerCase();
       }
 
       docUtil.addTags(xmlDoc, "display", "lds50", titles);
 
       return xmlDoc;
}

This system calls this function for any exception thrown from the enrich() function.

public boolean shouldSkipFailedRecord(Document xmlContent, Exception e)

URL url = new URL(pUrl);
URLConnection connection = url.openConnection();
connection.setConnectTimeout(conTimeout);
connection.setReadTimeout(readTimeout);