Screen Configurations

Source: This article refers to Screen Configurations

In a Nutshell

The Screen Configuration feature allows you customize supported screens located in the mobile application and browser-based application to meet your needs. With it, you can structure the layout and order of fields in the mobile applicaiton, including editing field names, hiding fields, making fields required, making fields editable, as well as configuring basic and advanced “validation” settings.

Note: The Screen Configuration tool is currently optimized for Google Chrome. Using another browser may result in latencies and rendering issues.

Access

The Service Call screen configuration feature can be accessed as follows:


A Closer Look

The following is an overview of the parts that make up the Screen Configuration feature:


Available Fields


Available Fields are all fields supported natively by the Coresystems Data Model. These fields all have Default settings that are included.

For more information on the Data Model, refer to the Data Object Table.




Custom Fields


Custom Fields represent fields supported by another Enterprise Resource Planning (ERP) system such as SAP B1. These are generally imported as user-defined fields (UDFs) from the ERP. Custom Fields do NOT have default settings, and therefore require either basic or advanced settings to be configured before being visible and usable in the application.

There is an additional property that custom fields have called Preserved. If this flag is set to TRUE, then the custom field is not yet transferred to the ERP, but only preserved in the Coresystems Cloud. If this flag is set to FALSE, the user will be warned that the custom field can't be deleted or edited.




Cards


A Card is a grouping of a fields that appear together in the mobile or browser-based application separated by a divider from other cards/field-groupings.

For an idea of how the Cards will appear in the mobile application or in the browser-based app, it is recommended to adjust the size of the browser window.




Screen Configuration Process

1. Login to Admin Module
The Screen Configuration feature can be accessed from the Admin Module with Super Admin permissions or with your Cloud Store credentials, and then by selecting a Company, selecting the Screen Configuration tab, and then selecting the Configure option beside the supported mobile application screen you wish to edit.
2. Modify Default Screen Configuration
After selecting a company and clicking the Screen Configuration option from the left menu, you can then modify the existing default screen configuration using the Screen Configuration tool.
3. Synchronize Changes
After saving the changes to the Service Call screen configuration, the changes can be synchronized to the mobile application. Alternatively, if fields or sidebars included in the browser-based applications have been configured, you can then sign-out and sign back in to the relevant application to view the changes.

Settings

Basic Settings

When you select the Settings option on an Available Field or Custom Field and select the Basic Settings tab, you can edit the following:



Setting Description
Description Required. The text displayed in the label. This can be changed to suit your preferences and needs.
Default Value If applicable, the default value to be displayed when creating a new record. The following values are supported:

  • String values
  • Number and decimal values
  • Boolean values (as an exceptional situation for the EMME chargeable field, instead of saving true/false, the screen configuration application will save ‘CHARGEABLE/NONCHARGEABLE’ as default value in the field configuration)
  • dateTime values (in the format ‘2012-04-23T18:25:43’)
  • duration values (in milliseconds)
  • Enumeration: the Screen Configuration application allows users to select a default enumeration value. The enumeration CODE will be saved as default value in the field configuration.
  • setting a field that displays a linked object to empty: “defaultValue”:null (Example: material.warehouse)

Note: Since in JSON all of the above are strings, they must be formatted using the English standard (e.g “1.25” instead of “1,25”). The apps will parse them as formatted in English and display them according to the current language settings.


The following values are not supported:

  • setting a field that displays a linked object to a default object, e.g. Warehouse on Material, Payment Terms on Business Partner and all other linked objects
  • monetary values
Visibility Choices include:
  • Default: visible
  • Visible: visible
  • Hidden: not visible
Editability Choices include:
  • Default can be edited.
  • Editable: can be edited
  • read-only: will display but cannot be edited
Required Choices include:
  • Default the field is not required
  • Required: the field is required
  • Optional: the field is not required

Advanced Settings


Advanced Settings


Advanced Settings use "expressions" to control behavior, and provide additional options for save-on validations. The application does NOT validate the expression input.

When you select the Settings option on an Available Field or Custom Field and select the **Advanced Settings** tab, you can edit the following:





Setting Description
Translation Key Here you can search for the translation key that has been added in Admin > Translations for the field. This will bind all translated strings assigned to the translation key to the field. Please note that the application will return suggested results after three characters have been entered. This is done in order to limit the number of results and improve performance.
Default Value Expression If applicable, the default value to be displayed, entered, or pre-selected.
Visible Expression The visibility expression associated with the field. This setting determines if the field is visible or not.
Editable Expression The editable expression of the field. This setting determines whether the field can be edited by the end-user or not.
Required Expression The required expression of the field. This setting determines whether the field is required or not.
Input Validation Expression The expression used to validate what the user enters or selects from the field.
Validation Error Message This expression is used to define the text displayed when the input data is not valid according to the conditions of the Input Validation Expression

Advanced Setting Expressions


Advanced Setting Expressions consist of the following contraints:


Expression Type Explanation
visibleExpression Boolean Must return a boolean value indicating if the field is visible or not.
editableExpression Boolean Must return a boolean value indicating if the field is editable or not.
requiredExpression Boolean Must return a boolean value inidicating if the field is required or not.
defaultValueExpression String, number, boolean, datetime or duration (in milliseconds) The default value to be displayed or pre-selected.
validationExpression Boolean Must return a boolean value indicating if the entered value is valid or not.
validationErrorMessage String This defines the text to be displayed to the user when the field is not valid according to the above condition. If this is translated, then it will contain the translated strings associated with the from the translations key (see the Translation Key field details for more information).

Expression Examples


The following are examples of the expressions that can be used in the Advanced Settings:


Expression Explanation Example
Visible The following marks a field as visible or not, depending on whether the custom field’s meta value is greater than (>) “22” "visibleExpression": "${udfMeta.SWA_CT_FixAmnt} > 22"
Editable The following marks a field as editable or not, depending on whether the service call’s problem type name is “Broken” "editableExpression": "${serviceCall.problemType.name} === 'Broken' "
Required The following marks a field as required or not, depending on whether the service call’s origin name is “Web” "requiredExpression": ${serviceCall.origin.name} === 'Web' "
Visible The following assumes mileage.code to be a String "visibleExpression": "${mileage.code} ==='Hello12345' "
Editable This one assumes mileage.driver to be a boolean (hence the usage of boolean comparison). "editableExpression": "${mileage.driver} === true"
Visible Here’s how you can test whether a field has (or doesn’t have) a value
The field will be shown if distance has a value. "visibleExpression": "${mileage.distance} !== undefined"
The field will be shown if distance doesn’t have a value. "visibleExpression": "${mileage.distance} === undefined"
Visible Here’s how you can use dates:
The field will be shown if travelStartDateTime is later than today. "visibleExpression": "${mileage.travelStartDateTime} > new Date()"
The field will be shown if travelStartDateTime is on the 7th day of the week. "visibleExpression": "${mileage.travelStartDateTime}.getDay() === 6"
The field will be shown if travelStartDateTime is on any date of 2016. "visibleExpression": "${mileage.travelStartDateTime}.getFullYear() === 2016"
Visible Here’s how to use durations
The field will be shown if duration is 5 minutes, i.e. 5 minutes * 60 seconds in a minutes * 1000 milliseconds in a second, because the value will be in milliseconds. "visibleExpression": "${effort.duration} === 5 * 60 * 1000"

Additional Resources

Examples with JavaScript Functions

Both Business Rules & Notifications and screen configurations support JavaScript functions. Functions are defined at Admin > Companies > Functions.

The following example could be used to validate Brazilian Tax IDs:

 { "validationExpression" : "isValidCNPJ(${udfMeta.CNPJNumber})", "validationErrorMessage" : "Please enter a valid CNPJNumber" } 

Custom Fields



Custom Fields can be created by clicking the + icon and selecting a “Custom Field” option or by dragging a Custom Field from the designer pane and dropping it on a card.

In case you are editing the properties of a custom field, there is another option available for some custom field types called Custom Settings. Here you can edit UdfMeta properties related to the custom field (example: Value Length for custom text fields).


Appendix

Data Object Table

For more information on the Available Fields supported in screens available in the Screen Configuration tool, refer to the following table:

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

0 comments

Article is closed for comments.