Agnostic Guides
Solution Guide

Utilities: Cleaning Gateway Errors

2min

This function allows you to maintain (ie: delete) errors in the Gimmal Link Enterprise API gateway that may have subsequently been processed successfully. This allows the API gateway to be more "clean" and have less false negatives as its history grows and as corrections are made.

We recommend you run the program monthly, with the input variant set for a date equal to + 1 day since the last time it was ran, or, aligned with how often you run the API gateway to use the errors to trigger a resolution action.

To execute a gateway error clean, enter transaction /dflow/sys and choose the menu path Configure->Execute->Clean Gateway Errors.

Selection Criteria

Setting

Description

Sample Value(s)

CMS Profile

The content management system profile to limit cleaning on.

 

CMS Use Tag

The use tag to limit cleaning on.

 

CMS Repository Type

The content management system repository type to limit cleaning on.

 

CMS RFC Destination

The remote function call (RFC) destination to limit cleaning on.

 

API Source

The source of the api calls to limit cleaning on.

SAPLINK

API Type

The particular api call type to limit cleaning on.

 

SAP object ID

The particular SAP ArchiveLink object keys to limit cleaning on.

 

Document Type

The SAP ArchiveLink document types to limit cleaning on.

 

Date

The date range to limit cleaning to.

 

Time

The time range to limit cleaning on.

 

User Name

The SAP user name to limit cleaning on.

 

CMS SAP User

The SAP user name to limit cleaning on.

 

CMS Rep./Store

The content management system repository or object store to limit cleaning on.

 

CMS ID

The content management system id(s) to limit cleaning on.

 

CMS Filename

The content management system filename(s) to limit cleaning on.

 

CMS Type

The content management system document class, object type or metadata template to limit cleaning on. 

 

Test Only

If selected the cleaning isn’t actually performed and the process is just simulated.



Creating and Scheduling Background Job

  1. Consult with your SAP Basis team to create the job using the program “/DFLOW/ZCMSAPI_GTW_ERROR_CLEAN”
  2. Create a variant for the above program using a dynamic date selection per the below (as an example)
    1. Select “Save as Variant…” from the “Goto” menu under the “Variants“.
    2. Adjust the date range by Selecting “X:Dynamic Date Calculation (System Date)” for the Selection variable of the “Date” Field name.
    3. Configure the “Name of Variable (Input Only Using F4)” to select the particular date range to archive.
      1. We suggest selecting I for include (the I in the I/E column) with the LT (for less than) option the “Current date +/- ??? days” selection from the choices.
    4. Enter 31- for the ??? value.
    5. This cleans errors that have been processed successfully older than 31 days.