Creating a Serialization Type - EIS Workflow Messaging - Foundation 24.1 - Foundation 24.1 - Ready - OnBase - external - OnBase/EIS-Workflow-Messaging/Foundation-24.1/EIS-Workflow-Messaging/Configuration/Serialization-Types/Creating-a-Serialization-Type - 2024-03-25

EIS Workflow Messaging
Platform
OnBase
Product
EIS Workflow Messaging
Release
Foundation 24.1
License

To create a serialization type:

  1. Connect to the appropriate repository in OnBase Studio.
  2. Launch the Create Serialization Type wizard by doing one of the following:

    • Click the Serialization Type button in the Integration Services ribbon.

    • Right-click the OnBase Object Serialization node in the Integration Services tab of the Repositories pane, then select New | Serialization Type.

    The Create Serialization Type wizard is displayed.
  3. Enter the name of the serialization type in the Name field and press Tab. The XML Compatible Name field is automatically populated with a name that follows XML validation rules.
  4. Enter a target namespace in the Target namespace for serialization types field. This value must be an absolute URI.
  5. Click Next. The OnBase object serialization details page is displayed.
  6. Select the type of OnBase object that you want serialize with this serialization type. The following object types are available in the OnBase Object Type drop-down list:

    • Document

    • EForm

    • Unity Form

    • WorkView

  7. Click Next. The object selection page is displayed.
    Note:

    The following illustration displays Document Types as an example, but the actual objects listed in the wizard depends on the OnBase object type selected in the previous page.

  8. Select the OnBase object that you want to serialize. You can enter the object name in the Find field to filter the list of objects.
  9. Click Next.

    • If you are serializing a Document Type, E-Form, or Unity Form, proceed to the next step.

    • If you are serializing a WorkView class, select any related WorkView classes to include in the serialization in the Select the related WorkView Classes page.

      Related classes are nested under each class. Arrow icons indicate how each class is related to the class that it is nested under: classes with arrows pointing left are child classes, and classes with arrows pointing right are parent classes.

      Note the following:

      • Related classes are displayed based on the relationship attribute set in the child class. If the main class is an extension class, the relationship attribute should be configured to the top-level base class, not the extended class.

      • If a class relates to itself, all recursive objects of the same class can be serialized up to 10 levels.

  10. The Select the Serialization Type Fields page is displayed.
    Note:

    The following illustration displays Keyword Types for a Document Type as an example, but the actual data fields listed in the wizard depends on the OnBase object type being serialized.

    This page lists all possible fields to include in the serialization of the OnBase object. By default, all fields are selected in the Include column.
  11. Ensure the Include check box is selected for all fields you want to include in the serialization, and deselected for any fields you do not want to include.
    Tip:

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

  12. If needed, revise the XML-compatible name for a selected field in the Edit XML Compatible Name section, then click Set to set the name for that field.
  13. Click Next. The Summary page is displayed.
  14. Review the summary and click Finish.