Getting Started with Deployments

Overview

The Deployments screen in Loyalty allows you to manage and execute metadata deployments. Making changes to certain asset types in Loyalty requires that you deploy metadata to the platform servers, for those changes to take effect. Examples of assets requiring metadata deployment include Segments, Member Attributes, Member Functions, and Triggered Actions. In most cases, you must deploy metadata after making the following types of changes:

  • Publishing a new asset.

  • Editing any aspect of a Published asset.

  • Deleting a Published asset.

  • Archiving a Published asset.

For some asset types, you can deploy metadata directly from the asset's main screen, such as the Segments screen or the Member Attributes screen, for example. When you deploy metadata in this manner, you deploy only the metadata for that asset type. For example, let's say you have recently published a new Segment and a new Member Attribute. If you navigate to the Segments screen and deploy metadata from there, the platform will deploy only Segment metadata; the new Member Attribute will not get deployed.

Conversely, if you deploy metadata from the Deployments screen, the platform will deploy all metadata, for all asset types. Therefore, deploying metadata from the Deployments screen should be done with care, as you may inadvertently deploy something that you didn't intend to. The comparison tool can help you identify all the pending changes that will get deployed (see Compare Metadata Versions for more information).

Program Versions

Metadata in Loyalty is always versioned. The Program Versions section of the Deployments screen displays a historical log of all past deployments, including the version number, created date, and any user-defined notes.

Program-level Settings

The Deployment screen contains several program-level settings, including your loyalty program name and description.

From this screen, you can also designate the Primary Metric and Primary Tier Scheme for your loyalty program. The platform allows you to define multiple Metrics and Tier Schemes, but one Metric and one Tier Scheme must be designated as the "primary" one. This designation is important, as most API calls into the Loyalty platform that retrieve Metric or Tier information can only access the "primary" Metric or Tier Scheme.

Access

The Deployments screen is used to view and manage the metadata deployments in your loyalty program. To access the Deployments screen, select Program from the top navigation bar, then select Deployments from the side navigation menu.

 Compare Metadata Versions Configure Program-level Settings Deploy Program Metadata