Consuming UHIMS Events

Request Access

  1. Review UHIMS Events - Message Specs and determine which messages you are interested in.
  2. Contact its-iam-help@lists.hawaii.edu to request access:
    • State that you want to consume UHIMS Events
    • Provide the IP address(es) you'll be connecting from.
    • Provide a desired username for the UH Message Broker. This should be something related to your application, not your personal username, e.g.
      • uhm-student-housing
    • Provide a desired queue name. It will always be preceded by the above username, e.g.
      • uhm-student-housing.prod
      • (warning) You must register your queues with us. We will declare the queue and its bindings for you. This is to ensure the queues exist and have the correct settings for persistence, high-availability, etc.
    • Provide the message routing key pattern for the messages you want to be routed to your queue. It is OK to provide multiple patterns. Here are some examples:
      • # (you are interested in all messages)
      • username.# (you only want username messages)
      • affiliation.*.*.uhm.hris (you only want affiliation changes for UH Manoa coming from PeopleSoft)

        You need affiliation messages for accurate deprovisioning

         

        If you plan to use UHIMS Events to deprovision people from your application, you will need to consume affiliation messages.    A deleteAffiliation message will be sent whenever someone changes jobs, changes department or completely leaves the University.

        ITS implements its own lifecycle (see UH Role Assignments and Transitions), so you should not rely on deleteUsername to deprovision a person's access to your application.

Download Client Software

To receive UHIMS Events, you need to connect to the UH Message Broker. Download the RabbitMQ client of your choice.

Consume Messages

See Consumer Code Example