Spotfire® Service for R Installation and Administration

Installing the Service on a Node Manager for a Spotfire Server

After installing and authorizing a node manager, you can install the Spotfire Service for R.

Before you begin

  • You have installed and authorized a node manager. See the topics Node manager installation and Trusting a node in the Spotfire® Server Installation and Administration user guide.
  • The Spotfire Server and the node manager are up and running.
  • You have installed the operating-system-specific version of the R on the node where you intend to install the Spotfire Service for R.
  • For Windows, you have set the environment variable SPOTFIRE_R_HOME (or you have set rhome.path in custom.properties). For Linux, you have set rhome.path in custom.properties.
  • You have deployed the operating-system-specific SDN for the Spotfire Service for R into a deployment area of your Spotfire Server. For information about deploying the SDN, see the topic Adding software packages to a deployment area in the Spotfire® Server Installation and Administration user guide.
    Important:
    • You can install the Spotfire Service for R on a node manager running on a computer with an operating system (OS) that is different from that of your Spotfire Server.
    • All services belonging to the same Spotfire deployment area must run on node managers with the same OS.
  • Optional: You have created and imported a custom configuration for the Spotfire Service for R.

Procedure

  1. Log in to the Spotfire Server and click Nodes & Services.
  2. Under Node managers, select the node to which you want to add the Spotfire Service for R.
    A running service shows a green circle with a check mark next to the selected node manager.
    In the Services area, the names of the current services are shown in the lower-right pane of the window.
  3. Click Create new service.
  4. Make your selections in the Create new service dialog:
    1. Under Deployment area, select the area where you deployed the Spotfire Service for R.
      Note: Administrators often create a Test deployment area to use as a staging server.
    2. Under Capability, select R.
    3. Under Configuration, select the service configuration to apply to the service.
      Note: In most cases, this is the default configuration, unless you have created a custom configuration. See the Spotfire® Server Installation and Administration user guide for more information on creating a custom configuration.
    4. Under Service name, provide a display name for the service.
    5. Under Add instances, specify the number of instances.
    6. Under Instances name, provide a name for the instances.
    7. Under Number of instances, leave the option set to 1.
      The Spotfire Service for R can have only one instance per node. If you set it to a value other than 1, the service does not work as expected.

      One Spotfire Service for R instance can serve multiple users simultaneously. See the Custom configuration properties for more information.

    8. Under Port, you can change the default as needed.
  5. Click Create service.
    To view the progress of the installation, click the Activity tab.

Results

The service is installed and starts.

Additionally, three helper R packages are installed. See Helper packages included in the service.

Note: If you experience errors, click View logs for more information.

What to do next

For information on the remaining setup tasks, see the topic Post-installation steps in the Spotfire® Server Installation and Administration user guide.