Package com.ibm.di.connector.sapr3.aleidoc

Class SapALEIDocConnector

  • All Implemented Interfaces:
    ConnectorInterface, VersionInfoInterface
    public class SapALEIDocConnector
extends Connector
implements ConnectorInterface

    The SAP R/3 and ERP ALE IDoc Server Connector.

    The connector enables external applications, using TDI, to access SAP Intermediate Documents (IDocs) sent from an SAP R/3 or ERP client system. It supports the following TDI Connector Modes: Iterator The connector supports design time schema query via querySchema(java.lang.Object). When parsing is enabled the input attribute mapping must be created manually based on the IDoc message type being processed.

    The configuration parameters of the connector are described below. IDoc Server SAP Gateway Host
    The SAP Gateway host name or IP address for the R/3 RFC connection.

    IDoc Server SAP Gateway Service
    The SAP Gateway service name for R/3 RFC connection. Standard naming convention is the string "sapgw" appended with the SAP System Number. i.e. A SAP System with System number "00" would normally have a gateway service of "sapgw00".

    IDoc Server Program ID
    The SAP JCo Server external program identifier. This is used when configuring the SAP RFC destination to be used by logical system that will represent the TDI IDco Server Connector in SAL ALE distrbution models.

    IDoc Server Program ID
    The SAP JCo Server external program identifier. This is used when configuring the SAP RFC destination to be used by logical system that will represent the TDI IDco Server Connector in SAL ALE distrbution models.

    IDoc Server Unicode Connection?
    The SAP JCo Server needs this set when the client SAP R/3 or ERP system requires a unicode RFC connection.

    IDoc Server Optional Connection Parameters
    The SAP JCo Server optional RFC connection parameters. Delimite with space char. i.e. "jco.server.trace=1 jco.server.sysnr=00"

    IDoc Server Poll Time
    The Connector waits for incoming IDoc requests to be created on an internal Inbound IDoc queue. This is the period of time between checks on the queue for new Inbound IDoc requests. This time is also used in the TID Management processing when waiting for a particular transaction to be confirmed by the SAP Client and the connectors Iterator mode functionality.

    IDoc Client Number
    The SAP JCo Client RFC connection parameter that identifies the SAP System client identifier from which IDoc requests are made on the Connector.

    IDoc Client User
    The SAP JCo Client RFC connection parameter that identifies the SAP User Account used to authenticate the RFC connection.

    IDoc Client Password
    The SAP JCo Client RFC connection parameter that identifies the SAP User Account's password used to authenticate the RFC connection.

    IDoc Client Lang
    The SAP JCo Client RFC connection parameter that identifies the RFC connection logon language.

    IDoc Client Hostname
    The SAP JCo Client RFC connection parameter that identifies the client SAP R/3 or ERP system's hostname or IP address.

    IDoc Client System Number
    The SAP JCo Client RFC connection parameter that identifies the client SAP R/3 or ERP system number.

    IDoc Client SAP Gateway Servicer
    The SAP JCo Client RFC connection parameter that identifies the SAP Gateway service name for R/3 RFC connection. Standard naming convention is the string "sapgw" appended with the SAP System Number. i.e. A SAP System with System number "00" would normally have a gateway service of "sapgw00".

    IDoc Client SAP Gateway Host
    The SAP JCo Client RFC connection parameter that identifies the SAP Gateway host name or IP address for R/3 RFC connection.

    IDoc Client Max Connections
    The maximum allowed SAP JCo Client RFC connections in the internal JCo Client Connection pool.

    IDoc Client Optional Connection Parameters
    The SAP JCo Server optional RFC connection parameters. Delimite with space char. i.e. "jco.client.trace=1 jco.client.use_sapgui=1" pool.

    IDoc As XML Only?
    If set then only one attribute will be provided to represent the IDoc. This attribute's value is an XML representation of the IDoc. pool.

    Process SAP RFM Requests?
    If set then any Remote Function Module calls made on the JCo Server will be handled. The result is an attribute in the TDI entry who's value is an XML represenation of the RFM invoked. pool.

    Parse IDoc or RFM XML?
    If set then any if the attributes representing the IDoc or RFM call as XML are available, then they will be parsed with the appropriate TDI XML parser attached. The only parser options are the DOM, SAX and XSLT TDI parsers.

    Enable JCo Middleware Trace Logging?
    If set then the JCo trace listener will be instantiated and attached to the JCo IDoc Server. The trace messages and their level will be contained within the TDI trace mechanism.

    JCo Middleware Trace Level
    Sets the minimum JCo trace level allowed to be captured by the TDI trace mechanism.

    JCo Middleware Trace File Path
    Sets the path where the JCo trace files will be dumped.

    • Constructor Detail

      • SapALEIDocConnector

        public SapALEIDocConnector()
        Default constucter for SapALEIDocConnector object.

    • Method Detail

      • getVersion

        public java.lang.String getVersion()
        Returns the version of the connector based on source repository variables.
        Specified by:
        getVersion in interface VersionInfoInterface
        Returns:
        A String format for the version of this released Connector.

      • isConnParamValueValid

        public boolean isConnParamValueValid​(java.lang.String key,
                                     boolean mandatory)
        Checks if a Connector configuration parameter is valid for use.
        Parameters:
        key - - The key for the Connector configuration parameter being checked.
        mandatory - - flag indicating if the Connector configuration parameter is obligatory.
        Returns:
        boolean result on the validity of the Connector configuration parameter.

      • replyEntry

        public void replyEntry​(Entry requestResult)
        This method is to called for Server modes. This method would normally be used to build and send a response to the client. As the IDoc communication is asynchronous this method does nothing for this release of the Connector.
        Specified by:
        replyEntry in interface ConnectorInterface
        Overrides:
        replyEntry in class Connector
        Parameters:
        requestResult - the information as an Entry

      • terminate

        public void terminate()
        This method is to called for all modes. This method is used to stop the IDoc Server. Stopping the IDoc Server affects the TID management cycle so this method does nothing for this release of the Connector.
        Specified by:
        terminate in interface ConnectorInterface
        Overrides:
        terminate in class Connector

      • getSapALEIdocApp

        public SapIDocServerListener getSapALEIdocApp()
        Returns:
        Returns the IDoc Server listener object.

      • getSapALEIDocRepos

        public com.sap.mw.idoc.IDoc.Repository getSapALEIDocRepos()
        Returns:
        Returns the IDoc Server IDoc repository object.

      • getSapALEIDocServer

        public SapIDocServerImpl getSapALEIDocServer()
        Returns:
        Returns the IDoc Server object

      • getSapALEIRepos

        public com.sap.mw.jco.IRepository getSapALEIRepos()
        Returns:
        Returns the IDoc Server JCo repository object.

      • getServerConnProps

        public java.util.Properties getServerConnProps()
        Returns:
        Returns the IDoc Server RFC Connection properties.

      • getTidIDocMap

        public java.util.Map getTidIDocMap()
        Returns:
        Returns the IDoc Server Inbound IDoc request queue.

      • getJcoServerProgId

        public java.lang.String getJcoServerProgId()
        Returns:
        Returns the IDoc Server program ID. Required when configuring the RFC Destination on the SAP Client.