Runtime help

Everything useful about PiFlow in one place.

This help page is tied to the current simulator code. It summarizes authentication, route groups, runtime defaults, and example calls without sending you hunting through the repository first.

Back to landing page

5 Public routes

10 JSON discovery endpoints

28 Directory service paths

8 Repository helper paths

12 Monitoring routes

2 Assessment callbacks

PiFlow requires explicit environment configuration for authentication and token signing. If PIFLOW_SIGNING_SECRET, PIFLOW_USERS_JSON, or PIFLOW_OAUTH_CLIENTS_JSON is missing or invalid, protected routes fail closed instead of falling back to demo credentials.

Quick start

Start in the same order a real integration flow would.

Health first, auth second, then discovery routes and assessment callbacks. This sequence mirrors how the main app and manual validation usually interact with the simulator.

Step 1

Verify the simulator is alive

Start with GET /health before moving on to protected routes.

Step 2

Choose an auth flow

Use Basic Auth for quick checks or mint a Bearer token through the OAuth client credentials flow.

Step 3

Exercise discovery surfaces

Use JSON catalogs for quick inventory and SOAP endpoints for SAP-like Query and Read behavior.

Step 4

Run a stateless assessment

POST /migration-assessment/run and poll GET /migration-assessment/results/{job_id}.

Auth and configuration

Protected routes require explicit configuration.

This PiFlow deployment requires explicit environment configuration for authentication and token signing. If those values are missing or invalid, protected routes fail closed instead of falling back to demo credentials.

Runtime config

Env overrides and local defaults

PIFLOW_SIGNING_SECRET
Required secret for bearer tokens and signed assessment job identifiers.
PIFLOW_USERS_JSON
Required JSON map of Basic Auth users, passwords, scopes, and roles.
PIFLOW_OAUTH_CLIENTS_JSON
Required JSON map of OAuth client IDs, client secrets, scopes, and subjects.

Supported auth

Three ways to reach protected routes

Basic authentication for protected JSON, SOAP, and assessment routes
Bearer tokens minted by POST /oauth/token
OAuth2 client credentials with scoped access tokens

Route groups

The help is generated from the simulator surface that exists today.

Each group below summarizes access expectations, supported verbs, and the concrete paths currently wired into the app.

Public routes

Landing page, runtime help, health probe, metadata, and OAuth token issuance.

Public GET and POST 5 paths

/
/help
/health
/api/meta
/oauth/token

JSON discovery

Catalog endpoints for PI/PO, BRM, and BPM artifacts returned as JSON.

Scope: catalog.read GET and HEAD 10 paths

/api/v1/bpm/process-definitions
/api/v1/bpm/service-tasks
/api/v1/bpm/workflows
/api/v1/brm/decision-tables
/api/v1/brm/functions
/api/v1/brm/rulesets
/api/v1/pipo/communication-channels
/api/v1/pipo/integration-flows
/api/v1/pipo/mappings
/api/v1/pipo/value-mappings

Directory services

SAP-like Directory API services with WSDL discovery plus SOAP Query, Read, and Check behavior.

Scope: migration-assessment.read or wsdl.read HEAD, GET, and POST 28 paths

/AlertRuleInService
/AlertRuleInService/AlertRuleInImplBean
/AlertRuleInService/AlertRuleInImplBeanHTTPS
/BPMFacadeBeanImplService
/BusinessComponentInService
/BusinessComponentInService/BusinessComponentInImplBean
/CommunicationChannelInService
/CommunicationChannelInService/CommunicationChannelInImplBean
/ConfigurationScenarioInService
/ConfigurationScenarioInService/ConfigurationScenarioInImplBean
/IntegratedConfiguration750InService
/IntegratedConfiguration750InService/IntegratedConfiguration750InImplBean
/IntegratedConfigurationInService
/IntegratedConfigurationInService/IntegratedConfigurationInImplBean
/IntegrationProcessInService
/IntegrationProcessInService/IntegrationProcessInImplBean
/InterfaceDeterminationInService
/InterfaceDeterminationInService/InterfaceDeterminationInImplBean
/ReceiverAgreementInService
/ReceiverAgreementInService/ReceiverAgreementInImplBean
/ReceiverDeterminationInService
/ReceiverDeterminationInService/ReceiverDeterminationInImplBean
/ReceiverRuleInService
/ReceiverRuleInService/ReceiverRuleInImplBean
/SenderAgreementInService
/SenderAgreementInService/SenderAgreementInImplBean
/ValueMappingInService
/ValueMappingInService/ValueMappingInImplBean

Repository helpers

Repository and directory helper routes for ESR-style Query and Read flows.

Scope: migration-assessment.read HEAD, GET, and POST 8 paths

/dir/query/
/dir/query/ext
/dir/read/ext
/rep/query/
/rep/query/ext
/rep/query/int
/rep/read/ext
/rep/support/SimpleQuery

Monitoring and admin probes

CPA cache, Channel Admin, MDT, and schema-style technical probes.

Scope: migration-assessment.read GET and HEAD 12 paths

/AdapterFramework/ChannelAdminServlet
/AdapterFramework/channelAdmin/ChannelAdmin.dtd
/AdapterFramework/channelAdmin/ChannelAdmin.xsd
/CPACache
/CPACache/history.jsp
/CPACache/monitor.jsp
/CPACache/refresh
/mdt
/mdt/messageoverviewqueryservlet
/mdt/monitor/MessageOverviewQuery.xsd
/mdt/monitor/PerformanceDataQuery.xsd
/mdt/performancedataqueryservlet

Migration assessment

Stateless run and result callbacks compatible with hosted deployment.

Scopes: assessment.execute and migration-assessment.read POST and GET 2 paths

/migration-assessment/run
/migration-assessment/results/{job_id}

Example calls

Ready-to-adapt commands for the most common checks.

Use these as smoke tests or as starting points when you are wiring the simulator into the main app.

Example 1

Health probe

curl https://piflow.ayreshub.com/health

Example 2

List integration flows with Basic Auth

curl -u <configured-user>:<configured-password> \
  https://piflow.ayreshub.com/api/v1/pipo/integration-flows

Example 3

Request a bearer token

curl -u <configured-client-id>:<configured-client-secret> \
  -X POST https://piflow.ayreshub.com/oauth/token \
  -d grant_type=client_credentials \
  -d scope="catalog.read migration-assessment.read"

Example 4

Run a SOAP alert rule query

curl -u <configured-user>:<configured-password> \
  -X POST https://piflow.ayreshub.com/AlertRuleInService/AlertRuleInImplBeanHTTPS \
  -H "Content-Type: text/xml" \
  -d '<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:bas="http://sap.com/xi/BASIS"><soapenv:Body><bas:AlertRuleQueryRequest/></soapenv:Body></soapenv:Envelope>'

Example 5

Start an assessment run

curl -u <configured-user>:<configured-password> \
  -X POST https://piflow.ayreshub.com/migration-assessment/run \
  -H "Content-Type: application/json" \
  -d '{"sourceSystem":"SAP_PI_PO","scope":"full","namespace":"demo","credentialName":"pipo"}'