Skip to main content

Delivery settings

Delivery options define how a product is delivered to the customer and what delivery-related information appears on the confirmation page, in confirmation emails, or in delivery-related parts of the order flow.Depending on the product type and selected delivery type, different setup options can appear.

Delivery type

The Delivery Type setting defines how the product is delivered to the customer. Depending on the selected delivery type, additional setup options can appear.

This setting is available for:

  • Base product
  • Perpetual product
  • Recurring product (plan)
note

The Delivery Type setting is not used for bundle products.

Delivery types

Following subsections describe available delivery types and their settings

Cleverbridge delivers key

Cleverbridge delivers the license key for the software to the customer.

CB delivers key

Use this delivery type when Cleverbridge should deliver license keys through a key list, web key generator, or another supported key delivery setup. When this type is chosen, the following options can be defined:

OptionDescriptionUse to
Key ListKey list selected for license key delivery.Deliver keys from a predefined list.
Web Key GeneratorWeb key generator selected for license key delivery.Generate license keys dynamically. To set up a new web key generator, use Commerce Assistant. For details, see Key generators.
Key result typeControls how the key and template are shown to the customer. Options include Auto, Binary, Html, and Text.Define whether the key is displayed automatically, as binary data, as HTML, or as plain text.
Execute once per purchased quantityGenerates only one key per cart item, regardless of the purchased quantity.Avoid generating one key for each purchased unit.
Use key templateUses the key template text that was set up in the Key Template field.Show the delivered key together with custom confirmation page text.

Cleverbridge can also deliver keys by using an executable key generator or a dynamic link library. These options are hosted by Cleverbridge. For more information, contact Client Experience.

note

If a key generation or key list error occurs, Cleverbridge creates an error log entry and makes up to five attempts to generate or obtain the key. If the fifth attempt fails, Customer Support investigates the error unless Client handles errors is activated.

Cleverbridge delivers full version by download

Cleverbridge delivers the full version of the software to the customer by download.

CB delivers key

Use this delivery type when Cleverbridge should provide the full version of the software as a downloadable file. When this type is chosen, the following options can be defined:

OptionDescriptionUse to
Download FileFile that the customer downloads through a link.Select the downloadable product file. To upload a new file click the Upload product file button.
Link Validity in DaysNumber of days for which the download link is valid.Limit how long the download link remains available to the customer.
DescriptionDescriptive information displayed with the download link on the confirmation page and confirmation email.Explain what the customer is downloading or provide short download-related instructions.
Only show download when customer orders in this languageRestricts the download to a specific language in which the customer orders.Show the download only for orders placed in a selected language.

Client delivery

Use client delivery when the product or license key is delivered outside of Cleverbridge by your own systems or processes.

The following client delivery options are available:

Delivery typeDescriptionUse to
Client deliversThe full version of the product is delivered to the customer outside of Cleverbridge.Handle product delivery outside of Cleverbridge.
Client delivers license keyThe license key is delivered to the customer outside of Cleverbridge.Handle license key delivery outside of Cleverbridge.

No additional delivery type options are listed for these delivery types.

Key templates and delivery notes

CB delivers key

These settings define custom license key and delivery information shown to customers on the confirmation page or in confirmation emails. They are available for all product types and particularly important for products that use delivery-related confirmation information.

The following settings can be defined:

FieldDescriptionUse to
Key TemplateCustom license key information shown on the confirmation page, such as customer name, product name, or license key number. If left empty, default key template text displays.Customize how the license key is presented on the confirmation page.
Email Key TemplateKey template for the email confirmation.Use a different key template in the confirmation email than on the confirmation page. If the same template should be used in both places, leave this field blank.
Additional Delivery NoteAdditional delivery information shown on the confirmation page. Supports dynamic placeholders.Provide delivery instructions, installation steps, or other customer-facing delivery details.
Information on Extra PageAdditional information that is too long to fit on the confirmation page.Create a button on the confirmation page that opens the instructions or product information in a separate window.
tip

If you do not want the default key template text to display on the confirmation page, and you do not want to enter custom text, enter only the Key placeholder in the Key Template field.

In this case, if you use a key list, only the license key itself displays. If you use a key generator, neither the default text nor a license key displays.

Placeholders for the key template

Use the following placeholders to insert customer, product, or order information into the Key Template.

PlaceholderDescription
<Key>License key
<RegName>Customer name
<ProductId>Product ID
<InternalProductId>Internal product ID
<[NAME_OF_X_PARAM]>Corresponding x-parameter
<ProductName>Name of the ordered product
<Quantity>Quantity of the ordered product
<ProductTrialUrl>URL to download a trial version of the product
Example

The following is an example of key template text:

<RegName>, here is your product key for your purchase of <ProductName>.
<Key>

Placeholders for the additional delivery note

Use the following placeholders to insert customer, product, or order information into the Additional Delivery Note.

PlaceholderDescription
<ProductId>Product ID
<InternalProductId>Internal product ID
<[NAME_OF_X_PARAM]>Corresponding x-parameter
<ProductName>Name of the ordered product
<Quantity>Quantity of the ordered product
<ProductTrialUrl>URL to download a trial version of the product
Example

The following is an example of additional delivery note text:

<p>Thank you for your order. To download and install your product, please follow these instructions:</p>
<ol>
<li>Download the installation file by clicking the button below.</li>
<li>Double-click on the downloaded file to begin installation.</li>
<li>Follow the onscreen installation instructions.</li>
<li>When prompted, enter your license key.<br /></li>
</ol>
<p>Please note: The license key is also included in your confirmation email.</p>

Did you find this doc useful?