4, API for document registration
Past Exit Reg.
Past Exit Registration, Enter a function that runs after the document is
registered in Inbound Configuration. Use the /OTX/PF01_UTTL_EXIT_REG_
AFTER template,
4.5 API for document registration
Starting with version 163.2, Business Center provides an API for the registration of,
documents. This allows the start of Business Center processes from none- SAP
systems,
Available services:
+ /OTBCINB/PFOI_REGIST_DOC
+ /OTX/PFO1_REGISTER
4.5.1 /OTBCINB/PF01_REGIST_DOC
The service registers the document as customized for the archive object and
document type.
‘The request is a multipart request that comprises three parts:
+ register_document_request
© document
+ metadata
The first part register_document_request is a XML. structure and contains the key
information for the document.
‘The XML is transferred using the XML transformation /OTX/PFO1_REGIST_DOC__
REQUEST with the /OTX/PFO1_S_REGIST_DOC_REQUEST DDIC structure . The the
length restrictions of this DDIC structure apply for all fields.
Element Description
Sean date
sean_date The format for the scan date is YYYY-MM-DD in the time zone of the
SAP system,
Sean time.
scan_time
The format is hh:mmn:ss in the time zone of the SAP system.
scan_user Sean user
ar_object Document type
doc_type Document class
BOCP200400-CGD-ENDS Configuration Guide for Foundation a Chapter 4 Inbound Configuration
Fien Tegster_document request>
J
2019-03-1809:00:00 __‘ domument has already been
arecl Z202
PDF version is version 1 If version
DOC_ID son will be used
A1
™ — 00ga000002
«
‘The second part document contains the document and is of type binary. If the
document has already been archived and the parameters ARC_DOC_ID and ARCHIV_
10 have been provided in the first part, you can leave this part empty.
The third part metadata is an XML structure and can contain information from an
extraction service. The provided data is mapped to the structure of the process data
as defined in the data model of the process. This part is only processed if the
document was also provided in the second part. It contains an array with the
following structure:
Element Description
extindex External index of field
tieldinto Adios ination (sample information nae of
extfield External field name
extvalue Value
Asa response, the service returns a multipart structure, This currently comprises
only a “response” part, which has the following XML structure:
Element Description
regid Registration ID of the document
Running the service requires the authorization OTBCINB for authorization object S_
IGF,
2 ‘OpenText™ Vendor Invoice Management for SAP® Solutions OCP200400-CGD-EN-08 4.8. Add additional logic to standard actions (BAdI /OTX/PF32_IDF_WOBJ_ACTION)
4.5.2
proc.
ESS_PRE_RE
GISTER
‘method
proc.
~'GISTER
method —
46
/OTX/PF01_REGISTER
You can implement additional logic using the /OTX/PFO1_REGISTER BAdI. This
BAdlI has the following interface.
This method is called at the beginning of the API. It allows you to access the
metadata to process own logic. is also possible to skip the whole standard logic to
register the document
Parameter ‘Type Description
PE_SKIP Exporting Skip processing / registration
PE_RESPNSE_REASON | Exporting HTTP response reason which
is sent when the processing is|
skipped
PE_RESPONSE_CODE Exporting HTTP response reason which
is sent when the processing is
skipped
PCT_MULTIPART Changing, Multipart content
This method is called at the end of the API when the document was registered. It
allows you to access the metadata and the response (with the registration ID),
Parameter Type Description
PIT_MULTIPART IMPORTING Malkipart content
PIS_RESPONSE IMPORTING ‘Response information which
is sent with multipart
Add additional logic to standard actions (BAdI/
OTX/PF32_IDF_WOBJ_ACTION)
‘The /OTX/PF32_IDF_OBJ_ACTION BAdI is part of the /OTX/PF32_TOF_WOB_
ACTION enhancement spot and implements the /OTX/PF32_IF_BADT_1DF_WOBJ_ACT
interface.
The BAdl allows to add additional logic to the following standard actions that are
available in the Inbound Administration work center of the Business Center
Workplace:
+ Change Status
+ Reject
+ Reset Retry Counters
# Reset Training
‘+ Submit Handler
BOCP200400-CGD-ENDS Configuration Guide for Foundation 2 Chapter 4 Inbound Configuration
46.1
4.6.2
For more information, see Section 2.1 “Navigating the Business Center Workplace”
in OpenText Vendor Invoice Management for SAP Solutions - User Guide for Solutions
Beyond Invoice (BOCP20040i
W0-UGD).
Add custom code before executing the action
(BEFORE_EXECUTE_ACTION)
This method allows to add custom code before executing the corresponding action,
Parameter
Type Description
PI_BULK Importing Indicator that an action isa
bulk action
PI_AGTION Importing “Technical ID of the executed
PIS_NOBJ_TYPE Importing Corresponding work objec
type configueation
PIS_DISPLAY_ Importing ‘Current inbound attribute
ATTRIBUTES. data values
PCT_RETURN Changing Returns messages ofthe
BAdI method,
Any message that returns
‘with E type stops the
execution of the action and
displays the error message to
the user
This method allows to add c
Add custom code after executing the action
(AFTER_EXECUTE_ACTION)
custom code after executing the corresponding action,
Parameter Type Description
PI_BULK Importing Indicator that an action is a
bulk action
PI_AGTION Importing, Technical ID of the executed
PIS_WOBJ_TYPE Importing, Corresponding work object
type configuration
PIS_DISPLAY_ Importing, ‘Current inbound attribute
ATTRIBUTES: data values
PI_ACTION_SUCCESS Importing. Indicator if the action has
sn executed successfully or
o
‘OpenText™ Vendor Invoice Management for SAP® Solutions
OCP200400-CGD-EN-08 47. Rendition management
Parameter Type Description
PIT_ACTION_RETURN Importing ‘Returns messages of the
executed action
POT_APTER_RETURN Changing [Returns messages of the
BAdI method,
Itis not possible to revert the
execution of the standard
‘action in this stage,
Only return messages other
than E type can be returned
and displayed to the user in
addition to the standard,
action return messages.
4.7 Rendition management
The inbound configuration provides the possibilty to integrate document rendering
by using the rendition management of OpenText™ Archiving and Document Access
for SAP Solutions. You must therefore, install and configure the corresponding
components of Archiving and Document Access for SAP Solutions. For more
information, see Open'Text Archiving and Document Access for SAP Solutions -
Installation and Upgrade Guide (ER-IGD).
For further information about rendition management, see the documentation of
Archiving and Document Access for SAP Solutions.
In some scenarios you will receive a Microsoft Office document and not the PDF
document that you need for processing. This PDF can get processed in the further
processing steps.
To do archiving and extraction for these documents, the rendition management
renders the document into a PDF within the document handler process. For more
information, see “Creating a document handler process” on page 58.
To integrate the rendition management, configure your own document handler
process with a new module, For more information, see “Configuring modules for
the required processing steps” on page 60.
Sequence
Define the sequence how the modules are processed. The Render and archive
image module should be processed before the document is sent to the extraction
Module Class
Implement processing logic in /OTX/PFO1_CL_MODULE_RENDER class.
Redefine this class to your need
End Status
Enter the status 35 “Document rendered and archived”.
BOCP200400-CGD-ENDS Configuration Guide for Foundation %