Dev GuideAPI Reference
Dev GuideAPI ReferenceUser GuideGitHubNuGetDev CommunityDoc feedbackLog In
GitHubNuGetDev CommunityDoc feedback

The Application Dictionary is designed to be highly configurable to accommodate a multitude of business needs. Custom Properties are attributes attached to entities that can be created without custom development. If the entity is displayed within the UI, then the Custom Properties are fields and other content that can be displayed on the page.


The Application Dictionary controls field names, field labels, language options, field length and securing access and data requirements based on assigned User Roles. Only make changes in this area if you are confident and understand the implications of the change.

For the steps below, we will use the scenario of adding an organizational code to an order. It is helpful to know the type of information that will be found within the organizational code before the configured property is created, so as to create the correct property type.

  1. Go to **Admin Console** > **Administration** > **System** > **Application Dictionary**.

  2. Search for the correct entity in the **Search** field. In this example we will search for **CustomerOrder**.

  3. Click **Edit** next to **CustomerOrder**.

  4. Select the **Properties** finger tab.

  5. Click **Add Property Configuration**.

  6. Name the new custom property.

    The **Name** field is what is displayed within the Application Dictionary and cannot include special characters, including spaces and dashes.

  7. Enter in a description in the **Label** field. The **Label** field is displayed in its respective object. For example, if the Custom Property is created for Customer Orders, the **Label** name will display when viewing the **Custom** finger tab of the **Customer Order** entity.

  8. From the **Property Type** menu, select **String** to allow for both numbers and letters.

  9. From the **Control Type** menu, select **Drop Down Control**.

  10. As necessary, use the radio buttons to force requirement and set the default security.

  11. Enter any desired contextual help in both the **Hint Text** (shows below the field) and the **Tool Tip** (shows in the question icon). In this example, the information can be found by going to **Sales** > **Cart History** > Edit an existing order \> select the **Custom** finger tab.


  12. Click **Save** to accept changes.

    The **Control Type Properties**, **Data Validator Properties**, **and Permissions** finger tags only become active after saving the information on the **Details** finger tab.

  13. The fields available in both the **Control Type** and **Data Validator** are dependent on what is selected in the **Property Type** and **Control Type** fields.

  14. Based on the example provided in this article the following three fields are only applicable based on the configuration of this Property Configuration:

    • In the **MultiValueList** field, using a comma as the delimiter, enter all of the Organizational Codes.

    • Select the maximum and minimum lengths of the Organizational Code.

    • Enter in the default Organizational Code in the **DefaultValue** field.

  15. Click **Save**.

By default, newly created custom properties are only accessible in the Admin Console by default and are NOT accessible by the website. To change this, go to the **Permissions** finger tab of the Custom Property and edit, as necessary, the **ISC_StoreFrontApi** Role.