Organization Custom fields
Introduction
This article guides administrators in creating and customizing fields for Organizations, including setting visibility, update permissions, and access controls. Custom fields allow you to sync and display specific details, such as customer profile data from your CRM, directly within the platform and appear on the Organization profile page.
In this article:
- Navigate to Custom Fields Settings
- Configure Custom Field Properties
- Required Custom Fields
- View Custom Fields in Different Contexts
- Handle Unsaved Changes Warning
Navigate to Custom Fields Settings
You can add additional information to an Organization by creating custom fields, which allow you to sync and display specific details directly within the platform.
To create Organization Custom Fields:
- Navigate to Settings → Custom Fields
- Click +Add new
Configure Custom Field Properties
Custom fields can be configured with specific options to meet your organizational needs:
-
Add Name of the Custom field
-
Select Organization from the entity options
-
Type: Choose between Text, Number, Checkbox, Single select drop-down, or Multi-select drop-down Checkbox
- Choose whether the field is required
-
Choose whether the field can be modified after its initial configuration
-
Choose which organization the field will be available to
-
Choose which roles from the list will have access to the field
View Custom Fields in Different Contexts
Custom fields appear in multiple locations throughout the platform to ensure consistent data management:
Organization Profile Page
Custom fields are displayed directly on the Organization profile page, allowing users to view and edit organization-specific information.
Create New Organization Page
When creating a new organization, custom fields appear in the form to ensure all required information is captured from the start.
Create/Edit Reseller Page
Custom fields also appear when creating or editing reseller information, maintaining data consistency across all organization types.
Required Custom Fields
Configuring Required Custom Fields
To set up a Required Custom Field:
1. Go to Settings
2. Open the Custom Fields section.
3. Click Add new.
3. Enter the necessary details and select the Is required checkbox.
4. Click Save to apply your configuration.
Organization Creation
Once a Required Custom Field has been configured, it will appear as a mandatory field during the creation of a new Organization.
For more information, see the document on Creating a New Organization.
An Organization must be Approved and Active in order to purchase Subscriptions and fully utilize the Platform.
Refer to Activating an Organization for details.
If a user attempts to click the Approve button without completing these fields, the system will block the action and display an appropriate error message.
Approving the Customer Organization without filling mandatory Required fields is also not possible by using Approve Customer API. In reponse the related error is shown:
Handle Unsaved Changes Warning
The system includes safeguards to prevent accidental data loss when working with custom fields.
Warning Pop-up Behavior
If a user has edited fields in the Organization profile page but has not saved them, attempting to navigate to another page will trigger a warning pop-up message: "You have unsaved changes to your custom fields"
The pop-up provides three options:
- Save (primary highlight button) - Saves changes and navigates to the new page
- Discard - Discards changes and navigates to the new page
-
Cancel - Closes pop-up and remains on current page with unsaved changes intact
User Action Scenarios
Cancel Option:
- User clicks Cancel
- Pop-up closes
- User remains on the page
- Unsaved changes are preserved
Discard Option:
- User clicks Discard
- User redirected to section which had selected initially (e.g. Subscriptions tab)
- Changes are not saved
- Original field values are restored
Save Option:
- User clicks Save
- Changes are saved to the system
- User redirected to target page (e.g., Subscriptions tab)
- Updated field values are preserved
Summary
Organization custom fields provide a powerful way to extend the platform's data model to meet specific business requirements. By configuring field types, access permissions, and visibility settings, administrators can ensure that relevant organizational data is captured, displayed, and managed consistently across the platform. The unsaved changes warning system helps prevent accidental data loss during the editing process.
Related Content
Add comment
Please sign in to leave a comment.