Admin.XMLPublishPluginConfiguration.xml
The Admin.XMLPublishPluginConfiguration.xml file contains the configuration for the plugins that are executed during the publish (post) process.
Changelog
| File version | Content Manager version | Notes |
|---|---|---|
| 1.0 | 13.0.0 | This is the first version of Admin.XMLPublishPluginConfiguration.xml. |
Introduction
This configuration file is accessible from the Content Manager Web Client. Select .
This configuration file contains:
- The global parameters that can be used by the export and by any publish post process plugins.
- The configuration for the export.
- The sequence of plugins that will be executed within the post processing step of the publish process.
Overview of the XML elements
| Node name | Description |
|---|---|
| infoSharePublishPluginConfig | Root node of the publish plugin XML configuration. |
| publish | Describes a sequence of plugins that will be executed within the publish process.
|
| publish @ishcondition | The condition that determines when the current publish sequence should be activated. |
| parameters | The global parameters that can be used by the export and by any publish post process plugin. |
| export | Contains the configuration (e.g. requested metadata) used during the export of the files. |
| postprocess | Describes a sequence of plugins that will be executed within the post processing step of the publish process.
|
Global parameters
| Node name | Description |
|---|---|
| parameters | The global parameters which can be used by the export and by any publish post process plugin. |
| parameter |
The parameter that is passed to the export and the plugins.
|
| parameter @name | The name of the parameter. |
| parameter @ishcondition | The condition for which the parameter will be used. |
Example:
<parameters>
<parameter name="CatalogFolder">%ISHPROJECTWEBPATH%\Author\ASP\DocTypes</parameter>
<parameter name="CatalogFile">catalog.xml</parameter>
<parameter name="DraftWhenFallbackLanguageUsed">yes</parameter>
<parameter name="DraftWhenFallbackLanguageUsedForIllustration">no</parameter>
<parameter name="DraftWhenFallbackLanguageUsedForResource">yes</parameter>
<parameter name="VariableAssignedXPath">//*[@varid][not(ancestor-or-self::*[@varref])][not(ancestor::*[@conref])]</parameter>
<parameter name="VariableInUseXPath">//*[@varref][not(ancestor::*[@varref])][not(ancestor::*[@conref])]</parameter>
...
</parameters>
Export configuration
| Node name | Description |
|---|---|
| parameters | The global parameters that can be used by the export and by any publish post process plugin. |
| parameter |
The parameter that is passed to the export.
|
| parameter @name | The name of the parameter. |
| parameter @ishcondition | The condition for which the parameter will be used. |
The configuration for the export is used to pass the parameters with the requested metadata for the document objects (e.g. maps, topics...) and the publication output:
<export>
<parameters>
<parameter name="documentobjrequestedmetadata">
<ishfields>
<ishfield name="FTITLE" level="logical" />
<ishfield name="FDESCRIPTION" level="logical" />
<ishfield name="VERSION" level="version" />
<ishfield name="FCHANGES" level="version" />
<ishfield name="FAUTHOR" level="lng" />
<ishfield name="FSTATUS" level="lng" />
...
</ishfields>
</parameter>
<parameter name="publicationoutputrequestedmetadata">
<ishfields>
<ishfield name="FTITLE" level="logical"/>
<ishfield name="FDESCRIPTION" level="logical"/>
<ishfield name="VERSION" level="version"/>
...
<ishfield name="FPUBINCLUDECOMMENTS" level="lng"/>
<ishfield name="FPUBINCLUDEMETADATA" level="lng"/>
<ishfield name="FPUBWATERMARK" level="lng"/>
<ishfield name="FISHPUBREVIEWENDDATE" level="lng"/>
<ishfield name="FISHPUBLNGCOMBINATION" level="lng" ishvaluetype="value" />
<ishfield name="FISHPUBSTATUS" level="lng" ishvaluetype="element" />
...
<ishfield name="FISHDITADLVRREMOTESTATUS" level="lng" ishvaluetype="element" ishcondition="ISHOutputFormat.FDITAOTTRANSTYPE='ishditadelivery'"/>
<ishfield name="FISHPRODUCTFAMILYNAME" level="logical" ishvaluetype="value" ishcondition="ISHOutputFormat.FDITAOTTRANSTYPE='ishditadelivery'"/>
<ishfield name="FISHPRODUCTRELEASENAME" level="version" ishvaluetype="value" ishcondition="ISHOutputFormat.FDITAOTTRANSTYPE='ishditadelivery'"/>
</ishfields>
</parameter>
</parameters>
</export>
Publish post process plugins
| Node name | Description |
|---|---|
| postprocess | Describes a sequence of plugins that will be executed within the post processing step of the publish process.
|
| postprocess @ishcondition | The condition that determines whether the current postprocess sequence should be executed or not. |
| sequence | The element that contains a sequence of publish post process plugins. |
| plugin | Describes one single publish plugin. |
| plugin @name | The name of the plugin. |
| plugin @handler | The reference to the plugin implementation. |
| plugin @ishcondition | The condition that determines when the current plugin should be executed. |
| description | The description of the plugin. |
| initialize | Describes the parameters that should be passed to the plugin instance upon initialization. |
| parameters | Contains parameter elements. |
| parameter |
The parameter that is passed to the plugin.
|
| parameter @name | The name of the parameter. |
| parameter @ishcondition | The condition for which the parameter will be passed to the plugin. |
Example:
<postprocess ishcondition="ISHOutputFormat.FDITAOTTRANSTYPE='ishditadelivery'">
<sequence>
...
<plugin name="ISHUPLOADPUBLISHRESULT" handler="IshUploadPublishResult">
<description>Uploads the file specified in the Items collection by the given key as a result to the publication output</description>
<initialize>
<parameters>
<parameter name="FilePathToUploadContextItemsKey">CompressedFilePath</parameter>
</parameters>
</initialize>
</plugin>
...
</sequence>
</postprocess>
Supported conditions
The following condition names can be used for determining if the plugin must be executed:
| Condition name | Description |
|---|---|
| ISHType | This controls when to execute the plugin depending on the type of the object to publish.
|
| ISHLevel | This controls when to execute the plugin depending on the level of the object to publish. The allowed values are: |
| EDT | The element name of the EDT linked with the output format (e.g. EDTZIP). |
| ISHOutputFormat | The output format used for publishing. |
| ISHOutputFormat.* | All fields from the output format used for publishing. The condition name is the element name of the field prefixed by
For example:
|
Out-of-the-box global parameters
| Parameter name | Description |
|---|---|
| CatalogFolder | The full path to the folder where the CatalogFile is located.
|
| CatalogFile | The file name of the catalog, in combination with CatalogFolder this should result in the full path to the catalog file.
|
| DraftWhenFallbackLanguageUsed | When some of the topics can only be retrieved in a fallback language but cannot be found in the requested language, this boolean indicate whether the publication output will be a Draft or still a Release candidate.
|
| DraftWhenFallbackLanguageUsedForIllustration | When some of the illustrations can only be retrieved in a fallback language but cannot be found in the requested language, this boolean indicate whether the publication output will be a Draft or still a Release candidate.
|
| DraftWhenFallbackLanguageUsedForResource | When some of the resources can only be retrieved in a fallback language but cannot be found in the requested language, this boolean indicate whether the publication output will be a Draft or still a Release candidate.
|
| VariableAssignedXPath | XPATH expression used to extract the variable definitions.
|
| VariableInUseXPath | XPATH expression used to find the variable references.
|
| ExtractTargetIds | XPath information to extract the targets.
|
| ExtractLinks | XPath information to extract the links
|
| ExtractImagelinks | XPath information to extract the image links
|
| ExtractHyperlinks | XPath information to extract the hyper links
|
| ExtractConrefs | XPath information to extract the conrefs
|
| ExtractKeyDefinitions | XPath information to extract the key definitions
|
Example
<infoSharePublishPluginConfig version="1.0">
<publish>
<parameters>
<parameter name="CatalogFolder">%ISHPROJECTWEBPATH%\Author\ASP\DocTypes</parameter>
<parameter name="CatalogFile">catalog.xml</parameter>
<parameter name="DraftWhenFallbackLanguageUsed">yes</parameter>
<parameter name="DraftWhenFallbackLanguageUsedForIllustration">no</parameter>
<parameter name="DraftWhenFallbackLanguageUsedForResource">yes</parameter>
<parameter name="VariableAssignedXPath">//*[@varid][not(ancestor-or-self::*[@varref])][not(ancestor::*[@conref])]</parameter>
<parameter name="VariableInUseXPath">//*[@varref][not(ancestor::*[@varref])][not(ancestor::*[@conref])]</parameter>
...
</parameters>
<export>
<parameters>
<parameter name="documentobjrequestedmetadata">
<ishfields>
<ishfield name="FTITLE" level="logical" />
<ishfield name="FDESCRIPTION" level="logical" />
<ishfield name="VERSION" level="version" />
<ishfield name="FCHANGES" level="version" />
<ishfield name="FAUTHOR" level="lng" />
<ishfield name="FSTATUS" level="lng" />
...
</ishfields>
</parameter>
<parameter name="publicationoutputrequestedmetadata">
<ishfields>
<ishfield name="FTITLE" level="logical"/>
<ishfield name="FDESCRIPTION" level="logical"/>
<ishfield name="VERSION" level="version"/>
...
<ishfield name="FPUBINCLUDECOMMENTS" level="lng"/>
<ishfield name="FPUBINCLUDEMETADATA" level="lng"/>
<ishfield name="FPUBWATERMARK" level="lng"/>
<ishfield name="FISHPUBREVIEWENDDATE" level="lng"/>
<ishfield name="FISHPUBLNGCOMBINATION" level="lng" ishvaluetype="value" />
<ishfield name="FISHPUBSTATUS" level="lng" ishvaluetype="element" />
...
<ishfield name="FISHDITADLVRREMOTESTATUS" level="lng" ishvaluetype="element" ishcondition="ISHOutputFormat.FDITAOTTRANSTYPE='ishditadelivery'"/>
<ishfield name="FISHPRODUCTFAMILYNAME" level="logical" ishvaluetype="value" ishcondition="ISHOutputFormat.FDITAOTTRANSTYPE='ishditadelivery'"/>
<ishfield name="FISHPRODUCTRELEASENAME" level="version" ishvaluetype="value" ishcondition="ISHOutputFormat.FDITAOTTRANSTYPE='ishditadelivery'"/>
</ishfields>
</parameter>
</parameters>
</export>
<postprocess ishcondition="ISHOutputFormat.FDITAOTTRANSTYPE='ishditadelivery'">
<sequence>
...
<plugin name="ISHCOMPRESSPUBLISHRESULT" handler="IshCompressPlugin">
<description>Compresses the file with the publish result specified in the Items collection.</description>
<initialize>
<parameters>
<parameter name="FullPathToCompressContextItemsKey">ExtendedOverallPackageObjectFilePath</parameter>
<parameter name="CompressionLevel">Optimal</parameter>
<parameter name="IncludeBaseDirectory">No</parameter>
</parameters>
</initialize>
</plugin>
<plugin name="ISHUPLOADPUBLISHRESULT" handler="IshUploadPublishResult">
<description>Uploads the file specified in the Items collection by the given key as a result to the publication output</description>
<initialize>
<parameters>
<parameter name="FilePathToUploadContextItemsKey">CompressedFilePath</parameter>
</parameters>
</initialize>
</plugin>
...
</sequence>
</postprocess>
</publish>
</infoSharePublishPluginConfig>