Skip to content

ERPConnect.R3Connection

Namespace: ERPConnect
Assembly: ERPConnectStandard20.dll

R3Connection represents a connection to a SAP R/3 System

public class R3Connection : IR3Connection, IDisposable

Inheritance

object ← R3Connection

Implements

IR3Connection, IDisposable

Inherited Members

object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()

Constructors

R3Connection()

Initializes a new instance of the R3Connection class

public R3Connection()

R3Connection(string, int, string, string, string, string)

Initializes a new instance of the R3Connection class and sets the logon data for a single application server

public R3Connection(string host, int systemNumber, string userName, string password, string language, string client)

Parameters

host string

Host name of the application server

systemNumber int

System number of the application server

userName string

Logon name

password string

Logon password

language string

Logon language

client string

Logon client

R3Connection(string, int, SNCSettings, string, string)

Initializes a new instance of the R3Connection class and sets the logon data for a single application server with SNC authentication

public R3Connection(string host, int systemNumber, SNCSettings sncSettings, string language, string client)

Parameters

host string

Host name of the application server

systemNumber int

System number of the application server

sncSettings SNCSettings

Settings for SNC

language string

Logon language

client string

Logon client

Properties

AliasUser

public string AliasUser { get; set; }

Property Value

string

CacheMetadata

Get / sets whether the meta data of functions, queries etc. is stored and recycled when a new Create... statement is called.

public bool CacheMetadata { get; set; }

Property Value

bool

Client

Gets / sets the logon client

public string Client { get; set; }

Property Value

string

Codepage

public string Codepage { get; }

Property Value

string

CpicConversationId

Gets the Id of the underlying CPI-C connection

public string CpicConversationId { get; }

Property Value

string

DynamicABAPCustomFunction

Sets the name of the function module which is used by the ABAPCode class.

public string DynamicABAPCustomFunction { get; set; }

Property Value

string

Host

Gets / sets the host name

public string Host { get; set; }

Property Value

string

Remarks

Only required when using logon to a single application server

InitialEncoding

Gets or sets initial encoding (required for some special characters in passwords).

public SAPEncodingInfo InitialEncoding { get; set; }

Property Value

SAPEncodingInfo

Remarks

ERPConnect.ClientProtocol.NWRFC only.

IsOpen

Gets a value indicating whether this connection has been successfully established and has been valid when the last message has been received/sent. To actively check the current state, please use ERPConnect.R3Connection.Ping

public bool IsOpen { get; }

Property Value

bool

IsUnicode

Defines whether the partner system is a unicode system

public bool IsUnicode { get; }

Property Value

bool

KernelRelease

The kernel release number of the SAP system

public string KernelRelease { get; }

Property Value

string

Examples

700

Language

Gets / sets the logon language

public string Language { get; set; }

Property Value

string

Examples

DE od EN

LogDir

Gets or sets the path to the directory in which trace files and XML log files are stored

public string LogDir { get; set; }

Property Value

string

Remarks

To enable logging, set the value to an existing directory to which the process has write access. To disable logging set the value to string.Empty. Property must be set before the connection is opened.

Logging

Gets or sets a value which indicates whether detailed RFC tracing is enabled or not

public bool Logging { get; set; }

Property Value

bool

Remarks

Must be set before the connection is opened. ERPConnect.IR3Connection.LogDir must also be set.

LogonGroup

Gets / sets the logon group

public string LogonGroup { get; set; }

Property Value

string

Remarks

Only required when using logon by load balancing

LogonTicket

public string LogonTicket { get; set; }

Property Value

string

MessageServer

Gets / sets the SAP message server

public string MessageServer { get; set; }

Property Value

string

Remarks

Required for logon via load balancing

MessageServerService

Gets or sets the non-standard service the message server listens on. Corresponds to NetWeaver connection parameter "MSSERV".

public string MessageServerService { get; set; }

Property Value

string

PartnerRelease

The release number of the SAP-BASIS of the system

public string PartnerRelease { get; }

Property Value

string

Examples

700

Password

Gets/ sets the user's password for authentication

public string Password { get; set; }

Property Value

string

Protocol

Get / sets the ERPConnect.ClientProtocol for the communication between client and SAP server

public ClientProtocol Protocol { get; set; }

Property Value

ClientProtocol

ReadTableFunctionName

Gets or sets the name of the function module that is used by ERPConnect.Utils.ReadTable. This will be overriden by ERPConnect.Utils.ReadTable.SetCustomFunctionName(System.String).

public string ReadTableFunctionName { get; set; }

Property Value

string

SAPEncodingInfo

Gets information about data encoding

public SAPEncodingInfo SAPEncodingInfo { get; }

Property Value

SAPEncodingInfo

SAProuterString

Gets or sets the parameters to use when the connection should be made through a SAProuter. Corresponds to NetWeaver connection parameter "SAPROUTER".

public string SAProuterString { get; set; }

Property Value

string

SID

Gets / sets SAP System ID

public string SID { get; set; }

Property Value

string

Remarks

Only required when using logon by load balancing

SNCSettings

Gets or sets the settings for SNC

public SNCSettings SNCSettings { get; set; }

Property Value

SNCSettings

See Also

IR3Connection.SNCSettings

SkipGetSystemInfo

Gets or sets a value which indicates whether details about the SAP system are obtained through an RFC function call, if necessary.

public bool SkipGetSystemInfo { get; set; }

Property Value

bool

Remarks

Only set to true, if there's no other way!

SystemNumber

Gets / sets the system number

public int SystemNumber { get; set; }

Property Value

int

Remarks

Only required when using logon to a single application server

TlsSettings

Gets or sets TLS settings to use when connecting using WebSockets. Corresponds to NetWeaver connection parameters related to TLS. Only used when ERPConnect.R3Connection.UsesWebSocket is set to true and using ERPConnect.ClientProtocol.NWRFC.

public TlsSettings TlsSettings { get; set; }

Property Value

TlsSettings

Remarks

SAP systems require you to use TLS (ERPConnect.R3Connection.TlsSettings) when connecting with RFC over WebSocket.

TraceLevel

Verbosity of NetWeaver RFC library trace messages.

public TraceLevel TraceLevel { get; set; }

Property Value

TraceLevel

UseDeltaManager

Gets or sets whether the delta manager is to be used for (de-)serializing TABLES parameters. If unset (null) the default NetWeaver library value is used. Corresponds to NetWeaver connection parameter "DELTA".

public bool? UseDeltaManager { get; set; }

Property Value

bool?

UseGui

Defines whether the SAP GUI should be used

public bool UseGui { get; set; }

Property Value

bool

UserName

Gets / sets the user name for authentication

public string UserName { get; set; }

Property Value

string

UsesLoadBalancing

Gets or sets a value indicating whether load balancing is used or not

public bool UsesLoadBalancing { get; set; }

Property Value

bool

UsesWebSocket

Gets or sets whether to use RFC over WebSocket. When set to true the following properties have to be specified:

  • `ERPConnect.R3Connection.WebSocketHost`
  • `ERPConnect.R3Connection.WebSocketPort`
  • `ERPConnect.R3Connection.TlsSettings`
public bool UsesWebSocket { get; set; }

Property Value

bool

Remarks

SAP systems require you to use TLS (ERPConnect.R3Connection.TlsSettings) when connecting with RFC over WebSocket.

WebSocketHost

Gets or sets the hostname to use when connecting using WebSockets. Corresponds to NetWeaver connection parameter "WSHOST". Only used when ERPConnect.R3Connection.UsesWebSocket is set to true and using ERPConnect.ClientProtocol.NWRFC.

public string WebSocketHost { get; set; }

Property Value

string

Remarks

SAP systems require you to use TLS (ERPConnect.R3Connection.TlsSettings) when connecting with RFC over WebSocket.

WebSocketPort

Gets or sets the WebSocket port to use when connecting using WebSockets. Corresponds to NetWeaver connection parameter "WSPORT". Only used when ERPConnect.R3Connection.UsesWebSocket is set to true and using ERPConnect.ClientProtocol.NWRFC.

public ushort WebSocketPort { get; set; }

Property Value

ushort

X509Certificate

Gets or sets an X.509 client certificate

public X509Certificate2 X509Certificate { get; set; }

Property Value

X509Certificate2

Methods

AppendToConnectionString(StringBuilder, string, object)

Appends a key/value-pair to a connection string.

public static void AppendToConnectionString(StringBuilder connectionStringBuilder, string parameterName, object parameterValue)

Parameters

connectionStringBuilder StringBuilder

parameterName string

parameterValue object

Remarks

Usage of connection strings is discouraged, connection properties are preferred.

Clone()

Clones the connection object, but doesn't open it!!!! Please use Open() to open it

public R3Connection Clone()

Returns

R3Connection

The cloned R3Connection object

Close()

Closes the client connection

public void Close()

ConfirmTID(string)

Confirms a Transaction ID

public void ConfirmTID(string tid)

Parameters

tid string

Transaction ID

CreateBWCube(string)

Creates a new BWCube object. Please refer to the manual for a sample

public BWCube CreateBWCube(string cubeName)

Parameters

cubeName string

Name of BW cube or BW query

Returns

BWCube

The created BWCube object

CreateBapi(string, string)

Creates a new BusinessObjectMethod object.

public BusinessObjectMethod CreateBapi(string businessObjectName, string methodName)

Parameters

businessObjectName string

Name of the Business Object. Case-sensitive

methodName string

Name of Business Object's method. Case-sensitive

Returns

BusinessObjectMethod

A BusinessObjectMethod object

Remarks

Please go to folder BAPIGetQty in your Examples folder for example source code.

CreateEmptyIdoc(string, string)

Creates an Idoc object. The segments are empty and have to be filled. Therefore use Idoc.CreateSegment

public Idoc CreateEmptyIdoc(string idocType, string enhancement)

Parameters

idocType string

Name of the Idoc type (e.g. MATMAS01)

enhancement string

Name of the Idoc enhancement (may be empty if no enhancement is needed)

Returns

Idoc

An empty Idoc object

CreateFunction(string)

Creates a function by the name of the SAP function module

public RFCFunction CreateFunction(string name)

Parameters

name string

Name of the function module

Returns

RFCFunction

A RFCFunction object

Examples

[C#]

static void Main(string[] args)
{
    R3Connection con = new R3Connection("hamlet",11,"theobald","pw","DE","800");
    con.Open(false);

    // Create a function object
    RFCFunction func = con.CreateFunction("RFC_CUSTOMER_GET");

    Console.WriteLine("Please enter customer number ...");
    Console.WriteLine("(and do not forget the leading zeros ...");

    // fill the export parameter
    StringBuilder CustomerNo =  new StringBuilder(Console.ReadLine());
    func.Exports["KUNNR"].ParamValue = CustomerNo.ToString();

    try 
    {
    func.Execute();
    }
    catch (ERPException e)
    {
        Console.WriteLine(e.Message);
        Console.ReadLine();
        return;
    }

    // Output the result of the function module
    Console.WriteLine("Name of customer:");
    Console.WriteLine(func.Tables["CUSTOMER_T"].Rows[0,"NAME1"]);
    Console.ReadLine();
}

[VB]

Sub Main()
    Dim con As New R3Connection("hamlet", 11, "theobald", "pw", "DE", "800")
    con.Open(False)

    ' Create a function object
    Dim func = con.CreateFunction("RFC_CUSTOMER_GET")

    Console.WriteLine("Please enter customer number ...")
    Console.WriteLine("(and do not forget the leading zeros ...")

    ' fill the export parameter
    Dim CustomerNo As New StringBuilder(Console.ReadLine())
    func.Exports("KUNNR").ParamValue = CustomerNo.ToString()

    Try
        func.Execute()
    Catch e As ERPException
        Console.WriteLine(e.Message)
        Console.ReadLine()
        Return
    End Try

    ' Output the result of the function module
    Console.WriteLine("Name of customer:")
    Console.WriteLine(func.Tables("CUSTOMER_T").Rows(0, "NAME1"))
    Console.ReadLine()
End Sub

Remarks

The following example demonstrates, how to logon, to create a function object and to execute the function

CreateIdoc(string, string)

Creates a fully initialized Idoc object ready to send ...

public Idoc CreateIdoc(string idocType, string enhancement)

Parameters

idocType string

Name of the Idoc type (e.g. MATMAS01)

enhancement string

Name of the Idoc enhancement (may be empty is no enhancement is needed)

Returns

Idoc

A new Idoc object ready for use

CreateQuery(WorkSpace, string, string)

Creates a new Query object

public Query CreateQuery(WorkSpace workSpace, string userGroup, string queryName)

Parameters

workSpace WorkSpace

Workspace local / global

userGroup string

Name of user group

queryName string

Name of query

Returns

Query

The new created Query object

CreateTID()

Creates a new transaction ID

public string CreateTID()

Returns

string

New transaction ID

Dispose()

public void Dispose()

Execute(RFCFunction)

Assigns this connection to the supplied ERPConnect.RFCFunction and then executes the function.

public void Execute(RFCFunction function)

Parameters

function RFCFunction

FromConnectionString(string)

public static R3Connection FromConnectionString(string connectionString)

Parameters

connectionString string

Returns

R3Connection

GetConnectionStringParameterValue(string, string)

Extracts the value of a parameter from a connection string

public static string GetConnectionStringParameterValue(string connectionString, string parameterName)

Parameters

connectionString string

The connection string from which the value should be extracted

parameterName string

The name of the parameter of which the value should be extracted

Returns

string

The value of the parameter

GetSSOTicket()

public string GetSSOTicket()

Returns

string

IsSystemEditable()

Checks, whether dynamic ABAP code can be executed.

public bool IsSystemEditable()

Returns

bool

Log(string)

This function can be used to access the internal log mechanism

public void Log(string message)

Parameters

message string

Message to be logged

Open()

Opens a connection to an SAP R/3 system.

public void Open()

Remarks

For opening via Load Balancing please set ERPConnect.R3Connection.UsesLoadBalancing = true

ParseConnectionString(string)

Parses a connection string and sets all properties accordingly

public void ParseConnectionString(string connectionString)

Parameters

connectionString string

Remarks

Does not change the ERPConnect.R3Connection.ConnectionString property

Ping()

Checks, whether the established connection is available

public bool Ping()

Returns

bool

Whether the operation was successful. No exception is thrown

Remarks

Marks the connection as closed if the operation is not successful.

ToConnectionString()

Generates a connection string based on the values of properties (ignores the ERPConnect.R3Connection.ConnectionString property).

public string ToConnectionString()

Returns

string

Remarks

Usage of connection strings is discouraged, connection properties are preferred.