Admin Portal Guide Pipeline Pilot 2016
Total Page：16
File Type：pdf, Size：1020Kb
ADMIN PORTAL GUIDE PIPELINE PILOT 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 Chapter 1: Introduction 1 Diagnostic Tools for Apache 15 BIOVIA Pipeline Pilot Server Overview 1 Diagnostic Tools 15 Supported Operating Systems 1 Admin Portal User Assistance 16 Client Software 1 Getting Help in the Admin Portal 16 Developer Tools 1 Tooltips 16 Enterprise Architecture 1 Expanding Help 17 Protocol Database Sharing and Data Access 1 Pipeline Pilot Help Center 18 Security 2 Using the Help Center 18 Java Server Package 2 Searching the Help Center 19 About this Guide 2 Chapter 2: Status and Monitoring 22 Getting Additional Information 2 Managing Jobs 22 Additional Information 3 Jobs Overview 22 Getting Started with BIOVIA Pipeline Pilot Job Management 23 Server 3 Queued Jobs 23 Administration Portal Overview 3 Running Jobs 24 Accessing the Admin Portal 3 Job Settings 26 Admin Portal Home Page Features 4 Appendix C: Job Folder Maintenance 28 Admin Pages Explorer 4 Scheduled Tasks 29 Displaying the Admin Pages Explorer 5 Overview 29 Client Support 6 Task types and triggers 29 Overview of Client Types 6 Monitoring scheduled tasks 30 Client Installation Overview 7 Displaying Server Information 30 Automatic Client Software Updates 7 Environment 31 Confirming User Identity 8 Ports 31 BIOVIA Plugin Administration 8 Paths 31 BIOVIA Plugin on Virtual Servers that Allow Monitoring Server Usage 31 Concurrent Login Sessions 9 Chapter 4: Reports 33 BIOVIA Plugin DNS and Proxy Configuration Guidelines 9 Monitoring XMLDBs with Catalog Search 33 DNS 9 Overview 33 Proxy 9 Using Catalog Search 33 Server Home Page 9 Query Options 35 Accessing the Home Page 10 Exporting Results to Excel 36 Managing Administrator Access 11 Completed Jobs 36 Web Services Overview 11 Filtering the Jobs Log 37 Client SDK Access 12 Installed Collections 37 SOAP Web Services API 12 Installed Packages 40 RESTful Web Services API 12 Server Usage Report 41 Apache 2 HTTP Server 12 Report Content 42 Windows Apache Users 13 Usage Categories 42 Linux Apache Users 13 Validation Report 42 Java Server Package 13 Overview 42 Web Connections and Ports 14 Customizing the Validation Schedule 43 Apache Support and Maintenance 14 Manually Running a Validation 43 Restarting Apache 14 Validation Report Results 43 Exporting Results to Excel 44 Connection Settings 68 Chapter 5: Security 45 Updating Registered Applications 68 Security Overview 45 Disconnecting 68 Authentication 45 Restoring Security Settings 68 Support for SAML Authentication 45 Registered Applications 68 Impersonation 45 Synchronization History 68 Authorization 46 Synchronization Status 69 Pipeline Pilot System Permissions 46 Groups and Permissions 69 Pipeline Pilot System Groups 46 Groups and Permissions Overview 69 Managing Pipeline Pilot Authorization 46 System Groups 69 Authorization Guidelines 47 Pipeline Pilot System Permissions 70 Access Rights 47 Admin Portal Users 71 XMLDB Access Rights Overview 47 Custom Groups and Permissions 72 Tab Publishing Rights 48 Support for Groups and Permissions in Managing Access Rights 48 Pipeline Pilot 72 Impersonation and File Access Rights 52 Getting Started with Groups 72 Authorizing Client Administrators 52 Group Management Features 73 Authentication 53 Managing Custom Groups 77 Authentication Overview 53 Adding a New Custom Group 77 Authentication Method 53 Removing a Custom Group 78 SAML Web SSO Settings 57 Renaming a Custom Group 78 Anonymous Access 57 Managing Group Assignments 78 Support for Kerberos via SPNEGO 57 Assigning Users to Groups 78 Passing Insecure Passwords 59 Assigning Group Member Types 79 User Directory Sharing 59 Mapping External Claims 79 Restricting Permissions 59 Getting Started with Permissions 80 Notification Protocols 59 Permission Management Features 80 Security for Linux Authentication 60 Managing Custom Permissions 84 Linux Shadow Password Support 61 Adding a New Custom Permission 84 Linux Username Case Sensitivity 61 Removing a Custom Permission 84 Managing a User List for Authentication 62 Renaming a Custom Permission 85 Managing Impersonation 62 Managing Permission Assignments 85 Windows Requirements for Impersonation 63 Certificates 87 Linux Requirements for Impersonation 63 Managing SAML Certificates 87 Client User Requirements under Overview 88 Impersonation 64 Importing Key Pairs into the SAML Stores 88 Enabling Impersonation 64 Adding Trusted Certificates 90 SAML Web SSO 64 Managing SSL Certificates 92 First-time Authentication 65 SSL Certificates 92 Limitations 65 Configuring SSL Certificates in the Admin Configuring SAML Web SSO 65 Portal 92 Setting up SSO and SAML Certificates 66 Using SSL Certificates from Recognized Authorities 93 Enabling SAML SSO and Configuring Service Provider Settings 66 Generating a Self-Signed Certificate 95 Configuring Identity Provider Settings 67 Using the BIOVIA Self-Signed Certificate 96 Verifying your Configuration 67 Chapter 6: Setup and Configuration 97 BIOVIA Hub Connection 67 Catalog Settings 97 Overview 97 Updating Catalog Indexes 97 Configuring for Load Balancing 120 Updating Incremental Catalog Indexing Distributed Grid Computing Deployments 120 Settings 97 Grid Features 120 Data Sources 98 Guidelines 121 Creating Data Source Connections 98 Configuring for Grid Operation 121 ODBC (PP) Data Sources 99 Testing a Grid Engine with Pipeline Pilot 123 JDBC Data Sources 99 Clustering Deployments 124 ODBC (DSN) Data Sources 100 Clustering Features 124 MongoDB Data Sources 100 Guidelines 125 Testing Data Source Connections 100 Configuring for Clustering 126 Advanced Data Source Connection Server Configuration 128 Configurations 101 Configuring Pipeline Pilot Servers 128 Connection Pooling 101 Recommendations for CPU Usage 131 Security 102 Remote Administration Access 131 Initializing the Connection 104 Configuring a Single Port Operation 132 Additional Information 104 Reconfiguring Ports 132 Query Service Settings 104 Settings for Web Client Hosts 133 Exporting and Importing Data Sources 104 Server Registry 134 Database Configuration 106 Validation Rules 135 File Browser Access Settings 106 Remote Administration Access 136 File Browser Shortcuts 106 Chapter 7: Server Maintenance 137 File Browser Access 107 Setting up MongoDB 137 Folder Locations 107 MongoDB Overview 137 Managing Folder Locations 107 Requirements 137 Overview 107 Installing and Deploying MongoDB 138 Redirecting Folders 108 Configuring a Pipeline Pilot Server to use a Redirecting the User Folder 109 MongoDB Server 139 Redirecting the Jobs Folder 109 Configuring MongoDB as a Secure Data Redirecting the Shared Public Folder 110 Source 140 Redirecting the Local Temp Folder 110 Importing/Exporting Configurations 141 Redirecting the Upload Folder 111 Exporting a Server Configuration 141 Redirecting the XMLDB Folder 111 Importing a Server Configuration 141 Preparing to Redirect an XMLDB Folder 111 Managing the Server 141 Global Properties 112 Taking the Server Offline for Maintenance 141 Job Settings 113 Restarting the Server 142 Proxy Settings 115 Configuring Java Servers 142 Setting up a Proxy Server Exclusion List 115 Overview 142 Server Deployments 116 Java Server Configuration 142 Server Deployments Overview 116 Managing the XMLDB 143 Configuring Pipeline Pilot to Support Backing Up XMLDB Files 143 Advanced Deployments 116 Backup guidelines 144 Reverse Proxy Deployments 118 Backing up your XMLDB 144 Reverse Proxy Features 118 Purging XMLDB Files 145 Guidelines 118 How purging impacts versioning 145 Configuring a Reverse Proxy 118 Restoring XMLDB Backups 145 Load Balancing Deployments 119 XMLDB versions 146 Load Balancing Features 119 Compressing an XMLDB 146 Guidelines 119 Sharing an XMLDB with Multiple Servers 147 Chapter 8: Pipeline Pilot Services 149 Managing Pipeline Pilot Services 149 Using the Windows Services Console to Manage Pipeline Pilot Services 149 Managing Pipeline Pilot Servers on Linux 150 Shutting Down Pipeline Pilot on Linux 150 Manually Starting the Linux Server 151 Pipeline Pilot Manager 151 Managing Services with Pipeline Pilot 151 Overview 151 Pipeline Pilot Service Tasks 151 Platform Builder Task 152 Version Change Process 153 Running Pipeline Pilot Services in Console Mode 153 Console Mode Commands 154 Appendices 155 Appendix A: Support for Security Issues 155 Logon Support 155 Resolving Administrator Lockout Problems 155 Deleting AuthConfig.xml and Logging on using scitegicadmin Credentials 155 Deleting