Diagram (Data Flow)

Here you can create new diagrams. There are two ways to do this.



images/download/attachments/131695697/1336-version-1-modificationdate-1677559215654-api-v2.png

images/download/attachments/131695697/1337-version-1-modificationdate-1677559215651-api-v2.png

Creating a diagram automatically


Here you only need to add an element, e.g. a profile, see (1) and (2). Starting with this profile, a diagram of the complete profile chain (including ASM entries, Content Inspection entries, etc.) is automatically created for you. The following screenshot shows an example of the profile named Profile_1. If a profile is inactive or no longer valid, it will be displayed as Profile_2. If a profile used in the diagram can no longer be found, e.g. because it has been deleted in the meantime, it is displayed in red. Note: If one of the profiles in the profile chain uses a variable in a Response of type "Message" to specify the profile to be triggered (this can be the case especially for dispatcher profiles), this Response is represented as an endpoint in the diagram. See the symbol for @var__TARGET_PROFILE@ in the screenshot below.


images/download/attachments/131695697/358-version-1-modificationdate-1677559215661-api-v2.png

Information about element


If you select any element (4) in the diagram ( only possible via left click) , its details will be displayed on the left (5).


images/download/attachments/131695697/1338-version-1-modificationdate-1677559215646-api-v2.png

Create a diagram from scratch manually


In this case, you create completely new elements in the right window via the context menu, see (3). So if you create a new profile there and generate a Response in it, this profile will actually be created like this. The same applies to other components in the diagram.

Note on saving


If you create a new element (e.g. a new profile to be created, an ASM entry, etc.), then this is saved immediately (and is then available as a new profile, for example). However, if you create a connection from a profile existing in the diagram to another profile (via message), then the message Response is not entered in the profile until you save the Data Flow diagram.

Creating REST API collection


As you probably know, you can implement REST interfaces via event-driven HTTP profiles and make them available via OpenAPI GUI.

The Data Flow module allows you to combine several of these profiles and offer them as a bundled OpenAPI GUI.

To do this, simply create a new Data Flow entry and add all the HTTP profiles that you want to display in this bundled view to the diagram (1) and save the entry.

Now switch to the main settings of the entry and click on link (2).


images/download/attachments/131695697/1921-version-1-modificationdate-1707797140645-api-v2.png

images/download/attachments/131695697/1925-version-1-modificationdate-1707808954081-api-v2.png

images/download/attachments/131695697/1924-version-2-modificationdate-1707807552605-api-v2.png

Versioning


To create a new version of your REST API, please switch to the Data Flow overview and select your Data Flow entry. Select the option Complete copy (including all entries) in the context menu. See details there. This creates a copy of the Data Flow entry and the profiles it contains (with versioned paths). You can then customise the profile copies as required.