Serialization Tab - Integration for Content Composer - Foundation 24.1 - Foundation 24.1 - Ready - OnBase - external

Integration for Content Composer Deployment Guide

Platform
OnBase
Product
Integration for Content Composer
Release
Foundation 24.1
License

The Serialization tab of the Properties pane allows you to configure the information that OnBase sends to Content Composer.

OnBase Serialization for Content Composer

Select the Serialization Type to use when transferring data from OnBase to Content Composer.

Note:

Only Serialization Types created from the Serialization tab of the Properties pane of the Generate Content Composer Bundle action are displayed in the drop-down list.

If no Serialization Types are available, or if none of the existing Serialization Types meet your needs, you can create a new Serialization Type.

To create a new Serialization Type, click Create New Serialization Type and complete the wizard.

Note:

For more information on creating Serialization Types, see the Integration for Content Composer Deployment Guide.

The fields included in the currently selected Serialization Type are displayed under Fields. To filter the displayed fields, begin typing a value into the Find field. Only fields beginning with the value you typed are displayed.

To modify the fields included in a newly created Serialization Type, select the newly created Serialization Type from the OnBase Serialization for Content Composer drop-down list.

Note:

You can modify fields used by a new Serialization Type if the repository has not been saved since the creation of the Serialization Type. If the repository has been saved since the Serialization Type was created, you are unable to modify the Serialization Type.

Click Edit and deselect the Include option in the Edit Fields dialog box to remove a field from the selected Serialization Type.

Tip:

You can use the Include/Exclude all option to select or deselect all available fields.

All available fields automatically have an XML-compatible name generated. You can change this name by selecting the field, modifying the Edit Canonical Name field, and clicking Set. The value entered in this field is truncated to 120 characters when saved to the database.

Note:

All canonical names must be unique. You cannot modify a field to use the same canonical name that is used by another field.

Once you have made changes to the Edit Fields dialog box, click Apply to save your changes.

Include Workflow Properties

Select the Include Workflow Properties option to include Workflow properties in the serialized data. When this option is enabled, all properties from the action's selected property bag are serialized and included in the data transferred to Content Composer.

Option: Include Current Document

Select this option to include an attachment in the serialized data that contains the current document. When this option is selected, the DocPopURL and Document Bytes (Base64 encoded) options are available.

Note:

This option is automatically selected and cannot be changed when the action is part of a life cycle configured to process documents.

Option

Description

DocPopURL

Select this option to add a DocPop URL for the current document as an attachment to the serialized data.

Note:

In order for DocPop URLs to be added as an attachment to the serialized data, the AppNetDirectory setting of the Application Server web.config file must be configured.

Document Bytes (Base64 encoded)

Select this option to add a document byte string for the current document as an attachment to the serialized data.

Option:Include Related Documents

Select this option to include an attachment in the serialized data that contains related documents. When this option is selected, the DocPopURL and Document Bytes (Base64 encoded) options are available.

Option

Description

DocPopURL

Select this option to add a DocPop URL for related documents as an attachment to the serialized data.

Note:

In order for DocPop URLs to be added as an attachment to the serialized data, the AppNetDirectory setting of the Application Server web.config file must be configured.

Document Bytes (Base64 encoded)

Select this option to add a document byte string for related documents as an attachment to the serialized data.

To download the Serialization Type, click Download Schema.