Module Documentation

AceADK

Version 1.0

October 2010

ACE Software Solutions, Inc.

Document History
Version Created or Updated by Release Date Comments
1.0 Saroj Kumar Nayak 26 Oct 2010 Created

Contact Information
Please feel free to contact us at the following address for information about this document.

For General or Sales Enquiries For Technical Enquiries

Tim Dawes Rajiv Desai Amit Desai
ACE Software Solutions Ltd. ACE Software Solutions Inc. ACE Software Solutions (I) Pvt.
Ltd.
53 St. George's Road, 33 Wood Avenue South, Unit 21, SDF 1, SEEPZ,
Wimbledon, London Suite 600, Iselin Andheri (East),
SW 19 4EA, NJ 08830, Mumbai 400 096,
UK USA India

Tel: +44 208 947 7200 Tel: +1 732 603 4997 Tel: +91 22 2829 2337
Fax: +44 208 947 2694 Fax: +1(732) 321 6562 Fax: +91 22 2829 2338
contact_uk@acesw.com contact_us@acesw.com contact_India@acesw.com

You can also visit our web site www.acesw.com for further details.

Trademarks
 1995-2010 ACE Software Solutions, Inc.

All rights reserved.

No part of this document may be reproduced in any form, including photocopying or translation
to another language, without the prior written consent of ACE Software Solutions, Inc.

STP Toolkit, STP Analyzer, STP Reporter, STP Administrator, STP Enhancer, STP
Assistant, STP Translator, STP Draftsman, STP Designer, STP Monitor, AML
Toolkit, AML Administrator, AML Monitor, OFAC Station OFAC Station and
Pelican are trademarks of ACE Software Solutions, Inc.

All other brand names and product names are trademarks or registered trademarks of their
respective companies and are recognized as such.

Disclaimer
ACE Software Solutions, Inc. uses its best endeavors to ensure the accuracy of the contents of
this document. However, ACE Software Solutions, Inc. assumes no responsibility for any
inadvertent error or omission that may appear in this document.
 TABLE OF CONTENTS

DISCLAIMER..................................................................................................................................................2
1. INTRODUCTION......................................................................................................................................4
2. MODULE INFORMATION.....................................................................................................................4
3. IMPLEMENTATION................................................................................................................................4
3.1 MAIN FLOW (ACEMQAPI.C).................................................................................................................4
3.1.1 Exceptional/Error flow...................................................................................................................4
3.2 MAIN FLOW (ACEMQAPI.C).................................................................................................................4
4. Environment variable...................................................................................................................................6
1 Introduction
It is a wrapper module that calls ADK C API functions. These ADK API functions help our
server components to properly work in ADK environment.

2 Module Information
MigrateRulLibs Tool is made up of following “c” files.

No File Name Requirement

1. ACEADKAPI.c All the wrapper functions

3. Implementation
3.1 Main Flow (ACEADKAPI.c)

1. Start
2. Connect to MQ Server.
3. Open the specific queue in either read mode or write mode for further communication.
4. If the queue is opened in read mode, messages can be read from the queue.
5. If the queue is opened in write mode, messages can be written to the queue.
6. If incase of any error roll back the whole transaction.
7. In case of no error, whole transaction is committed.
8. Close the queue.
9. Disconnect from the MQ Server.
10. End.

3.1.1 Exceptional/Error flow

 If connection is not successful.

 If failed to open the queue.
 If unable to read/write from the queue.

3.2 Main Flow (ACEADKAPI.c)

 Connecting to MQ Server
o “AceMQConn” function is used to establish a connection to the specified queue
manager and returns a connection handle. It takes Queue Manager name as
parameter and returns the connection handle.
  Connecting to MQ Series queue

o “AceMQOpen” function is to open a specified Queue in read or write mode

andreturns a connection handle to the queue. This connection handle will be
unique to do any further communication with the queue. s

 Putting a message into a queue

o “AceMQPut” function is used to put a message in a specified queue.

 Getting a message from a queue

o “AceMQGet” function is used to read messages from a queue.

 Comitting a transaction

o “AceMQCmit” function is used to commit a transaction.

 Rolling Back a transaction

o “AceMQBack” function is used to roll back a transaction.

 Closing a connection from a queue

o “AceMQClose” is used to close the connection from a queue.

 Disconnecting from the Queue Manager

o “AceMQDisc” is used to disconnect from the queue manager.

 Getting the reason code in case of any error

o “AceMQCheckforConnectionError” function is used to know the exact reason

behind the communication error.
o To display the error, “AceMQDisplayError” function is called.

 Initializing MQMD

o “AceMQInitMQMDStructure” is used to initialize the fields in the MQMD

structure.

4. Environment variable
To establish the connection with the MQ Server, MQSERVER environment variable must be
defined.

Syntax:-
MQSERVER=<CHANNEL_NAME>/<PROTOCOL_TYPE>/<MQ_SERVER_MACHINE_IP>
(<MQ_SERVER_PORT >)

Ex:-
MQSERVER=CHL_ACE_DEMO/TCP/127.0.0.1(1414)