Quick Start Guide

This page describes messaging and the steps needed for a Global Partner (GP) to be a participant in the messaging system.

Messaging is one of the vehicles used to transfer data from the GP to the GMC (Global Ministry Center) and from the GMC out to the GP. Another way the GP will receive data is through web services which provide read only request/reply data retrieval.

Currently, the GMC Source System database is Compass so any data sent to the GMC or being received from the GMC through the messaging system will be entered into or coming out of the Compass database.

Two-way Messaging Flow Diagram
One-way Messaging Flow Diagram
Messaging Setup
End to End Message Delivery Setup
Items for GPs to Be Familiar With

Two-way Messaging Flow Diagram

From GP to GMC Source System Database

One-way Messaging Flow Diagram

From GMC Source System Database to the GP

Messaging Setup

To participate in Compassion Messaging, the GP must:

1. Request a unique name to represent the GP's system which will participate in messaging. The format of this name is the two-letter country code plus the abbreviated tool name that will be used.
   For example, the Scandinavia partner uses Microsoft NAV tool, so their system has the unique name “SCNav”. This unique name acts as a delivery address (FromAddress, ToAddress) in Compassion Messaging.
2. Request an Active Directory system account in the Compassion CI domain. This system account is required for proper authentication when messages are sent to and from the GMC.

End to End Message Delivery Setup

1. Work with the GMC SOA Team to ensure that the unique name, the Active Directory system account, and all message types to be used (to and from the IP) are configured in the Compassion Messaging system.
2. Work with the GMC SOA Team to configure end-to-end communication. As in the picture above, GPs call the public OnRamp to send messages to the GMC.
3. Work with the GMC SOA Team to configure an GP OnRamp for receiving messages from the GMC. Click here for more details about setting up the IP OnRamp.

Items for GPs to Be Familiar With

• Be familiar with unique names of other systems to which the GP will send messages. For example, a message sent to the Compass database must be addressed to “GMCCompass”
• Be familiar with the types of messages which can be sent and received. Full details regarding available messages can be accessed at Available Message Types.
• Be familiar with the read-only services that can be called to retrieve data on child related information in the GMC Source System database. See details at Message and Service Relationships.

Other Important Articles

• Web Services Handshake (Legacy) - Notification and Command Messages
• Available Message Types
• Message and Service Relationships
• Sample REST End-To-End Test Plan
• OnRamp Prerequisites and Setup
• IP OnRamp Service Configuration
• Troubleshooting
• General Error Messages From Compass Party Host
• ErrorMOE Sample