Define interfaces for archiving and retention periods (SAP Library

Define interfaces for archiving and retention periods

Use

This is where you define interfaces so that you can archive their XML messages. You can also specify for how long XML messages are retained in the database before they are deleted or archived.

To periodically schedule jobs for archiving, in the Integration Engine menu, choose Administration ® Schedule Archiving Jobs.

Defining Interfaces for Archiving

To define interfaces for archiving, proceed as follows:

In the Integration Engine menu, choose Define Interfaces for Archiving and Retention Periods.

The system navigates to the screen Define Interfaces for Archiving, where you can enter the interfaces you want to define. The system differentiates between sending and receiving interfaces at this point.

To copy an interface to the list of interfaces displayed, enter the interface name and namespace in the respective fields, and choose Interface to be Archived.

You can either enter the interfaces you want to archive manually, or select them from the input help. However, the input help can only offer interfaces and the corresponding namespaces that are known to your system’s routing model. If you make an entry in either Name or Namespace, then search help takes this into account for both fields.

Example

If you enter FLIGHT* in the Name field, only those entries whose interface name begins with FLIGHT will be shown when you select the search help for Name or Namespace.

Which interfaces you want to archive is generally very customer-specific, since it depends on the respective applications. For this reason, SAP does not supply any default values.

To select multiple interfaces simultaneously, choose Multiple Selection. The system displays a list in the form of a table with all interfaces known by the routing model in your system.

The table contains the interface type (Inbound/Outbound Interface), the name and the namespace. In the Inbound/Outbound Interface column, O stands for a sender (outbound) interface and I for a receiver (inbound) interface.

You can select any number of entries in the table and add them to the list of interfaces to be archived by choosing Copy. Use the filter function to restrict the number of interfaces displayed.

It is also possible to copy generic entries such as FLIGHT* to the list. You must enter the namespace in this case. The interface name is only determined for this variant when the interfaces you want to archive have been determined at runtime.

Try to select as few interfaces as possible using the input help. Instead, use the generic entry option. Only specify fully qualified interfaces if lots of interfaces exist that have the same prefix, and you only want to archive one of them.

To delete an interface from the list, select the corresponding line and choose Delete Interface from List.

Save your changes.

All changes made are automatically entered in a customizing request. The system displays a corresponding dialog box, in which you must specify a request to transport the changes.

Specify or create a customizing request, and choose Continue.

Your changes are transported.

Defining Retention Periods

To define retention periods for messages in the database, proceed as follows:

Choose Retention Periods on the Define Interfaces for Archiving screen.

The system navigates to the Define Retention Periods screen, where you can enter in the corresponding fields the number days that XML messages marked for deletion or archiving are to be retained in the database.

If you want processed synchronous XML messages without errors to be deleted immediately, select the corresponding check box.
To transport your current specifications (regardless of any changes made), choose Transport Entries.
Save your changes.

All changes made are automatically entered in a customizing request. The system displays a corresponding dialog box, in which you must specify a request to transport the changes.

Specify or create a workbench request, and choose Continue.

Your changes are transported.

Example

XML messages to be deleted are retained in the database for 3 days. XML messages to be archived are retained in the database for 2 days.

The sender interface FlightBooking.Create is the only interface entered in the list.

Therefore, all XML messages that have the interface FlightBooking.Create as their sender are written to the archive and deleted from the database two days after they have been successfully processed.

All other XML messages are deleted from the database three days after they have been successfully processed.

XML messages that do not have the status Processed Successfully, remain in the database.