Schema Loader Plug-Ins

Table 4-4: Schema Loader Required Keys

Name

Values

Description

SchemaLoader. Factory

NCMSchemaLoader_ Factory

DTDSchemaLoader_ Factory

XMLSchemaLoader_Factory

NNTSchemaLoader_Factory

Indicates name of the factory function to use to create the SchemaLoader class.

Must be paired with Schema Loader.Library. Used in Schema mode.

SchemaLoader. Library

adk39ncmsl

adk39dtdsl

adk39xmlsl

adk39nnt56sl

Indicates the name of the Schema Loader library that contains the factory function. The library name must match the factory name and cannot contain a file extension or standard library naming.

Must be paired with SchemaLoader.Factory. Used in Schema mode.

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>. (The IC [inbound compound shown here] or OC [outbound compound] is inbound to or outbound from the Formatter.)

Prefix has a 5-character limit of ASCII characters.

Used in Schema Remove, Schema, Acquire, and Process modes with NDO.

remove.by.prefix

true

false (default)

Used to remove formats based on the prefix. Prefix has a 5-character limit.

Used in Schema Remove mode.

remove.schema.keys

User-defined

List used to identify the formats to be removed. When remove by prefix is turned on, the list contains the format without prefix. When remove by prefix is not turned on, the list contains the full name of the formats to be removed. Specify formats as comma delimited with parenthesis.

Used in Schema Remove mode.


NNTSchemaLoader

The NNTSchemaLoader should be used for testing the adapter or generating NCM files for the following Integration Servers:

NCF Serialization should be used for the runtime when this schema loader is used in design time.

Table 4-5: Keys for NNT56SchemaLoader

Name

Values

Description

clash.avoid

true

false (default)

This switch allows a unique format name to be generated when a format is loaded into the Formatter database and that format name currently exists.

Does not apply to a top-level format.

continue.format.exists

true

false (default)

Allows user to specify whether the program sends out an error and exits (if set to false) when a format exists in the database.

If set to true, it sends a warning message and continues loading remaining formats.

Used in Schema mode.

I18N_Condense

true

false (default)

The 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.

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 of ASCII characters.

Used in Schema, Acquire, and Process modes with NDO data representation.

repository.dir

User-defined. If no value specified, defaults to

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.

schema.input

true (default)

false

Set to true to generate input formats.

(Input designates into broker.)

Used in Schema mode.

schema.output

true (default)

false

Set to true to generate output formats.

(Output designates out of broker.)

Used in Schema mode.

session

User-defined

User-defined key used to describe the OT session name. Used in Schema and Schema Remove mode.

remove.by.prefix

true

false (default)

Used to remove formats based on the prefix. Prefix has a 5-character limit.

Used in Schema Remove mode.

remove.schema.keys

User-defined

List used to identify the formats to be removed. When remove by prefix is turned on, the list contains the format without prefix. When remove by prefix is not turned on, the list contains the full name of the formats to be removed. Specify formats as comma delimited with parenthesis.

Used in Schema Remove mode.


NCMSchemaLoader

The NCMSchemaLoader should be used for testing the adapter or generating NCM files for the following Integration Servers:

NCF Serialization should be used for the runtime when this schema loader is used in design time.

Table 4-6: Keys for NCMSchemaLoader

Name

Values

Description

clash.avoid

true

false (default)

This switch allows a unique format name to be generated when the Formatter loads a format into the database and that format name currently exists. Does not apply to top-level formats.

continue.format.exists

false (default)

true

Allows user to specify whether the program sends out an error and exits if an ncm already exists for the format. If set to true and the ncm exists, the program sends a warning message and continues creating ncms. If set to false and the format exists, the program logs an error and shuts down.

Used in Schema mode.

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.

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.

schema.input

true (default)

false

Set to true to generate input formats.

Used in Schema mode.

schema.key

User-defined

Used to retrieve schema from adapter plug-in and to retrieve schema from NCM repository.

schema.output

true (default)

false

Set to true to generate output formats.

Used in Schema mode.

session

User-defined

Used to describe the OT session name. Used in Schema and Schema Remove mode.


DTDSchemaLoader

The DTDSchemaLoader should be used for testing the adapter or generating a DTD for the following Integration Servers:

It can also be used with the following Application Servers:

XML Serialization should be used for the runtime when this schema loader is used in design time. This schema loader can be used best if the New Era of Networks Formatter will not be used during runtime.

Table 4-7: Keys for DTDSchemaLoader

Name

Values

Description

continue.format.exists

false (default)

true

Allows user to specify whether the program sends out an error and exits if a DTD already exists for the format. If set to true and the DTD exists, the program sends a warning message and continues creating DTDs. If set to false and the DTD exists, the program logs an error and shuts down

Used in Schema mode.

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.


XMLSchemaLoader

The XMLSchemaLoader should be used for testing the adapter or generating an XML Schema file.

XML Serialization should be used for the runtime when this schema loader is used in design time. This schema loader can be used best if the New Era of Networks Formatter will not be used during runtime.

Table 4-8: Keys for XMLSchemaLoader

Name

Values

Description

continue.format.exists

false (default)

true

Allows user to specify whether the program sends out an error and exits if an XML already exists for the format. If set to true and the XML exists, the program sends a warning message and continues creating XMLs. If set to false and the XML exists, the program logs an error and shuts down

Used in Schema mode.

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.