Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The button  allows you to import a workflow previosly previously exported.

This functionallity functionality is very usefull useful to next scenarios:

  • To restore a workflow from a backup (a workflow previosly previously exported)
  • To deploy a workflow from one environment to other (for example from Test to Live)
  • To start a new workflow from a template

...

The icon  open the workflow 's configuration page.

For more information, go to the Configuration section.

...

  • Process name. This is the identifier name of the process and also the label name for the final users. If you change the name, a new instance will be published, the previous one could be disabled in the Business process definition page.
  • Process type. The type of the workflow: "User management" or "Permissions management".
  • Description. This is the description of the workflow. When a final user starts a worktlowworkflow, this text is displayed into the Actions log tab.
  • Initiators. Here you could configure the roles or the identities that could start a new workflow from the Console and Selfservice. E.g. "admin" identity, "SOFFID_ADMIN" role, both separated by comma ',' as "admin,SOFFID_ADMIN" or if you want to publish the workflow to everyone, you can use the text "tothom" or the character '*'.
  • Managers. Here you could configure the roles or the identities that could perform tasks in the workflow as approve permissions or cancel the workflow.
  • Observers. Here you could configure the roles or the identities that could open the workflows in read-only mode.

...

The Steps tab has several parts.

Workflow diagram steps

In this part, you could see This part has the set of the steps that of your workflow has.

You could select a step to see its configuration on its right side.

...

Finally, you could remove a step, you have to select the step and the button  will appear.

Tasks details

Pending.

Fields

Pending.

Triggers

Pending.

Incoming transitions

Pending.

Outgoing transitions

Pending.Notice that the list seems sequential, but a workflow diagram is not like a list or a tree, is like a graph, every step could have some incoming transitions and some outgoing transitions.

Step details

This part has the configuration details of the step.

Image Added

These are the main attributes:

  • Step name. Identifier, name, and label of the step.
  • Step type. The type of this step:
    • Start.  Step to start the workflow.
    • Screen. Step to show the user a form that must be completed.
    • Grant approval. Step to show the manager a form with the changes that must be approved.
    • Mail. Step to send a mail.
    • Custom. Step to add custom logic.
    • Apply changes. Step to apply the changes of the user to Soffid repository.
    • End. Step to end the workflow.
  • Description. Description of the step.

The configuration tabs are described below and some of them depending on the step type selected.

Task details

This tab is for specific information about a step, it could be empty, and his information depends of the step type.

  • Start.  Empty.
  • Screen. To define the users that have to approve the user changes.

Image Added

  • Grant approval. To define the users that have to approve the user changes.

Image Added

  • Mail. Step to send a mail.

Image Added

  • Custom. Step to add a custom script to include more business logic between steps.

Image Added

  • Apply changes. Step to apply the changes of the user to Soffid repository.

Image Added

  • End. Empty.

Fields

In this tab you could choose from the all the possible user attributes, which are visible in write-mode or only-mode.

The list of attributes is:

  • Metadata attributes created in the workflow (attributes tab of the workflow)
  • Default attributes of the user (identity)
  • Custom attributes of the user (additional data)

This steps is only available on the steps: Start, Approve and Grant approval.

Actions that you could perform:

  • Add a new field with the button Image Added.
  • Change the order of the fields in the workflow form, just drag and drop with holding this icon Image Added.
  • Remove a field with the icon Image Added, the icon is displayed at the right when you select the row of the field.
  • You could update the Label of the field displayed in the workflow.
  • Also you could update the Name of the field.
  • By default, the fields are in write mode, if you want display the field in read only mode, please mark the checkbox Image Added.
  • You could add a custom script to validate the value of the field.
  • You could add a custom script to decide the conditions to display the value.

Image Added

In a validation or a visibility script you could access to the fields as the next script.

Code Block
if (object{"userName"}==null){
	throw new Exception("The userName is mandatory");
}
return true;


Triggers

In this tab you could create custom scripts to be triggered from some actions.

This steps is only available on the steps: Start and Approve.

Actions that you could perform:

  • OnLoad. To perform some actions before the execution of the step.
  • OnPrepareTransition. To perform some actions after the execution of the step and before to start a transition to another step.
  • OnChange. When the value of the attribute if changed. You could choose the filed from a list.

Image Added

In a trigger script you could access to the fileds as the next script:

Code Block
// Example 1
executionContext.setVariable("profileServer", "null");
executionContext.setVariable("homeServer", "null");
executionContext.setVariable("mailServer", "null");
executionContext.setVariable("userType","A");
un = executionContext.getVariable("userName");
executionContext.setVariable("userName", un+"_INT");

// Example 2
a = executionContext.getVariable("shortName");
u = serviceLocator.getUserService().findUserByUserName(user);
s = serviceLocator.getDispatcherService().findDispatcherByName("OC_DTVEXT");
u.userName = an+"_ATT";
account = serviceLocator.getAccountService().createAccount (u, s, a);
serviceLocator.getUserService().update(u);
serviceLocator.getAccountService().updateAccount2(account);


Incoming transitions

In this tab you could see the previous steps those it has connected.

Actions that you could perform:

  • Create a new transition with the buttonImage Added.
  • Change the From step (step from the flow come).
  • Change the Name of the transition (Incoming Transition).
  • Change the To step (step where the flow go, but it is itself).
  • Create a custom script (Action)
  • Remove the transition with the icon Image Added.

Image Added

Outgoing transitions

In this tab you could see the next steps those it has connected.

Actions that you could perform:

  • Create a new transition with the buttonImage Added.
  • Change the From step (step from the flow come, but it is itself).
  • Change the Name of the transition (Outgoing Transition).
  • Change the To step (step where the flow go).
  • Create a custom script (Action)
  • Remove the transition with the icon Image Added.

Image Added

Attributes section

In this tab you could create custom attributes to be used in the workflow.

previously

This configuration is almost the same that you can find in the Agents#Accountmetadata or in the Additional data#Modifyobjects.

...

You can create a new attribute with the button .

1252pxFor For every attribute, you could configure the next points:

...

These attributes will be used in the Steps tab to be mapped with the Soffid data.

About a generated workflow

Once you have a workflow named User.

Image Added

With this configuration.

Image Added

After publish it, the final user with the correct permissions will find the workflow here.

Image Added

When you enter into the workflow the first page is the form generated from the fields and configuration of the step Start.

Image Added

The header of the page is common for all the workflows.

Image Added

In the body of the tab Task, all the fields of the step Start are displayed.

Image Added

And the button Image Added is the Outgoing Transition of the step Start to go to the Approve step.

Now the identities configured in the step Approve as managers should accept or remove this user creation request.

The manager will receive a mail and they could access to the workflow in My tasks page.

Image Added

Notice that the workflow complete the Start step a workflow identifier is created to be found and observed for the creation user, manager and observers.

Image Added

Once the manager is into the workflow

...

Pendinghe could read or update the fields configured in the step Approve.

Image Added

At this moment the manager has to get the task with the button Image Added and update the editable fields.

Image Added


And finally decide if Image Added or Image Added the user creation.

Resources

Below you could find a set of workflows that you could import, edit and publish in your Soffid instance:

Documentation

...