Follow

Wizard Configurator

Contents

1. Introduction

The Wizard Configurator is a tool where you can build and configure wizards to manage processes in the WorkPoint 365 solution. Each wizard can be started with a default set of parameters. Dependent on the wizard configuration, the wizard can be launched from either MyTools, WorkPoint Express or from the Modern UI command bar. Several new standard wizards have been added due to additions and changes to the security system of WorkPoint.

A Wizard consists of a chain of Wizard Flows. The chain can have one or more Wizard Flows. A Wizard Flow can have one or more Wizard Steps. For each flow there is a predefined set of parameters which the flow supports. In the Wizard Configuration you can provide default values for each of these parameters.

An example of a wizard shown graphically is shown in the image below:

Wizards are shown as a small window which takes the user through each step.

A case where a wizard could be useful could be if a user wants to create a newentity which largely resembles an already existing one. The user can set up a wizard that has the necessary steps to copy an entity, and then the user can edit the copy to his/her specific needs. That Wizard then takes the user through all necessary steps for copying an entity, and the wizard can be used on any entity, whenever needed.

Certain wizards can be opened from WorkPoint Express. These are;

  • Change Stage Wizard
  • Copy Entity Wizard
  • Edit Entity Wizard
  • Create Document Wizard
  • Create Document (Advanced) Wizard
  • Relations Wizard

2. Requirements

The Wizard Configurator is a licensed feature. If you want this feature for your solution, please contact WorkPoint sales at sales@workpoint.dk.

3. Examples

   3.1. Edit Entity

Due to changes to WorkPoint’s security system this new wizard has been added. The master data of entities are now read-only for all users, but this data can still be changes through this wizard. In effect this means that no one can edit meta data for entities apart from through this wizard. Access to this wizard can be set through security rules, which in effect restricts access to meta data change to specific users, specified through security rules.

   3.2. Copy Document to Project

An example could be a wizard named “Copy Documents to Project”. The purpose of the wizard is to select some of documents from a document library on a company site and copy the documents to an underlying project document library, converting them to .pdf files in the process. This wizard consists of two Wizard Flows, “Find / Create entity” and “Copy documents”. The first flow has two steps - "Find Entity" and "Edit / Create Entity" - and the second flow has only step - "Copy Documents" - so this configuration will launch a wizard with a total of 3 steps.

   3.3. Copy Entity

Another example of a useful Wizard is the Copy Entity wizard. Often a user has the need to copy an existing entity. A typical case for this is that a new entity is needed which resembles an already existing one. This way, the user skips entering in basic data again.

The wizard guides the user through the following steps;

  1. Choosing the source entity (the entity from which to copy)
  2. Entering master data pre-entered from the source  with opportunity to enter additional data
  3. Choice of Scope, where the user chooses what to copy. The following can be chosen:
    • Entity lists
    • Relations

Step 1 from the list above can be skipped, in case the copy-entity action is performed directly on a selected entity in the entity list.

Visually, the wizard is set up as this:

    3.4. Types of Wizard Flows

        3.4.1. Pick a Candidate

This wizard is quite specific in its usage, and can only be used in relation to an e-mail. Thus, it must be started from WorkPoint Express. An example of ta setup utilizing this wizard flow is shown in the image below:

1.png

        3.4.2. Change Stage

Changes the state of the entity. If this flow is the only flow of the wizard, no editing form is shown afterwards. 

        3.4.3. Copy Entity

This flow is used for choosing which content from the source that should be copied over when copying an entity. The system can copy lists (content and folders) and relations.

An example of the copy entity interface is shown in the image below:

2.png

        3.4.4. Edit Entity

This step includes an editing form for the entity.

        3.4.5. Find / Create Entity

This step includes the searching and option to create a new entity or edit an existing one (this flow has a built-in editing form).

4. Configuration

For adding a new Wizard, and configuration of wizards, consider the Add wizard configuration interface:

  1. For title, the administrator can give the wizard a name. This should be descriptive of the functionality of the wizard.
  2. Optionally, the administrator can add one or more translations to the title defined in (1).
  3. The Administrator can type in a description of e.g. what the wizard does and/or when to use it.
  4. Optionally, the administrator can add one or more translations to the description defined in (3).
  5. Select whether this wizard should be enabled.
  6. Select whether this wizard should be accessible from the Command Bar in WorkPoint. If chosen, a button which opens the wizard will appear in the command bar when a copyable entity is selected.
  7. Choose the flow(s) of the wizard. Available flows are:
    • Pick a Candidate.
    • Change stage.
    • Copy entity.
    • Edit entity.
    • Find / Create entity.

A wizard can have one or more flows. The interface will let the administrator know if no more steps can be added to the chain, as some flows exclude others. In effect this means that certain combinations of flows are eligible, while others are not, and this cannot be set up together.

  1. Optionally, the administrator can configure the default parameters of the wizard. The list of available parameters depends greatly on the selected flows.

Configuration of the wizard can be finalized by clicking the Save-button at the bottom of the interface.

5. End User Guide

As previously mentioned, wizards can be run from the MyTools panel via a button, or it can be run from the command bar of a library, or both.

If set up to be enabled for the command bar, a button will appear in the bar as exemplified with the Copy Entity-wizard in the image below:

If set up via a button in the MyTools panel, the wizard can be opened clicking that button from the MyTools panel on the entity, as exemplified in the image below:

Regardless of where the wizard is opened from, the result is the wizard window, which takes the user through a series of steps, as shown in the image below:

  1. The current step has its name in bold text, and a gray bar behind it.
  2. The user makes relevant choices of the wizard step.
  3. The next step can be navigated to by clicking the Select and continue-button.
  4. The wizard will move on to step 2 after (3) is performed.

In this case, the next step allows the user to input more data:

  1. Data is put in to customize the copied entity.
  2. The Wizard executes the copy entity function when the user clicks “Save”.

After execution a new company appears with the data specified:

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments