Updating the database structure

To make your modifications to the data model effective and to be able to use them, the database structure needs to be updated.

Publishing a custom resource

To apply the changes carried out on the resources, you must perform a database update.

1. From the advanced menu, via the Adobe Campaign logo, select Administration > Development, then Publishing.

2. By default, the option Determine modifications since the last publication is checked, which means that only the changes carried out since the last update will be applied.

   NOTE

   The Repair database structure reestablishes a correct configuration if the publication failed before completing. Any modification that was carried out directly in the database and not using custom resources will be deleted.

   

3. Click the Prepare publication button to start the analysis. Please note that big table updates should be done when the instance is not intensively busy by workflows.

   To learn more on the action to perform on the Profiles & Services API, refer to Publishing a resource with API extension.

   

   NOTE

   As duplicate indexes cause publication to fail, the preparation step checks whether the index defined for the resource already exists with the same name for another resource. If this happens, an error message is displayed, asking you to rename the index. See Defining indexes.

4. Once the publication has been carried out, click the Publish button to apply your new configurations.

5. Once published, the Summary pane of each resource indicates that the status is now Published and specifies the date of the last publication.

   NOTE

   If you make new changes to a resource, you must repeat this operation for the changes to be applied.

   If resources have the Pending re-draft status before publishing, then an additional message will appear inviting you to check your actions because publishing will result in definitive changes (deleting columns, tables…). To help you carry out this last change, an SQL Script tab is available. It provides the SQL command that will be executed during the publication.

   

   NOTE

   You can stop the Re-draft process by clicking the Cancel re-draft button. This action will revert the resource’s status back to its original one.

6. If your publication failed, you can always go back to the previous publication by clicking Back to latest successful publication.

   Note that, if you leave your publication in a fail status, a pop-up window will open as soon as you log in to your instance to remind you to fix this publication. Your instance will not be upgraded with new product versions until your publication is fixed.

   

Publishing a resource with API extension

You can create the Profile and Services API in the following cases:

• When you extend the custom resources Profiles or Services, you can perform an update of the Profiles and Services API to integrate the fields declared in the custom resources extension.
• When you define a custom resource and you create a link between the resources Profiles or Services and the custom resource, you can perform an update to include the new resource in the API.

You can select this option in the publication screen.

• If the API has not been published yet (meaning if you have never extended the resource or if you have never checked this option yet for this resource or another resource), you have the choice to create it or not.

  

• If the API has already been published (meaning if you have already extended the resource and checked this option once), the API update is forced.

  Indeed, once it has been created, the API is automatically updated each time you publish it again. This is to avoid breaking the profile or service resource of this API and harming your instance.

Note that by default, the custom resource is integrated, but, for a specific behavior, if you don’t want to publish this resource, you can select the option Hide this resource from APIs available in the Resource Properties.

After the Prepare Publication step, Adobe Campaign displays the delta between the current version of the API and the future version after the publication in the tab Profiles & Services API Preview. If you extend the API for the first time, the delta compares the out-of-the-box custom resource definition with your extension.

The information displayed in the tab is divided into three sections: added, deleted and modified elements.

The analysis of the delta is a mandatory step as the publication step will modify the API behavior and will most likely affect the surrounding development in a domino effect.

For more information on the Adobe Campaign API, consult the dedicated Adobe Campaign documentation on Adobe IO.