PhenixID

PSD1103 – Configure PIM views

Overview

This PhenixID Solution Document (PSD) is written for PIM 5.x/6.x.

In PIM, there are 4 main ways to find objects:

  • Browse. You can add one or more LDAP containers/nodes (Root objects or OUs) to browse objects..
  • Search. You created search from to find information in LDAP.
  • Self Service. You manage your own object.
    This is not covered in this PSD, please read PSD1129.
  • Virtual view. You create a virtual OU structure based on values on LDAP objects.
    This is not covered in this PSD, please read PSD1098.

Depending on how you like to find objects you can add one or all oj the components mentioned above. PIM have the concept of views. There are also four different views included:

  • Main view
    Supports both browse, predefined search and virtual view
  • Browse view
    Supports only browse. Added in PIM 6.0.4.
    Note. This view is based on the main view and is not browse view that was available in previous version.
  • Predefined search view
    Supports only predefined search Added in PIM 6.0.4.
    Note. This view is based on the main view and is not predefined search view that was available in previous version.
  • Self Service view
    This is not covered in this PSD, please read PSD1129.

Views are defined using a policy in DSEditor.properties. Since different roles can have different DSEditor.properties, different roles can have different view configuration.
No views are configured when IM is installed. Any role can have one or several view configured.

Add Main view

Components in Main view

Components included in Main view:

  • Predefined search – Search. (no special configuration is needed, you just add searches like you did in previous versions)
  • Predefined search – Create. (no special configuration is needed, you just add create forms like you did in previous versions)
  • Categories (no special configuration is needed, you just add categories like you did in previous versions)
  • Browse
  • Virtual ViewFor more about Virtual View, please read PSD1098

Configure Main view

To add Main view to a role you just add the main view to the LOAD_VIEW policy in DSEditor.properties. Best practice is to have the LOAD_VIEW empty (no views added) in the DSEditor.properties of the web app and to add the value to the DSEditor.properties of the role.

  1. The policy and value to add the Main view in DSEditor.properties:
    LOAD_VIEW=se.nordicedge.view.main.View
  2. Example on how to configure more than one view, for example a role should have both Main view and Self service view:
    LOAD_VIEW=se.nordicedge.view.main.View,se.nordicedge.view.SelfServiceView

Change name of Main view

If you like to change the name of the Main view to, for example, Start.
Then open the lang-file, for example en.lang (drive:\Program Files\PhenixID\IM\customer\lang), and type:

Main=Start

Add Browse view

Components in browse view

Components supported in browse view:

  • Browse
  • Create forms
  • Virtual ViewFor more about Virtual View, please read PSD1098

Configure Browse view

  1. The policy and value to add Main view in DSEditor.properties:
    LOAD_VIEW=se.nordicedge.view.main.BrowseOnly
  2. Example on how to configure more than one view, for example a role should have both Browse view and Self service view:
    LOAD_VIEW=se.nordicedge.view.main.BrowseOnly,se.nordicedge.view.SelfServiceView

Change name of Browse view

This is done by adding another policy
MAIN_BROWSE_VIEW_LABEL=Custom_Browse_Name

Add Predefined search view

Components in Predefined Search view

Components supported in Main view:

  • Predefined search – Search. (no special configuration is needed, you just add searches like you did in previous versions)
  • Predefined search – Create. (no special configuration is needed, you just add create forms like you did in previous versions)
  • Virtual View, For more about Virtual View, please read PSD1098

Configure predefined search view

To add Main view to a role you just add the main view to the LOAD_VIEW policy in DSEditor.properties. Best practice is to have the LOAD_VIEW empty (no views added) in the DSEditor.properties of the web app and to add the value to the DSEditor.properties of the role.

  1. The policy and value to add Main view in DSEditor.properties:
    LOAD_VIEW=se.nordicedge.view.main.PredefinedOnly
  2. Example on how to configure more than one view, for example a role should have both Predefined search view and Self service view:
    LOAD_VIEW=se.nordicedge.view.main.PredefinedOnly,se.nordicedge.view.SelfServiceView

Change name of predefined search view

This is done by adding another policy
MAIN_PREDEFINED_VIEW_LABEL=Custom_PreDef_Name

Configure Browse and nodes.json

With Main or Browse view you can link one or several nodes from your LDAP directory. You just add the name of the OU that should be the start node in the Main view. See the example below how to add two OU.

  1. This is a screenshoot of an example Active Directory where where to add the two OU´s Data and Customers to the Main view. See full DN below of the two OU´s.
    OU=Data,OU=PhenixID5Demo,DC=phenixid,DC=local
    OU=Customers,DC=phenixid,DC=local
  2. In the folder drive:\Program Files\PhenixID\IM\customer\config there is a file called nodes.json.
    Add the two DN´s like below to the file and save and close the file.

    {
    "entryPoints": [
            {
              "dn":"OU=OU1,DC=phenixid,DC=net",
              "displayName":"SWEDEN Users"
            },
            {
              "dn":"OU=OU2,DC=phenixid,DC=net",
              "displayName":"DENMARK Users"
            }
         ]
    }

    Above will be displayed in e.g. MAIN view as below:

    Note: The displayName feature was added in IM 5.5.0

  3. This file is linked from DSEditor.properties with the policy VIEW_CONFIG_PATH
    In my demo environment it look likes:
    VIEW_CONFIG_PATH=C:\\Program Files\\PhenixID\\IM/customer/config/nodes.json
    The name nodes.json could be renamed to something else as long as above path is correct. If you have an IM environment with several roles where the different roles should have different nodes and some roles maybe no nodes. Then you can created several *.json files and use the policy VIEW_CONFIG_PATH for the respective DSEditor.properties for the different roles.

Exclude OU´s in Browse

To include or exclude OU´s in browse, read PSD1156

Views in previous versions of PIM

In previous versions of PIM there where two views with the same name as the new, Browse and Predefined Search. These views are not supported any more but are still available.

Browse

LOAD_VIEW=se.nordicedge.view.browseView.BrowseView

Predefined Search

LOAD_VIEW=se.nordicedge.view.PredefinedSearch


DISCLAIMER
Information provided in this document is for your information only. PhenixID makes no explicit or implied claims to the validity of this information. Any trademarks referenced in this document are the property of their respective owners.

The origin of this information may be internal or external to PhenixID. PhenixID makes all reasonable efforts to verify this information.

PhenixID - support.phenixid.se