Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

Version 1 Current »

Key Fields

The Key fields in the Events table are:

Field Name

Description

misCode

The three-digit college code (e.g., 111).

eventId

A unique identifier for each event.

eventType

The type of event (e.g., UPDATE_PROFILE' and 'FEDERATED_IDENTITY_LINK')

eventPayload

The detailed information for the event, which is often structured as a JSON object.

eventTimestamp

The timestamp when the event occurred.

The misCode and eventId form the natural unique key for this table. For example, cases where sister colleges within a district share a single SIS, a single given eventId may be sent to both misCodes.

In addition to these core fields, the table includes other fields for tracking event processing in external systems (e.g., SIS-specific fields).

Field Name

Description

sisEventId

Identifier for the event in the college's SIS.

tstmpSISProcessed

Timestamp of when the event was processed by the college's SIS system.

sisProcessedFlag

A flag indicating whether the event has been processed in the SIS.

sisProcessedNotes

Additional notes related to the event processing in the SIS.

Note: The SIS-specific fields are not part of the core event payload, but are added to the records for the colleges' internal processing.

Event Type Example : UPDATE_PROFILE

Here is an example of an event payload for the UPDATE_PROFILE Event type:

{
    "firstName": "AutoTester",
    "previous_firstName": null,
    "lastName": "Above 18yo",
    "previous_lastName": null,
    "email": "autotester",
    "previous_email": null,
    "cccid": "ABU9844",
    "idme_status": "unverified",
    "previous_idme_status": null,
    "idme_confirmation_timestamp": null

Description of fields:

  • firstName: The updated first name of the user. This field is a string with a maximum length of 100 characters.

  • previous_firstName: The previous first name of the user, if applicable. This field is a string with a maximum length of 100 characters.

  • lastName: The updated last name of the user. This field is a string with a maximum length of 100 characters.

  • previous_lastName: The previous last name of the user, if applicable. This field is a string with a maximum length of 100 characters.

  • email: The updated email address. This field is a string with a maximum length of 256 characters.

  • previous_email: The previous email address, if applicable. This field is a string with a maximum length of 256 characters.

  • cccid: A unique identifier for the user (e.g., CCCID). This field is a string with a maximum length of nine characters.

  • idme_status: The current status of the user's ID verification (e.g., unverified, verified). This field is a string with a maximum length of 50 characters.

  • previous_idme_status: The previous ID verification status, if applicable. This field is a string with a maximum length of 50 characters.

  • idme_confirmation_timestamp: Date with UTC time of when the ID verification was confirmed, if applicable.

Event Triggering action:

Despite the eventType value of ‘UPDATE_PROFILE’ and ‘FEDERATED_IDENTITY_LINK’, CCCTC systems will solely deliver this event payload to college staging tables if or when the previous_idme_status field contains a different value from the idme_status field’s value. It is theoretically possible that a student modifies the first name (or other field) in such a way that does not change their http://Id.me status. In this case, no event would be sent to the college.

Event Payload Structure Variations:

As new event types are added in the future, new fields may be introduced to the event payload structure.

  • The event payload will differ based on the type of event being recorded.

  • Future event types may include additional fields that are specific to those events.

  • No labels