INSTALLATION GUIDE PIPELINE PILOT SHAREPOINT BRIDGE 2016 Copyright Notice
©2015 Dassault Systèmes. All rights reserved. 3DEXPERIENCE, the Compass icon and the 3DS logo, CATIA, SOLIDWORKS, ENOVIA, DELMIA, SIMULIA, GEOVIA, EXALEAD, 3D VIA, BIOVIA and NETVIBES are commercial trademarks or registered trademarks of Dassault Systèmes or its subsidiaries in the U.S. and/or other countries. All other trademarks are owned by their respective owners. Use of any Dassault Systèmes or its subsidiaries trademarks is subject to their express written approval.
Acknowledgments and References
To print photographs or files of computational results (figures and/or data) obtained using BIOVIA software, acknowledge the source in an appropriate format. For example: "Computational results obtained using software programs from Dassault Systèmes BIOVIA. The ab initio calculations were performed with the DMol3 program, and graphical displays generated with Pipeline Pilot."
BIOVIA may grant permission to republish or reprint its copyrighted materials. Requests should be submitted to BIOVIA Support, either through electronic mail to [email protected], or in writing to:
BIOVIA Support 5005 Wateridge Vista Drive, San Diego, CA 92121 USA Contents
Overview 1 Installation Files 2 Web parts 2 BAT files 2 stsadm tools 2 Installing on a Single SharePoint Server 3 Installing on Multiple SharePoint Servers 5 Using the upgrade_pipeline_pilot_sp_ bridge.bat script 6 Upgrading from SharePoint 2007 to SharePoint 2010 7 Package Contents 8 Non-GAC Deployment and CAS Permissions 9 Minimal CAS Version 9 Overview The SharePoint Bridge is distributed as a Windows SharePoint Services solution file containing all the configuration files and assemblies needed for deployment, and two Windows batch scripts to install or upgrade the solution in a single step. To get started: 1. Download the following file in the download center: BPPF2016_sharepointbridge.zip. 2. Copy and unzip them on your SharePoint server (you must be a member of the Administrators group on the server).
Overview | Page 1 Installation Files
Web parts Install/PipelinePilotSharePointBridge2007.wsp Install/PipelinePilotSharePointBridge2010.wsp Install/PipelinePilotSharePointBridge2007MinimalCAS.wsp BAT files These bat files allow you to install or upgrade the web parts for a single server (see Installing on Multiple SharePoint Servers to install on more than one SharePoint server): Install/install_pipeline_pilot_sp_bridge.bat Install/upgrade_pipeline_pilot_sp_bridge.bat There are three variants for the solution (.wsp) file. The bat script automatically chooses the appropriate one to install based on your SharePoint version and the command line flags you specify. In most cases, install one of the first two files listed above, which declare all of the code access security (CAS) permissions required to work optimally. If the default set of CAS permissions (see details below) is at odds with your IT policy, and you are using SharePoint 2007, you can install the third option, which defines only the minimal set of CAS permissions needed to function properly (with some changes in behavior). stsadm tools Install/stsadm_tools/ install_pipeline_pilot_stsadm_tools.bat Install/stsadm_tools/ PipelinePilotStsadmTools2007.wsp Install/stsadm_tools/ stsadmcommands.PipelinePilotStsadmTools.xml Install/stsadm_tools/source/ UserProfileUtils.cs
Installation Files | Page 2 Installing on a Single SharePoint Server The standard installation script can be used to install or uninstall the Bridge Web Part solution file. With no command line options, the installation script will install the solution file that is appropriate for your SharePoint version, deploy the solution to the root web application, activate the feature for the root site collection, and restart the SharePoint server. The following command line options are also available: Option Details /u (or /uninstall) Uninstalls the Bridge Web Parts. After uninstalling, you can optionally delete the webpart files from the Web Part Gallery (part of the site settings). Note that the first step of uninstallation removes the BIOVIA Web Parts from the Add Web Parts dialog. /weburl Use this flag to specify the root of the web application to which the solution should be installed. You may need to set this if your default SharePoint web application cannot be reached using http://localhost on the SharePoint server. /siteurl Use this flag to specify the site collection in which the "SharePoint Bridge" feature should be activated. Use this if you want to limit the web sites in which users have access to the Bridge Web Parts, or if http://localhost does not reach the preferred website on the SharePoint server. /noreset Do not restart the SharePoint server after all other tasks are finished. A restart will be needed before the Web Parts can be used. /minimalcas Installs the version of the Bridge with the minimal set of CAS permissions (SharePoint 2007 only). If you are installing on MOSS 2007 and want users to be able to store their connections in their user profile, then use the Stsadm tools to create the necessary user profile properties. For more details, see User Profile Properties in the Administration Guide.
Notes: The final step of the batch script is to restart the SharePoint server. The server may be inaccessible for a few seconds during the restart. The SharePoint Bridge feature is activated at the site collection level (not the farm, or web application level). To install the Bridge to an entire farm, you need to edit the "feature.xml" file inside the solution to be deployed. To install the Bridge to multiple site collections, you can edit the installation script before running it and hardcode your site collection URLs. If you run the batch script in a command window, you can view the output to verify that the installation is successful. The output should look something like this: Checking if solution PipelinePilotSharePointBridge.wsp is already installed ... Copying solution file PipelinePilotSharePointBridge2007.wsp to PipelinePilotSharePointBridge.wsp 1 file(s) copied. Adding solution PipelinePilotSharePointBridge.wsp to SharePoint ...
Installing on a Single SharePoint Server | Page 3 Operation completed successfully. Deploying solution PipelinePilotSharePointBridge.wsp ... Operation completed successfully. Activating feature SESProtocolLauncher ... Operation completed successfully. Resetting IIS Attempting stop... Internet services successfully stopped Attempting start... Internet services successfully restarted
Page 4 | Pipeline Pilot • Installation Guide Installing on Multiple SharePoint Servers 1. In the bin folder of the installer rename PipelinePilotSharePointBridge2010.wsp to PipelinePilotSharePointBridge.wsp. 2. Use standard deployment commands to add and deploy the PipelinePilotSharePointBridge.wsp solution package: a. Run Add-SPSolution as described in http://technet.microsoft.com/en-us/library/ff607552 (v=office.14).aspx. For example: Add-SPSolution -LiteralPath "
Installing on Multiple SharePoint Servers | Page 5 Using the upgrade_pipeline_pilot_sp_bridge.bat script The upgrade script can be used to update an existing installed version of the SharePoint Bridge solution to the latest version, without uninstalling the old version, or needing to worry about feature activation. The solution upgrade is added to the queue for the SharePoint Timer Service, which will execute the upgrade as soon as it can. The upgrade triggers a server restart. If no SharePoint Timer Service is running, instructions are displayed on the command line for executing queued administrative tasks using the stsadm tool. The following command line option may be specified: Option Details /minimalcas Installs the version of the Bridge with the minimal set of CAS permissions (SharePoint 2007 only).
IMPORTANT! The batch script schedules an administrative task that restarts the SharePoint server. The server may be inaccessible for a few seconds during the restart.
Using the upgrade_pipeline_pilot_sp_bridge.bat script | Page 6 Upgrading from SharePoint 2007 to SharePoint 2010 After upgrading your SharePoint 2007 site collections to SharePoint 2010, the Web Parts will automatically pick up configurations from your 2007 content database and update them for use in SharePoint 2010. We performed limited testing with the database attach upgrade method for bringing up 2007 sites on a 2010 server and did not encounter any issues. To reduce the number of warnings generated during the upgrade process, install the Web Parts before beginning the database upgrade. Note: User connections, which may be stored in browser cookies for the SharePoint 2007 server or in their user profile, are not migrated. To create new content with the Bridge Web Parts, users need to re-create their Pipeline Pilot server connections on the SharePoint 2010 server using a Manager Web Part.
Upgrading from SharePoint 2007 to SharePoint 2010 | Page 7 Package Contents A Windows SharePoint Service solution file is a standard Windows cabinet file with a .wsp suffix. To view the contents of the solution file, change the suffix to .cab and double-click the file. It opens in WinZip (if you have this program installed). The solution file contains two assemblies: "PpProtocolRunner.dll" and "nalpp.dll". The first assembly contains the code that supports the three Web Parts in the bridge. The second assembly is the .NET API, the standard library that assists in writing .NET client applications for Pipeline Pilot server. The solution contains a single feature, SESProtocolLauncher, configured in "feature.xml", which includes all three Web Parts. The "manifest.xml" file is responsible for loading the assemblies into SharePoint, adding the safe control definitions to SharePoint’s "web.config" file, and adding the code access security (CAS) permissions needed for the Web Parts to function properly. The solution file also contains numerous image, JavaScript, and stylesheet files, which are deployed as class resources. Non-GAC Deployment and CAS Permissions The SharePoint Bridge code is deployed to a SharePoint server’s bin directory where it is executed in a limited trust environment. (The alternative is to deploy code to a server’s Global Assembly Cache (GAC), which executes in a full trust environment with permissions equivalent to a systems administrator.) To function properly, the SharePoint Bridge requires specific code access security (CAS) permissions. These permissions are set up during installation by the "manifest.xml" file. To verify that the code in the package will work properly, you can visually inspect the set of permissions requested by the Bridge solution. The CAS permissions for the default install are listed below. AspNetHostingPermission (level=Medium): Minimal is needed by all Web Parts. Medium allows us to query the SharePoint server’s host name and send it to Protocols. SecurityPermission Execution: Needed for anything to start. Unmanaged Code: Required to connect to Pipeline Pilot servers without valid SSL certificates. This is needed to change System.Net.ServicePointManager.CertificatePolicy. Infrastructure: Also related to SSL certificate validation. This is needed to set the System.Net.ServicePointManager.ServerCertificateValidationCallback. SerializationFormatter: Allows serialization of internals to persist configuration information. ControlPrincipal: Needed to perform asynchronous loading of result files. SharePointPermission ObjectModel: Needed to access SharePoint server objects such as the user profile. UnsafeSaveOnGet: Allows a unique ID to be generated and persisted when the Launcher Web Part is first created. DnsPermission: Needed to resolve the hostnames of Pipeline Pilot servers. The NALPP library relies on DNS lookups to obtain the name of the local machine, which is transmitted to Pipeline Pilot server for logging purposes. This permission can safely be removed, but doing so will compromise the usefulness of the Pipeline Pilot server logs. WebPermission: Needed to connect to Pipeline Pilot servers, launch protocols, and fetch result files. FileIOPermission: Needed to create and append to log files, which provide useful debugging information should a problem occur. Changes are restricted to the C:\PipelinePilotSharePointLogs directory. This permission can safely be removed, if logging is not needed.
Minimal CAS Version The "manifest.xml" file in the "PipelinePilotSharePointBridge2007MinimalCAS.wsp" solution does not demand the Unmanaged Code, Infrastructure, DNS, or File IO permissions. The "minimal CAS" solution is only currently provided for SharePoint 2007. The Web Parts will function as for the standard permission set, with the following exceptions: Users can only connect to Pipeline Pilot servers with valid SSL certificates. The Pipeline Pilot server logs do not record the IP address of the SharePoint server in jobs launched using the Launcher Web Part. It is not possible to troubleshoot problems enabling the logging of information to files in the C:\PipelinePilotSharePointLogs directory.
Non-GAC Deployment and CAS Permissions | Page 9