Guides by role
The same Lattice documentation, organized by who you are and what you want to do. Each role page is a list of goals in your own words ("I want to ..."): where to go, what to do there, which role it needs, and where the detail lives. To follow a whole process from start to end across roles, use the guides by process instead.
| Role | Assign | What you do |
|---|---|---|
| Integration administrator | Integration administrator (and, for a named person only, Database access administrator) | Sets Lattice up in an environment and owns its security and risk: access for people and systems, configuration, events and alerts, just-in-time database access. |
| Integration operator | Integration operator; Integration read-only for reviewers and auditors | Watches the integrations every day, finds what failed and why, and gets it moving again (recovery actions need the administrator role). |
| Integration developer | No developer role: Integration administrator in development and test, Integration read-only in production | Builds the external system that calls Lattice: looks up contracts, makes and tests calls, traces them, subscribes to events, sends files. |
| Data management consultant | Integration operator, plus standard data management access | Moves data in bulk: plans a migration, loads journals with set-based entities, keeps data projects and recurring data jobs in source control. |
The Lattice security roles, their duties and privileges are in Security model.
Find your task
Integration administrator
Give people and systems access
- I want to register an integration client
- I want to choose which Lattice role to assign
- I want to review which operations are high-risk and who can run them
- I want to control which client applications can submit to a recurring data job
- I want to retire an integration client
Look after the environment
- I want to deploy or update Lattice
- I want to refresh the explorers and the event catalog after a deployment
- I want to check that the Lattice background processes are running
- I want to schedule the Lattice jobs that are not background processes
- I want to act on an item an operator hands over
- I want to check the Lattice license status
- I want to point the Help icon at our own documentation
Configure integrations
- I want to set how much each service operation logs
- I want to turn off an asynchronous operation
- I want to set up the inbound order guardrails
- I want to stamp a financial dimension from the sales origin
- I want to register external systems for cross-reference keys
- I want to set up a file ingestion connection
- I want to keep connection secrets in Azure Key Vault
- I want to publish the API to Azure API Management
Events and alerts
- I want to activate a business event and send it to an endpoint
- I want to resend business events that failed
- I want to leave noisy batch jobs out of the batch job status event
- I want to set health thresholds and alerts for a recurring data job
Just-in-time database access
Integration operator
Every day
- I want to see at a glance whether integrations are healthy
- I want to do the daily check
- I want to check call volumes and error rates
- I want to check that the Lattice background processes ran
When a call fails
- I want to find the inbound calls that failed
- I want to see why a call was refused
- I want to trace one request end to end
- I want to check whether a request was a duplicate
- I want to close a claim that is stuck in processing
- I want to check an asynchronous operation
- I want to check which key an external system uses for a record
When a message is dead-lettered
- I want to see what is in the dead-letter queue and why
- I want to look up what an operation expects
- I want to retry, hold, release or discard a dead-lettered message
- I want to fix a bad payload and resubmit it
- I want to follow a file from arrival to posting
- I want to test a corrected record without posting anything
Recurring data jobs
- I want to see which recurring data jobs need attention
- I want to find the rows a recurring data job rejected
- I want to repair or reactivate a recurring data job
- I want to change when a recurring data job counts as unhealthy
Held orders and business events
- I want to see and release orders held by the inbound order policy
- I want to check that business events were sent
Get told instead of looking
Integration read-only: what you can see
- I want to review integration activity for a period
- I want to see who ran a call or acted on a failed message
- I want to keep a copy of what a partner sent
- I want to check recurring data job health without changing anything
- I want to read the integration logs from my own reporting tool
Integration developer
Look up a contract
- I want to find the operation for a business process
- I want to review the request and response contract of a service operation
- I want to review the data contract of an OData entity
- I want to download the OData metadata document for my client code
- I want to get a Postman collection or an OpenAPI specification
- I want to find the business event for a business moment and its payload
Connect and make calls
Test without posting
- I want to try a posting without posting anything
- I want to run an operation from inside Finance and Operations
When a call fails
- I want to find out why my call was refused
- I want to trace one of my calls
- I want to see what happened to a file I sent
Make the integration robust
- I want to make my calls safe to retry
- I want to send my own keys instead of D365 ids
- I want to send many documents in one call
- I want to run a long posting in the background and collect the result
- I want to read data back efficiently
- I want to subscribe my system to a business event
- I want to know when a contract I use changes
Send files instead of calls
- I want to write and test a Liquid template for my files
- I want to run a sample file through the pipeline without posting
- I want to start from a ready-made intake bundle
- I want to send or collect files for a recurring data job
Data management consultant
Plan the load
- I want to find which entity covers a table
- I want to list the tables that hold data but no entity can reach
- I want to see the fields and keys of an entity and which fields I can write
- I want to give the source system team a template to fill in
Load data in bulk
- I want to import a large journal file as ready-to-post journals
- I want to see why lines were refused and resend only those
- I want to post the journals I imported
- I want to bring legacy keys across with the records
Check the result
- I want to read data back to reconcile a migration
- I want to export every field of an entity to Excel
Run recurring data jobs
- I want to create a data project and a recurring data job by hand
- I want to set up a recurring data job and its client application through Lattice entities
- I want to check that my recurring data jobs are healthy
- I want to find the staging row that failed in a recurring import
- I want to start, stop or repair a recurring data job
- I want to be told when a recurring data job changes health
Keep configuration in source control
- I want to capture a data project and its recurring data jobs as a file
- I want to keep field mappings in the specification
- I want to see how an environment differs from the specification
- I want to apply the specification to another environment
- I want to restore integration configuration after a database copy
Before and after an update