Working with the API Gateway and SCRUD Test Harness
The docuflow API gateway provides the below functions:
- Reporting of all docuflow processing, useful for a wide array of reporting and analysis
- An entry point to the SCRUD (and PL) Test Harness
- Load MDPro (metadata push) from an API gateway results set
Regardless of the function above, execute the docuflow API gateway via either:
- Transaction /dflow/docuflowsys and choose the button API Gateway
- Enter the transaction /dflow/docuflowgtw
Once a results set is displayed, you see all data columns left to right - these can be filtered to provide a more focused view depending on what you are looking for/at by choosing the "Views" menu path when viewing the report results.
Within the both summary and detail level line, you can drill down on the columns indicated with a green checkbox to view further data, eg: viewing metadata, viewing the full return table, etc.
Due to the volume of logging, it is recommended you routinely purge the gateway (primarily at the detail level) to keep table space to a minium. Refer to the section in this document "Utilities: Archiving Gateway Data".
Setting | Description | Sample Value(s) |
|---|---|---|
CMS Profile | The CMS profile to filter on. | Box_1 |
CMS Tag | The CMS Use Tag to filter on. | DocuFlow Document Storage |
CMS Repository Type | The CMS repository type (FileNet P8, Documentum, or Box) | BX |
RFC Destination | The RFC destination to filter on. | ZDOCUFLOW_CMSAPI_01 |
API Source | The source of the process to filter on like viewing or choice list processing. | STORENEW |
API Type | The underlying API call to filter on (search, create, read, update, delete, ping and load). These calls are used together to form various processing so it may be interesting to focus the results on just a port of say the viewing process. | READ |
SAP Key | The unique SAP ArchiveLink key for a particular object to filter on. | 00000000013000 |
DocType | The ArchiveLink document type to filter on. | ZCONTRACT |
Call Date | The date when the api call was made to filter on | 12/25/2020 |
Call Time | The time when the api call was made to filter on | 00:00:00 |
Call User | The originating user that made the API call. | DOCUFLOW |
Call Return Message Type | The return that was associated with the API call which can either be an (E)rror, (S)uccess, (W)arning, or (I)nfo. | E |
SAP User | The originating user that made the API call. | DOCUFLOW |
CMS ID | The content management system document id number to filter on. | 123456 |
Label | Migration and MDPro labels | docuflow is great |
Hide System Ping | If selected the ping API messages are not reported. |
|
Hide DocViewing | If selected, and if docuflow DocManager or the TOAEX method is used for viewing content, then those entries are not reported. |
|
Hide Detail Entries | If selected the detail API messages are not reported. By default, the gateway summarizes API calls into 1 “summary” entry in the gateway for ease of reporting. If you wish to see the underlying API calls (for example, the CREATE and UPDATE for a DocManager Storage request), click this off. |
|
Default Layout | Optionally you can select a previously saved layout for the gateway dashboard before displaying the results. | DEFAULT |
All docuflow processing is logged at a summary and detail level within the API Gateway, and therefore reporting can done so for various reasons such as:
- Viewing general activity
- Troubleshooting and unhappy path scenerios
- Exporting results for performance and load analysis
- etc...
Familiarize yourself with the input selection criteria and drill down information available. Also note that by default document viewing activity and "detailed entries" are hidden. See input criteria above "Hide DocViewing" and "Hide Detail Entries" for more information and to see what additional data is available.
The SCRUD "Test" Harness allows the testing of basic SCRUD API's with no coding via the docuflow API Gateway. The (S)earch, (C)reate, (R)ead, (U)pdate, and (D)elete API's that are executed are identical to those called when using the ABAP SCRUD API set (refer to the docuflow Developers Guide) or the docuflow Enterprise Connector test harness.
All docuflow processing leverages the same endpoint API calls and resulting calls in the docuflow middleware and therefore the test harness can provide you the ability to simulate all docuflow processing.
To enter the SCRUD "Test" Harness:
- Execute the API gateway using input parameters that will return:
- a small dataset or
- NO dataset or
- a dataset that contains the line(s) that you wish to use to action (or "re-process") using SCRUD functions
- "Re-process" in this context means that for Read and Update, you can choose an existing line in the API gateway report and the test harness will use those values as the input to the test harness (you have the option to change those values of course, but they can be handy to reduce entring all the data).
- Choose the "Execute" menu path and choose the applicable SCRUD function.
- The ...."New" options bring up a new/empty SCRUD input screen
- The ...."Again" options require you to select a reported line (click once anywhere on the desired results screen on the line of choice) and basically pre-populates the SCRUD input screen with already utilized values in the case of (R)ead and (U)pdate. Not to worry....these values can be changed prior to execution.
**** NOTE **** Even though this is referred to as "test harness", all actions are processed fully to the CMS endpoint. So albeit you can use this to test (Search/Read of course have no lasting effect other than load and performance), in the case of Create/Update/Delete, especially in a production environment, these actions must be approached with caution.
MDPro allows you to push metadata from SAP to your CMS endpoint, and can be executed directly or alternatively, you can "load" the input selection criteria from the API Gateway if you are reporting on (U)pdate API activity.
Refer to the section "Utilities: Metadata Push (MDPro) for more detail on how to run MDPro.
