Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Corrected links that should have been relative instead of absolute.

Interface Specification

Each System of Record has a set of profiles that define a tuple of Endpoint, Inbound Specification, and Outbound Specification. A System of Record can have more than one profile. Each specification can define a messaging queues its interested in, as well as how activation notifications should be sent to new people.

Profile

Inbound

  • All required fields for that System of Record
  • All disallowed fields
  • Additional Limits/Validations on the fields (i.e. can only send one address)
  • Allowed values for enumerations (i.e. can only give addresses of type CAMPUS, HOME)
  • Data Format for Input (LDIF, XML, JSON, etc.)

Outbound

  • Fields that need to be sent back
  • Transformers (i.e. CAPITALIZE)
  • Export Format (LDIF, XML, JSON, etc.)

Messaging Queue

  • Messages that we're interested in

Activation

  • Notification Scheme (EMAIL, TEXT, MAIL, etc.)