Query Service Administration Guide

Total Page:16

File Type:pdf, Size:1020Kb

Query Service Administration Guide ADMINISTRATION GUIDE BIOVIA QUERY SERVICE 9.5.200 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 BIOVIA Query Service." 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 Creating an ADS 19 Purpose of the BIOVIA Query Service 1 Using the template IDS XML configuration Query Service 1 files 20 Client applications 1 Setting up a data source using existing Isentris data source files 20 The Query Service RESTful API 1 Creating a data source XML file manually 21 Key features of the Query Service 2 Configuring an IDS to support retrieval of Conventions 2 molecules as Pipeline Pilot Chemistry Additional information 2 instead of CHIME strings 23 Chapter 2: System Requirements 3 Configuring Query Service in the Software requirements (Data Source Builder) 3 Administration Portal 23 Required software 3 Configuring the Query Service catalog 24 Required software settings 3 Editing the Catalog.xml file 24 Optional software 3 Checking the Query Service catalog 25 Supported Registration databases 3 Chapter 5: Optional Configuration Tasks 26 Modifying the definition of the automatic Chapter 3: Overview for Administrators 4 structure search 26 Query Service concepts 4 Example 26 REpresentational State Transfer (REST) 4 Modifying exact structure "query type" Data sources 4 searches 28 Data Source Builder 5 To modify the XML file 28 Query 5 Enabling matching of total charge in Active query 5 substructure mapping of pi systems 29 Hitlist 5 To modify the XML file 29 Catalog 5 Setting up custom JAR files and configuration files 30 Metadata 5 Setting properties for shared data sources 30 Sharing data sources 6 Chapter 6: Setting Up the Query Service Closed data sources 6 Examples 32 The lifetime of a recordset 6 Setting up example protocols with the Managing lists and temporary tables 7 Research Workbench (RWB) database 32 Configuration 7 Setting up example protocols with the ACD Important files and folders 8 database 32 Setting permissions for using Web Port to run Chapter 4: Required Configuration 9 example protocols 32 Host name and port name 9 Chapter 7: Troubleshooting 34 Configuring Query Service permissions 9 Using the Query Service log file 34 Managing permissions 11 Using the Tomcat log file on Windows 34 Configuring Query Service data sources 12 Using the Tomcat log file on Linux 35 Adding and configuring relational data sources in the Pipeline Pilot Administration Using the monitor REST endpoints 36 Portal 12 Examples 36 Using the Template_rel.xml file 17 Appendix A: Installing the RWB Database 37 Using Oracle proxy accounts 17 Tables 38 Editing a relational data source 17 Views 38 Deleting a relational data source 18 Appendix B: Spanning multiple Oracle Installing Data Source Builder 18 instances 40 Creating an IDS 18 About spanning multiple Oracle instances 40 IDS workflow summary 19 IDS over Oracle materialized views 40 Advantages 40 Disadvantage 40 IDS standard data source connector 41 Advantage 41 Disadvantage 41 IDS DBLink data source connector 41 Advantage 41 Disadvantage 41 IDS INCursor data source connector 41 Advantage 42 Disadvantages 42 When to use 42 Examples 42 IDS over Oracle view of DBLinked table 43 Advantage 43 Disadvantages 43 Chapter 1: Introduction The BIOVIA Query Service is a Web service that provides client and Web applications with integrated access to corporate scientific data sources. It is supplied with BIOVIA Pipeline Pilot Server. The Query Service is an HTTP-based service implemented using a REpresentational State Transfer (REST) interface. To learn more about the REST interface, see the BIOVIA Query Service Developer’s Guide. This guide is designed for BIOVIA Pipeline Pilot Server and database administrators familiar with Oracle administration concepts and BIOVIA Pipeline Pilot developers familiar with objects in a database. Purpose of the BIOVIA Query Service Traditional scientific database systems load data into individual schemas, each system having its own client application. As the availability of external data grows, or companies merge systems, the number of database systems and platforms multiplies, and more systems are introduced to handle the increase in data. The complexity of the infrastructure increases, and data becomes difficult to manage and access across multiple systems and platforms. The Query Service solves the problem of searching across multiple data sources, by mapping the metadata of each data source to descriptive field aliases. Queries are built using these field aliases, and can be mapped onto any data source for which a corresponding mapping is provided. This method eliminates the need to migrate data or modify database schemas, and provides the flexibility to modify data sources. Query Service queries are written using the Unified Query Language (UQL). UQL has a similar syntax to the widely-used Structured Query Language (SQL). An XML query format is also available. The Query Service is compatible with Oracle databases. Query Service Client applications The client application of the Query Service can be any of the following: Pipeline Pilot Client. Access to Query Service data sources is provided by a comprehensive set of Pipeline Pilot components. A web-based application that sends RESTful HTTP requests to the Query Service and converts the response data to HTML for display on web pages. A custom client with an HTTP back end, that presents the data retrieved from the Query Service to the user in any format desired. The Query Service RESTful API The Query Service exposes a RESTful API that client applications can use to perform the following tasks: Get the metadata of a data source to determine what data can be queried Execute cataloged (i.e. stored) and ad hoc queries Combine record sets (i.e. sets of full records) or search results Introduction | Page 1 The Query Service can provide responses in various formats, including XML (the default format), XDfile, SDfile, JavaScript Object Notation (JSON), and several character-delimited formats. For more details about available response formats, see the Query Service Developer's Guide. Key features of the Query Service The following features are available: A full set of Pipeline Pilot components that provide access to all the main features of the Query Service API in a highly visual and user-friendly way. An extended RESTful API that provides client applications with greater flexibility in querying data sources. Simpler configuration of data sources using the Data Source Builder application. It is no longer necessary to edit data source configuration XML files directly. Conventions These are the conventions in this guide: References to functions, paths, and file names are presented in this font. For clarity and readability in paragraphs and tables, the font may also appear in bold. All code input and output snippets are presented in this font on a gray background. You must follow the order in a numbered list. A bulleted list has no order. Note: In this guide, {PPS installation directory} is used to represent the root folder of the BIOVIA Pipeline Pilot Server installation. On 32-bit Windows this is typically C:/Program Files/BIOVIA/PPS On 64-bit Windows this is typically C:/Program Files/BIOVIA/PPS For 32-bit installations on 64-bit Windows this is typically C:/Program Files (x86)/BIOVIA/PPS Additional information For additional information about the Query Service, see the following documentation: Query Service Developer's Guide Integrating Data Source (IDS) Guide Aggregating Data Source (ADS) Guide For more information about the Query Service and other BIOVIA software products, visit: https://community.3dsbiovia.com Page 2 | BIOVIA Query Service • Administration Guide Chapter 2: System Requirements The following requirements are specific to Query Service, and these requirements are in addition to BIOVIA Pipeline Pilot Server system requirements. Software requirements (Data Source Builder) You can use Data Source Builder to create integrating data sources and test the Query Service. Data Source Builder is available for download from the BIOVIA Pipeline Pilot Server Home page. Before using Data Source Builder, install and configure the software described below. Required software Software Version(s) Comments Microsoft .NET Framework 4.0 or 3.5 Required to run the Data Source Builder installer. Required software settings Software Version(s) Comments Apache Tomcat Virtual Standard The Query Service runs within the Apache Memory Tomcat virtual machine. There is
Recommended publications
  • Database Schema Migration Tools Open Source
    Database Schema Migration Tools Open Source Validating Darian sometimes tranquillize his barony afterwards and cast so stubbornly! Vilhelm rocket his flirt bludge round-arm or best after Worthy smuts and formulise conspiratorially, quinoidal and declaratory. Implied Ernest rinsings: he built his Kathy lexically and amorally. Does this coupon code that is ideal state can replicate for speaking with their database tools and handled it ensures data, a granular control Review the tool for migrating to? If necessary continue browsing the site, will agree specify the rush of cookies on this website. Iteratively make both necessary changes to applications. 1 Database Version Control DBMS Tools. It moves to schema migration database tools source database migration is a few clicks configuration as well as someone to. GDPR: floating video: is from consent? Openmysql rootwelcometcp1270013306migrationtest if err nil fmt. Database health Suite itself and Schema Sync across. The Top 33 Database Migrations Open Source Projects. The community edition of PDI is useful enough they perform our mystery here. Migration Supports schema migration for MySQL SQLite and PostgreSQL Reverse Engineering For existing database structures we to reverse enginering. Most schema migration tools aim to minimize the footprint of schema changes on any existing data in tally database. Contains errors, warnings, and informational messages relating to migration operations. To schema and tools with a tool allows you take years of the tooling uses the type of. But migrating data services ownership, and integrity checks will be able to other objects to use open source tools now part of. Making database schema while capturing any databases, open source endpoint to migrate to get started with constraints between data sources in an altered outside the.
    [Show full text]
  • Dbartisan Reviewers Guide
    DBArtisan® XE Product Review Guide May 2010 Americas Headquarters EMEA Headquarters Asia-Pacific Headquarters 100 California Street, 12th Floor York House L7. 313 La Trobe Street San Francisco, California 94111 18 York Road Melbourne VIC 3000 Maidenhead, Berkshire Australia SL6 1SF, United Kingdom The High Performance DBA CONTENTS Contents ..................................................................................................................................................................... - 1 - Overview ......................................................................................................................................................................... - 2 - Introduction ............................................................................................................................................................... - 2 - Product Description .................................................................................................................................................. - 2 - Contact Information .................................................................................................................................................. - 2 - DBArtisan XE Highlights ................................................................................................................................................ - 3 - New and Interesting Features of DBArtisan XE ..................................................................................................... - 3 - Key Benefits
    [Show full text]
  • Opengis Catalog Services Specification
    OGC 02-087r3 Open GIS Consortium Inc. Date: 2002-12-13 Reference number of this OpenGIS® project document: OGC 02-087r3 Version: 1.1.1 Category: OpenGIS® Implementation Specification Editor: Douglas Nebert OpenGIS® Catalog Services Specification Copyright notice This OGC document is copyright-protected by OGC. While the reproduction of drafts in any form for use by participants in the OGC standards development process is permitted without prior permission from OGC, neither this document nor any extract from it may be reproduced, stored or transmitted in any form for any other purpose without prior written permission from OGC. Document type: OpenGIS® Publicly Available Standard Document subtype: Implementation Specification Document stage: Adopted Document language: English OGC 02-087r3 Contents 1 Scope........................................................................................................................1 2 Conformance ..........................................................................................................1 3 Normative references.............................................................................................1 4 Terms and definitions............................................................................................1 5 Conventions ............................................................................................................3 5.1 Symbols (and abbreviated terms).........................................................................3 5.2 UML notation.........................................................................................................4
    [Show full text]
  • Odbc — Load, Write, Or View Data from ODBC Sources
    Title stata.com odbc — Load, write, or view data from ODBC sources Syntax Menu Description Options Remarks and examples Also see Syntax List ODBC sources to which Stata can connect odbc list Retrieve available names from specified data source odbc query "DataSourceName", verbose schema connect options List column names and types associated with specified table odbc describe "TableName", connect options Import data from an ODBC data source odbc load extvarlist if in , table("TableName") j exec("SqlStmt") load options connect options Export data to an ODBC data source odbc insert varlist if in , table("TableName") fdsn("DataSourceName") j connectionstring("ConnectionStr")g insert options connect options Allow SQL statements to be issued directly to ODBC data source odbc exec("SqlStmt") , fdsn("DataSourceName") j connectionstring("ConnectionStr")g connect options Batch job alternative to odbc exec odbc sqlfile("filename") , fdsn("DataSourceName") j connectionstring("ConnectionStr")g loud connect options Specify ODBC driver manager (Unix only) set odbcmgr iodbc j unixodbc , permanently 1 2 odbc — Load, write, or view data from ODBC sources where DataSourceName is the name of the ODBC source (database, spreadsheet, etc.) ConnectionStr is a valid ODBC connection string TableName is the name of a table within the ODBC data source SqlStmt is an SQL SELECT statement filename is pure SQL commands separated by semicolons and where extvarlist contains sqlvarname varname = sqlvarname connect options Description user(UserID) user
    [Show full text]
  • Developing Database Applications
    Developing Database Applications JBuilder® 2005 Borland Software Corporation 100 Enterprise Way Scotts Valley, California 95066-3249 www.borland.com Refer to the file deploy.html located in the redist directory of your JBuilder product for a complete list of files that you can distribute in accordance with the JBuilder License Statement and Limited Warranty. Borland Software Corporation may have patents and/or pending patent applications covering subject matter in this document. Please refer to the product CD or the About dialog box for the list of applicable patents. The furnishing of this document does not give you any license to these patents. COPYRIGHT © 1997–2004 Borland Software Corporation. All rights reserved. All Borland brand and product names are trademarks or registered trademarks of Borland Software Corporation in the United States and other countries. All other marks are the property of their respective owners. For third-party conditions and disclaimers, see the Release Notes on your JBuilder product CD. Printed in the U.S.A. JB2005database 10E13R0804 0405060708-987654321 PDF Contents Chapter 1 Chapter 4 Introduction 1 Connecting to a database 27 Chapter summaries . 2 Connecting to databases . 28 Database tutorials. 3 Adding a Database component to your Database samples . 3 application . 28 Related documentation . 4 Setting Database connection properties . 29 Documentation conventions . 6 Setting up JDataStore . 31 Developer support and resources. 7 Setting up InterBase and InterClient. 31 Contacting Borland Developer Support . 7 Using InterBase and InterClient with JBuilder . 32 Online resources. 7 Tips on using sample InterBase tables . 32 World Wide Web . 8 Adding a JDBC driver to JBuilder .
    [Show full text]
  • JDBC Driver for SQL/MP
    Contents HP JDBC/MP Driver for NonStop SQL/MP Programmer's Reference for H10 Abstract This document describes how to use the JDBC/MP Driver for NonStop SQL/MP on HP Integrity NonStop™ NS-series servers. JDBC/MP provides NonStop Server for Java applications with JDBC access to HP NonStop SQL/MP. JDBC/MP driver conforms where applicable to the standard JDBC 3.0 API from Sun Microsystems, Inc. Product Version HP JDBC/MP Driver for NonStop SQL/MP H10 Supported Hardware All HP Integrity NonStop NS-series servers Supported Release Version Updates (RVUs) This publication supports H06.04 and all subsequent H-series RVUs until otherwise indicated by its replacement publication. Part Number Published 529851-001 January 2006 Document History Part Number Product Version Published JDBC Driver for SQL/MP September 526349-002 (JDBC/MP) V21 2003 JDBC Driver for SQL/MP 527401-001 October 2003 (JDBC/MP) V30 JDBC Driver for SQL/MP 527401-002 July 2004 (JDBC/MP) V30 JDBC Driver for SQL/MP 527401-003 May 2005 (JDBC/MP) V30 and H10 JDBC/MP Driver for NonStop 529851-001 January 2006 SQL/MP H10 Legal Notices © Copyright 2006 Hewlett-Packard Development Company L.P. Confidential computer software. Valid license from HP required for possession, use or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under vendor’s standard commercial license. The information contained herein is subject to change without notice. The only warranties for HP products and services are set forth in the express warranty statements accompanying such products and services.
    [Show full text]
  • Maven Plugin for Defining Sql Schema
    Maven Plugin For Defining Sql Schema Wily Nealy never nerved so synergistically or bowses any lobules crassly. Von is unanchored and job salleeforward pander as seemly not continuously Cyrus labializing enough, grossly is Wallas and misspeaking teleological? forcibly. When Obie encouraged his The library translates to install plugin sql plugin for maven schema update scripts in the maven central character bash shell script This plugin sql schemas that defines no longer pass it is plugins will define custom webapps that. Storing the most common attack in the information regarding their projects using maven for enabling query for this argument passed to relational database. Just defining identifier attribute which would become out all maven plugin for defining sql schema changes made permanent. I am setting up first liquibase maven project told a MySQL DB. Like to sql plugin execution is useful for defining different mechanisms of jdbi provides all for maven defining sql plugin schema? Both catalog and collections have created database plugin schema to apply changes are both. Format A formatter for outputting an XML document with three pre-defined. Configuring the Alfresco Maven plugin Alfresco Documentation. The installation of the MSSQL schema was pure pain there were a turn of plain SQL files which had even be. The maven for defining and define sql schemas for uuid identifier. To load SQL statements when Hibernate ORM starts add an importsql file to the. Setting up and validating your film project Using Maven. The hibernate3-maven-plugin can dash be used to toe a schema DDL from. For maven plugin creates sql schemas, you can become.
    [Show full text]
  • Websphere Application Server V7 Administration and Configuration Guide, SG24-7615
    Chapter 9 of WebSphere Application Server V7 Administration and Configuration Guide, SG24-7615 WebSphere Application Server V7: Accessing Databases from WebSphere When an application or WebSphere® component requires access to a database, that database must be defined to WebSphere as a data source. Two basic definitions are required: A JDBC provider definition defines an existing database provider, including the type of database access that it provides and the location of the database vendor code that provides the implementation. A data source definition defines which JDBC provider to use, the name and location of the database, and other connection properties. In this chapter, we discuss the various considerations for accessing databases from WebSphere. We cover the following topics: “JDBC resources” on page 2 “Steps in defining access to a database” on page 7 “Example: Connecting to an IBM DB2 database” on page 9 “Example: Connecting to an Oracle database” on page 17 “Example: Connecting to an SQL Server database” on page 24 “Example: Connecting to an Informix Dynamic Server database” on page 30 “Configuring connection pooling properties” on page 36 © Copyright IBM Corp. 2009-2010. All rights reserved. 1 JDBC resources The JDBC API provides a programming interface for data access of relational databases from the Java™ programming language. WebSphere Application Server V7 supports the following JDBC APIs: JDBC 4.0 (New in V7) JDBC 3.0 JDBC 2.1 and Optional Package API (2.0) In the following sections, we explain how to create and configure data source objects for use by JDBC applications. This method is the recommended method to connect to a database and the only method if you intend to use connection pooling and distributed transactions.
    [Show full text]
  • SMS 2.0 ODBC Launch Kit
    SMS 2.0 ODBC Launch Kit _________________________________________________________________________________________________________ Table of Contents WHAT IS ODBC? .............................................................................................................................................................................. 3 WHAT PRODUCTS USE ODBC TO ACCESS THE SKYWARD DATABASE? ...................................................................... 3 ODBC/JDBC DRIVERS .................................................................................................................................................................... 3 SKYWARD CUSTOM REPORTING OPTIONS........................................................................................................................... 3 ODBC DRIVER INSTALL METHODS .......................................................................................................................................... 4 INSTALLING AN ODBC DRIVER ON A NON-SKYWARD COMPUTER; WORKSTATION OR SERVER. .................... 6 WHERE DO I FIND THE IP ADDRESS OF A SKYWARD DATABASE SERVER?............................................................. 10 WHAT IS THE STANDARD SQL PORT NUMBER OF A SKYWARD DATABASE? .......................................................... 11 WHERE DO I FIND THE SQL PORT NUMBER OF A SKYWARD DATABASE?............................................................... 11 WHAT ARE READ-ONLY ODBC USERS IN A SKYWARD DATABASE? ..........................................................................
    [Show full text]
  • IDL Dataminer Guide
    IDL DataMiner Guide IDL Version 6.3 April 2006 Edition Copyright © RSI All Rights Reserved 0406IDL63DM Restricted Rights Notice The IDL®, ION Script™, and ION Java™ software programs and the accompanying procedures, functions, and documentation described herein are sold under license agreement. Their use, dupli- cation, and disclosure are subject to the restrictions stated in the license agreement. RSI reserves the right to make changes to this document at any time and without notice. Limitation of Warranty RSI makes no warranties, either express or implied, as to any matter not expressly set forth in the license agreement, including without limitation the condition of the software, merchantability, or fitness for any particular purpose. RSI shall not be liable for any direct, consequential, or other damages suffered by the Licensee or any others resulting from use of the IDL or ION software packages or their documentation. Permission to Reproduce this Manual If you are a licensed user of this product, RSI grants you a limited, nontransferable license to repro- duce this particular document provided such copies are for your use only and are not sold or dis- tributed to third parties. All such copies must contain the title page and this notice page in their entirety. Acknowledgments IDL® is a registered trademark and ION™, ION Script™, ION Java™, are trademarks of ITT Industries, registered in the United States Patent and Trademark Office, for the computer program described herein. Numerical Recipes™ is a trademark of Numerical Recipes Software. Numerical Recipes routines are used by permission. GRG2™ is a trademark of Windward Technologies, Inc.
    [Show full text]
  • Data Sources
    Data Sources • Data Source Overview, on page 1 • Data Source Rules, on page 1 • Streaming Data Source, on page 2 • Create or Edit a Query Based Data Source, on page 2 • Switch Nodes to a Data Source, on page 3 • Delete a Data Source, on page 4 Data Source Overview Unified Intelligence Center supports the following types of data sources: • Query based SQL Data Source • Microsoft SQL server • IBM informix • Streaming Data Source Data Source Rules • Set up a database with an SQL user account and password, with read-only permission for the database. • The database server must allow SQL authentication to enable TCP/IP and remote network connection. • Do not block the database port by firewalls or any other security software (such as Cisco Security Agent). Note Windows integrated authentication connection to MS SQL Server is not supported. Data Sources 1 Data Sources Streaming Data Source Streaming Data Source Live Data report uses Streaming data source. This is a stock data source in Unified Intelligence Center and the fields are not editable. On the data source listing page, the primary and secondary host name or IP address is displayed. Figure 1: Data Source Page Note When you launch the data source listing page, a new tab displays to accept certificates. Create or Edit a Query Based Data Source A data source can be created or edited only by users with System Configuration Administrator role. To create a data source, follow the steps below. Procedure Step 1 Click the Data Sources drawer. Step 2 In the Data Sources tab, click Create.
    [Show full text]
  • Micro Focus Fortify Software Security Center User Guide
    Micro Focus Fortify Software Security Center Software Version: 19.2.0 User Guide Document Release Date: December 2019 Software Release Date: November 2019 User Guide Legal Notices Micro Focus The Lawn 22-30 Old Bath Road Newbury, Berkshire RG14 1QN UK https://www.microfocus.com Warranty The only warranties for products and services of Micro Focus and its affiliates and licensors (“Micro Focus”) are set forth in the express warranty statements accompanying such products and services. Nothing herein should be construed as constituting an additional warranty. Micro Focus shall not be liable for technical or editorial errors or omissions contained herein. The information contained herein is subject to change without notice. Restricted Rights Legend Confidential computer software. Except as specifically indicated otherwise, a valid license from Micro Focus is required for possession, use or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under vendor's standard commercial license. Copyright Notice © Copyright 2008 - 2019 Micro Focus or one of its affiliates Trademark Notices Adobe™ is a trademark of Adobe Systems Incorporated. Microsoft® and Windows® are U.S. registered trademarks of Microsoft Corporation. UNIX® is a registered trademark of The Open Group. Documentation Updates The title page of this document contains the following identifying information: l Software Version number l Document Release Date, which changes each time the document is updated l Software Release Date, which indicates the release date of this version of the software This document was produced on December 12, 2019.
    [Show full text]