Working towards the next version of the SWIM Supporting Material

Page tree

Working towards the next version of the SWIM Supporting Material

Skip to end of metadata
Go to start of metadata
Page Table of Content

Version

This page concerns v2.0 of the Specification. Supporting material on v1.0 is SWIM-SERV-018 TI Profile and bindings

Requirement

Title

SWIM TI Profile and interface bindings

Identifier

SWIM-SERV-250

Requirement

A service description shall include or refer to information about the profile and interface bindings for each service interface, including:

  • the selected SWIM TI Profile and its version;
  • a reference to a service interface binding as specified in the selected SWIM TI Profile;
  • a reference to a network interface binding as specified in the selected SWIM TI Profile; and
  • references to additionally supported requirements as specified in the selected SWIM TI Profile.

Rationale

To support the concept of interoperability between the service provider and service consumer, the SWIM TI Profiles only allow a certain set of technical solutions, which can be chosen by the service designer.

This is used by technical experts to assess feasibility to implement.

Verification

Completeness: Verify that the reference information is provided for each provider side and consumer side interface.

Consistency: Verify that the selected service interface binding, network interface binding and additionally supported requirements are consistent with the selected SWIM TI Profile and version.

Correctness: Not Applicable.

Examples/Notes

Note: If configuration options are available in the service interface binding, it is best practice to document them (e.g. use of GZIP compression, Message Transmission Optimization Mechanism (MTOM) encoding).

Example additionally supported requirements:

  • “SWIM-TIYP-0092, SWIM-TIYP-0098”.

Level of Implementation

Mandatory

Guidance

Verification Support

Completeness

Check that:

[  ] The service description includes or refers to information about the profile and interface bindings for each service interface.

[  ] The  information about the profile and interface bindings includes the selected SWIM TI Profile and its version.

[  ] The  information about the profile and interface bindings includes a reference to a service interface binding as specified in the selected SWIM TI Profile.

[  ] The  information about the profile and interface bindings includes a reference to a network interface binding as specified in the selected SWIM TI Profile.

[  ] The  information about the profile and interface bindings includes references to additionally supported requirements as specified in the selected SWIM TI Profile.

Consistency

Check that:

[  ] The selected service interface binding, network interface binding and additionally supported requirements are consistent with the selected SWIM TI Profile and version.

Examples

The following example shows the content as a table.

XML requests and replies embedded into SOAP messages, themselves embedded into HTTP requests and responses. Operation names are associated to SOAP requests.

SWIM TI profile and interface bindings





profile name

TI Yellow Profile specification

profile version

Edition Number 1.1

selected service interface binding

WS SOAP

selected network interface binding
IPV4_UNICAST

supported optional requirements

-

The following example shows an extract of the content of a JSON file that conforms to the Service Metadata Schema

Example of SWIM-SERV-250 using Service Metadata Schema
"serviceInterface": [{
 "serviceInterfaceBinding": {
  "name": "SWIM_TI_YP_1_1_WS-N_SOAP"
 },
 "networkInterfaceBinding": {
  "name": "IPV4_UNICAST"
 }
}

Complete examples are available at Example service description.


  • No labels