Documentation Center

IPublishPostProcessPlugin - IshConnectorFramework

This plugin renames and uploads a file from the filesystem to a specified connector as a media object.

Plugin Input

Plugin configuration parameters
ParameterRequiredDefault valueAllowed valuesDescription
FullPathToCopyFileContextItemsKeyYes Valid key name, present in items collectionItem containing the path to the file that should be copied.
ConnectorNameYes The name of connectorSpecifies the name of connector that is responsible for handling multimedia.
ConnectorEntityYesThe type of entity that represents multimedia in the ICreateMultimediaCapability contract of the connector.The specific type of entity that implements IMultimedia interface and exposed by connector.
MaximumFileNameLengthNoValid integer number.Specifies the limitation for name length of file after renaming.
{ConnectorEntityValue}_{ParameterName}NoStrings, numbers, booleanSpecifies extra metadata that is dynamically attached to the multimedia entity and can be retrieved in the connector.

Plugin Outcome

Specified connector retrieves multimedia to upload:

  • Multimedia uploaded to the connector.

plugin name="IshConnectorFramework" configuration example


  <plugindefinition name="IshConnectorFramework" handler="IshConnectorFramework">
        <description>This plugin renames and uploads the file on the filesystem that are present in the Items collection to specified connector.</description>
        <initialize>
          <parameters>
            <parameter name="FullPathToCopyFileContextItemsKey">DITAOTOutputFile</parameter>
            <parameter name="ConnectorName">FileSystmemConnector</parameter>
            <parameter name="ConnectorEntity">FileSystemMultimedia</parameter>      
            <parameter name="FileSystemMultimedia_Location">C:\Test\Outputs</parameter>
            <parameter name="FileSystemMultimedia_Overwrite">true</parameter>
          </parameters>
        </initialize>
    </plugindefinition>

			

Plugin flow

  • The IshConnectorFrameworkPlugin renames and uploads the file given in the FullPathToCopyFileContextItemsKey to connector specified in ConnectorName .
  • The ConnectorName represents name of target connector, for example FileSystmemConnector
  • The ConnectorEntity represents an entity type in the connector that represents multimedia object, for example FileSystemMultimedia
  • The FileSystemMultimedia_Location parameter is the target location to upload multimedia
  • The FileSystemMultimedia_Overwrite parameter indicates that target multimedia can be overwritten by connector if it already exists
  • The value of the MaximumFileNameLength parameter is the maximum length of name of the file after renaming