IMES Prerequisites for Shift Handover Reports
IMES data reaches Shift Handover Reports from the iMES database through TaskOrchestration and Kafka. The implementation team sets up everything before the Shift Handover settings.
How IMES data reaches Shift Handover Reports
The shift-handover use case pulls four iMES data sets into Shift Handover Reports:
- Read. TaskOrchestration reads the iMES MySQL database with a read-only account.
- Execute SQL. One task graph per data set and work center runs the data set's SQL (task
execute_sql), on a schedule. - Publish. The graph's
publish_kafkatask publishes the result to the Kafka topictask.sql.results. - Consume. The mRounds Shift Handover service consumes the topic and adds the result's table and columns as an IMES source and collection.
- Present. Plant admins add IMES widgets, and reports refresh about every 30 seconds. See Add Alerts and IMES Widgets to Shift Handover Reports.
| Topic | Covers |
|---|---|
| iMES Data Sets for Shift Handover | The four data sets, their columns and SQL |
| TaskOrchestration Connection Settings for iMES | iMES database and Kafka connection settings |
| iMES Task Graphs and Schedules | Task graphs, parameters and schedules |
| iMES Results Message on Kafka | The Kafka message that mRounds consumes |
| Verify That IMES Results Reach Shift Handover Reports | End-to-end verification |
Checking that TaskOrchestration publishes results and checking that Shift Handover consumes them for your tenant are separate checks.
Implementation team handoff
The implementation team sets up and confirms these items. Plant admins do not configure them.
| Item | What must be true |
|---|---|
| iMES database | The data-set tables and views hold current data. TaskOrchestration reads them with an account that is read-only on those objects. |
| TaskOrchestration | Running with the iMES database and Kafka settings issued for the deployment. Its startup log shows the resolved host, port, database and brokers. |
| Task graphs and schedules | A graph exists for each data set and work center the plant needs, with a schedule that matches how often shift handover needs fresh data. |
| Kafka topic | task.sql.results exists. The Kafka listener requires TLS and SASL/SCRAM. The Shift Handover IMES consumer reads the same topic. |
| Temporal | TaskOrchestration and its worker use the same Temporal namespace (TEMPORAL_NAMESPACE=default) and task queue (TEMPORAL_TASK_QUEUE=default-workers), and the Temporal namespace default is registered. It is a Temporal grouping, not the Kubernetes namespace named default. The API can run the temporal CLI in the admintools pod (TEMPORAL_KUBECTL_NAMESPACE, TEMPORAL_ADMINTOOLS_DEPLOYMENT, and RBAC in that Kubernetes namespace); without it, the API fails at startup. |
| Task graphs in MongoDB | The API loads task graphs into MongoDB when it starts. It adds missing graphs but never replaces existing ones, so a changed graph does not reach MongoDB on redeploy until it is re-seeded. |
| TaskOrchestration API URL | The implementation team gives DevOps the URL to enter in imesConfig.baseUrl. See Configure Shift Handover Alerts and IMES Settings. |