Integration discovery worksheet
This page is for integrators running the discovery workshop of an integration project. Copy the worksheet, fill it in with the customer, and keep it as the input for the interface specifications and the estimate. Each question points to the page that explains why it matters.
Contents
- How to use it
- Part 1: the installation
- Part 2: the systems around it
- Part 3: one block per data flow
- Part 4: identity and access
- Part 5: constraints and open questions
How to use it
- Fill it in a workshop with the customer's project lead, the owners of the other systems and an operator.
- Ask for samples: a real export file, a real API answer, real form submissions. Discovery without real data underestimates data quality problems every time.
- Mark every answer that is a guess; it becomes an assumption in the statement of work.
Part 1: the installation
Exponential version (Setup > System information or composer show): ...........
Distribution (Legacy / Nexus): ........... Database engine: ........... PHP: ...........
Served by (Apache + PHP-FPM / Velocity / FrankenPHP): ...........
Siteaccesses involved: ...........
Extensions active that matter (ezprestapi, expservices, xrowextract, syndication, sevenx_authentication_2fa ...):
...........
Environments available (development / staging / production), and who hosts them: ...........
Who may deploy code, and how (Git, Composer, a pipeline): ...........Why: Integration surfaces at a glance.
Part 2: the systems around it
System Product and version Owner (team, contact) API / export available Test instance? Docs?
CRM ... ... ... ... ...
ERP ...
PIM / DAM ...
Identity ...
Search ...
Mail ...
Payment ...
Analytics ...
Other CMS ...Why: What integrators do with Exponential.
Part 3: one block per data flow
Flow name: ........................................... Priority: must / should / could
Direction: into Exponential / out of Exponential / both
Master of the data: ........... Fields owned by editors: ...........
Started by: Exponential (push) / the other system (push) / a schedule (pull)
Timing: nightly / hourly / within minutes / on event Acceptable delay: ...........
Volume: records in total ........... changes per day ........... peak ...........
Record key at the source: ........... remote_id scheme: ...........
Content: plain fields / rich text / media / relations / languages (which) ...........
Removals at the source: remove / hide / state / keep
Errors: what happens with an invalid record? who is told?
Personal data in the flow: yes / no, which ...........
Sample received: yes / no (file, date) ...........
Surface proposed: ........... Credential proposed: ...........Why: Push and pull, batch and real time, Idempotent imports, Choosing credentials.
Part 4: identity and access
Who signs in to the site? staff ...... members ...... partners ...... public ......
Where do their accounts live? directory (LDAP, Active Directory) / identity provider (SAML, OIDC) / social / Exponential
Password typed on the site acceptable? yes / no
Groups and roles derived from the directory? which mapping ...........
Leavers: how is Exponential told? ...........
Apps acting for users (OAuth)? ...........Why: Login handlers, Single sign-on.
Part 5: constraints and open questions
Security requirements (network zones, allowed protocols, IP allowlists, SIEM): ...........
Data protection (processors, regions, retention): ...........
Availability needed per flow, maintenance windows: ...........
Deadlines and fixed dates: ...........
Budget frame: ...........
Open questions (owner, due date):
1 ...........
2 ...........Why: Security for integrations, Estimating.
Related pages
- Interface specification template
- Integration project playbook
- Content modeling workshops
- Free documentation: this page is free to copy, translate and improve under the GNU FDL 1.3.
Become an Exponential Partner
Partners share their information, provide funding, contribute back and develop the products with us, and that is how Exponential grows. A partner website and dashboard are planned for mid-2027: please become a partner today to speed up our growth rate and land new features faster.