Application configurations are done in the Application Builder application.
Name applications so that they are free of numbers, special characters, and spaces. Once an application is created, the name cannot be changed at a later date. All words must be written in upper camel case, which means the first letter of each word should be capitalized. The name should reflect the purpose of the application. For example, PurchaseOrderEntry.
When entering information in the Application Builder header, the Description field entry should be short and concise. The entry should not contain any punctuation or complete sentences.
Use Application Builder to enforce UI standards based on patterns. For example, fields and checkboxes, header layout, and detail and list forms should always appear in the same place across different applications within the same family.
Always name the detail form pages of your application, even if there is only one page.
Create an Application Setting for each application to make it easy for customers to configure defaults without having to customize the application.
Naming conventions and standards
Application names should reflect the purpose of the application and follow the upper camel case convention. For example, PurchaseOrderEntry, ApplyCustomerCredits, and BillOfMaterial are all acceptable names for applications.
Give your application layout a name format of Layout. For example, a layout for the TrackandTraceBatchJobs application would be named TrackAndTraceBatchJobsLayout. If an application has multiple layouts for different purposes, the naming format should be Layout. For example, the ServiceContract application has layouts for warranty and performance that are named ServiceContractWarrantyLayout and ServiceContractPerformanceLayout.
When an application performs a specific purpose, additional naming conventions may be necessary. The naming convention should only be in the Name field, not the Description field.
| Application purpose | Naming convention | Example |
|---|---|---|
Search | If a mini application is used to search another table for a record to select, include Search in the application name. | DirectorySearch |
Integration | If the application is used for integration, end the name with Integration. | StudentScheduleIntegration |
Header | If the application is used for a header application, end the name with Header. | GeneralLedgerHeader |
Detail | If the application is used for a detail application, end the name with Detail. | GeneralLedgerDetail |
Header Detail | If the application is used for a header detail application, the name should be plural. | GeneralLedgerTransactions |
The Description field entry may match the name of the application, but should include spaces. Application descriptions should always reflect the type of data the user will access from the application. Don't use complete sentences when writing descriptions. For example:
| Application Name | Description |
|---|---|
SalesOrderHeader | Sales Order, Sales Quote, and Sales Credit Headers |
SalesOrderDetail | Sales Order, Sales Quote, and Sales Credit Details |
ServiceContractHeader | Warranty and Performance Contract Headers |
ServiceContractDetail | Warranty and Performance Contract Details |
ClaimsIntegration | Customer and Supplier Claims Integration |
ClaimsSearch | Search for Customer and Supplier Claims |
When you are creating a menu entry record for your application in the Menu Definitions application, the Title should have the basic name of the application with no verb. For example Purchase Order, Manual Checks, or Company Structure are all acceptable names for the menu title. If the application you are creating the menu for is a mini search application, do not put the word Search in the Description. The Description is what displays in the mini search application. The description should be what the mini application is searching on and should be plural. For example, GL Accounts.
Deprecated application best practices
On rare occasions, existing applications need to be deprecated. These are the deprecation best practices that should be used when deprecating an application.
Deprecation Strategy for Applications:
- Deprecate the application by checking the Deprecate checkbox in Application Builder.
- When the application is launched (form init) or when trying to be used, call a Logic Block that sets an error that says: "This application is obsolete. Use NAME application."
- Each application could have a slightly different implementation of the error. If launching the application doesn't allow for an immediate error, it is possible to throw the error when trying to edit the record or when pressing a button. The main goal is to ensure that the customer's data integrity remains intact. Implement the error in a way, that the user cannot used the deprecated application to change their data.
- A release note with the Action Required and Within this Release should be set to true and delivered in the release when the application was deprecated. The release note should say that the application is being deprecated in this release and will be removed in the next. Give instructions on how to move off from the deprecated application. The application should not be moved to the Family until the following release.
- In the following release, the application can be moved to the Family. This will prevent it from being delivered to downstream environments. Another Action Required release note is needed to inform users that the application has been fully deprecated and will no longer exist.
- Any dependent objects, like application settings or menus, may also need to be deprecated or moved to the Family following the same release cycle as the application.
It is very important to notify an end user that the application they are using is no longer supported. An end user could have an application favorited and they need to be notified to change to the new application. We cannot expect that every end user has read release notes. When an application is considered deprecated, it means the application is now obsolete.
Setup applications best practices
These best practices ensure that global configuration for setup applications is done consistently. Setup applications are applications used to identify how a family or module works.
When global configuration is performed, it indicates that the Company field is not required during setup, and that those configuration options are for all companies in the organization. Customers may still choose to set up data for individual companies if they have unique configurations.
To implement global configurations for all companies in an organization:
- Do not require Company and Organizational Unit fields for any tables that can be configured across companies.
- Add the data item
GlobalRecordto the table. - Validate that when
GlobalRecordis True, the Company and Organizational Unit must be empty. - Validate that when
GlobalRecordis False, the Company is required.