Advanced: Customize delivery logs customize-delivery-logs
For monitoring deliveries in the Campaign UI, refer to the Campaign v8 Monitor deliveries in Campaign UI documentation.
Customize delivery logs use-case
For Campaign Classic v7 hybrid/on-premise deployments, you can customize delivery logs by extending schemas. This section shows how to add senders’ IP addresses to the delivery logs.
Step 1: Extend the schema
To add publicID in your delivery logs you need to extend the schema first. You can proceed as follow.
-
Create a schema extension, under Administration > Configuration > Data Schemas > New.
For more information about schema extensions, refer to this page.
-
Select broadLogRcp to extend the Recipient delivery logs (nms) and define a custom Namespace. In this case it will be “cus”:
note note NOTE If your instance is in Mid-sourcing, you need to work with broadLogMid schema. -
Add the new field in your extension. In this sample, you need to replace:
code language-none <element img="nms:broadLog.png" label="Recipient delivery logs" labelSingular="Recipient delivery log" name="broadLogRcp"/>by:
code language-none <element img="nms:broadLog.png" label="Recipient delivery logs" labelSingular="Recipient delivery log" name="broadLogRcp"> <attribute desc="Outbound IP identifier" label="IP identifier" name="publicId" type="long"/> </element>
Step 2: Update database structure
Once modifications are done, you need to update database structure so that it is aligned with its logical description.
To do this, follow the steps below:
-
Click the Tools > Advanced > Update database structure… menu.
-
In the Edit tables window, the NmsBroadLogRcp table is checked (or the broadLogMid table if your are in a Mid-sourcing environment), as below:
note important IMPORTANT Always ensure there is no other modification, except the NmsBroadLoGRcp table (or the broadLogMid table if your are in a Mid-sourcing environment). If so, uncheck other tables. -
Click Next to validate. The following screen displays:
-
Click Next, then Start to start updating database structure. Index building is starting. This step can be long, depending on the number of rows in the NmsBroadLogRcp table.
Step 3: Validate the modification
To confirm everything worked correctly, you need to update delivery logs screen.
To do this, access the delivery logs and add the “IP identifier” column.
Below is what you should see in the Delivery tab after modifications:
Related topics
- Monitor deliveries in Campaign UI (Campaign v8 documentation)
- Delivery statuses (Campaign v8 documentation)
- Understanding delivery failures (Campaign v8 documentation)
- Quarantine management (Campaign v8 documentation)
- Extending a schema (v7 hybrid/on-premise)