Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
This page goes threw describes the steps that you need to follow in order to be able to call for calling a web service using the SOAP protocol. This page also give you background information you need to understand on how web service services work within the Blueriq architecture. 4 The following steps are required:
  • Importing
  • Mapping with Domain Model
  • Creating a Service Call
  • Table of Contents
    maxLevel2
    minLevel2
    outlinetrue

    Using the Web service

    Note

    Not everything of the WSDL standard is supported. If you find that you have troubles performing one of the following steps, please also check in our Web Services datasheet to see if the service should work.

    ...

    Open your project and go the (possible newly-created) module which contains the web service. The module now has a Schema Set and a Soap Service. These can be found in the bar on the left side of the screen, as can be seen below.

    The Schema Set defines which entities, attributes and relations are used by the webservice (they map the XSD to the domain model). The Soap Service defines which entities are sent (the message parts from the WSDL). You use these elements to define what entities, attributes and relation in your domain correspond to concepts in the WSDL and XSD. If the domain model was created automatically in an empty module, then you can skip the configuring these elements, because they are automatically set up correct and directly go to Creating a Service Call.

    Schema Set Editor

    Open the Schema Set, and unfold the schema. You can choose which entity is mapped to this type in XSD schema, as can be seen below. In this case, the anonymous complex type of the element “add” in the XSD schema is mapped to the entity “add” in the domain model (the red box). It is good to realize that in general entities that are based on elements in an XSD schema are not singleton.

    When choosing simple elements, you can choose to which attributes they map. See below. Mapping relations works in a similar way.

    You can add validations on attributes. These are used when exposing Blueriq as a service, and are of no interest when calling another web service.

    Soap Service Editor

    The Soap Service Editor lets you configure the messages that you want to send to your web service and how you store messages received from the web service. For each operation, the web service needs two singleton entities: a Request entity and a Response entity, which will be used to create the message. When you create the domain automatically, you will find these along with the other entities of the domain. You can use the soap service editor to create mappings for these, if you did not create the domain automatically, see below:

    These entities are the only singleton in your domain if you generated your domain automatically. Conceptually, they represent the envelope of your message (remember Chapter 2: Simple Object Access Protocol (SOAP)). You can recognize these entities by their name. They are post fixed with either REQUEST or RESPONSE. These entities have no attributes and only one relation. In the code, Blueriq will start at this singleton, and work its way along the relation to all (indirectly) connected instances while creating the XML for the message. When sending a message, you have to make sure that this relation is set. otherwise the SOAP envelop will be empty.

    ...