SOAP based webservice

1) Create new application.
2)New soap based message model with existing wsdl
3)new message flow
4)drag the wsdl onto the message flow edit on the new flow
5)this gives a skeleton etc. then write business transformation, routing logic's etc.

REST API and JSON sample message

1) New -->start by creating a REST API
2)give name, check radio button import resources and operations  ->next button
3)check radio button select from a file system to get the .json file.

Generating JSON sample message from xml/soap request..

1)copy soap request/JSON message in the the link to generate JSON from xml message http://www.freeformatter.com/xml-to-json-converter.html#ad-output

2)Remove Body{ and at the end closing bracket } from the message and update the first letter of the each field with small letter.

Validating JSON at the below link..

http://jsonlint.com/

Message modelling using DFDL in WMB

This article addresses the DFDL message modelling feature in IBM® WebSphere® Message Broker (also known as IBM® Integration Bus). It contains step by step instructions for creating a DFDL schema for a flat file using WMB tool-kit.

Data Format Description Language, commonly known as DFDL is an open standard based modelling language which is using in Websphere message broker V8 onwards for modelling data.  DFDL is based on the XML schema and is the recommended way of modelling over the proprietary MRM domain. DFDL is using a subset of the constructs in XML schema to modell the non-XML messages.

DFDL can be used to describe legacy data files,  record-oriented text or scientific and numeric computations. DFDL is more flexible than the MRM modelling and provides better performance.

Objective

To Parse a Tab separated flat file using DFDL in Websphere Message Broker v8. This flat file contains a repeating structure having optional records as well.

Input data:

A ‘Show all characters’ view from notepad++ as below.

Note : The last record is not terminated with a new line.

Below are the steps to create a DFDL model for the above test data.

1. Create a library named EmployeeDFDLLib, right click-on it, and select New => Message Model:

2. Select Record-oriented  text and click Next:

3. Select Option-2. Create an empty DFDL schema (we can choose option 1 as well. Here we are using the second option).

4. Create folder named ‘TabSeperated’ and schema named ‘TabSeperatedSchema’ and Click Finish.

5. Here is the empty model schema we have created:

Now we are going to define two complex types here (For ‘address’ and ‘name’).

a). Click the ‘Add a complex Type to the Schema’ option on Schema Tab.

b). And give the complex type name as ‘PersonName

c). Add two local elements to this complex type as ‘FirstName’ and ‘LastName’.

 

d). Similarly create another complex type as ‘Address’ and add local elements to it.

 

Now we are going to create our message. Here we should have a root element, followed by a repeating message structure of Header (Name) and Body (Address).

i). Create a Message named ‘Employee’. Use the ‘Add a message to the schema’ option as below:

 

ii). Add a local element to the message Employee and name it as ‘EmployeeDetails’.

iii). Change ‘EmployeeDetails’ type from String to Anonymous.

iv). Add 3 local elements to EmployeeDetails.

v). Change the Type of element to the comlextTypes we already created.

vi). HomeAddress is Optional. Change the Minimum Occurrence to ‘0’. You may get an error. Change the ‘Occurs Count Kind’ property to ‘implicit’ and save.

 

vii). It is been noted that the Separator ‘,’ is been applied for all sequence by default if we have not defined any separator.

To reset this, please follow the steps

Click the ‘Show all sections’ on top.

Go to the data format and click on the ‘<default format>’. Remove the separator and save.

viii). Now define a separator for the message sequences. Define separator ‘CRLF’ for the EmployeeDetails sequence.

ix). Change the Employeedetails Maximum occurrence to ‘unbounded’ (Repeating structure).

x). Click on the sequence of EmployeeDetails. Update the separator policy from ‘Suppressed’ to ‘SuppressedAtEndLax’ and save (SuppressedAtEndLax means there is no clash with delimiters from the containing structure –Refer here).

xi). Define the initiator ‘H%HT’ (H followed by Horizontal TAB) for EmployeeName

xii). Similarly define the initiator for other two elements as below:

xii). Define the element sequence as ‘%HT’ (Each element separated by TAB).

xiv). We do not have a ‘CRLF’ as last record terminator. Hence update the property to avoid parser exceptions.

‘Document Final terminator can be missing’ property can be found on Data Formats<default format> properties. Update this to ‘yes’.

Now the DFDL is ready for testing. Websphere Message Broker V 8 provides a feature to test our message model using DFDL before it can actually be using in any message flow.

Click on the ‘Test Parse Model’ on top and it will show the wizard.

Select the input file and click OK. It will prompt to switch to DFDL Test perspective. Click Yes.

It will parse successfully and produce the output as below.

(You can check the DFDL Trace to see the details of message parsing).

If we have to produce the Tab separated message as output (serialise) from an XML, we can use the ‘Test Serialize Model’ option to test it. For this we should have an XML sample message generated as per the DFDL Schema.

Below is the input sample XML to be serialized as a Tab separated flat text.

Click on the ‘Test Serialize Model’ and provide the input XML in the wizard.

It will produce the Tab Separated output as below.

Appendix

DFDL can be used in message flows to parse (input) or serialise (Output) message.

• For input parsing, you can set the parser option as DFDL and select the message (Employee) using the browse option.

• For output serialising, use the ESQL to set the DFDL domain and set the message type as below:

CREATE LASTCHILD OF OutputRoot DOMAIN ‘DFDL’ NAME ‘DFDL’;
SET OutputRoot.Properties.MessageType= ‘{}:Employee’; — Employee is the message name.

What's WSDL?

A WSDL document defines services as collections of network endpoints, or ports. In WSDL, the abstract definition of endpoints and messages is separated from their concrete network deployment or data format bindings. This allows the reuse of abstract definitions: messages, which are abstract descriptions of the data being exchanged, and port types which are abstract collections of operations. The concrete protocol and data format specifications for a particular port type constitutes a reusable binding. A port is defined by associating a network address with a reusable binding, and a collection of ports define a service. Hence, a WSDL document uses the following elements in the definition of network services:

• Types– a container for data type definitions using some type system (such as XSD).

  <wsdl:types> ?
        <wsdl:documentation .... />?
        <xsd:schema .... />*
        <-- extensibility element --> *
    </wsdl:types

• Message– an abstract, typed definition of the data being communicated.

    <wsdl:message name="nmtoken"> *
        <wsdl:documentation .... />?
        <part name="nmtoken" element="qname"? type="qname"?/> *
    </wsdl:message>

• Operation– an abstract description of an action supported by the service.
• Port Type–an abstract set of operations supported by one or more endpoints.--Operation

  <wsdl:portType name="nmtoken">*
        <wsdl:documentation .... />?
        <wsdl:operation name="nmtoken">*
           <wsdl:documentation .... /> ?
           <wsdl:input name="nmtoken"? message="qname">?
               <wsdl:documentation .... /> ?
           </wsdl:input>
           <wsdl:output name="nmtoken"? message="qname">?
               <wsdl:documentation .... /> ?
           </wsdl:output>
           <wsdl:fault name="nmtoken" message="qname"> *
               <wsdl:documentation .... /> ?
           </wsdl:fault>
        </wsdl:operation>
    </wsdl:portType>

• Binding– a concrete protocol and data format specification for a particular port type.

 <wsdl:binding name="nmtoken" type="qname">*
        <wsdl:documentation .... />?
        <-- extensibility element --> *
        <wsdl:operation name="nmtoken">*
           <wsdl:documentation .... /> ?
           <-- extensibility element --> *
           <wsdl:input> ?
               <wsdl:documentation .... /> ?
               <-- extensibility element -->
           </wsdl:input>
           <wsdl:output> ?
               <wsdl:documentation .... /> ?
               <-- extensibility element --> *
           </wsdl:output>
           <wsdl:fault name="nmtoken"> *
               <wsdl:documentation .... /> ?
               <-- extensibility element --> *
           </wsdl:fault>
        </wsdl:operation>
    </wsdl:binding>

• Port– a single endpoint defined as a combination of a binding and a network address.

  <wsdl:port name="nmtoken" binding="qname"> *
           <wsdl:documentation .... /> ?
           <-- extensibility element -->
  </wsdl:port>

• Service– a collection of related endpoints-- 

•     <wsdl:service name="nmtoken"> *
          <wsdl:documentation .... />?
          <wsdl:port name="nmtoken" binding="qname"> *
             <wsdl:documentation .... /> ?
             <-- extensibility element -->
          </wsdl:port>
          <-- extensibility element -->
      </wsdl:service>

Example 1 SOAP 1.1 Request/Response via HTTP

<?xml version="1.0"?>
<definitions name="StockQuote"

targetNamespace="http://example.com/stockquote.wsdl"
          xmlns:tns="http://example.com/stockquote.wsdl"
          xmlns:xsd1="http://example.com/stockquote.xsd"
          xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
          xmlns="http://schemas.xmlsoap.org/wsdl/">

    <types>
       <schema targetNamespace="http://example.com/stockquote.xsd"
              xmlns="http://www.w3.org/2000/10/XMLSchema">
           <element name="TradePriceRequest">
              <complexType>
                  <all>
                      <element name="tickerSymbol" type="string"/>
                  </all>
              </complexType>
           </element>
           <element name="TradePrice">
              <complexType>
                  <all>
                      <element name="price" type="float"/>
                  </all>
              </complexType>
           </element>
       </schema>
    </types>

    <message name="GetLastTradePriceInput">
        <part name="body" element="xsd1:TradePriceRequest"/>
    </message>

    <message name="GetLastTradePriceOutput">
        <part name="body" element="xsd1:TradePrice"/>
    </message>

    <portType name="StockQuotePortType">
        <operation name="GetLastTradePrice">
           <input message="tns:GetLastTradePriceInput"/>
           <output message="tns:GetLastTradePriceOutput"/>
        </operation>
    </portType>

    <binding name="StockQuoteSoapBinding" type="tns:StockQuotePortType">
        <soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
        <operation name="GetLastTradePrice">
           <soap:operation soapAction="http://example.com/GetLastTradePrice"/>
           <input>
               <soap:body use="literal"/>
           </input>
           <output>
               <soap:body use="literal"/>
           </output>
        </operation>
    </binding>

    <service name="StockQuoteService">
        <documentation>My first service</documentation>
        <port name="StockQuotePort" binding="tns:StockQuoteBinding">
           <soap:address location="http://example.com/stockquote"/>
        </port>
    </service>

</definitions>

For more information please click the link

Message Broker Commands

Message Broker Commands                                                    

1 . Queue Manager Commands
* * * * * * * * * * * * * * * * * * * * * *
Create a Queue Manager
crtmqm <QUEUE_MANAGER_NAME>

Start a Queue Manager
strmqm <QUEUE_MANAGER_NAME>

Stop Queue Manager
endmqm -i <QUEUE_MANAGER_NAME>

Delete Queue Manager
dltmqm <QUEUE_MANAGER_NAME>

Define and view Queue Manager Configuration using runmqsc

Open mqsc console for Queue Manager
runmqsc <QUEUE_MANAGER_NAME> --> Press Enter

Display list of Local Queue
display QLOCAL(*)
dis QLOCAL(*)
dsp QLOCAL(*)


Display list of Remote Queue
display QREMOTE(*)

Create Local Queue Under Queue Manager
DEFINE QLOCAL(QUEUE_NAME)


Create Local Queue Under Queue Manager overriding default value e.g maxdepth
DEFINE QLOCAL(QUEUE_NAME) MAXDEPTH(100000)

Create Server Connection Channel
DEFILE CHANNEL(CHANNEL_NAME) CHLTYPE(SVRCONN) TRPTYPE(TCP)

To view the list of local queues created under a Queue Manager:
runmqsc QUEUE_MANAGER_NAME -> Press ENTER
dis qlocal(*)
end
[As an alternative to 'dis', 'display' or 'dsp' can also be used. 'end' is used to exit performing any operations on the QUEUE_MANAGER_NAME]

* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  WebSphere Message Broker Commands
* * * * * * * * * * * * * * * * * * * * * * * *
To view the Components (Broker, Configuration Manager & Queue Manager associated with the Broker) created:

mqsilist

To view the Execution Groups created under a particular Broker: (The 4-digit number displayed against each Execution Group is the Process ID of the Process DataFlowEngine.exe which corresponds to an Execution Group)

mqsilist BROKER_NAME

To view the Flows & Resources (Jars, Message Dictionaries, Message Maps etc) deployed onto a Broker's Execution Group:

mqsilist BROKER_NAME -e EXECUTION_GROUP_NAME
To view the Broker's EG Properties:

mqsireportproperties BROKER_NAME -e EXECUTION_GROUP_NAME -o ObjectName -n PropertyName

To view all the properties of a Broker's EG ('-r' indicates recursive fetch, use '-a' for non-recursive fetch):
mqsireportproperties BROKER_NAME -e EXECUTION_GROUP_NAME -o AllReportableEntityNames -r

To view all the Configurable properties of a Broker ('-r' indicates recursive fetch, use '-a' for non-recursive fetch):
mqsireportproperties BROKER_NAME -c AllTypes -o AllReportableEntityNames -r

To view the Max Heap Size set to a Broker's EG:

mqsireportproperties BROKER_NAME -e EXECUTION_GROUP_NAME -o ComIbmJVMManager -n jvmMaxHeapSize

To view the Min Heap Size set to a Broker's EG:

mqsireportproperties BROKER_NAME -e EXECUTION_GROUP_NAME -o ComIbmJVMManager -n jvmMinHeapSize

To view the Debug Port set to a Broker's EG:

mqsireportproperties BROKER_NAME -e EXECUTION_GROUP_NAME -o ComIbmJVMManager -n jvmDebugPort

To change the Broker's EG Properties:

mqsichangeproperties BROKER_NAME -e EXECUTION_GROUP_NAME -o ObjectName -n PropertyName -v ValueToBeSet

To change any of the Configurable properties of a Broker ('-r' indicates recursive fetch, use '-a' for non-recursive fetch):

mqsichangeproperties BROKER_NAME -c ConfigurablePropertyName -o ObjectName -v NewValue

To change the Max Heap Size set to a Broker's EG: [-v parameter should be a value in Bytes]

mqsichangeproperties BROKER_NAME -e EXECUTION_GROUP_NAME -o ComIbmJVMManager -n jvmMaxHeapSize -v NewValue

To change the Min Heap Size set to a Broker's EG: [-v parameter should be a value in Bytes]

mqsichangeproperties BROKER_NAME -e EXECUTION_GROUP_NAME -o ComIbmJVMManager -n jvmMinHeapSize -v NewValue

To change the Debug Port set to a Broker's EG: [-v parameter should be a 4-digit value]

mqsichangeproperties BROKER_NAME -e EXECUTION_GROUP_NAME -o ComIbmJVMManager -n jvmDebugPort -v NewValue
________________________________________________________________________

Commands for taking trace: [-u indicates 'User Trace' and -t indicates 'Service Trace']
Values of -l (Trace Level) parameter:
1. normal,
2. none,
3. debug.
Values of -m (Mode) parameter:
1. safe,
2. fast.

User Trace:

To view the user trace: (Optional -f to view the trace level of a particular message flow deployed onto an EG)

mqsireporttrace BROKER_NAME -u -e EXECUTION_GROUP_NAME -f MESSAGE_FLOW_NAME

To set the user trace: (Optional -f to view the trace level of a particular message flow deployed onto an EG)

mqsichangetrace BROKER_NAME -u -e EXECUTION_GROUP_NAME -f MESSAGE_FLOW_NAME -l TRACE_LEVEL -c SIZE_OF_TRACE_IN_KB

Service Trace:

To view the service trace: (Optional -f to view the trace level of a particular message flow deployed onto an EG)
mqsireporttrace BROKER_NAME -t -e EXECUTION_GROUP_NAME -f MESSAGE_FLOW_NAME

To set the service trace: (Optional -f to view the trace level of a particular message flow deployed onto an EG)

mqsichangetrace BROKER_NAME -t -e EXECUTION_GROUP_NAME -f MESSAGE_FLOW_NAME -l TRACE_LEVEL -c SIZE_OF_TRACE

To read the trace file: (Optional -f to view the trace level of a particular message flow deployed onto an EG)
mqsireadlog BROKER_NAME -u/-t -e EXECUTION_GROUP_NAME -f MESSAGE_FLOW_NAME -o PATH_TO_FILE_WITH_NAME_AND_EXTENSION
________________________________________________________________________
To create a BAR file:

mqsicreatebar -data PATH_TO_BAR_DIRECTORY -b BAR_FILE_NAME -p PROJECT_NAME -o NAME_OF_THE_RESOURCE_TO_BE_ADDED_WITH_EXTN
['-cleanBuild' parameter can be used to refresh the workspace projects and perform a clean build before adding]
Syntax: mqsicreatebar -data workspace -b barName [-version id] [-esql21] [-p projectName [...]] -o filePath1 [filePath2 [...]]
Command Options:
'-data workspace' workspace location (Mandatory)
'-b barName' bar file name to create or replace
'-version id' appends '_' and id to compiled names in the archive (optional)
'-esql21' compile ESQL for brokers version 2.1 (optional)
'-p projectName' specify projects containing files to link (optional, multiple projects can be specified)
'-o filePath1' workspace relative path (including the project) of deployable files to add to the broker archive. Multiple deployable files can be compiled in a single mqsicreatebar command.

To cancel all outstanding deployments:

mqsideploy -n PATH_TO_CONFIGURATION_MANAGER_FILE -c
To deploy a BAR file:
mqsideploy -n PATH_TO_CONFIGURATION_MANAGER_FILE -b BROKER_NAME -e EXECUTION_GROUP_NAME -a PATH_TO_BAR_FILE_NAME

To remove a flow or resource from the Broker's EG:

mqsideploy -n PATH_TO_CONFIGURATION_MANAGER_FILE -b BROKER_NAME -e
EXECUTION_GROUP_NAME -d FLOW_OR_RESOURCE_NAME_TO_BE_UNDEPLOYED
NOTE:
1. For all the mqsideploy commands above, a combination of -i, -p & -q parameters can be used instead of -n. -i carries the machine name, -p indicates the port on which the Queue Manager is open and -q represents the name of the Queue Manager,
2. An additional '-w' parameter can be added at the end of the command to set a Timeout Value (in seconds).
________________________________________________________________________

To reload/restart a particular Execution Group:

mqsireload BROKER_NAME -e EXECUTION_GROUP_NAME
To reload/restart all the Execution Groups of the Broker: [This command does not restart the Broker]
mqsireload BROKER_NAME
________________________________________________________________________

To stop a Broker: [Optional '-i' parameter before BROKER_NAME immediately stops the Broker, else, the Broker is stopped in Control Mode. Optional '-q' parameter after BROKER_NAME stops the Broker's Queue Manager along with the Broker]

[CONFIGURATION_MANAGER_NAME, USER_NAME_SERVER or DATABASE_INSTANCE_MANAGER can be used in place of BROKER_NAME to stop the respective Component]

mqsistop BROKER_NAME
To stop a Broker's EG:
mqsistop BROKER_NAME -e EXECUTION_GROUP_NAME
To stop a Message Flow running on a Broker's EG:
mqsistopmsgflow BROKER_NAME -e EXECUTION_GROUP_NAME -m MESSAGE_FLOW_NAME
________________________________________________________________________

To start a Broker:

[CONFIGURATION_MANAGER_NAME, USER_NAME_SERVER or DATABASE_INSTANCE_MANAGER can be used in place of BROKER_NAME to stop the respective Component]
mqsistart BROKER_NAME

To start a Broker's EG:

mqsistart BROKER_NAME -e EXECUTION_GROUP_NAME
To start a Message Flow running on a Broker's EG:
mqsistartmsgflow BROKER_NAME -e EXECUTION_GROUP_NAME -m MESSAGE_FLOW_NAME
________________________________________________________________________

To set the DSN Name to a Broker which will be used by the flows deployed onto its' EGs:

mqsisetdbparms BROKER_NAME -n DSN_NAME -u USER_ID -p PASSWORD

To reset the DSN Name to a Broker which will be used by the flows deployed onto its' EGs:

mqsisetdbparms BROKER_NAME -n DSN_NAME - -u USER_ID -p PASSWORD

To remove the DSN Name to a Broker which was used by the flows deployed onto its' EGs:

mqsisetdbparms BROKER_NAME -n DSN_NAME -d
________________________________________________________________________
To list/display/export an ACL Entry:

mqsilistaclentry CONFIGURATION_MANAGER_NAME -n .configmgr_FILE_NAME -f FILE_TO_WHICH_THE_ACL_ENTRIES_ARE_EXPORTED
To create an ACL Entry:
mqsilistaclentry CONFIGURATION_MANAGER_NAME -n .configmgr_FILE_NAME -f FILE_FROM_WHICH_THE_ACL_ENTRIES_ARE_IMPORTED
To delete an ACL Entry:
mqsideleteaclentry CONFIGURATION_MANAGER_NAME -n .configmgr_FILE_NAME -f FILE_FROM_WHICH_THE_ACL_ENTRIES_ARE_IMPORTED
________________________________________________________________________
To create a Broker:

mqsicreatebroker BROKER_NAME -i USER_ID -a PASSWORD -q BROKER_QUEUE_MANAGER_NAME

To create a Configuration Manager:

mqsicreateconfigmgr CONFIGURATION_MANAGER_NAME -i USER_ID -a PASSWORD -q BROKER_QUEUE_MANAGER_NAME

To create a User Name Server: [Optional '-r' parameter can be added to set the Refresh Interval at the end of the command with a value in seconds. Default value is 60 seconds]

mqsicreateusernameserver -i USER_ID -a PASSWORD -q BROKER_QUEUE_MANAGER_NAME
________________________________________________________________________

To delete a Broker: [Optional '-q' parameter can be added to delete the associated Queue Manager along with the Broker]
[Optional '-w' parameter can be added to delete all the files related to the Broker under the work path mentioned by '-w's value]

mqsideletebroker BROKER_NAME
To delete a Configuration Manager: [Optional '-q' parameter can be added to delete the associated Queue Manager along with the Configuration Manager]
mqsideleteconfigmgr CONFIGURATION_MANAGER_NAME

To delete a User Name Server: [Optional '-q' parameter can be added to delete the associated Queue Manager along with the User Name Server]
[Optional '-w' parameter can be added to delete all the files related to the User Name Server under the work path mentioned by '-w's value]
mqsideleteusernameserver
________________________________________________________________________

To create a Configurable Service:

mqsicreateconfigurableservice BROKER_NAME -c CONFIGURABLE_SERVICE_NAME -o ObjectName -n PropertyName -v PropertyValue

To delete a Configurable Service:

mqsideleteconfigurableservice BROKER_NAME -c CONFIGURABLE_SERVICE_NAME -o ObjectName
________________________________________________________________________

To perform the Component Verification:

mqsicvp COMPONENT_NAME
[COMPONENT_NAME can be BROKER_NAME or CONFIGURATION_MANAGER_NAME]
__________________________________________________________________________________