Skip to content
Last updated:

Documentation PDF

Generate the documentation of an iFlow or a whole package, and publish it to SharePoint.

  1. In Document Flow, with an iFlow selected, open ≡ → Preview PDF.
  2. The PDF is built in the background; you can keep working. Follow it in the PDFs tray, the inbox icon in the header.
  3. When it is ready, Preview opens it in a new tab and Save downloads it.

To document a whole package, right-click the package in the Map and choose Document all interfaces, or use Generate N documents in its panel. Each iFlow gets its own PDF, and Download all saves them as a ZIP.

PageContent
CoverEnvironment, deployed version, who deployed it, when the document was generated and by whom.
OverviewThe iFlow and its package.
ArchitectureThe drawing: the generated one, or yours if you edited it.
Inbound interfaceHow the iFlow is triggered.
Outbound callsEach system it calls.
Message schemaWhen a schema is known.
Monitoring & analyticsVolumes over 24 hours, 7 days, 30 days and a year. Needs the Monitoring module.
Incident recordsIncidents of the last 90 days.

Ready files stay in the tray for 30 minutes. They are also lost when you reload the page, close the tab or sign out, so save the ones you need. While a PDF is building, the inactivity sign-out waits.

When an admin has set up SharePoint, ready PDFs can be published to a document library: with Publish in the tray, or automatically. The tray shows Published to SharePoint with a link to the file.

Set it up in Settings → Integrations → SharePoint (needs the Integrations module):

  1. Connection: the site URL, the Microsoft Entra directory (tenant) ID, the client ID and the token URL, authenticated with a client secret or a certificate (recommended). Click Test connection: the credential is used only after a successful test.
  2. Publishing: turn on Enable publishing and, if you want, Publish automatically. Choose the Document library, the Folder path and the File name, which accept {tenantName}, {iflowName}, {packageName}, {date}, {yyyy} and {mm}.
  3. Choose what happens if the file already exists: replace it, keep both, or report the conflict.

Files up to 60 MB can be published.