{"id":34054,"date":"2017-12-12T08:56:45","date_gmt":"2017-12-12T00:56:45","guid":{"rendered":"http:\/\/localhost\/help\/?page_id=34054"},"modified":"2024-08-15T11:16:35","modified_gmt":"2024-08-15T03:16:35","slug":"configuring-the-r-adaptor","status":"publish","type":"page","link":"https:\/\/oihelp.corporate.ifs.com\/help\/p2-server\/server-resources\/configuring-the-r-adaptor\/","title":{"rendered":"Configuring the R Adaptor"},"content":{"rendered":"\n

This article applies to IFS OI Explorer version 4.17.0 and IFS OI Sentinel 4.17.0, and later.<\/p>\n

The R Language<\/a> infrastructure is available as a separate licensable component in IFS OI Server. R is an open source programming language and software environment for statistical computing and graphics that is supported by the R Foundation for Statistical Computing<\/em><\/a>.<\/p>\n

Note: Before you can use the R Script component, ensure that\u00a0Microsoft R Open 3.3.3 or R.NET<\/strong>\u00a0is installed on the same machine as IFS OI Server.<\/p>\n

IFS OI Server provides access to R via the R Language calculation<\/a> functions.<\/p>\n

Related: RTimeSeries<\/a>()<\/p>\n

Adaptor Overview<\/h2>\n

The R Adaptor is responsible for executing R scripts for the R Language functions. This adaptor supports 64-bit R engines and allows parallel R script execution by running multiple R adaptors at once with one R engine instance in each.<\/p>\n

The R Adaptor differs from other adaptors in that it does not appear in IFS OI Server Management. Configuring the R Adaptor is done through the ServerConfig.xml<\/strong>, available at:
\nC:\\Program Files\\P2 Energy Solutions\\P2 Server\\Configuration<\/em><\/p>\n

Here is an example configuration:<\/p>\n

<ConfigGroup Name=\"R Adaptor\">\r\n     <Param Key=\"RHome\" Value=\"C:\\Program Files\\Microsoft\\R Open\\R-3.4.0\" \/>\r\n     <Param Key=\"RRelativePath\" Value=\"bin\\x64\" \/>\r\n     <Param Key=\"RAdaptorEnabled\" Value=\"false\" \/>\r\n     <Param Key=\"RAdaptorMinPoolSize\" Value=\"2\" \/>\r\n     <Param Key=\"RAdaptorMaxPoolSize\" Value=\"8\" \/>\r\n     <Param Key=\"RAdaptorInitTimeout\" Value=\"60\" \/>\r\n     <Param Key=\"RAdaptorRequestTimeout\" Value=\"600\" \/>\r\n     <CollectionParam Key=\"RAdaptorEnabledPackages\">\r\n        <Value>Package1Name<\/Value>\r\n        <Value>Package2Name<\/Value>\r\n     <\/CollectionParam>\r\n     <CollectionParam Key=\"RAdaptorDisabledFunctions\">\r\n        <Value>Function1Name<\/Value>\r\n        <Value>Function2Name<\/Value>\r\n     <\/CollectionParam>\r\n<\/ConfigGroup><\/pre>\n
Parameters<\/h2>\n\n\n\n\n\n\n\n\n\n\n\n
RHome<\/strong><\/td>\nMain folder of the R installation.<\/td>\n<\/tr>\n
RRelativePath<\/strong><\/td>\nRelative path of the R engine within the RHome folder.<\/td>\n<\/tr>\n
RAdaptorEnabled<\/strong><\/td>\nTrue<\/strong> or False<\/strong>. Indicates whether the R Adaptor and thus executing R scripts is enabled. Default: false<\/em><\/td>\n<\/tr>\n
RAdaptorMinPoolSize<\/strong><\/td>\nThe smallest number of R Adaptor instances that will always be available to execute R scripts. Default: 2<\/em><\/td>\n<\/tr>\n
RAdaptorMaxPoolSize<\/strong><\/td>\nLargest number of R scripts that the system will attempt to execute simultaneously. Default: 8<\/em><\/td>\n<\/tr>\n
RAdaptorInitTimeout<\/strong><\/td>\nTime limit (in seconds) allowed for the R Adaptor to initially set up and configure the R engine before timing out. Default: 60<\/em><\/td>\n<\/tr>\n
RAdaptorRequestTimeout<\/strong><\/td>\nTime limit (in seconds) applied to all non-initialization operations against the R Adaptor. Default: 600<\/em><\/td>\n<\/tr>\n
RAdaptorDisabledFunctions<\/strong><\/td>\nA collection of additional R functions which are not allowed to be executed in R scripts. The following functions are considered insecure and are already permanently disabled in the R Adaptor: detach(), eval(), file.remove(), install.packages(), library(), require(), shell(), source(), system(), system2(), and unlink().\u00a0If there are no additional values in the collection, use:
\n<CollectionParam Key=\"RAdaptorDisabledFunctions\"\/><\/span>
\nor
\n<CollectionParam Key=\"RAdaptorDisabledFunctions\"><\/CollectionParam><\/span><\/td>\n<\/tr>\n
RAdaptorEnabledPackages<\/strong><\/td>\nA collection of R packages which will be pre-loaded by the R Adaptor for executing R scripts. If a package is not in this list then it cannot be used inside an R expression. See Installing New Packages<\/a> below. If there are no values in the collection, use\u00a0
\n<CollectionParam Key=\"RAdaptorEnabledPackages\"\/><\/span>
\nor
\n<CollectionParam Key=\"RAdaptorEnabledPackages\"><\/CollectionParam><\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Installing New Packages<\/h2>\n
New packages cannot be installed from inside of IFS OI Explorer, and must be installed by the system administrator using the standard R installation functions.\u00a0 This has been restricted inside of Explorer so that System Administrators retaiin full control over what R Packages get installed onto the system.<\/p>\n
To install new packages:<\/p>\n
    \n
  1. Download and install the R package onto the IFS OI Server machine.<\/li>\n
  2. Add the name of the new package to the RAdaptorEnabledPackages<\/strong> This will ensure that the R adaptor will load and allow the new R package to be used.<\/li>\n
  3. Restart the Data Broker Windows service to force the R adaptor to pick up the changes.<\/li>\n<\/ol>\n
    \n
    Release History<\/h2>\n