ERP Integrator V2 - Online Help
ERP Integrator V2
Questions / Feedback?

SapClient Configuration

The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

SapClient Configuration Settings

LogPerformanceData:   Logs the performance information when a function is called.

The default value is false. If set to true, the component will fire the Status event with the number of milliseconds it took the component to call the function.

LogRawData:   Logs the raw data being sent and received.

The default value is false. If set to true, the component will fire the Status event with all data that was sent and received. This can be helpful for debugging purposes.

ParseTables:   Indicates whether to parse tables into rows and columns.

If this is set to False, table rows and columns will not be filled when the function is called. The RowCount will be zero. Instead, you may read the row data directly from the TableRow event, and parse it yourself. This is useful when you're expecting a large number of results, as the component will not waste time or memory allocating storage for the results. Note that ParseTables must be True when calling GetFunctionInfo, or no info will be retrieved.

ResponseParamText[i]:   The value of the PARAMTEXT for the specified reponse parameter.

This will be populated with the PARAMTEXT for the response parameter specified by i.

The index i has a range from 0 to ResponseParameters.Count-1.

RequestParamText[i]:   The value of the PARAMTEXT for the specified request parameter.

This will be populated with the PARAMTEXT for the request parameter specified by i.

The index i has a range from 0 to RequestParameters.Count-1.

Group:   The logon group.

This specifies the logon group to be used to when using load balancing.

MessageServer:   Service name of load balancer service.

This should be set to the service name of the load balancer service if using load balancing. In most cases this does not need to be set.

SncLibPath:   The external security product's library.

This should contain the path to the external security product's library.

SncMode:   The SNC activation indicator.

If set to true, the component will send the SNC parameters. By default, this is set to false.

SncName:   The Initiator's SNC name.

The SNC name for the machine making the connection.

SncPartnerName:   The communication partner's SNC name.

This should contain the SNC name of the SAP system the component is connecting to.

SncQop:   The quality of protection level.

This indicates the quality of the protection level. The SAP server should list the data protection levels it will accept. Valid values are as follows:

Value Meaning
-1 (default) Not set
1 Apply authentication only. No data protection is provided.
2 Apply integrity protection. The data is signed and then verified upon receipt.
3 Apply privacy protection. The data is signed and encrypted, then decrypted and verified upon receipt.
8 Apply the default protection
9 Apply the maximum protection

SystemID:   The system ID of the SAP system.

This contains the R3NAME (System ID/name of the SAP system) and should be used when connecting to a message server for load balancing.

A system ID is always a string with a maximum of three letters. You can find out the correct SAP System ID (SID) by looking at the "System ID" property of the system's entry in SAP Logon.

SOAP Configuration Settings

LocalHost:   The IP address of the local interface.

This setting contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the control initiate connections (or accept in the case of server controls) only through that interface.

ProxyAutoDetect:   Whether or not to automatically detect and use proxy system settings, if available.

This setting is provided for tells the component whether or not to automatically detect and use proxy system settings, if available.

ProxyAuthorization:   The authorization string to be sent to the proxy server.

If this config contains a non-empty string, a Proxy-Authorization HTTP request header is added to the request. This header conveys proxy authorization information to the server. If ProxyUser and ProxyPassword are specified, they are this value is calculated using the algorithm specified by ProxyAuthScheme.

ProxyAuthScheme:   The authorization scheme to be used for the proxy.

This is the same as ProxyAuthScheme. This setting is provided for use by components that do not directly expose Proxy properties.

ProxyPassword:   A password if authentication is to be used for the proxy.

This is the same as ProxyPassword. This setting is provided for use by components that do not directly expose Proxy properties.

ProxyPort:   Port for the proxy server (default 80).

This is the same as ProxyPort. This setting is provided for use by components that do not directly expose Proxy properties.

ProxyServer:   Name or IP address of a proxy server (optional).

This is the same as ProxyServer. This setting is provided for use by components that do not directly expose Proxy properties.

ProxyUser:   A user name if authentication is to be used for the proxy.

This is the same as ProxyUser. This setting is provided for use by components that do not directly expose Proxy properties.

FirewallAutoDetect:   Tells the component whether or not to automatically detect and use firewall system settings, if available.

This is the same as FirewallAutoDetect. This setting is provided for use by components that do not directly expose Firewall properties.

FirewallHost:   Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.

NOTE: This is the same as FirewallHost. This setting is provided for use by components that do not directly expose Firewall properties.

FirewallPassword:   Password to be used if authentication is to be used when connecting through the firewall.

If FirewallHostis specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the component throws an exception.

NOTE: This is the same as Password. This setting is provided for use by components that do not directly expose Firewall properties.

FirewallPort:   The TCP port for the FirewallHost;.

Note that the FirewallPort is set automatically when FirewallType is set to a valid value.

NOTE: This is the same as FirewallPort. This setting is provided for use by components that do not directly expose Firewall properties.

FirewallUser:   A user name if authentication is to be used connecting through a firewall.

If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the component throws an exception.

NOTE: This is the same as FirewallUser. This setting is provided for use by components that do not directly expose Firewall properties.

FirewallType:   Determines the type of firewall to connect through.

The applicable values include the following:

0No firewall (default setting).
1Connect through a tunneling proxy. FirewallPort is set to 80.
2Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
3Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.

NOTE: This is the same as FirewallType. This setting is provided for use by components that do not directly expose Firewall properties.

Base Configuration Settings

GUIAvailable:   Tells the component whether or not a message loop is available for processing events.

In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The component will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

In some non-GUI applications an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GuiAvailable to false will ensure that the component does not attempt to process external events.

UseBackgroundThread:   Whether threads created by the component are background threads.

If set to True, when the component creates a thread the thread's IsBackground property will be explicitly set to True. By default this setting is False.

UseManagedSecurityAPI:   Tells the component whether or not to use the system security libraries or a managed implementation.

By default the component will use the system security libraries to perform cryptographic functions. This means calls to unmanaged code will be made. In certain environments this is not desirable. To use a completely managed security implementation set this setting to True. Setting this to True tells the component to use the internal managed implementation instead of using the system's security API.

Note that when this value is set the product's system dll is no longer required as a reference, as all unmanaged code is stored in this file.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 2.0.6240.0