{"id":3692,"date":"2022-08-30T00:00:11","date_gmt":"2022-08-29T16:00:11","guid":{"rendered":"http:\/\/localhost\/help\/?page_id=3692"},"modified":"2024-07-02T10:48:54","modified_gmt":"2024-07-02T02:48:54","slug":"creating-a-dataset-datasource","status":"publish","type":"page","link":"https:\/\/oihelp.corporate.ifs.com\/help\/p2-server\/connecting-your-data\/creating-a-dataset-datasource\/","title":{"rendered":"Creating a Dataset Datasource"},"content":{"rendered":"\n

This article applies to version 4.10.5 and later of IFS OI Explorer. For more, see Release History<\/a>.<\/p>\n

Before you can get data into IFS OI Server, you must define a datasource. A datasource is a connection that allows IFS OI Server to retrieve data from an external system, such as a database, historian, accounting system, etc. Each datasource retrieves data from one source system. You need to define a connection for each system you want to connect to.<\/p>\n

This article\u00a0explains how to create a datasource, and the terms that relate to dataset\u00a0datasources (e.g. data stored in SQL Server or Oracle databases).<\/p>\n

You can add a datasource using IFS OI Server Management or the Import\/Export spreadsheet.<\/p>\n

Server Management<\/h2>\n

Step 1. Create the Datasource<\/h3>\n

In IFS OI Server Management, adding a datasource is performed through the Configuration\u00a0\"\"\u00a0menu option.<\/p>\n

1. Open IFS OI Server Management, click the Configuration\u00a0<\/strong>icon.<\/p>\n

2. Select the Datasources<\/strong> \"\"option from the middle panel.<\/p>\n

3. Click the Create New Datasource<\/strong>\u00a0button.<\/p>\n

If you are updating a datasource, click the name of the datasource instead.<\/p>\n

<\/a><\/p>\n

Step 2. Configure a Connection<\/h3>\n

The configuration parameters are different depending on the type of datasource you are configuring. For a dataset\u00a0datasource, the parameters are as follows.<\/p>\n\n\n\n\n\n\n\n\n\n\n\n
Parameter<\/strong><\/td>\nDescription and example<\/strong><\/td>\n<\/tr>\n
Name<\/strong><\/td>\n\n

The name that this datasource will be known by, to be used in other applications such as IFS OI Explorer<\/a>. In the example below, the list of datasources appears in IFS OI Explorer when choosing a dataset.<\/p>\n

\"adddatasource\"<\/a><\/p>\n<\/td>\n<\/tr>\n

Description<\/strong><\/td>\n\n

Detailed information on the external system that this datasource connects to. A good description helps to address any ambiguities when there are several datasources with similar names.<\/p>\n

\"\"<\/a>\u00a0<\/p>\n<\/td>\n<\/tr>\n

Data Type<\/strong><\/td>\n\n

The format of data retrieved by the datasource. For data stored in databases, you should choose \"Dataset\".<\/p>\n

\"\"<\/a><\/p>\n<\/td>\n<\/tr>\n

Adaptor<\/strong><\/td>\n\n

The type of connection that is used by the datasource to retrieve the data.<\/p>\n

\"\"<\/a><\/p>\n<\/td>\n<\/tr>\n

Time Zone<\/strong><\/td>\n\n

The time zone applicable for the location of the source system. Choose \"Geographical Timezone\" if you want the system to automatically obey daylight savings, otherwise choose \"Fixed Offset\" to specify the difference in hours and minutes from UTC.<\/p>\n

Geographical Timezone<\/strong><\/em>: Begin typing the name of the time zone<\/a> you are looking for. This field uses predictive text, so choose one of the items that appears in the list.<\/p>\n

\"\"<\/a><\/p>\n

Fixed Offset<\/strong><\/em>: Specify the offset from UTC\/GMT<\/a>\u00a0(e.g. + 08 00).\u00a0<\/p>\n

\"\"<\/a><\/p>\n<\/td>\n<\/tr>\n

Adaptor Pool Size<\/strong><\/td>\n\n

The adaptor pool hosts a number of adaptors (datasource connections), which can be called upon to retrieve data. You need to specify the minimum and maximum adaptor pool size by moving the sliders left and right.
\nIf your external system only allows one active connection at a time, set both minimum and maximum to 1. Default: Min=2, Max=8.<\/p>\n

For more information on adaptor pool sizes, see \"Datasources and Adaptors<\/a>\".<\/p>\n<\/td>\n<\/tr>\n

Initialisation Timeout<\/strong><\/td>\n\n

Applies to the initialisation of an adaptor, when it first connects to a datasource. This is the same as the Init_Timeout setting used in Explorer 2.6.x. \u00a0Note: This setting was added in Server v 4.5.2.<\/em><\/p>\n

\"\"<\/a><\/p>\n<\/td>\n<\/tr>\n

Request Timeout<\/strong><\/td>\n\n

Applies to all other operations against the datasource, such as tag fetch. It is similar to the Submit_Timeout setting used in Explorer 2.6.x.
\nNote: This setting was added in Server v 4.5.2.<\/em><\/p>\n

\"\"<\/a><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Step 3. Configure the Adaptor<\/h3>\n

The Adaptor Parameters depend on the adaptor that has been selected.\u00a0The following tables list the parameters for each dataset adaptor, along with the\u00a0name<\/em>\u00a0and\u00a0type<\/em>\u00a0to be used in the Import\/Export spreadsheet.<\/p>\n

Microsoft SQL Server Adaptor<\/h4>\n\n\n\n\n\n\n\n\n
Parameter<\/strong><\/td>\nDescription and example<\/strong><\/td>\nName<\/strong><\/td>\nType<\/strong><\/td>\n<\/tr>\n
Server<\/span><\/td>\nName of the Microsoft SQL Server machine to connect to. E.g. Perauthor01<\/td>\nServer<\/td>\nString<\/td>\n<\/tr>\n
Database<\/span><\/td>\nName of the Microsoft SQL Server database to connect to. E.g.\u00a0ExplorerTrainingData<\/td>\nDatabase<\/td>\nString<\/td>\n<\/tr>\n
Use Trusted Connection<\/span><\/td>\nSelect this check box to use trusted connection, otherwise you must provide a user ID and password for the database. Options: True, False.<\/td>\nUse Trusted Connection<\/td>\nBoolean<\/td>\n<\/tr>\n
User ID<\/span><\/td>\nUser ID to use to connect to Microsoft SQL Server. E.g. sa<\/td>\nUser ID<\/td>\nString<\/td>\n<\/tr>\n
Password<\/span><\/td>\nPassword for the User ID used to connect to Microsoft SQL Server. E.g. Password<\/td>\nPassword<\/td>\nEncryptedString<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Supported Data Types<\/strong><\/p>\n\n\n\n\n
\n

Fully Supported<\/strong><\/p>\n

These types are\u00a0fully supported; they are converted to relevant variable values<\/em><\/p>\n<\/td>\n

\n

Read Support<\/strong><\/p>\n

These types have read support, but are always converted into string values<\/em><\/p>\n<\/td>\n

\n

Not Supported<\/strong><\/p>\n

Adaptors will return an error when they encounter these\u00a0data types<\/em><\/p>\n<\/td>\n<\/tr>\n

\n
    \n
  • Bigint<\/li>\n
  • Bit<\/li>\n
  • Char<\/li>\n
  • Date<\/li>\n
  • Datetime,\u00a0Datetime2<\/li>\n
  • Datetimeoffset<\/li>\n
  • Decimal<\/li>\n
  • Float<\/li>\n
  • Int<\/li>\n
  • Money<\/li>\n
  • Nchar<\/li>\n
  • Ntext<\/li>\n
  • Numeric<\/li>\n
  • Nvarchar,\u00a0Nvarchar (max)\u00a0<\/li>\n
  • Real<\/li>\n
  • Smalldatetime\u00a0<\/li>\n
  • Smallint\u00a0<\/li>\n
  • Smallmoney\u00a0<\/li>\n
  • Text<\/li>\n
  • Time<\/li>\n
  • Tinyint<\/li>\n
  • Varchar,\u00a0Varchar (max)<\/li>\n<\/ul>\n<\/td>\n
\n
    \n
  • Geography\u00a0<\/li>\n
  • Geometry<\/li>\n
  • Hierarchyid\u00a0<\/li>\n
  • Sql_variant<\/li>\n
  • Uniqueidentifier<\/li>\n<\/ul>\n<\/td>\n
\n