Rationale

Many organizations ask to be able to have an organization diagram in the platform. In order to implement the relation between user we should be able to identified the manager of the users.

1. Functional Requirements

Top User Stories

Field manager

Profile

• P1 - New system attribute "Manager"
  • multi-valued attribute
  • new attribute type: user
• P1 - Display:
  • Avatar
  • Full name (first name + last name)
• P1 - Hover:
  • Pop-up card of the user
• P1 - Click: open the new organization chart feature
• Edition:
  • P1 - AD or LDAP knowing that the information provided by LDAP is the LDAP reference type CN
  • P1 - CSV import thanks to user name attribute
  • P1 - for the user: thanks to a user selector from the contact information edition
• P1 - In case of the user identified in the attribute is inactive:
  • for member/platform/user: the field is hidden
  • for member/platform/administrator and member/platform/user in its profile: the field is displayed as if the field is hidden
• P1 - In case the attribute is inactive:
  • the field is not displayed at all
  • if the field is inactive could we still provide value thanks to CSV or AS/LDAP for it?
  • QUID about the organizational chart?

Administration

• P1 - default values:
  • name: Manager
  • Visible: True
  • Editable: False
  • Non-maskable: False
  • Required: False
  • Multi-valued: True
  • Group synchronize: False
  • Active: True
  • No parent
• the attribute can be edited by the administrator
  • P1 - rename, visible, non-maskable, required, group synchronized, active
  • P1 - multi-valued can't be changed
  • P1- editable can be changed

Organization chart

• New portlet Organization chart

• Portlet properties:

  • in the section Tools
  • permission to add it: member/platform/administration
  • Settings:
  • Portlet settings:
    • Display name: Organization chart
    • Hide info bar
    • Hide portlet mode
    • Hide Window state
  • Access permission: member/platform/user
  • No other settings tabs

• Display hierarchical relationships

  • in the middle the current user we are looking

  • above the manager (N+1)

  • below the people who have the current user as manager (N-1)

  • the users are displayed with cards

  • Current user card:

    • Full name
    • Avatar
    • 3 fields (1 principal and 2 secondaries) that can be defined by the administrator by interface in a drawer
      • if no data or the attribute is hidden by the user then the field is not displayed
    • See more that linked to the profile page
    • No click action on the card
    • this card layout should replace the current card in the user list of the people page
    • CTA buttons using only icons
      • Mail: to send a mail with the default mailing software of the device
        • if no data in the attribute email or hidden by the user the CTA is displayed as disabled and not clickable
      • Kudos

  • N+1 card:

    • Full name
    • Avatar
    • 1 field (same as the principal of the current user card)
    • Click on the card make the user as current user

  • N-1 card:

    • Full name
    • Avatar
    • 1 field (same as the principal of the current user card)
    • chip to indicate the number of N-1 user linked to this users - no action on this chip
    • Click on the card make the user as current user

  • Fields setting

    • a new drawer to select
      • the 3 fields of the cards
      • the attribute "manager" of the profile from which the organizational chart is based
      • the user in the center of the organizational chart
    • attribute "manager" choice
      • dropdown selector to choose from the profile attribute which attribute "user" is used to generate the organization chart. We select the manager attribute we want
      • by default, it's the default manager field that is selected
    • User at the center of the organizational chart
      - user selector to choose only one user that will be the user in the center of the organizational chart
      - by default, it's the user from which we have open the organizational chart
      - if it's a customer organizational chart created on a new page, we have to select the user.
      - It's a mandatory field
    • Field of the cards
      • 3 dropdowns to select profile attribute
      • the field settings are different from one portlet to another so we could manage separately the different organization charts
      • default values:
        • principal field: function
        • second field: Team
        • Third field: city

Expand view

• Download

  • download the current view of the organizational chart
  • if possible a PDF with all the text that can be search in the PDF
  • if not possible an image of the current view

• New page with this portlet

  • a new page with the new portlet inside

2. Technical Requirements

Expected Volume & Performance

N/A

Security

This feature will use existing security mechanisms

Extensibility

No extensibility requirements

Configurability

Configurations will be added for :

• The new field Manager in the list of Profile property settings
• The new page containing the Organizational chart

Upgradability

• This feature will add new data (manager field) and will use existing user data without changing it

Requirements related to existing features

• A new profile property setting Manager will be added by configuration to the list of properties and will be available by default to be used by administrators
• The new field Manager will be displayed in the user profile
• A new portlet Org chart will be based on the values of the manager field and use it to build the organigram of the company
• A drawer will be added to configure the fields displayed in the user cards

Feature Flags

No feature flag will be added, unless the org chat feature is not needed on Meeds side
should we disable by default the Org chart for Meeds ?

Other Non Functional Requirements

Make sure that the new developments respect the accessibility requirements

Impacts

Documentation
Training

Software Architecture

Security

• We will follow the existing recommendation and best practices of the security
• Rest endpoints should be configured correctly with the @RolesAllowed annotation
• Only administrators will be able to alter the field manager, this restriction should be integrated in the front end application and in the Rest API

Access

• All users will be able to view the added data
• Administrators will be able to configure the portlet Org chart and set the fields to display inside the people card

Rest API design

• Organizational chart :
• The manager information will be added to the response returned by the existing Rest endpoint that returns the social user profile, it should be enabled/disabled in the response using the expand query parameter
• The number of collaborators will be added to the response returned by the existing Rest endpoint that returns the social user profile
• Drawer to Configure Organizational chart portlet
• A new Rest endpoint to configure the list of fields to show on the user card inside the Organizational Chart portlet
• Those settings will be saved as portlet preferences of the portlet.

Portlet Vue & Vuetify

• The Organizational Chart is a new Vuejs portlet
• The portlet will use existing VueJs components
• Export to PDF : jspdf & html2canvas libraries will be used to generate the PDF file
• This will require moving the libraries from Notes module to the Social module

Services & processing

• Functions will be added to :
• Retrieve the number of collaborators for a requested user

Data and persistence

No new data model to add

• Organizational chart settings will be saved as portlet preferences
• Manager field will be saved in the user profile properties, We will use the userName of the manager as the value of this field.

Migration strategy

• Profile index should be updated to make all fields use the keyword type
• Full reindexation of user profiles may be needed to update the mapping and refresh unindexed data

Annexes

Reasoning that explain the technical choices
Impacts
References