SAP xMII Data Servers

Related Topics

You can add and delete servers and edit their specific parameters on the Data Servers page. Server names must be meaningful since they are used on the Template Editor page and during runtime data browsing. If you made changes to server parameters and the server is enabled, it is reloaded and the new settings take effect immediately.

Note:  To review connector types and their parameters, see the Connectors/Datasources book in the help table of contents.

Common Server Parameters

Name

Description

Type

Usage

Name

Unique name of the server

String

 

Connector

The class of server

String

This field is determined by the datasource class and is not editable

Connector Type

ALARM, TAG, SQL, AGG (Aggregate), OLP (OLAP), XML, or XCT

String

This field is determined by the datasource class and is not editable

Enabled

Turns the server on or off in SAP xApp Manufacturing Integration and Intelligence (SAP xMII)

Boolean

 

IDBC Server Parameters

Required parameters for servers that utilize the SAP xMII database access sub-system include the following.

Database Related Server Parameters

Name

Description

Type

Usage

Autobind

Business Logic Services connector parameter

Check box

If this check box is selected, any parameters that have the same name as an input parameter for the transaction are passed to SAP xMII Business Logic Services and automatically populated with their values. No linking is required. If the check box is clear, all parameters must be linked to be assigned values.

DatePrefix

Prefix to date strings in date comparisons

String

A string corresponding to any delimiters that must precede the date string when comparing date values

DateSuffix

Suffix to date strings in date comparisons

String

A string corresponding to any delimiters that must follow the date string when comparing date values

Description

Long description

String

Information only

InitCommand

Any command that should be run when a connection pool is created

String

This parameter is used by the database connector. It could be used to set the database locale in Oracle.

InternalDateFormat

The date format to be used when constructing WHERE clause conditions

String

The SAP xMII has a sophisticated date range selection engine that can dramatically ease the authoring of time-sensitive queries.  This parameter controls how the "WHERE" clause for date comparisons will be constructed for a specific database/server.

IP

Machine name or IP address where requests are made

String

For a UDC, it is where the UDS is installed. For the Business Logic Services connector, it is the machine where Business Logic Services is running. The value "localhost" should be used for anything running on the local machine.

JDBCDriver

Name of the JDBC driver to use when connecting to the server

String

The JDBC drivers shipped with the SAP xMII include those for Oracle, SQL Server, and ODBC.  The driver specifications for these are:

Oracle:  oracle.jdbc.driver.OracleDriver
SQL Server:
com.inet.tds.TdsDriver
ODBC:
sun.jdbc.odbc.JdbcOdbcDriver

If you will be using a third party JDBC driver with the SAP xMII, please refer to the vendor's documentation to determine the driver class name, and be certain to add this to the class path.  Please contact technical support if you are unsure as to how to accomplish this.

Password

Database-specific password

String

The Password to use when connecting to the database.  Note that no passwords are ever sent between the browser clients and the database for maximum security, nor is the Servers.xml file accessible via the Web server. Regardless of the number of characters in your password or even if your password is blank, the password field shows six asterisks (i.e., ******).

PoolMax

Maximum connection pool size

Integer

This parameter defines the maximum number of connections that the pool will ever allocate.  If a request is received and all connections are in use and allocated, the query will wait for a connection to come available or a timeout period expires.

PoolSize

Initial connection pool size

Integer

This parameter defines the # of initial connections to create when the connection pool is initialized

Port

Socket used for communication to the server

Integer

For UDC this is a direct socket communication usually on a port like 8080.  For the Business Logic Services connector it is the http port on which Business Logic Services is listening, typically 80.

Protocol

Indicates the protocol used for URL requests for that server

String

Used by Business Logic Services and proxy connectors

QueryTimeout

The time before a request is terminated

Integer

Used by the UDC and OLEDB connectors. If a request takes longer than the value, the request expires and returns an error. For example, if it is set to five seconds and it takes 10 seconds to retrieve the requested data, the query times out at five seconds.

ServerPackage

The SAP xMII Java class that is instantiated for the server

String

You should never change this parameter.

ServerURL

Driver-specific string defining how to access the physical database

String

Here are examples for Oracle, SQL Server, and ODBC:

Oracle:  jdbc:oracle:thin:@hammer1:1521:ORC1

In this example, the Oracle server located on a machine named "hammer1" will be connected to via TCP/IP port 1521, to an Oracle instance named "ORC1".

SQL Server: jdbc:inetdae:hammer9:1433?database=MyDatabase&sql7=true

In this example, the SQL Server located on a machine named "hammer9" will be connected to via TCP/IP port 1433, to a database named "MyDatabase", and the optional flag to indicate that the database is a SQL7 database (to allow access to its new column data types) has been set.

ODBC: jdbc:odbc:AccessNorthwind

In this example, AccessNorthwind is the name of an ODBC System Datasource Name (DSN) to which the server will be linked.

TagConfigFile

The file contains the list of tags, their values, etc.

String

Used by Simulator to get its configuration information

TimeOut

Length of time (in minutes) that an unused connection will be retained

Integer

This parameter defines how long to keep connections "alive" even when they are unused.  When the timeout period expires, the connections will be returned to the pool.  This value should be a minimum of 30 minutes.

UseCount

# of times a connection can be used before it must be recycled

Integer

This parameter defines how many queries can be executed against a pre-opened connection before the connection should be closed and its resources released.  This is usually only required in the case of ODBC data sources which are notorious for resource leaks when used to execute large number of statements.

User Name

Database-specific User ID

String

The UserID to use when connecting to the database.

ValidationQuery

Used to validate that a database connection is valid

String

For example, a simple query is "SELECT GETDATE()." If you want a more specific query, use "SELECT * FROM Orders WHERE  OrderId = -1." The query does not have to return any rows;however, it has to work.

WaitTime

Query Timeout Parameter

Integer

This is the time that the SAP xMII will wait for a connection before failing

Writable

Used by OLEDB and UDC to indicate wether or not the CurrentWrite mode is supported for that server

Check box

If the check box is selected, you can update values in the underlying server, as long as it supports it.

UDC/UDS Specific Server Parameters

Refer to the UDC topic for UDC/UDS specific parameters.