addSpecFormat

Description
This transaction creates a new spec format in the system and, optionally, SpecFormatTranslation objects for that spec format.
Web Services
Operation name: addSpecFormat
Service name: DWLCommonServices-Admin
Example
Deploy a new spec format to the system, along with its related SpecFormatTranslation objects, to provide a new schema for some of the variable data used by some entities in the system.
Usage information
The transaction supports two types of specs: XSD-based specs normally defined in the MDM Workbench, or XML-based MDM unified specs that you can define using InfoSphere® MDM Collaboration Server. MDM unified specs facilitate the integration of InfoSphere MDM Collaborative Server with InfoSphere MDM Advanced Edition. The inputs to this transaction depend on the type of spec used.
For standard XSD-based specs, you must provide the following:
  • SpecId
  • ExternalXSD (that defines the XSD-based spec)
  • InternalXSD
  • FormatVersion
Optionally, you can provide:
  • LocalizedXSD (if your spec contains localized attributes)
  • child SpecFormatTranslationBObj objects (for translating attribute names)
For MDM unified specs, you must provide the following:
  • SpecId
  • ExternalXSD (that defines the XML-based spec)
  • FormatVersion
Important: neither SpecFormatTranslationBObj nor LocalizedXSD is supported by MDM unified specs, so you do not need to provide these. You also do not need to provide the InternalXSD if using MDM unified specs, as the transaction will generate it based on the provided ExternalXSD and return it in the response.
For more information on MDM unified specs, refer to the section Banking Solution Technology preview under Collaborative Authoring with IBM InfoSphere Collaboration Server.
Preconditions
Not applicable
Mandatory input
  • SpecId
  • ExternalXSD
  • InternalXSD
  • FormatVersion
Note: If the spec is defined using the XML Unified style, the InternalXSD is not required in the request.
Inquiry levels
Not applicable
Filter values
Not applicable
Transaction behavior
If the SpecId provided is not valid, this transaction will fail.

If a SpecFormat already exists with the same FormatVersion for the given SpecId, the transaction will fail.

If the internal, external, or localized XSDs are not valid, this transaction will fail.

If the external XSD is of XSD format, then valid internal XSD and optional localized XSDs must be provided. If external XSD is of XML format (Unified XML style), the internal XSD is generated by the application, and internal and localized XSDs are not expected in the request.

The FormatVersion specified must be greater than any existing FormatVersion for the given SpecId.

If the SpecFormat has localized types, then you must specify a LocalizedXSD.

Note: Dependent on the platform, additional steps might be required to re-index the searchable spec attributes. For more information about indexing and its impact on spec value searches, see the developer documentation and Business Administration UI documentation.
Request message
<DWLTxType> addSpecFormat

<DWLTxObject> SpecFormatBObj

<DWLObject> SpecFormatBObj

Response objects
SpecFormatBObj
Special note
Not applicable