Configuring Sample JSON Content Processor

  1. System administrators need access to the CMS file system to build the SampleJsonPublishContentProcessor.csproj and recycle the application pool.
  2. System administrators need to set up a DITA content processor in order to use the JSON processor.

Developers can add custom content processors as a new plugin to the CMS publishing pipeline. A sample has been included in the CMS installation to model pipeline processing and to serve as a base for custom processors. Processors introduced to the pipeline can either consume output from upstream processors or generate output for further modification by downstream processors. The sample plugin simply converts DITA XML to JSON.

The JSON processor depends on the DITA Publishing Content Processor, which displays beneath This processor requires the following processor(s) to precede it in the queue. This means that the JSON processor requires the output of the DITA processor, so this JSON processor must follow the DITA processor in the list of content processors.

To configure the sample content processor:

  1. Build the sample JSON processor.
    1. Navigate to [Drive]:\[path-to-cms-site-instance]\site\App_Data\xml\Custom\PlugIns\PubContentProcessors\SampleJsonPublishContentProcessor.
    2. Open SampleJsonPublishContentProcessor.csproj in Visual Studio.
    3. Build the VS project.
    4. Recycle the CMS application pool.
  2. In the CMS, navigate to Administration > Publishing System > [Your-Publishing-Target] > Post-Publish Processing tab.
  3. Click the Add Content Processor drop-down menu.

    The Sample JSON Publish Content Processor list item now displays as a new content processor.

  4. Click the Sample JSON Publish Content Processor list item.

    The processor's configuration fields display.
  5. Required: Provide a name in the Content Processor Name field.
  6. Select the Pretty-print JSON checkbox if you want the resulting JSON to be formatted.
  7. If you require a filename prefix, enter the prefix in the field provided.
  8. If you require a timestamp concatenated to filenames, choose the appropriate format pattern from the format pattern drop-down list.
  9. Click Save in the top-right corner of the Manage Publishing Targets pane.
  10. Execute a publish of normalized DITA content to the associated target.
    After the publish completes, you will find the generated JSON in the same folder as the normalized DITA output.

Next Steps:

Once the sample JSON processor is in place, CMS developers can use the sample as a model to build their own content processors.