Parameters (Connect-SAPERP Cmdlet)
The following is the full list of the parameters of the cmdlet with short descriptions. Click the links for further details.
| Property | Description |
| ConnectionType | The type of connection you are making. |
| ConnectionScheme | Specifies whether you are connecting to a SAP system with a message server (GroupServer) or without one (ApplicationServer). |
| Host | Host name of the target system. |
| SystemNumber | The number by which the target system is defined. Used when setting the Host connection property. |
| User | The user that is authenticating to the SAP system. |
| Password | The password used to authenticate to the SAP system. |
| Client | The client authenticating to the SAP system. |
| X509Certificate | The X509 certificate used for login as an alternative to User , and Password . |
| MessageServer | The message server must be specified when connecting to an SAP system that uses load balancing. |
| Group | The Logon Group being used. This typically only needs to be specified when connecting to an SAP system that uses load balancing. |
| SystemId | The System Id or R3Name of the SAP System is a string with a maximum of three characters. It is often used in load balancing connections. |
| RFCURL | The URL of the SOAP interface to connect with SAP. |
| MessageServerService | The message server service you wish to connect to. |
| Property | Description |
| SNCMode | A boolean determining if you are using SNC. Set this to true to use SNC. |
| SNCName | An optional input with the name of your SNC connection. |
| SNCQop | The quality of protection for your SNC connection. |
| SNCPartnerName | The application server's SNC name. This is a required input when using SNC. |
| SNCLibPath | An optional input detailing the path and file name of the external library. |
| SNCSSO | Whether to use the SNC identity for authenticating the caller when connnection via SNC mode. |
| Property | Description |
| SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | The protocol used by a proxy-based firewall. |
| FirewallServer | The name or IP address of a proxy-based firewall. |
| FirewallPort | The TCP port for a proxy-based firewall. |
| FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
| FirewallPassword | A password used to authenticate to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | When this connection property is set to True, the provider checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details). Set to False if you want to manually configure the provider to connect to a specific proxy server. |
| ProxyServer | The hostname or IP address of the proxy server that you want to route HTTP traffic through. |
| ProxyPort | The TCP port that the proxy server (specified in the ProxyServer connection property) is running on. |
| ProxyAuthScheme | The authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | The username of a user account registered with the proxy server specified in the ProxyServer connnection property. |
| ProxyPassword | The password associated with the user specified in the ProxyUser connection property. |
| ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
| Property | Description |
| Logfile | A filepath which designates the name and location of the log file. |
| Verbosity | The verbosity level that determines the amount of detail included in the log file. |
| LogModules | Core modules to be included in the log file. |
| MaxLogFileSize | A string specifying the maximum size in bytes for a log file (for example, 10 MB). |
| MaxLogFileCount | A string specifying the maximum file count of log files. |
| Property | Description |
| BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
| Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
| Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
| Property | Description |
| AutoCache | Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider . |
| CacheLocation | Specifies the path to the cache when caching to a file. |
| CacheTolerance | The tolerance for stale data in the cache specified in seconds when using AutoCache . |
| Offline | Use offline mode to get the data from the cache instead of the live source. |
| CacheMetadata | This property determines whether or not to cache the table metadata to a file store. |
| Property | Description |
| SAPEdition | The edition of SAP being used. Set either SAP cloud or SAP OnPremise. |
| BAPINameSeparator | A separator for concatenating table and column names when the output of the stored procedure contains a table type parameter. |
| Charset | The system code page used for Unicode to multibyte translations. |
| CheckDecimalNotation | A boolean indicating if you need to use the Decimal Notation of the SAP user profile to format the decimal data. |
| Destination | Reference to an existing destination that is specified in a local saprfc.ini or sapnwrfc.ini file. |
| EndianType | The endian type for the SAP server. Enter either Big or Little. |
| GatewayHost | The gateway host you wish to connect to. |
| GatewayService | The gateway service you wish to connect to. |
| GenerateSchemaFiles | Determines how schema files should be generated. |
| InitialValueMode | How to treat initial values in SAP. |
| Language | The language value to be used when connecting to the SAP system. |
| Location | A path to the directory that contains the schema files defining tables, views, and stored procedures to work with your chosen data source. This must be set in order to add new tables to provider. |
| MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
| Other | These hidden properties are used only in specific use cases. |
| Pagesize | The number of results to return per page from SAP. Only used for SAP tables. |
| PseudoColumns | Specify a set of pseudocolumns to expose as columns. |
| QueryMode | Determines which SAP queries will be displayed as views, if any. |
| ReadTableDelimiter | The delimiter is submitted to the ReadTableFunction . |
| ReadTableFunction | The function to use for reading table data. |
| RTK | The runtime key used for licensing. |
| StoredProcedureFilter | A filter indicating which function modules to report as stored procedures. |
| SupportServerSideCount | Determines if the count function of the simple query is executed in the SAP server. For example, select count(*) from ADRC. |
| TableMode | Determines which SAP tables will be displayed as views if any. |
| Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
| TrimStrings | A boolean indicating if varchar columns should be trimmed or not. |
| UseInternalNames | Specifies the whether to use the internalName of columns. |
| UseLabels | Set this property to determine if labels should be used for table and column names. |
| UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
| UseSimpleNames | Boolean determining if simple names should be used for tables and columns. |
| UseUnicodeRFC | A boolean indicating if you want to use RFC_GET_UNICODE_STRUCTURE to get structure information. |
| WhitespaceToNull | Indicates whether to read the empty value as original value or as null. |