Managing Deployment Products

Knowledge Base Home

Search the Omeda Knowledge Base

In the Deployment Products section of the Manage Database tool, all deployment products are available to search in the dashboard.

A deployment product is the indicator of an audience member’s relationship with a ‘list’ that is used to send email deployments, otherwise known as a deployment type. There are two types of deployment products, a Newsletter deployment product and an Email deployment product. Newsletters are a ‘product’ that an audience member can subscribe to i.e. “I signed up for a newsletter and you can track the source, promocode, and date of my subscription.” Email Deployment products typically include things like 3rd party sends, webinar invites, surveys, etc. are not normally a ‘product’. They do not have subscription data since customers normally do not sign up for those types of deployments.

Using the the Deployment Products screen, both the deployment product and the deployment type can be created in one action so the set up is quick and easy.

 

image-20240424-214432.png

In the table on the dashboard, you’ll see information about each deployment product including:

  • The deployment product name and ID

  • The deployment type ID. This will be the value used to indicate deployment type in Omeda’s APIs.

  • The Product Type

  • Updated By. This will be the last user to update the deployment product.

  • Last Modified. The date of the last change to the deployment product.

  • The Status. (active or inactive)

  • On this screen users can also:

  • Download a list of all deployment products and their deployment types

  • Sync Environments to sync their deployment products and types to their Staging environment. This is likely only necessary when testing API or integration changes.

  • Edit or view the settings of a deployment product by clicking the name or ID in the first column or the edit icon in the Actions column.

  • Create a new deployment product

Creating a Deployment Product

When you click Create + you will be navigated to the New Deployment Product page. Here there are several sections where you will need to provide information about the deployment product, but first you will need to set whether you are creating a Newsletter product or an Email Deployment product at the top of the page.

image-20240424-214444.png

A Newsletter Product will send content with a distinct subject regularly to an audience who can subscribe to it. This product will have associated classes, sources, and promo codes for tracking.

An Email Deployment Product will not have associated classes and promo codes and is usually used for marketing, sponsored, and other types of content with irregular subject matter.

General Information

  1. This will be how you will find the deployment product in other applications like Audience Builder, Data Loader, Reporting, etc. To make finding deployment types easier, it is recommended that you follow a naming convention like NL-{brand abbreviation}-{newsletter name}.

  2. This is the name that will appear in some reporting.

Deployment Types

In this section, you will need to provide information about the linked deployment type.

You will first need to specify if the product requires a deployment type. You would select no if Omeda is not sending emails for this deployment but just storing a list. This will likely only be the case when moving data during onboarding.

If the product does need a Deployment Type, you may be asked if you’d like to use an existing deployment type. This will only be available if deployment types exist without a linked product. If there is no appropriate deployment type to link to, you can use this screen to create a new one. You will need to provide the following information:

  1. Deployment Type Name – this can be the same as the deployment product name.

  2. Description – a brief description of the deployment type.

  3. Designation – the type of content that will be sent from the deployment type

  4. Deployment Domain – the sending domain for each deployment. If you must create a new deployment domain, please submit a support request.

Unsubscribe Defaults

If you created a new deployment type for your product, you will also have the opportunity to modify the default language on the unsubscribe pages.

Unsubscribe Page Message : this content will display after a user has confirmed their unsubscribe request.

Confirm Unsubscribe Message : this content will display when a recipient clicks the @{confirmunsubscribelink}@ from an email.

Canceled Unsubscribe Message: this content will display if a user cancels their unsubscribe request.

Advanced Settings

Lastly, you can select the profiles in which the Deployment Product should be configurable. This will allow users to add the product into Audience Builder using Admin > Tools > Configure Audience Builder.

What’s Next

When your set up is complete for a deployment product and/or type, click Create at the top right corner of the page. Omeda will immediately begin syncing the opt outs from the Global Opt Out list if you created a linked deployment type. This may take up to a day to complete, depending on the size of your database. You will receive an email notifying you when the sync is complete. Meanwhile, you can set up the default settings for the deployment type, like the Friendly From, Mailbox, default Reply-to, and tracking settings in Email Builder > Tools > Deployment Defaults.

There may be also some additional steps necessary to use the deployment product and type as desired. Below are some examples:

  • In order to query, output, or include in Field Count or Crosshatch reports in a profile, the deployment product must be configured into Audience Builder using the Admin tool “Configure Audience Builder”. If you don’t have access to this tool or need assistance doing so, you will need to submit a support request.

  • In order to query or output, the deployment type must be configured into Audience Builder using the Admin tool “Configure Audience Builder”. If you don’t have access to this tool or need assistance doing so, you will need to submit a support request.

  • If a deployment type is needed in another profile(s), the linked product must be added to those profiles. This will require a support request to complete.

  • Add your deployment type or product to a Form Builder form to collect opt ins and outs or submit a support request to Omeda.