Serialization is the process of walking a tree and writing the data for each node to wireform. This generates a wireform containing the format representation of the data in the tree. It then converts the wireform or contiguous messages so they can be used for transport or persistence.
Deserialization is the process of converting messages from wireform or contiguous formats and creating the corresponding tree representation.
Serialization and deserialization plug-ins are used to convert message data so that it can be used for transport, persistence, or by another program. The serializer plug-ins are used during runtime paired with schema loaders used during design time.
The e-ARE allows you to determine which format to use when putting data from an NNDOObject DataTree to a transport. The format is chosen based on four configuration keys when running the adapter.
The Input.Serializer keys are used in Deliver and Process modes (NDO data only) to deserialize from the wireform received from the input transport into a NNDOObject to be accepted by the adapter plug-in.
Input.Serializer
Factory: NCFSerializer_Factory
Library: adk39ncfsd
Modes: Deliver and Process
Action: Deserialize
From: data in wireform received from input transport
To: NNDOObject to be sent to adapter plug-in
Handles Formats: NCF 101 (New Era of Networks Canonical Format, version 101) and NCF 102
Integration Server: MQSI 2.0.2, WMQI 2.1, e-Biz Integrator 3.6
Input.Serializer
Factory: XMLSerializer_Factory
Library: adk39xmlsd
Modes: Deliver and Process
Action: Deserialize
From: Data in wireform received from input transport
To: NNDOObject to be sent to adapter plug-in
Handles Formats: XML
Integration Servers: MQSI 2.0.2, WMQI 2.1, e-Biz 3.6,
Application Servers: EAServer, WebSphere Application Server, and WebLogic Application Server
The Output.Serializer keys are used in Acquire and Process modes (NDO data only) to serialize the NNDOObject received from the adapter plug-in to be placed on the output transport.
Output.Serializer
Factory: NCFSerializer_Factory
Library: adk39ncfsd
Modes: Acquire and Process
Action: Serialize
From: NNDOObject received from adapter plug-in
To: Data in wireform to be placed on outside transport
Handles Formats: NCF 101 (New Era of Networks Canonical Format, version 101) and NCF 102
Integration Servers: MQSI 2.0.2, WMQI 2.1, and e-Biz Integrator 3.6
Application Servers: EAServer, WebSphere Application Server, and WebLogic Application Server
Output.Serializer
Factory: XMLSerializer_Factory
Library: adk39xmlsd
Modes: Acquire and Process
Action: Serialize
From: NNDOObject received from adapter plug-in
To: data in wireform to be placed on outside transport
Handles Formats: XML
Integration Server: MQSI 2.0.2 and WMQI 2.1
Name |
Values |
Description |
|---|---|---|
Input.Serializer.Factory |
NCFSerializer_Factory XMLSerializer_Factory |
Indicates the factory function used to create the Serializer/Deserialzer class. This Serializer deserializes the message data into an NDO for the adapter to use. Used in Deliver and Process mode for NDO data representation. |
Input.Serializer.Library |
adk39ncfsd adk39xmlsd |
Indicates the name of the Serializer library that contains the factory function. The library name and factory name must be associated; for example, both contain XMLSerializer or both contain NCFSerializer. The names cannot contain a file extension or standard library naming. Used in Deliver and Process modes for NDO data representation. |
Input.Serializer.Encoding |
User-defined |
Used to specify the encoding section of the NDO created by the deserialization process. If no encoding is set, the system defaults to the native system encoding. Used in Acquire and Process modes for NDO data representation. |
Output.Serializer.Factory |
NCFSerializer_Factory XMLSerializer_Factory |
Indicates the name of the factory function to use to create the Serializer/Deserializer class. This Serializer is used to serialize the NDO returned from the adapter into message data. Used in Acquire and Process modes for NDO data representation. |
Output.Serializer.Library |
adk39ncfsd adk39xmlsd |
Indicates the name of the Serializer library containing the factory function. The library name and factory name must be associated; for example, both contain XMLSerializer or both contain NCFSerializer. the name cannot contain a file extension or standard library naming. Used in Acquire and Process modes for NDO data representation. |
prefix |
User defined - ASCII values only |
Adds prefix to the format name in Schema, Acquire, and Process in NDO mode. The message type name becomes <prefix> + “IC.” + <NDO name>. Prefix has a 5-character limit. Used in Schema Remove, Schema, Acquire, and Process modes with NDO. |
Output.Serializer.Encoding |
User-defined |
Used to specify the encoding set of the serialized message. If no encoding set is specified, the system defaults to the native system encoding for NCM or UTF-8 for XML. Used for Deliver and Process modes for NDO data representation. |
The NCF Serializer puts the data out in an ncm stream of data. The NCFSerializer should be used for the following Integration Servers:
MQSI 2.0.2
WMQI 2.1
e-Biz Integrator 3.6
New Era of Networks Rules and Formatter 5.6
The NNTSchemaLoader should have been used for the schema loading when this format is used.
Name |
Values |
Description |
|---|---|---|
I18N_Condense |
true false (default) |
This key designates use of specific methodology of condensing format names. False = Signals the e-ADK to use the old methodology of condensing the format name if necessary. The old methodology does not support multi-byte characters. True = Signals the e-ADK to use the new methodology of condensing the format name if necessary. The new methodology is a simple character truncation routine and supports multi-byte data. Used in Schema mode. It is also used in Acquire and Process modes for NDO data representation when the NCF serializer is used. WARNING! Setting the key to false and using multi-byte format names will generate undetermined results. |
NCF.version |
101 (default) 102 |
Indicates the New Era of Networks Canonical Format version to use when loading schema. Used in Acquire and Process modes. |
prefix |
User-defined - ASCII values only |
Adds prefix to the format name. The message type name becomes <prefix>IC.<NDO name>. Prefix has a 5-character limit. Used in Schema, Acquire, and Process modes for NDO data representations. Used in Acquire and Process mode for NCFSerializer. |
repository.dir |
User-defined. If no value specified, defaults to NNSY_ROOT/NNSYContentRepository |
Indicates the directory in which NNSY content model files are written (.ncm files). Used in Schema, Deliver, and Process modes for NDO data representations. |
set.msg.options |
true false (default) |
Sets the following message options, depending on APP_GROUP and MSG_TYPE set for BUFFER: OPT_APP_GROUP OPT_MSG_TYPE Used in Acquire and Process modes. |
This serializer puts the data out in a XML Stream of data.
The XMLSerializer should be used for the following Integration Servers:
MQSI 2.0.2
WMQI 2.1
The XMLSerializer should be used for the following Application Servers:
EAServer
WebSphere Application Server
WebLogic Application Server
The XMLSchemaLoader or DTDSchemaLoader should have been used for the schema loading when this format is used.
Name |
Values |
Description |
|---|---|---|
prefix |
User-defined - ASCII values only |
Used in Schema, Acquire, and Process modes for NDO data representations. Prefix has a 5-character limit. Adds prefix to the format name. The message type name becomes <prefix>IC.<NDO name>. |
repository.dir |
User-defined. If no value specified, defaults to NNSY_ROOT/NNSYContentRepository |
Indicates the directory in which NNSY content model files are written (.ncm files). Used in Schema, Deliver, and Process modes for NDO data representations. |
set.msg.options |
true false (default) |
Used in Acquire and Process modes. Sets the following message options, depending on APP_GROUP and MSG_TYPE set for BUFFER: OPT_APP_GROUP OPT_MSG_TYPE |
