How To Add a new field to the User Edit or Customer Edit screens

How To Add a new field to the User Edit or Customer Edit screens

Overview

Additional properties can be saved along with a User or Customer entity when provisioning these items.
This article describes how you can go about adding additional properties to the Customer or User Edit forms to accept custom properties.

Procedure

In this example, we will add a field called “Cost Center” to the edit user form.
1.  Login as a Service Provider administrator user
2.  Navigate to the Display Properties page located under the Customers > Configuration > Customer List navigation menu.
            
3.  The Display Properties page lists all of the fields that currently exist on the User or Customer Page.
Info: The List Filter allows you to switch between User Properties and Customer Properties 
      For this example, Select the Users "List Filter"
4.  Add a new property by clicking the "New Property" link at the top left of the page under Management
            

5.  Provide the details for the new field as in the following image

            


Variable Names

These are the different fields used to configure a field in the user form.
Property Name
This is the internal name used in the database for the field.  It must be unique and it cannot have spaces. 
Property Label
This is the label shown on the Form
AD Attribute
If you would like Atria to update an Active Directory attribute for this user, specify the attribute name here.  On provisioning, Atria will set the attribute with the value entered by the user.
Category
The category name is used to group fields together – it is free text, but any field with the same category value will be grouped together.
Description
Optional – this will display in small print underneath the property label
System
If checked, the field will appear for all customers, if unchecked the field will only apply to the current selected customer.
Validation Type and Name
Validation types determine the type of data that can be entered.  They can be configured to allow pre-defined drop down lists of data , a regular expression or to retrieve data from the database.   In this case, we are using a simple Text field.
Error Message
When validation fails this is the error that is displayed to the user, in this case we do not need this.
Sort
Used to order the field on the page within the Category.
Mandatory
Mandatory fields must be entered, if selected this will also be forced to the default “General” group of properties.
Visible
This means the property is available to edit, in some circumstances a system property may need to be hidden from view.
Search
When enabled, this is a searchable option on the left hand user filter/search fields.

       
5.  Once saved, go to the Edit User page to see the new field 





Advanced - Using variables in Provisioning Processes

The data within this field will be sent along with all the other user properties, the value will be appear with the property name as the name of the value.
For rules, these appear in the “SpecificProperties” section of the provisioning request
This property was called “cc” – this can be referenced from the SpecficProperties array

e.g.        {SpecificProperties}("cc")


    • Related Articles

    • HOW TO : Configure Atria to have a freeform Company Name attribute for users.

      Users in Active Directory and Azure AD have an attribute called Company.  By default, Atria will automatically populate this value with the Customer Name field from Atria.  With default configuration, this means that on importing users with the AD ...
    • How to Customize Display Name Patterns

      Overview By default, Atria's Display Name Pattern is set to First Name Last Name format.  This is used to default the Display Name when creating new users. This guide shows how to customize Display Name Patterns in Atria to meet the needs of ...
    • Atria API User Guide (CortexAPI)

      Overview The application programming interface (API) is a powerful interface that allows you to interact directly with Atria without using the ATRIA Web User Interface (UI).  The API grants a user, with some development knowledge, the ability to ...
    • How to Move and Copy users through the Web Management Portal

      Objective This article will guide you how to move a user from one customer to another; and copy a user to create a new user. Applies To: CloudService Portal Manager V11.x CloudService Portal Manager V11.5.x Overview User move can only be performed by ...
    • Atria Billing Setup User Guide

      Objective This article describes how to configure Atria to utilize the latest billing features. This document outlines the billing setup attributes that should be configured.    Applies to Introduced in Atria version 12.0.0 Billing Setup Overview To ...