Revolution R Enterprise DeployR™ 7.1 Overview Guide The correct bibliographic citation for this manual is as follows: Revolution Analytics, Inc. 2014. Revolution R Enterprise DeployR Overview Guide. Revolution Analytics, Inc., Mountain View, CA. Revolution R Enterprise DeployR Overview Guide Copyright © 2014 Revolution Analytics, Inc. All rights reserved. No part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, photocopying, recording, or otherwise, without the prior written permission of Revolution Analytics. U.S. Government Restricted Rights Notice: Use, duplication, or disclosure of this software and related documentation by the Government is subject to restrictions as set forth in subdivision (c) (1) (ii) of The Rights in Technical Data and Computer Software clause at 52.227-7013. Revolution R, Revolution R Enterprise, RPE, RevoScaleR, DeployR, RevoTreeView, and Revolution Analytics are trademarks of Revolution Analytics. Other product names mentioned herein are used for identification purposes only and may be trademarks of their respective owners. Revolution Analytics 2570 West El Camino Real Suite 222 Mountain View, CA, 94040 USA We want our documentation to be useful, and we want it to address your needs. If you have comments on this or any Revolution document, write to [email protected]. Contents Chapter 1: Introduction ..........................................................................................................1 What’s New in Revolution R Enterprise DeployR ................................................2 Client-Server Model ...............................................................................................4 Installing DeployR .................................................................................................4 DeployR Web Services API (RESTful) .................................................................4 DeployR Landing Page ..........................................................................................5 Chapter 2: Key Features in DeployR .....................................................................................7 Key Technologies ...................................................................................................7 Key API Services ...................................................................................................7 Chapter 3: The Administration Console ..............................................................................11 Chapter 4: Java, JavaScript, and .NET Client Libraries ...................................................13 Java Client: jDeployR ..........................................................................................13 JavaScript Client: JSDeployR ..............................................................................13 .NET Client: DeployR ..........................................................................................13 Chapter 5: Examples .............................................................................................................15 [i] 1 Revolution R Enterprise DeployR Overview Guide Introduction 1 Revolution R Enterprise DeployR is a server framework that exposes the R platform as a service allowing the integration of R statistics, analytics and visualizations inside Web, desktop and mobile applications. DeployR does not replace R. Instead, DeployR provides a layer on top of R to handle resource management, security, R session management, load balancing, XML/JSON encoding, and more. Using DeployR, data analysts that are working in R can publish R scripts to a server-based installation of Revolution R Enterprise. Then, Web, desktop, and mobile application developers can use the DeployR Web Services API to securely integrate the results of these scripts into any application without needing to learn the R language. With DeployR, authorized users can combine interactive Web-based applications and widgets, desktop applications such as Microsoft ExcelTM, business intelligence dashboards, and mobile applications with on-demand analytics, predictions, and advanced visualizations from R. Behind the scenes, these applications can dynamically call a DeployR server hosted on-premise, or consolidate and schedule computations in real-time to available processors on a cluster or in the cloud. Furthermore, DeployR provides convenient functionality such as its repository, which stores and manages R projects, R scripts, R objects, data files, and plots. DeployR is designed to be completely standardized, which facilitates the integration of R functionality into any type of application without having to worry about the complications from R or high performance statistical computing. Note to Existing Users! If you plan to upgrade from RevoDeployR 2.x, 6.2, 7.0, carefully read the Revolution R Enterprise DeployR Migration Guide before uninstalling RevoDeployR. 2 Chapter 1: Introduction What’s New in Revolution R Enterprise DeployR Revolution R Enterprise DeployR 7.1 • With this release, RevoDeployR is now called Revolution R Enterprise DeployR, or DeployR for short. • We’ve also introduced the DeployR Repository Manager, which is a tool that simplifies the task of managing repository files. Authenticated DeployR users can use the Repository Manager to manage repository files (R scripts, data files, and so on) as well as interact with their R scripts in a live debugging environment. Note that the script management functionality formerly found in the RevoDeployR Management Console is now contained in the Repository Manager. This tool can be accessed through the DeployR landing page. • The Management Console has been renamed to the Administration Console. Other changes to that console include: o The Administration Console can only be accessed by the admin user. o All R script management functionality, other than import and export of R scripts, has been moved to the Repository Manager. o The user testmanager and the role SCRIPT_MANAGER were obsoleted and removed when script management functionality was moved to the DeployR Repository Manager. • There is new and updated API support, including new directory support on the Repository APIs. Refer to the 7.1 Change History section in the API Reference Guide for details. • The default installation port numbers have changed for this version. RevoDeployR 7.0 This release contains new features and improvements, including: • New and updated API support including: o Support for user blackbox projects, which are a new type of secure temporary project for authenticated users o Support for HTTP blackbox projects, which are a new type of secure, stateful project for anonymous users o Support for creating pools of temporary projects on the /r/project/pool API o New standardized set of parameters across all execution APIs 3 Revolution R Enterprise DeployR Overview Guide o New R script execution chaining support on all script execution APIs o New role-based restricted access control for files on the Repository APIs o For JavaScript developers, server-side events pushed on new /r/event/stream API o For an overview of additions and updates to the API for this release please refer to the section API Change History on the documentation landing page (http://SERVER:PORT/revolution/docs/documentation/). • New Event Stream Console, which is a browser-based console window for viewing /r/event/stream events. This console is integrated into the management console, the API Explorer tool, and the JavaScript sample applications delivered with RevoDeployR. • The management console was updated to include: o The creation and use of custom roles to restrict access to R scripts and event streams o Private, Restricted, Shared and Public access controls for R Scripts o Validation of grid node configurations upon creation, update, and import o New event stream access policies under Server Policies RevoDeployR 6.2 This release contains new features and improvements, including: • New API support for: o Priority scheduling for asynchronous jobs o Executing scripts found on external URLs or file paths including scripts in GIT and SVN repositories o The lifecycle management of repository-managed files, including scripts o Enhanced file versioning for repository-managed files, including scripts • New pre-authentication support for the users that have been reliably authenticated by an external system such as CA Siteminder® • A new high-performance, scalable persistence infrastructure, which is built on top of the MongoDB NoSQL database, to manage the reliable persistence of all user, project and repository data • Updated documentation and accompanying sample applications • Updated Javascript, Java, .NET client libraries • A new RevoDeployR Deployment Planning Guide is now available to help administrators plan the provisioning of server and grid capacity • Removed dependency on Apache HTTP Server 4 Chapter 1: Introduction Client-Server Model DeployR uses a client-server computing model. Web, desktop, and mobile applications can connect and consume services exposed by the DeployR server. Client applications do not have direct memory access to the R objects or processes on the server. Instead, all functionality is accessed via the standardized DeployR Web services API over HTTP(S). This model guarantees that the integration of R into your applications is clean, reusable, standardized, scalable, and secure. Installing DeployR The server framework is supported on Linux and