Installed apps screen
The Installed Apps screen displays both the apps that are currently installed and those available for installation on your instance. Typically, one or more apps are installed when a company's instance is initially set up. This screen also shows the apps you have developed, including those still in the Draft state.
Click an app to see the details about it.
To add an app to the list of available apps, click Medallia Xchange to open Medallia Xchange. A client instance will only be able to see and install the apps to which they have been granted access. Use the client key to make an app available to that company on the Install Apps screen. For more information, see Manage and build apps.
Click Get Client Key to see and copy the unique key for the company on the instance.
Initial preparation
Use this list before installation. Contact your Medallia expert for assistance:
-
Confirm that you know which app is being requested; make sure that the App mentioned in the installation request case is among those listed on the Manage Apps screen of the app-building instance. If it is not listed on Managed Apps, see Best-practice apps and have them specify which app they need.
-
Confirm the installation location URL: sandbox (recommended).
Restriction: Direct-to-production installations are strictly prohibited: perform the initial installation in a sandbox. -
Ensure you can sign in to the instance where you will be installing the app.
-
Make a list of all active locales on the instance prior to installation from Setup > Reporting > Translations > Locales or, alternatively, the language drop down list on Admin Suite > Translations.
-
Verify the client instance has access to the app. For more information, see Grant an entitlement to a company.
Standard installation
To install an app:
- In the Available Apps section of the Install Apps screen, click the tile of the app to install.
- Review the app Details tab for any app-specific pre-installation or installation steps and ensure they have been completed.
-
Confirm that you have the list of active locales from the prep steps.
- On the app details screen, select the version and the snapshot of the app to install.Tip: Select the most recent version for installation. Alternative versions only appear if they have been granted entitlement.
- To perform a standard installation, Click Install. Standard installations are appropriate for most instances.
-
After making an installation choice, Medallia Experience Cloud begins a validation process that ensures the app is safe to install and checks for conflicts between the app and the destination instance. Wait for the instance to validate the app.
If the app does contain configuration entities that already exist on your instance, a message indicates this in the upper-right corner.
When installing new apps to existing instances with live clients, it is very important not to undo the customizations made to existing apps. To prevent customizations that have been made from being lost when installing a new app, these conflicts must be resolved before proceeding with the installation. See App impact preview to get information on how to manage conflicts during installation.
-
Once all conflicts are resolved, click Continue to install the app. The app Details screen updates to show the success or failure of the installation.
-
The Details tab updates to show the success or failure of the installation. Once the app is successfully installed, review the locales and ensure that those listed as Active prior to install are still active and any new locales added are either Inactive or Active and Condition=”false”. Correct any that have been changed.
-
For failed installations, this area includes related error messages and links to download a full report or to see debug information.
-
Click Close to return to the Install Apps screen.
The tile for the app now appears in the Installed section.
Custom installation
Custom Installation allows you to map certain objects included in the app to objects that already exist on the client instance. This effectively tells the installer that the app should use the mapped object from the instance in place of the object included in the app: the installer replaces all references to the app object with the mapped instance object. For example: if you map e_app_field_a to e_client_field_b, every report, survey, or other process in the app that references e_app_field_a references e_client_field_b instead.
Custom install can unblock installations that face certain known issues. This approach should be used sparingly and comes with some very important caveats:
-
There can be differences between the mapped objects that break app functionality or cause the installation to fail.
-
As this effectively customizes this app during installation, using mapping may make it difficult or impossible to upgrade the app on this client instance in the future.
-
Only these entities types are available for mapping:
- Unit groups
- Unit group fields
- Unit fields
- Aggregated Reporting fields
- Calculated fields
- Event fields
- Feedback Fields
- Translation languages
- Calculations
- Timeperiods
To perform a custom install:
- In the Available Apps section of the Install Apps screen, click the tile of the app to install.
- If there is an installation already in progress, click Cancel.
- Review the Details tab for any app-specific pre-installation or installation steps and ensure they have been completed.
-
Confirm that you have the list of active locales from the prerequisites.
- On the Details tab, select the version and the snapshot of the app to install.Tip: Select the most recent version for installation. Alternative versions only appear if they have been granted entitlement.
- When there have been custom mappings for this app, click View mappings to verify how configuration entities in the app are mapped to entities on the instance. Optionally, click Download mappings to download the current custom mappings in JSON format.
- To perform a custom installation, click Custom Install .
-
In the confirmation dialog, click Continue.
- In the Mappings tab, select the desired Entity type to map from the dropdown list and click Continue.
The dialog shows a row for each object of that type included in the app.
-
Find the entity to map on the list and click on the corresponding Map to entity.
Map To shows a search box that lists all existing objects of that type in the instance:
-
Find the object to map to using either the search tool or scrolling through the options, and click on it.
-
Complete these steps for all entities of all types that need to be mapped.
Entities that you do not map are installed as they would be with a standard installation.
-
Alternatively, click Upload Mappings, and select a file with the desired custom mappings for the installation.
-
Click Continue.
Experience Cloud begins a validation process that ensures the app is safe to install and checks for conflicts between the app and the destination instance. These conflicts must be resolved before proceeding with the installation. For more information, see App impact preview.
-
Once all conflicts have been managed or there are none detected, click Continue to start the install.
-
The app details screen updates to show the success or failure of the installation. Once the app is successfully installed, review the locales and ensure that those listed as Active prior to install are still active and any new locales added are either Inactive or Active and Condition=”false”. Correct any that have been changed.
-
For failed installations, this area includes related error messages and links to download a full report or to see debug information.
-
Click Close to return to the Install Apps screen. The tile for the app now appears in the Installed section.
App impact preview
Apps directly include specific entities, but also include those objects dependencies and prerequisites. An app does not install without having all the entities it needs:
-
App impact preview shows differences when something is being added, removed or changed.
-
Conflicts often contain "false positives" for differences that are expected and desired, like adding new roles to a time period.
-
Because apps are point-in-time snapshots, older apps can contain older versions of entities that could show as conflicts because of structure changes.
-
Conflicts warn you before you change something in a live environment.
The App impact preview screen shows all the entities of an app to preview an installation's impact and manage conflicts.
Conflicts are entities that exist in the app and also on the installation instance but are configured differently. To manage conflicts, choose to either keep the object as it is on the client instance (skip) or replace that version entirely with what is in the app (overwrite). All conflicts must be given either a skip or overwrite designation before an app install can be completed.
On this screen you can search entities by name, ID or description or filter them by status and type.
To resolve conflicts:
- Click one entity from the list to see the old value for the entity and the changes for the new version on the details pane.
A sub-pane on the App details pane lists all entities that have the selected entity as a dependency.
- On the details pane, select the desired resolution for the conflict.
Alternatively, make a multiple selection of conflicts and define the desired resolution for the whole batch.
Important: If you reject the changes to an entity during installation, elements in the new version of the app that reference that entity may not behave the way they were intended. - After validating your installation choice and all conflicts have been resolved, click Continue to install.
Critical safety and risk mitigation
To protect your environment, adhere to the following precautions:
Fresh sandbox reloads — Ensure your sandbox has been recently reloaded with current production data. Outdated environments can mask integration conflicts that may only appear later in production.
The "DNA" of fields (UUIDs) — Field names may look identical, but their UUIDs (Unique Universal Identifiers) are what matter. A manually created field will have a different UUID than one created by an app.
Reserved prefixes — Do not use "bp_" prefixes for manually created fields or calculations. This prefix is reserved for Best Practice (BP) apps; existing manual fields with this prefix may cause the installation to fail.
