Install Applications

This action occurs after an application is installed to a sandbox.

Action TypeEmbedded
Full Action IDembedded.platform.applications.install
Runs multiple custom functions?Yes

JavaScript File Structure

Action files share the following basic structure:

module.exports = function(context, callback) {
   // Your custom code here
   callback();
};

When you code the custom function for an action, you have access to two arguments:

callback—This argument follows the established JavaScript callback pattern: it takes an error as the first argument (or null if there is no error) and a result as the second argument (if required).

context—This argument provides the function access to relevant objects and methods that interface with Kibo

Context: Platform

The following methods and objects are available to this action through the use of the context argument.

Microservice Operation

This action corresponds to the microservice that installs and uninstalls applications

Get Methods

Exec Methods

Context Objects Available to All Actions

Get

get.applicationKey

Returns the application key.

ParametersTypeDescription
N/AN/AN/A

Example:

context.get.applicationKey();

Response:

"string"

get.exports

Returns the exports for the application.

ParametersTypeDescription
N/AN/AN/A

Example:

context.get.exports();

Response:

"object"

get.installationState

Returns the installation state of the application.

ParametersTypeDescription
N/AN/AN/A

Example:

context.get.installationState();

Response:

"object"

get.nameSpace

Returns the namespace of the application.

ParametersTypeDescription
N/AN/AN/A

Example:

context.get.nameSpace();

Response:

"string"

Exec

exec.saveInstallationState

Saves the supplied application installation state to Kibo.

ParametersTypeDescription
installationStateobjectThe application installation state. You can retrieve this object using the corresponding GET method.

Example:

context.exec.saveInstallationState(installationState);

Response: N/A

Context Objects Available to All Actions

apiContext

Accesses tenant information.

PropertiesTypeDescription
baseUrlstringThe base URL for the site.
basePciUrlstringThe base PCI URL for the site.
tenantPodstringThe name of the tenant pod in which the tenant resides.
appClaimsstringThe application claims token.
appKeystringThe application key.
tenantIdintegerUnique identifier for the tenant.
siteIdintegerUnique identifier for the site. This ID is used at all levels of a store, catalog, and tenant to associate objects to a site.
masterCatalogIdintegerUnique identifier for the master catalog.
catalogIdintegerThe unique identifier for the product catalog. Catalogs are part of a master catalog.
currencyCodestringThe default three-letter ISO currency code for monetary amounts.
previewDatedate/timeThe date and time that the content is being viewed. This might be a future date if the content is previewed with an active date range set in the future.
localeCodestringThe locale code per the country code provided. This code determines the localized content to use and display.
correlationIdstringThe unique identifier of the API request associated with the event action, which might contain multiple actions.
isAuthorizedAsAdminBooleanIndicates whether the Dev Account user is authorized as an admin.
userClaimsstringThe user claims token.

Example:

context.apiContext.baseUrl;

configuration

Receives a JSON response that contains information about the configuration data set in the Action Management JSON editor.

PropertiesTypeDescription
VariesobjectCustom fields and values that you can set in the Action Management JSON Editor.

Example:

context.configuration.customData;