Editing a Flow


We're Moving ... Again

Yes, the Identity Cloud documentation is once more on the move. And this time we're headed to two different locations:

As for the Education Center, well, the Center itself will disappear on July 23rd. We apologize for any inconvenience, but we look forward to becoming a full-fledged member of the Akamai family.
 

REST API Equivalent: You can use the /config/{app}/flows/{flow}/versions endpoint to return version information (and change information) for a specific flow.


Currently, the Edit page provides a way for you to: 

  • View detailed version information about your flows.
  • Create a copy of any of those versions (the Console keeps track of the past 100 versions of each flow.
  • “Restore” a previous version of a flow (i.e., make that the current version of the flow).
  • “Promote” a flow to a different application. 

In subsequent releases to the Registration Builder, this page will also allow you to modify the values found in the flow – add a new attribute to a form, delete a translation, create new strings, etc.

Let’s start by looking at the version history for a flow. If you start on the Registration Flows page, click the Actions icon for a flow, and then click Edit, you’ll end up on the Edit page. There, you’ll see the flow name and current version number, as well as a button labeled Show History:

If you click Show History, you’ll see the last 100 versions of the flow (well, assuming that there are 100 previous versions of the flow:

As the name implies, these are prior versions of the flow in question. Don’t be surprised if you see a number of items in the version history: each time you make a change to a flow, a new version is created. Suppose you add a new field to a flow. When you do that, you’ll have the original version of the flow plus the new version (the version containing the new field). Suppose the next day add a new translation to the flow. Now you’ll have three versions: the original; one with the new field; and one with both the new field and the new translation.

Etc., etc.

For each flow version you’ll see the following properties:

Property

Description

Version

Version number automatically assigned at the time the flow was created. For example, a flow might have a version number similar to this:

20181121175636000443

That version number is actually a timestamp that tells you exactly when the flow was created:

  • The first four digits (2018) indicate the year.
  • The next two digits indicate the month (11). Leading zeroes are used for the months of January through September; for example, August is represented as 07.
  • The next two digits indicate the day (21). Again, leading zeroes are used for the first through the ninth days of a month.
  • The next four digits (1756) indicate the flow creation time, based on a 24-hour clock. For example, 17:56 is equivalent to 5:56 PM on a 12-hour clock. Leading zeroes are used as needed.
  • The next two digits (36) indicate the seconds of the day when the flow was created. Leading zeroes are used as needed.
  • The final six digits (000443) indicate the microseconds of the day. Leading zeroes are used as needed.

Note that version numbers never change. If you update a flow and then save your changes, a new flow (with a new version number) is created. That means that you’ll then have two flow versions: the original version (20181121175636000443) and the new version (for example, 20190121131822000985).

Change

Indicates the reason why the flow was updated. For example:

Updated mail template: registrationConfirmation

Changedby

Indicates who changed the flow. If a user changed the flow from within the Console, then the Changedby property shows the email address of the user who made the change (e.g., karim.nafir@mail.com). If the change was made by using the Configuration APIs, then the Changedby property shows the client ID of the API client used the make the change (for example, 4256d8ed89kvcpvyxmak9p9pm3wtqtqm).

Why the client ID and not the user email address? That’s because, with the Configuration APIs, authentication (and auditing) is based on the API client credentials and not on the individual user’s personal credentials. The Configuration APIs don’t know who you are, the only know which API client you’re using.

Note that any flow changes made prior to the release of Registration Builder will not tell you who made the change:

That’s because, prior to the release of Registration Builder, the API used to modify flows only logged the change message; it did not log the name or client ID of the user who made the change. The API in question has been updated, however, and, from this point forward, will log both the change message and the identity of the user/client responsible for the change.