Path

ez.no / documentation / ez publish / user manual / 5.x / the administration interface / the login page / user registration with appr...


Caution: This documentation is for eZ Publish legacy, from version 3.x to 5.x.
For 5.x documentation covering Platform see eZ Documentation Center, for difference between legacy and Platform see 5.x Architecture overview.

User registration with approval workflow

It is possible to set up an approval workflow for the user registration. This is the registration carried out by the user himself when he logs in to eZ Publish the first time. This functionality is useful in the case when you wish to control who logs on to your system.

Configure the workflow

The system does not come with an approval workflow functionality enabled. In order to enable the functionality follow the steps below. First create the needed workflows, then connect the workflows to triggers, so that the approval workflow functionality is triggered when a user wants to register on your system.

Create workflow

An example of how an administrator creates a workflow as described in the steps below:

  • Go to "Setup"-"Workflow"
  • Click on the pre-defined workflow called "Standard"
  • Click "New workflow"
  • Enter the name of the workflow, in this case "UserRegistration1" as shown in the screen below:
    Creating New Workflow

    Creating New Workflow

  • Select "Event / Approve" and press "Add event" button. The screen below will appear:
    Workflow Specification

    Workflow Specification

  • Select "Users" under "Affected Sections" and "Publishing New Object" under "Affected Versions".
  • Select proper group who can approve the event 
  • Press "Add groups" under "Users who approve content" and select the group you wish to give control of approving the new users.
  • Press "OK" to save.

The steps above shows an example for approving content before publish. This workflow can be complex, depending on the case. For more workflow configuration please see the separate workflow documentation.

Note that in the case of creating an approval workflow for user registration you will need to create a new workflow: This workflow will end the registration process by sending a confirmation mail to the user that his account has been successfully created.

Follow the steps below to create the new workflow, in this case "FinishUserRegistration" as shown in the screenshot below:

  • Go to "Setup"-"Workflow"
  • Click on the pre-defined workflow called "Standard"
  • Click "New workflow"
  • Enter the name of the workflow, in this case "FinishUserRegistration" as shown in the screen below:
    Creating Workflow Finish User Registration

    Workflow Finish User Registration

     
  • Select "Event / Finish User Registration" and press "Add event" button. In the screen that appears you:
  • Press "OK" to save the new workflow.

Connect workflow to triggers

An administrator will do the following to connect the workflow to a trigger so that the user registration workflow will be enabled when a user wishes to register his/her user information.

  • Go to "Setup"-"Triggers"
  • Connect the workflow for user registration to the workflow trigger "Content"-"Publish"-"Before", in this case, select UserRegistration1 as shown in the screenshot below:
     
    Connecting Workflow to Trigger

    Connecting Workflow to Trigger

  • Connect the workflow for ending the user registration with a confirmation e-mail to the workflow trigger "Content"-"Publish"-"After", in this case, select FinishUserRegistration (note again that you need to create the FinishUserRegistration workflow before it appears in the "Workflow triggers" screen), as shown in the screen below:
    Connecting Workflow to Trigger

    Connecting Workflow to Trigger

  • Click "Apply changes" in the bottom of the screen

You have now connected the approval workflow to triggers. This means that you have set-up a workflow approval process, and the user is presented with an approval workflow when he/she wants to register the user information in the log-in page.

Register user with approval workflow enabled

When a user logs in to eZ Publish the first time he/she needs to click "Sign up" in the log-in screen in order to register an account on the eZ Publish installation. In this case there is a workflow approval process connected to the user registration.

  • The process starts when the user clicks "Register" to register his/her user information
  • A mail is sent to the user to confirm the user account.
  • When the user clicks the confirmation mail, he/she is presented with a screen as shown below:
    User Registered Message

    User Registered Message

  • An event workflow process is created and a notification is created in the "Collaboration" screen in the "Dashboard" of an administrator or another role with the right policies (the "Approval" Collaboration Notification must be enabled - see "Dashboard", "My Notification Settings"). In this case the administrator must check the "Collaboration" item in the "Dashboard".  After clicking the notification from the user he as 3 choices: he can either Add comment, Approve or Deny the user registration.
    When the Administrator clicks "Approve" the user gets a confirmation mail that the user is created and is ready for eZ Publish log-in.  

Geir Arne Waaler (21/01/2011 2:12 pm)

Andrea Melo (21/12/2012 1:50 pm)

Geir Arne Waaler, Andrea Melo


Comments

There are no comments.