Identity Manager 8.0 - Web Designer Reference Guide

Create New Module

Use this wizard to execute all the necessary steps to add a new module and reference it in a web project.

Enter the identifier for the new module in the first step. You can also enter a title for the new page. If you have added the identifier as well as the title, a new Label-type node is automatically added under the Form node type in the definition tree view.

A corresponding caption object is not added. A warning is output the next time the project is compiled and the caption can then be added including any translations required.

To create a new module

1. Select Create new module in the Edit menu.

   This display the dialog box Wizard for creating a new module.

2. Enter the following information on the page, General module settings, and click Next.
   1. A name for the new module.
   2. A title for the new page.

   The general data for a module page closes and the Navigation page is displayed.

   Here, you can set whether a menu item is created for the new module or not. If this option is set, you will see more settings for defining the position of the menu item in the menu bar and its caption.

3. Apply the following settings to the Navigation page and click Next.

   Table 46: Navigation settings for the new module

   Setting	Description
   Add a menu item	Adds a new menu item.
   Menu item caption	Displays the title on a new page. A title is only displayed if you entered one on the first page of the wizard. You can override this title and add a caption object.
   Above the selected item Below the selected item A hierarchy level under the selected item	Options for selecting those which specify the position of the menu item. With the option "A hierarchy level under the selected item" you can first select the main view in the Web Portal and then open the sub menu items by clicking on and continue selecting.

4. On the Security page, define the group of employees who can use this menu item.

   NOTE: You can multi-select employees in the editor tree structure with the option Only for employees in specific roles. The new menu item is available in the web application to all employees that are assigned to at least one of these selected structures.

   NOTE: If the Employees matching a given filter condition option is selected, the usual SQL wizard for formulating an SQL query is started. In this case the query always refers to the Person table. Therefore, this must not be entered again.

5. Select one of the following options on the Permissions page and click Next.
   • Visible to everyone

     No viewing restrictions are applied to the new menu item if this option is selected.

   • Configuration Parameter

     Select this option to add a new configuration parameter. A predefined value is suggested for the key. These options are also available:

     a) Only for employees in specific roles

     b) Employees matching a given SQL query

   The visibility settings are closed. The new module is added.

6. Close the dialog box using Finish and save all the changes made to your web project by clicking in the toolbar.

   The new module is shown as a tab in the definition tree view.

Use case

You want to add a new menu item, which can only be seen by users who belong to a particular department. In this example, only the menu item of the department "Sales" should be visible. This example is described in detail in the following step-by-step instructions.

To add a new menu item, which can only be seen by certain users

1. Work through the steps in To add a new module until you get to step 5.
2. Select the options Configuration parameters and Employees matching a given filter condition on the Security page
3. Perform one of the following tasks.
   1. Enter the following text in Value.

      (UID_Person='%useruid%')

      AND (EXISTS

      (

      SELECT 1 FROM

      (SELECT UID_Department FROM Department WHERE DepartmentName = N'Sales') as X

      Where X.UID_Department = Person.UID_Department

      ))

   2. Open the WHERE clause wizard by clicking on and use the link Add expression to set the following properties.

      Table 47: WHERE clause wizard filter conditions

      Setting	Description
      References to other objects	Object selection in a hierarchical structure. Open the hierarchy by clicking on and select the item Primary department.
      At least one recordset exists / Add expression	Link under the new condition for select an additional condition. Click on the link and select Department from the Value comparison.
      The following applies to the value in the Department column: The value contains equals ""	Use the link "" to open a text box and enter "Sales".

4. Create the new module and click Next.

   This generates the new module and displays it as a new tab in the definition tree view.

Adding New Components

You can add new components in the following ways. If you want to create a new component for an object dependent reference, you use a wizard to add the object dependent reference as well as the new component conveniently. The wizard can also help you set up column-dependent references. Both variations are described in the steps below.

To add new components using the navigation view

1. Select Components in the navigation view.
2. Click in the navigation view toolbar.
3. Select .

   The new component is shown in a new tab in the definition tree view.

   NOTE: New components are automatically prefixed. You can change the name later. Text boxes with * are mandatory.

4. Select The component root node in the definition tree view.
5. Select the Node editor view for the root node and edit the predefined name.
6. Click or in the toolbar.

   This renames the component.

7. Select the Definition node in the component’s definition tree view.

   The selection Type is show in the Node Editor. Use the selection to define which type of nodes the new component will have.

8. Select a type in the Type option box.

   This displays the selected node type under Definition and you can continue editing.

9. Select the new node in the definition tree view to modify other settings.

   You can specify conditions, rules and extensions.

To create a new component through object-dependent references.

1. Click Edit | Add new | Create component for object-dependent reference on the start page.
2. Click Next in the Create component for object-dependent reference dialog box.
3. Enter a name in the Reference name text field on the Entering a name for the new reference page and click Next.
4. Select a reference type on the Select a reference type page and click Next.

   Note: Depending on which reference type is marked, before you confirm with the Create component for object-dependent reference button, this reference type is preset.

5. Select one or more objects to be displayed via the Select object page and click Next.

   NOTE: The nodes are grouped on the basis of the reference type's grouping column. You can select products and product groups from the AccProduct table. If you have selected the product group, its products do not have to be selected explicitly.

6. Enter a name for the component on the Enter the component name page and click Next.

   The object-dependent reference and the component are generated.

7. Close the dialog box with Finish.

   The reference and component are added and shown on a new tab.

To create a new component through column-dependent references

1. Click Edit | Add new | Create component for column-dependent reference on the start page.
2. Click Next in the Create component for column-dependent reference dialog box.
3. Enter a name in Component name on the the Create a component name page and click Next.
4. Select an interface on the Select an interface page and click Next.
5. Select a table and a column on the Select tables and columns page and click Next.

   Your settings are processed and the fitting elements are generated.

6. Close the dialog box with Finish.

   The reference and component are added and shown on a new tab.

Customizing Object Definitions

Copy existing objects with Web Designer and customize them. Not only is there a wizard to help you here, but you can also copy the desired object directly in the definition tree view.

Another possibility to customize objects is to use extensions. For more information, see Extensions.

To create an object copy

1. Select an object in the definition tree view.
2. Click .

   This opens the dialog box Copy object.

3. Click the text field in the Copy name* column on the Object copy settings page and overwrite the preset name.
4. Click the text field in the Description column and enter an optional description for the copied object.
5. Enable the Add substitution rule for current object option if required and click Next.

   Your entries and settings are processed and displayed on the Processing page.

6. Close the dialog box with Finish.

   The object copy is displayed in the definition tree view.

   NOTE: In the definition tree view, if you call an object for which a substitution rule was defined, a header with a corresponding comment is shown above the object.

   NOTE: After an object has been assigned a substitution rule, a button is added in the Node editor view providing further information. Click to display the object being substituted in the definition tree view.

   NOTE: If you copied a default object, future changes to the default object are not transferred to the object copy. This is the case after a migration, for example.

Creating Object Copies with the Wizard

You must make a copy of a default object if you want to add new functionality to it that cannot be added in the configurator. The Copy objects wizard helps you with this.

To add a copy of an object with the wizard

1. Select Edit | Copy objects in the menu bar.
   The the dialog box Copy objects... is opened after compiling. All existing database objects are ordered by different object types into a hierarchical structure.

2. Enable the option next to the database object you want to copy.

   NOTE: The database objects cannot be multi-selected.

   NOTE: The wizard automatically adds substitution rules for the objects used for copying if the option Add substitution rule for current object is set. The copies are automatically referenced instead of the default objects. The Web Designer does not generate substitution rules if custom database objects are used as copy templates. You can use the configurator to enter these substitution rules manually.For more information, see Project Configuration - Customization.

3. Enter a name for the copy in the Copy name* column, if required.

   A custom prefix stored in the database is automatically prefixed to the entered or suggested name.

4. Click Next.
   

   A copy of the selection is created and a conformation prompt is displayed. After you have closed the wizard, new tabs are created in the definition tree view displaying the copies.

5. Save the copy manually from the toolbar.