X4 Produktdokumentation
X4 Produktdokumentation
Breadcrumbs

SAP Explorer (JCo 3)


symbol_adapter-sapidoc.png

SAP Explorer (JCo3): Generates structure descriptions of IDocs and BAPIs, lists BAPIs or IDocs, or generates empty IDoc and BAPI structures. Depending on the operation, it outputs a corresponding XML document.


Note:

To use the SAP Explorer (JCo 3), rights for the remote execution of the following RFC components is required:

  • RPY_BOR_TREE_INIT

  • IDOCTYPES_LIST_WITH_MESSAGES

  • IDOCTYPE_READ_COMPLETE

  • RPY_OBJECTTYPE_READ

  • RFC_FUNCTION_SEARCH

Properties

Operation

Defines the operation executed by the function adapter

Possible values:

  • GetBapiTree: Output a list with all available BAPIs

  • GetIDocList: Output a list with all available IDocs

  • ReadBapi: Output a BAPI structure description

  • ReadIDoc: Output an IDoc structure description

  • CreateEmptyBapi: Create empty BAPI structure in order to use it within X4 BPMS

  • CreateEmptyIdoc: Create empty IDoc structure in order to use it within X4 BPMS

  • SearchForBapis: Output list of all BAPIs that match the filter expression

  • ClearCache: Clears the BAPI and IDoc cache in JCo

Parameters

Adapter

Main adapter class (do not change!)

Possible values: de.softproject.integration.adapter. sapjco3.SAPBapiIdocNotationExplorer: Main class (Default)

PropertyFile

URL to the adapter's configuration file

Possible values: Any valid URL within the Java VM (e. g. xstore://Project/Folder/Configuration.properties)

Client

SAP client (jco.client.client within the properties file)

User

User name (jco.client.user within the properties filei)

Password

Password (jco.client.passwd within the properties file)

Language

Login language (jco.client.lang within the properties file)

SystemNumber

SAP system number (jco.client.sysnr within the properties file)

RouterString

Router string (jco.client.ashost within the properties file)

SystemType

Remote host type (jco.client.type within the properties file)

Possible values:

  • 2 : R/2

  • 3 : R/3

  • E : External

ReplaceEscapedControlChars

Replace masked control characters (e.g.: ) within the XML strings returned by the JCo library by the replacement character:

replacement-character.png  

Possible values:

  • true: Replace masked control characters

  • false: Do not replace masked control characters

Input

This function adapter expects an adapter-specific input XML structure depending on the selected operation.

Operation


Get BapiTree

For the operation Get BapiTree the adapter doesn't require any input XML document.

Get IDocList

For the operation Get IDocList the adapter doesn't require any input XML document

Read Bapi

For the operation Read Bapi the adapter expects the following input XML document:

<Object><!--BAPI-ID--></Object>


Read IDoc

For the operation Read IDoc the adapter expects the following input XML document:

<ReadIDoc><!--IDoc-ID--></ReadIDoc>


Create Empty Bapi

For the operation Create Empty Bapi the adapter expects the following input XML document:

<Bapiname><!--BAPI name--></Bapiname>


Create Empty Idoc

For the operation Create Empty Idoc the adapter expects the following input XML document:

<IDoc><!--IDoc name--></IDoc>


SearchForBapis

For the operation SearchForBapis the adapter expects the following input XML document:

<Search functionname="BAPI name/Function name" />