You are here:
Framework API
This section defines the public classes or methods from the CG Cloud Mobile App Framework.
Required Editions
| Available in: Lightning Experience in Professional, Unlimited, and Enterprise Editions that have Consumer Goods Cloud enabled. |
- API for Sales Folder
Sales Folder uses getNumberOfColumns() API method to calculate the number of columns depending on the form factor and the orientation in the same way as the Cockpits. Cockpits are card collections that serve as a landing page for certain business processes or modules. They provide users with a compact view of the most relevant information and can be used as entry points for more details. - Application Security PIN
To enable better security and adherence to the mobile security standards, the Consumer Goods Cloud offline mobile app has a PIN feature. This pin is specific to a user and enables access to the Consumer Goods Cloud offline mobile app. It also enables the application to lock itself, if the user is inactive for a predefined period. - Bulk Update Mode for Lists
Whenever a change of value is made to a list item, an event is triggered to the business logic, to inform about the change which contains information about the old value and the updated value of the item. - Business Object Helper Contract
The BusinessObjectHelper (BoHelper) contract is similar to a standard BO contract but doesn’t need a data source. - Controls with Test IDs
To enable test automation framework for the UI, a key automatedTest is defined in the info.JSON file that is packaged in Deployment.zip. Based on the value of the key, the test automation framework is enabled or disabled. When the Consumer Goods Cloud offline mobile app is deployed, the Consumer Goods Cloud Mobile App Framework reads the value of the key from the info.JSON file. If the value is true, Test IDs are generated and if the value is false, the Test IDs aren’t generated. - Dropdown
The Dropdown UI control is a drop-down control that you can use in the HeaderLine control. You can use it as a standalone control and is available for the Consumer Goods Cloud solution. It supports both edit and visibility rights. The quick filter is modeled by using the Dropdown UI control. - Enable Pop-Up Notification about Unsaved Data Changes
You can show a pop-up notification on a mobile on iOS platform to inform users about unsaved data in the Consumer Goods Cloud offline mobile app. - Extend Validations for Framework
Consumer Goods Cloud Mobile App Framework supports validations that check for exceptions within asynchronous Business Logic (BL) contracts. The BL contracts are validated on saving, importing, during generator calls and are manually triggered from the Implementation Backend Environment (IBE). The validation includes checking the structural correctness of the contract, validating promise chains in asynchronous BL contracts, and checking asynchronous calls in synchronous contracts. - Flex List
Consumer Goods Cloud Mobile App Framework supports the Flex List feature in the GroupedList and the BreadCrumbControl UI controls. This feature provides better user experience for a mobile app user. The experience includes list-driven screens like the questionnaire screen or a survey screen, by enabling slide-in-out animations for list items. - Hurdle Evaluation - Framework Support
Hurdles are a list of conditions that must be fulfilled before a promotion is executed. The conditions are defined for a particular promotion, during the order entry process. - Input Validations
Consumer Goods Cloud supports the validation of user inputs before the data is saved to the database. Data in the modified Business Objects and List Objects is validated before storage. This provides enhanced security for the CG Cloud Offline Mobile app. The validation is performed on the length and the base type of the input. Process context variables that are used during runtime and aren’t saved aren’t validated. The validations are performed only if the InputValidationActive attribute is set to true. - Parameterized Query Support
Consumer Goods Cloud Mobile App Framework provides enhanced app security by using parameterized queries that ensure that no data other than the data that users have visibility and editability rights for is manipulated. To enable parametrized queries, data used as parameters in the data sources is inserted in the SQL statements by using parameter binding. Parameter binding is applied only for data sources with a schema version of 2.0. - Parsing URI Scheme
To enable error-free input in the application, use the parsing URI scheme that’s available in Android and iOS in both Consumer Goods Cloud and CG Cloud offline mobile app. - Stepper Control Extensions
Stepper control is an input control that you can use to navigate through a range of values. To enable lists to display latest values that are selected in one stepper control but not reflected in the linked stepper control, use the stepperCorrelationId attribute in list bindings. This attribute links the input areas of the two lists that are rendered on the page. This enables you to view the change made in stepper control in one list, which is then reflected in the co-related stepper control of the other list. - Allowlisted Third-Party Apps
You can launch third-party apps using the Consumer Goods (CG) Cloud offline mobile app, only if their URI schemes are allowlisted on the iOS platform. - Deprecated APIs and Methods
These methods are no longer recommended and will be retired in a future release. - Attachments
Attachment is a class that is used to work with media paths. It can be used from the UI thread that is inside UI plugins. - BindingUtils
BindingUtils is a class of the Framework API. - BoFactory
BoFactory is a class of the Framework API. - Buttons in Lists
Consumer Goods Cloud Mobile App Framework supports display of buttons in lists. This feature enables Consumer Goods Cloud offline mobile app users to perform quick actions like image capturing from a mobile device and attaching it to the current list item task. - Consumer Goods Cloud
This section lists the features and functionality of the Consumer Goods Cloud offline mobile app framework. - Utils
Utils is a class of the Framework API. - Facade
The facade acts as an interface between the proxies and the application. - FrameworkUser
When you select the FrameworkUser for the BoUser base class, the business object has access to four functions. You can use these functions for edit and access rights based on user roles. The FrameworkUser class is only available via the class from which it’s extended, that is, BoUser. - List Model
List Model is the base class for all list objects. It isn’t meant to be accessed directly, but provides methods for all objects that inherit from this class. - Model
The framework methods are available for use with business objects. - Print
This section describes the APIs that are used for the print series. - VersionInfo
The VersionInfo class fetches the version information of different components. You can only use it from the UI thread.
Did this article solve your issue?
Let us know so we can improve!
