IBM CM plugin
This plugin is used to export batch XML in IBM content management schema format. Basically this plugin transforms batch.xml to another XML acceptable by IBM Content Management.
Configure the plugin
To configure the plugin, expand the Export module and select the IBM CM plugin configuration page. You can edit the settings to change the settings as per their requirements.
The following table lists the configurable properties of the plugin.
|
Configurable property |
Type of value |
Value options |
Description |
|---|---|---|---|
|
IBM CM Final Export Folder |
String path to export folder |
Ex -C:EphesoftSharedFoldersibm-cm-export-folder |
Folder in which the file will be exported after transformation in desired format. |
|
IBM CM Switch |
List of values |
|
Determines whether the plug-in will run or not.Default OFF. |
Also, configure the property file if required: {Ephesoft Transact-Home}/WEB-INF/classes/META-INF/dcma-ibm-cm/ dcma-ibm-cm.properties
|
Configurable property |
Type of value |
Value options |
Description |
|---|---|---|---|
|
ibm.cmod_app_group |
String |
NA |
Value for setting parameter cmod app group's value in XML. |
|
ibm.cmod_app |
String |
NA |
Value for setting parameter cmod app's value in XML. |
|
ibm.user_name |
String |
NA |
Value for setting parameter user name's value in XML. |
|
ibm.email |
String |
NA |
Value for setting parameter email's value in XML. |
|
ibm.supplying_system |
String |
NA |
Value for setting parameter for DAT file name's value in XML. |
Steps of execution
-
Plugin uses batch xml file inside batch instance folder.
-
Batch XML is transformed in IBM content management schema format. This format is acceptable by the IBM Content Management system. This plugin creates 3 files as the result of processing. Plugin creates one .ctl file, one .dat file, and one .xml file. Names of these files are in the following format:
"name of batch folder" + "_"+ "batch instance identifier"+.ctl/.dat/.xml
-
These files are then copied in IBM CM final export folder in a fixed format.
Example:
A user has 5 batch folders to import, named ABC1, ABC2, ABC3, ABC4, and ABC5. After batch processing, IBM CM plugin creates ABC folder inside IBM CM export folder and subfolders for each batch instance on the basis of batch instance identifier. This ABC folder has 5 subfolders: BC1, BC2, BC3, BC4, and BC5. Each of these subfolder has one .ctl, one .dat, and one .xml file.
Dependency
The plugin assumes the extraction for the incoming batch has been done properly and just changes the results of the provided batch.xml in a desired format.
Troubleshooting
If a malfunction occurs with the IBM CM plugin, the following error messages may appear.
| Error message | Possible root cause |
|---|---|
|
IBM Content Management Export Folder value is null/empty from the database. Invalid initializing of properties. |
IBM CM Export folder path is incorrect in database. |
|
Could not find xsl file in the classpath resource |
ibmCMTransform.Xsl file is not present in classpath resource. It is possible that the .jar file is not valid. |
|
targetXMLPath is null. Unable to create directory |
Unable to create file in specified folder. Check for a permissions issue. |
|
Unable to create directory |
IBM CM Export folder is not present and unable to create the folder. |
|
Error in creating output xml file |
File not found at specified location. |
|
Could not transform ibmCMTransform.xsl file |
Error occurred while transforming batch.xml file. |
|
Failed exporting batch instance for IBM Content Management |
If any of the above errors occur, then this message is logged in files. |