Client Empowerment: Deployment Types

Knowledge Base Home

Search the Omeda Knowledge Base

Deployment Types Dashboard

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

A deployment type can be thought of as a ‘list’ that is used to send email deployments. Built into the functionality of a deployment type are many functions that help to maintain your audience. For example, each deployment type will have a corresponding product by which subscription changes will be synced i.e. a deployment type used to send newsletters will have a corresponding newsletter product while other deployment types may be assigned to 3rd party sends, subscription renewals, digital alerts, webinar invites, etc.  Unsubscribes/Optouts are stored at the deployment type level.  When creating a new deployment for sending, the first step is to declare the deployment type – any audience members who have already opted out will be automatically removed when the deployment is sent.  In addition, since the Unsubscribe link is a merge variable, the Deployment Type dictates the level at which the unsubscribes will be captured and stored. 

image-20240520-220306.png

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

  • The deployment type name and ID

  • The alternate ID for the deployment type. You will see this value on the Email Builder search screens. The alternate ID of 05 will always indicate that the deployment type is audited.

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

  • The linked Product.

  • The sending domain and IP address

  • The designation. This describes the content sent from this deployment type allows users to run segmented reporting on each Designation value.  You are also able to filter on these values in the Deployment Search screen.

  • On this screen users can also:

  • Download a list of all deployment types

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

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

  • Create a new deployment type

Creating a Deployment Type

When you click Create + you will be navigated to the New Deployment Type page. Here there are several sections where you will need to provide information about the deployment type.

General Information

image-20240520-220316.png
  1. Name – this will be how you will find the deployment type in other applications like Email Builder, 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. Description – this can be a simple description of the deployment type. It can be helpful to use this field to communicate with others the type of content that will be sent.

  3. Status – here you can set whether the deployment type should be Active or Inactive. Active deployment types can be used across other applications while Inactive cannot. You may want to set your deployment type to Inactive if you’re not finished setting it up but need to step away and would like to prevent others from using it.

  4. Designation – the designation describes the content sent from this deployment type allows users to run segmented reporting on each Designation value.  You are also able to filter on these values in the Deployment Search screen.

  5. Deployment Domain – This will be the sending domain that will be used for emails sent from this deployment type. If you need a new sending domain created for your deployment, you will need to submit a support ticket so that can be created. This should be the domain you would like to send from for this deployment permanently. We do not suggest changing the sending domain after deployments have been sent because this may have undesired repercussions on the deliverability.

  6. Will this deployment type be audited? – if a deployment is set to Audited, sends from the deployment will be saved for audit purposes and duplicate email addresses will not be removed automatically from sends.

  7. Products – Each deployment type will require a linked deployment type product. This linked product will have subscription information synced from the product to the deployment type and opt in/out information synced to the product from the deployment type. Only products that don’t already have a linked deployment type will be selectable here.

Unsubscribe Defaults

In the next section, you can 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.

What’s Next

When your set up is complete for a deployment 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 to the 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 type as desired. Below are some examples:

  • In order to query or output for the master profile, 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 the 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 to a Form Builder form to collect opt ins and outs or submit a support request to Omeda.