Tool Search: Message History
The Message History tool allows users to generate a report of SIF Unity data activity and a report of State IDs that have been updated.
The Message History tool allows users to generate the following types of reports:
- Message History - generates a report that includes detailed information about messages sent for a specific SIF object within a specific time frame. This report allows you to review recent SIF data activity and can be used to verify configuration and troubleshoot any errors that have occurred during the exchange of data.
- State ID Report - generates a report of state IDs that have been updated in a specific time frame.
SIF Unity tools are only available for SIF v3.X or higher.
Message HistoryRead - Access and generate the reports.
Write - Provides no function for this tool.
Add - Provides no function for this tool.
Delete - Provides no function for this tool.
For more information about Tool Rights and how they function, see this Tool Rights article.
Generate the SIF Message History Report
Users can generate the SIF Message History Report to review recent SIF activity and diagnose SIF message errors that may be occurring from a SIF reporting entity.
Message HistoryReview the Message History Summary:
The Message History Summary displays below the editor and shows a summary of SIF events that have occurred for the objects.
Message History SummaryMessage History Summary Fields
| Field | Description |
|---|---|
| Object | The name of the SIF object(s) for which a message occurred. |
| Last Response | The data and time the message was sent. |
| Status | Indicates if the message was a success or failure. |
| Records Sent | The number of records sent for the object. |
To Generate the SIF Message History Detail Report:
- Select Message History as the Report Option.
- Enter the Start Date. This is the first day in the date range of SIF messages included in the report.
- Enter the End Date. This is the last day in the date range of SIF messages included in the report.
- Select which SIF Objects will report message data. Select 'All Objects' to see all SIF messages within the timeframe or select an individual (or more) SIF Object to see SIF message results for these specific objects.
- Generate the report.
- The report will display below the editor. If desired, the report can be exported to Excel.
SIF Message History ReportMessage History Detail Fields
| Field | Description |
|---|---|
| Object | The name of the SIF object(s) selected for which the report is being generated. The objects are selected in the Extract Options editor. |
| Configuration | The name of the configuration in which the report is being generated. |
| Start Date | The Start Date indicated in the Extract Options editor. |
| End Date | The EndDate indicated in the Extract Options editor. |
| Status | The determined status of the batch sync.
Note: The report is filtered to show Successful statuses by default. |
| Request Type | The type of request for the SIF object.
|
| Records Sent | Indicates the number of records sent for the object. |
| Records Processed | The number of records successfully processed by the receiving SIF entity. If this number varies from the Records Sent number, this indicates errors occurred. |
| Number of Errors | The number of records that were not successfully processed by the receiving SIF entity. This indicates additional investigation might be necessary to identify the reason behind these errors. |
| Message History GUID | A unique identifier for the batch sync processed for that object. |
Generate the State ID Report
The State ID report generatea a report of State IDs that have been updated within a specified timeframe.
State ID Update SummaryTo Generate the State ID Report:
- Select State ID Report as the Report Option.
- Enter the Start Date. This is the first day in the date range of the State ID report.
- Enter the End Date. This is the last day in the date range of the State ID report.
- Generate the report.
- The report will display below the editor. If desired, the report can be exported to Excel.
State ID Update Summary Fields
| Field | Description |
|---|---|
| Last Response | Indicates the time and date of the last response. |
| Last name | The last name of the individual for whom the State ID was updated. |
| First Name | The first name of the individual for whom the State ID was updated. |
| Middle Name | The middle name of the individual for whom the State ID was updated. |
| Student Number | The student number of the individual for whom the State ID was updated. |
| State ID | The State ID of the individual for whom the State ID was updated. |
