Skip to content Skip to site navigation

Getting Started with the MaIS Harvester

The Middleware and Integration Services (MaIS) Harvester is a solution providing near real-time event-based updates from the Registry to your application or service through Java Messaging Service (JMS). Read on to find out how to get started. If you would prefer a pull mechanism read about the Web APIs available.

Harvester checklist

Recommended Task Actor
  Review the MaIS Data Usage and Integration Policies. Client
  Initial contact - discuss requirements MaIS, Client
  Seek data owner approval - where applicable Client
  Create Jira/ServiceNow request MaIS or client
  Determine if event-based harvesting is the best solution for the client, or if another solution would be better (e.g. Web APIs). MaIS
 

Determine how data will be delivered to the clients:

  • post to webservices
  • file transfer to client server
  • update client database (not recommended)
  • any data transformation is required
 MaIS
  For proof of concept for event harvesting, ask clients to apply for a test/non-prod certificate MaIS
  Client to request certificates (non-prod and prod) via Registrycm Client
  Sign certificates, and review selection of services before signing MaIS
 

Download certificates

  • construct p12 file for harvesting events
  • construct keystore file for accessing xmldoc
 Client
  Configure firewall access — create a MAI JIRA MaIS or client
 

Event harvesting: create a MAI JIRA to set up WebLogic

  • create new user, assign to an existing topic/group or, on a rare occasion, create a new group
  • create exception topic if needed
 MaIS
  Develop the harvester MaIS or client

Troubleshooting

My harvester is not working. What should I do?

  • Verify that the harvester is running by:
    • Checking the timestamp on the log files (logs/*.log) OR
    • Checking if the process is running
$ ps -ef|grep <harvester name>
  •  If the harvester is running, check for errors by:
    • Checking the log files (logs/*.log) for error messages/exceptions. Common error messages and causes include:
      • a) Destination unreachable (JMS issue, contact MaIS)
      • b) Connection timeout (check connectivity)
      • c) SSL exception (check certificate)
  • Verify that the connection is open by using telnet to check:

    • JMS

$ telnet [hostname] [port]
example: telnet maisjms-test.stanford.edu 7112
  • Document service
$ telnet [hostname] [port]
example: telnet registry-test.stanford.edu 443
  • Verify that downstream service is ready by checking the:
    • Connectivity
    • Credential/authentication
Last modified April 14, 2023