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
| Parameter | Required | Default value | Allowed values | Description |
|---|---|---|---|---|
| FullPathToCopyFileContextItemsKey | Yes | Valid key name, present in items collection | Item containing the path to the file that should be copied. | |
| ConnectorName | Yes | The name of connector | Specifies the name of connector that is responsible for handling multimedia. | |
| ConnectorEntity | Yes | The 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.
| |
| MaximumFileNameLength | No | Valid integer number. | Specifies the limitation for name length of file after renaming. | |
| {ConnectorEntityValue}_{ParameterName} | No | Strings, numbers, boolean | Specifies 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
IshConnectorFrameworkPluginrenames and uploads the file given in theFullPathToCopyFileContextItemsKeyto connector specified inConnectorName. - The
ConnectorNamerepresents name of target connector, for exampleFileSystmemConnector - The
ConnectorEntityrepresents an entity type in the connector that represents multimedia object, for exampleFileSystemMultimedia - The
FileSystemMultimedia_Locationparameter is the target location to upload multimedia - The
FileSystemMultimedia_Overwriteparameter indicates that target multimedia can be overwritten by connector if it already exists - The value of the
MaximumFileNameLengthparameter is the maximum length of name of the file after renaming