Managing a Package

Introduction

You can add multiple versions to a Package configuration. This can be done by either adding a child to the Package or adding siblings to the version. Additionally, you can duplicate an existing version to create a new one. You also have the option to delete the Package configuration.

You can modify the Package details and its versions, add new versions, replace the Marketing Company, or add, remove or edit the Document associations.

If the initial Config ID, used for Package creation, is closed, and if you want to edit the Package, you can perform the following:
  1. Create a new Config ID.
  2. Modify the existing Package details such as, basic information.

    Note:

    You cannot replace the Marketing Company or remove the associated Documents.
  3. Associate new Documents to the existing versions.

    OR

  4. Duplicate the existing version to create a new version. Then you can remove the existing Document associations or associate new Documents.

Editing a Package

From Landing Page:
  1. For editing the Package configuration, from Action column, select Edit from More Menu.
From Summary Page:
  1. On the Communication Package landing page, hover over the name of the Package and select it.
  2. From the Summary page, select Edit.

In Update Communication Package page, modify the details as needed. You can navigate through the left pane to access the Communication Package Version to modify the version details.

Select Save to save the changes, or Save&Exit to save the details and return to the landing page.

Replacing Brand Marketing Company

You can replace the Brand Marketing Company only if the Config ID, that you used to create the Package, is in Open state.

From Landing Page:
  1. For editing the Communication Package configuration, from Action column, select Edit from More Menu.
From Summary Page:
  1. On the Communication Package landing page, hover over the name of the Package and select it.
  2. From the Summary page, select Edit.

In Update Communication Package page, under Brand, select More Menu from Action, and then select Replace.

Select the new Marketing Company and select Save to save the changes, or Save&Exit to save the details and return to the landing page.

Previewing a Package

You can preview the Package that you have created to produce output in different formats such as, PDF, CSV, HTML, or JSON. The Preview option is available across the hierarchy of a Package.

Note:

You cannot delete a Package that you have already previewed.

Note:

The PDF preview of a Communication Package is not displayed while using Google Chrome in emulator mode. See Known Issues for more details.

You can preview in two ways:

From Landing Page:
  1. For editing the Communication Package configuration, from Action column, select Preview from More Menu.
From Update Communication Package Page:
  1. On the Communication Package landing page, hover over the name of the Package and select it.
  2. From the Summary page, select Edit.
  3. From Actions, select Preview. You can also navigate to the Communication Version page and select Preview.

In the Create Preview page, under Output Type select the type of output you want to preview. By default, the Effective Date is set to current date. You can modify the date, if required. In Data, paste the data value in JSON format, that is the customer-specific and transactional information required to preview the version configuration.

Then select Preview.

Creating a New Version

You can create a new version of an existing Package in two ways:

Adding Child to Communication Package:

  1. In Update Communication Package page, select Actions from the top right corner, and then select Add Child.

Add Sibling to Communication Package Version:

  1. In Update Communication Package Version page, select Actions from the top right corner, and then select Add Sibling.

Provide the version details, and select Save to save the changes, or Save&Exit to save the details and return to the landing page.

Duplicating the Existing Version

You can duplicate the existing version to create a new version. This duplicates the existing version with its details except Name and Status Date.
  1. In Update Communication Package Version page, from the left pane, select the required version that you want to duplicate.
  2. From the right pane, select Actions and then select Duplicate to Create New Version.

Modifying the Association

You can modify the Documents association in the Package Version configuration using the Config ID which is in Open status. Ensure that you have at least one Document configuration associated to the version.

To edit the Documents association details, follow these steps:
  1. In Update Communication Package Version page, expand Associations section, and then from Action, select Edit corresponding to the document that is associated.
  2. Under Action, select the icon corresponding to the document attribute that you want to edit.
  3. In Document Attributes page, select Edit icon to modify the Document Always Triggered to either True or False.
  4. Select check mark to save the changes or cross mark to discard the changes.
  5. If you have multiple Documents and you want to rearrange the order, select the Document you want to reorder, and drag and drop it to the position where you want to reorder.
  6. Select Done to return to Update Communication Package Version page.
To remove the association, follow the step:
  1. In Update Communication Package Version page, expand Associations section, and then from Action, select Remove corresponding to the document that is associated.

Deleting a Package

You can delete a Package and its version, but you cannot delete a Package if it has multiple versions in its hierarchy.

Note:

You cannot delete a Package that you have already previewed.
From Communication Package Landing Page:
  1. In the Action column, select Delete from More Menu corresponding to the Package name that you want to delete.
  2. If there are no multiple Package Versions, the Package is deleted after confirmation. If there are multiple Package Versions, a warning message is displayed. You need to remove the Document association of each Package Versions, delete the Package Version, and then delete the Package.
From Communication Package Summary Page:
  1. On the Communication Package landing page, hover over the name of the Package and select it.
  2. From the Package's Summary page, select Edit.
  3. In Update Communication Package page, under Associations section, ensure that there are no associations.
  4. From Actions on the top right corner, select Delete. In the dialog box, select Delete to confirm.

Deleting Package Version

To delete the Package Version, it must not be associated with any other configurations. If the Package has only one version and if you delete that version, then the corresponding Package also gets deleted.
  1. On the Communication Package landing page, hover over the name of the Package and select it.
  2. From the Package's Summary page, select Edit.

    OR

  3. In the Action column, select Edit from More Menu corresponding to the Package that you want to delete the version.
  4. In Update Communication Package Version page, from the left pane, navigate to the Version that you want to delete.
  5. To remove an association, expand the Document association under Associations section in the right pane.
  6. From Action, select Remove corresponding to the Document that is associated.
  7. Repeat the step to remove all the associations before deleting the Version.
  8. In Update Communication Package Version page, from Actions, select Delete.
  9. In the dialog box, select Delete to confirm.