4me Help
App Offering Fields

App Offering Fields

The table below lists the fields of the App Offering form and provides utilization guidelines for each field.

Field Label Utilization Guideline
Picture

The Picture field is used to add a picture or logo to the app offering.

Click on the picture to enlarge it or to change it.

Name

The Name field is used to enter a name for the app offering.

Disabled

The Disabled box is checked when the app may no longer be installed by new customers. Customers that have an older version installed can still update when the app offering is disabled.

Reference

The Reference field can be used to identify the app offering via the APIs. It is the only identifier that will remain stable across version updates. It may only be changed until the app offering is published for the first time. The Reference field defaults to the Name field value, written in lower case characters and with all spaces replaced by the underscore character, prefixed with the account name followed with an underscore (e.g. wdc_). The field value must be unique across all accounts.

Description The Description field is used to enter a description of the app offering. This information is shown to customers in the app offering’s ‘Description’ tab in the Settings console’s ‘Apps’ section.

This field allows basic text formatting.

Features The Features field is used to enter a high-level overview of the apps’s capabilities. This information is shown to customers in the app offering’s ‘Features’ tab in the Settings console’s ‘Apps’ section.

This field allows basic text formatting.

Compliance The Compliance field is used to specify the policies and/or regulations the app complies with. This information is shown to customers in the app offering’s ‘Security & Compliance’ tab in the Settings console’s ‘Apps’ section.

This field allows basic text formatting.

Service instance

The Service instance field is used to select the service instance that should be related to requests that concern the app offering.

UI extension version

The UI extension version field is used to select the (version of the) UI extension for this app’s instances. The UI extension is shown on the ‘Configuration’ tab in the Settings console’s ‘Apps’ section for customers that install the app.

Scopes
Effect

The Effect field is used to select whether the app is allowed or denied the ability to perform the actions defined in the Actions field.

Actions

The Actions field is used to define which actions the app is allowed or denied to perform and for which record types.

Webhook
URI

The URI field is used to enter the URI template for the app’s webhook. The placeholder text {account} can be included in this field’s value. This placeholder text is automatically replaced by the account id (or subdomain name) of the customer’s account.

Policy JWT algorithm

The Policy JWT algorithm field contains the algorithm used for generating the policy for the app’s webhook.

Policy claim expires in

The Policy claim expires in field is used to specify after how much time a policy claim expires for the app’s webhook.

Policy audience

The Policy audience field is used to specify the policy audience for the app’s webhook.