urlopen.open() formats for IBM MQ messages

Examples

• Sample call to MQ in the options JSON object format. The headers label information in the options object is in a different format from the information for the other labels.

  var urlopen = require ('urlopen');
  var putData = '<MQRequest>Hello World</MQRequest>'; 
  
  var options =
  {
      target: 'mq://192.0.2.0:1414?QueueManager=QM1;UserName=mqm;Channel=QM1.SVRCONN;ChannelTimeout=10;'
                + 'channelLimit=100;Size=1024000;RequestQueue=queue1;ReplyQueue=queue2',
    
       data : putData,
    headers : { MQMD   : { // JSON object for specified header_name
                              MQMD: { // JSON object for the MQMD header
                                     StructId : { $ : 'MD' } ,
                                      Version : { $ : '1'} ,
                                    }
                          } 
                }
  };
  
  urlopen.open (options, function (error, response) {} );

• An example shows how more complicated IBM MQ headers are set and used.

  var urlopen = require('urlopen');
  var putData = '<MQRequest>Hello World</MQRequest>'; 
  
  var urlopenHeaders = {
          // supply an MQMD header
          MQMD : {     // This MQMD is the header name.
                  MQMD: {  // JSON object for the MQMD header
                StructId : { $ : 'MD' },
                 Version : { $ : '1' },
                  Format : { $ : 'MQHRF2' },
                 MsgType : { $ : '1' },
             ReplyToQMgr : { $ : session.parameters.qm },
                ReplyToQ : { $ : session.parameters.replyQ },
                  Expiry : { $ : '10000' },
             Persistence : { $ : '1' },
                Priority : { $ : '10' },
             PutApplType : { $ : '6' },
             PutApplName : { $ : 'My Datapower IBM MQClient' }, 
          ApplOriginData : { $ : 'testUrlOpenMPGW' },
        ApplIdentityData : { $ : 'mqUrlOpenDemo.js' } }
                 },
           // supply an MQRFH2 header
           MQRFH2 : { 
             MQRFH2: {
                   Format: { $ : 'MQSTR' },
            NameValueData: {
                     NameValue: [
                                  { mcd : { property1 : { $ : '1111' } } },
                                  { jms : { property2 : { '@dt': 'string', $ : 'value2'} } },
                                  { usr : { group : {
                                               property3 : { $ : 'value3' },
                                               property4 : { $ : 'value4'} } } }
                                ] }
                 }
           }
   };
  
    var options = {
                       target : 'idgmq://' + session.parameters.qm + '/?RequestQueue='
                           + session.parameters.requestQ,
                     headers : urlopenHeaders,
                      data : putData,
             replyQueue : session.parameters.replyQ,
                    pmo : 2052  // MQPMO_NO_SYNCPOINT (4) + MQPMO_SET_ALL_CONTEXT (2048) };
  
   try {
         urlopen.open(options, function(connectError, response) {
               if (connectError) {    
                     var errorMessage = connectError + 'errorCode='
                                          + connectError.errorCode.toString(16);
                     console.error(errorMessage);
                     session.output.write(errorMessage);
  
                } else {
                     var responseCode = response.statusCode; 
                     if (responseCode == 0) {
                           console.info('Received MQ ' + response.statusCode
                                         + ' for target ' + options.target); 
                           response.readAsXML(function(readAsXMLError, xmlDom) {
                                if (readAsXMLError) {
                                    var errorMessage = 'Error on readAsXML: ' + readAsXMLError;
                                    console.error(errorMessage);
                                    response.readAsBuffer(function(readAsBufferError, buffer) {
                                         if (readAsBufferError) { 
                                               var errorMessage = 'Error on readAsBuffer: '
                                                                   + readAsBufferError;
                                               console.error(errorMessage);
                                               session.output.write(errorMessage);
                                         } else {
                                               console.info('MQ Response headers: ' + response.headers);
                                               session.output.write(buffer);
                                         }
                              });
                      } else { 
                          console.info('MQ Response headers: ' + response.headers);
                          session.output.write(xmlDom);
                      }
                 });
             } else {
                var errorMessage = 'Received MQ ' + response.statusCode + ' for target ' + options.target;
                session.reject(errorMessage);
             }
          }
      }); 
  } catch (err) {
       var errorMessage = 'Thrown error on urlopen.open for target ' + options.target + ': '
                           + err.message + ', error object errorCode=' + err.errorCode.toString(16);
       session.reject(errorMessage);}

• An example of how options JSON object can be declared for an MQMP header.

  var urlopenMQMPHeaders = {
  // supply an MQMD header
  MQMD: {         // The property name 'MQMD' is the header name.
    MQMD: {       // This 'MQMD' represents the root property.
              StructId: {$:'MD'},
               Version: {$:'2'},
                Format: {$:'MQSTR'},
               MsgType: {$:'1'},
           ReplyToQMgr: {$:session.parameters.qm},
              ReplyToQ: {$:session.parameters.replyQ},
                Expiry: {$:'10000'},
           Persistence: {$:'1'},
              Priority: {$:'10'},
           PutApplType: {$:'6'},
           PutApplName: {$:'My Datapower IBM MQClient'},
        ApplOriginData: {$:'testUrlOpenMPGW'},
      ApplIdentityData: {$:'testUrlOpen.js'}
    }
  },
  // supply an MQMP header
  MQMP : {         // The property name 'MQMP' is the header name.
    MQMP: {        // This 'MQMP' represents the root property.
      Property : [ // an array of property
        {'@name':'car.brand','@type':'string',$:'DataPower'},
        {'@name':'car.color','@type':'string',$:'GREEN'},
        {'@name':'car.year','@type':'int32',$:'2005'}
      ]
      }
    }
  };
  options = {
      target: 'idgmq://' + session.parameters.qm + '/?RequestQueue=GATEWAYSCRIPT.PROPERTIES.REQUEST' 
                        + ';ReplyQueue=' + session.parameters.replyQ,
     headers: urlopenMQMPHeaders,
        data: putData,
         pmo: 2052  // MQPMO_NO_SYNCPOINT (4) + MQPMO_SET_ALL_CONTEXT (2048)};
  };