INSTALLATION GUIDE | PUBLIC SAP IQ 16.1 SP 04 Document Version: 1.0.0 – 2019-04-05
SAP IQ Installation and Update Guide for Windows company. All rights reserved. affiliate
THE BEST RUN 2019 SAP SE or an SAP © Content
1 SAP IQ Installation and Update Guide for Windows...... 6
2 Installation Overview...... 7 2.1 You are Here in the Implementation Process...... 7 2.2 Who Should Read This Document?...... 9 2.3 What is SAP IQ?...... 9 2.4 By the End of This Document, I Should be Able to...... 9
3 Learn What's New and Changed...... 11 3.1 Where This Guide Resides in the Information Landscape...... 11 3.2 Where Do I Find Help?...... 12
4 Supported Server and Client Operating Systems...... 13
5 Plan the Installation...... 14 5.1 Installation Types...... 14 Do I Need the SAP IQ Client? ...... 15 Virtualized Environments...... 16 5.2 Product Components...... 16 Typical or Custom Installation?...... 17 SAP IQ Server Components...... 17 SAP IQ Client Components...... 18 SAP IQ Database Administration Tool...... 19 5.3 License Requirements...... 19 Evaluation Edition...... 21 Express Edition...... 21 Enterprise Edition and Licensed Options...... 21 License Deployment...... 22 Before You Generate Licenses...... 31 5.4 Storage Options...... 37 Avoiding Environmental Issues...... 38 5.5 Network Options...... 38 Network Clients and ODBC Kits...... 39 5.6 Product Compatibilities...... 39 5.7 Planning Checklist...... 39
6 Preinstallation Tasks...... 41 6.1 Check for Operating System Patches...... 41
SAP IQ Installation and Update Guide for Windows 2 PUBLIC Content 6.2 Increase the Swap Space...... 42 6.3 Check Port Availability for SAP IQ Cockpit...... 42 6.4 Verify Network Functionality...... 42 6.5 Platform-Specific Tasks...... 42 Install MS Visual C++ Redistributable Packages...... 43 Windows Support Issues...... 43 6.6 Create the SAP IQ Account...... 45 6.7 Download Installation Files...... 46
7 Installing SySAM License Server...... 47 7.1 Set Windows 2012 R2 Compatibility Mode for SAP IQ Installer...... 48 7.2 Installing SySAM in GUI Mode...... 48 7.3 Installing SySAM in Console Mode...... 49 7.4 Starting and Stopping a SySAM License Server...... 50 7.5 Apply or Update Licenses on the SySAM License Server...... 51 7.6 Understanding the SySAM Directory Structure...... 52 7.7 SySAM Utilities...... 53 Using SySAM Utilities...... 54
8 Installing SAP IQ Server Software...... 55 8.1 Installing a Server in GUI Mode...... 56 8.2 Installing a Server in Console Mode...... 58 8.3 Installing a Server in Unattended (Silent) Mode...... 61 Creating a Server Response File...... 61 Installing a Server Using a Response File...... 63 8.4 Server Environment Variables...... 65 8.5 Finding Server Utilities and Files...... 65 8.6 Reviewing Server Installation Logs...... 68
9 Installing SAP IQ Client Software...... 70 9.1 Set Windows 2012 R2 Compatibility Mode for SAP IQ Installer...... 71 9.2 Running the Client and Server on the Same System...... 71 9.3 Installing a Client in GUI Mode...... 71 9.4 Installing a Client in Console Mode...... 73 9.5 Installing a Client in Unattended (Silent) Mode...... 74 Creating a Client Response File...... 75 Installing a Client Using a Response File...... 76 9.6 Client Environment Variables...... 78 9.7 Finding Client Utilities and Files...... 78 9.8 Reviewing Client Installation Logs...... 80 9.9 Configuring Client Connectivity...... 80 Connecting Using ODBC...... 81
SAP IQ Installation and Update Guide for Windows Content PUBLIC 3 Connecting Using JDBC...... 84 Connecting Using OLE DB...... 84 Connecting Using Open Client...... 84 Network Issues for SAP IQ Servers...... 85 Connecting Across a Firewall...... 86
10 Postinstallation Tasks...... 88 10.1 (Optional) The Demo Database...... 89 Creating the Demo Database...... 89 Starting and Stopping the Demo Database...... 90 Removing the Demo Database...... 90 10.2 (Optional) The SAP IQ Utility Server...... 91 Starting and Stopping the SAP IQ Utility Server...... 91 10.3 Setting Up Your Environment...... 92 Installation Directory Structure...... 92 How SAP IQ Locates Files...... 93 Environment Variables...... 95 Registry Entries...... 104 10.4 Licensing After Installation...... 106 Verifying and Authorizing Optional Licensed Components...... 106 Applying an Unserved License...... 107 Applying a Served License...... 108 10.5 Starting and Running an SAP IQ Server...... 109 10.6 Stopping an SAP IQ Server...... 111 10.7 Starting and Stopping the SAP IQ Cockpit Agent...... 113 10.8 Stopping the SAP IQ Cockpit Agent...... 113 10.9 Configuration ...... 114 Using Configuration Files...... 114 Running SAP IQ as a Windows Service...... 115 10.10 Remove Sample Application Files...... 117 10.11 Starting Interactive SQL...... 117 10.12 Verify an SAP IQ Server Is Running...... 118 10.13 Verify SAP IQ Server Is Licensed...... 119
11 What's Next?...... 121 Create Your Production Database...... 121
12 Troubleshooting Your Installation...... 122 12.1 What to do When the Installation Fails...... 122 Installation Fails with Error Messages...... 123 Installation on Windows 2012 R2 Fails...... 124 Installation from a Remote Directory Fails...... 124
SAP IQ Installation and Update Guide for Windows 4 PUBLIC Content 12.2 Licensing...... 124 12.3 Do Not Install SAP IQ into the Same Directory as Other Products...... 125 12.4 Client Suite Installation Finishes, but with Errors ...... 125 12.5 Uninstalling in Silent Mode does not Echo any Response...... 126 12.6 Database Upgrade Issues...... 126 12.7 SAP IQ and Other SAP Products...... 127 12.8 Installing New System Tables Requires ALTER DATABASE UPGRADE PROCEDURE ON...... 128
13 Uninstalling SAP IQ...... 129 13.1 Set Windows 2012 R2 Compatibility Mode for SAP IQ Uninstaller...... 129 13.2 Uninstalling SAP IQ Software...... 130 Using GUI Mode...... 130 Using Console Mode...... 130 Using Unattended (Silent) Mode...... 131
14 Upgrade to SAP IQ 16.1 SP 04...... 132 14.1 Supported Upgrade Scenarios...... 132 14.2 SAP IQ 16.x Upgrades...... 133 SAP IQ 16.x Pre-upgrade Tasks...... 133 Install SAP IQ 16.1 SP 04...... 136 Upgrade the 16.x Database...... 136 SAP IQ 16.x Postupgrade Tasks...... 137 14.3 SAP IQ 15.4.x Upgrades...... 138 SAP IQ 15.4.x Pre-upgrade tasks...... 139 Install SAP IQ 16.1 SP 04...... 142 Upgrade 15.4.x Database...... 143 SAP IQ 15.4.x Postupgrade Tasks...... 144 14.4 SAP IQ Database Administration Tool...... 199 14.5 SAP IQ 12.7 Upgrade and Database Migration...... 199 Preparing to Migrate...... 200 Migration Utilities...... 201 Migration Issues...... 208 Unloading Legacy Schemas...... 216 Migrating Legacy Databases...... 216 Postmigration Tasks...... 233 14.6 Hardware Changes...... 236 Moving 32-Bit Databases to 64-Bit Platforms...... 237 Converting to a New Hardware Platform...... 238
SAP IQ Installation and Update Guide for Windows Content PUBLIC 5 1 SAP IQ Installation and Update Guide for Windows
Installation and configuration procedures for Windows platforms.
SAP IQ Installation and Update Guide for Windows 6 PUBLIC SAP IQ Installation and Update Guide for Windows 2 Installation Overview
In this section:
You are Here in the Implementation Process [page 7] This guide assumes the evaluator/purchaser has already planned and sized the hardware for your SAP IQ implementation.
Who Should Read This Document? [page 9] This installation guide is intended for three SAP IQ audiences with different skill sets and knowledge: the evaluator/purchaser, the installer, and the network administrator.
What is SAP IQ? [page 9] SAP IQ is a highly optimized analytics server designed specifically to deliver superior performance for mission-critical business intelligence, analytics and data warehousing solutions.
By the End of This Document, I Should be Able to... [page 9] When you complete this document, you will have an initial installation ready to provision with your production data and settings.
2.1 You are Here in the Implementation Process
This guide assumes the evaluator/purchaser has already planned and sized the hardware for your SAP IQ implementation.
There are four stages to the implementation process:
SAP IQ Installation and Update Guide for Windows Installation Overview PUBLIC 7 Size Your Hardware
Set up your hardware. The SAP IQ Hardware Sizing Guide provides important hardware sizing information for all supported platforms. Sizing guidelines include:
● CPUs, cores, and processors ● Memory ● Storage ● Network ● Page sizes ● Threads
See the SAP IQ Hardware Sizing Guide on the SAP Community Network .
Create Production System
Create and manage your production database. Create and manage users.
See SAP IQ Administration: Database.
Tune Production System
Tune your production database for optimal performance.
See the SAP IQ Performance and Tuning Series: Basics.
Related Information
Where This Guide Resides in the Information Landscape [page 11]
SAP IQ Installation and Update Guide for Windows 8 PUBLIC Installation Overview 2.2 Who Should Read This Document?
This installation guide is intended for three SAP IQ audiences with different skill sets and knowledge: the evaluator/purchaser, the installer, and the network administrator.
Audience Description
Evaluator/purchaser The individual who makes the purchasing decision and determines the scale of the imple mentation, including simplex versus multiplex, the licensing model, and which licensable op tions to include.
The installation workflow in this guide assumes the purchaser/evaluator has already made these decisions.
Installer The individual who installs and configures SAP IQ server and client.
The installer might be the network administrator, or it might be someone without network administration privileges and training.
Network Administrator The individual responsible for hardware and OS setup.
If a task in this guide is not intended for all audiences, the task will state which audience the task applies to.
2.3 What is SAP IQ?
SAP IQ is a highly optimized analytics server designed specifically to deliver superior performance for mission- critical business intelligence, analytics and data warehousing solutions.
To learn more about SAP IQ, see Introduction to SAP IQ.
2.4 By the End of This Document, I Should be Able to...
When you complete this document, you will have an initial installation ready to provision with your production data and settings.
When you've finished this document, you'll have:
● A licensed and installed SAP IQ server ● A licensed and installed SAP IQ client ● A running initial database for testing your installation ● A running Interactive SQL session ● A running SAP IQ Cockpit instance ● Basic configuration settings
You are then ready to create your production environment.
SAP IQ Installation and Update Guide for Windows Installation Overview PUBLIC 9 See What's Next? [page 121] and You are Here in the Implementation Process [page 7].
Related Information
You are Here in the Implementation Process [page 7] What's Next? [page 121]
SAP IQ Installation and Update Guide for Windows 10 PUBLIC Installation Overview 3 Learn What's New and Changed
Locate information on what's new and changed in this release, locate sizing information, and find answers to commonly asked questions.
See Release Notes: What's Changed in SAP IQ 16.1 (SP 01 to SP 04) on the SAP Help Portal for information on what's new, changed, and removed in the latest SAP IQ 16.1 Support Package, and previous Support Packages.
In this section:
Where This Guide Resides in the Information Landscape [page 11] Supporting documentation resources can help you with installation and configuration. Learn how this guide relates to other commonly-used SAP IQ documentation resources.
Where Do I Find Help? [page 12] Find SAP IQ help on the SAP Help Portal, and on the Support Portal.
3.1 Where This Guide Resides in the Information Landscape
Supporting documentation resources can help you with installation and configuration. Learn how this guide relates to other commonly-used SAP IQ documentation resources.
When installing or upgrading SAP IQ, you'll need to refer to other documents to understand important changes in the software, learn how to create a productive database, and learn how to add users to your system. These documentation resources help you become productive as quickly as possible:
SAP Notes
Latest known issues for this release. Access the central SAP Note for this release of SAP IQ from the What's New section on the SAP Help Portal.
Release Notes: What's Changed in SAP IQ 16.1 (SP 01 to SP 04)
Information on what's new, changed, and removed in the latest SAP IQ 16.1 Support Package, and all previous Support Packages. See Release Notes: What's Changed in SAP IQ 16.1 (SP 01 to SP 04).
SAP IQ Installation and Update Guide for Windows Learn What's New and Changed PUBLIC 11 SySAM Users Guide
Additional information about the SySAM product licensing and asset management system used by SAP IQ. The guide contains instructions for establishing and administering SySAM licenses. See the SySAM Users Guide.
Getting Started With SAP IQ
The Getting Started With SAP IQ guide assumes you've completed the tasks in this installation guide and have a licensed and working SAP IQ installation. Use Getting Started With SAP IQ to create your production database.
SAP IQ Administration: User Management and Security
Add users to your system and implement role-based security.
SAP IQ Cockpit
Without access to the SAP IQ Cockpit, you cannot use the Create Database wizard to create your initial server. See SAP IQ Cockpit.
3.2 Where Do I Find Help?
Find SAP IQ help on the SAP Help Portal, and on the Support Portal.
See product documentation on the SAP Help Portal – online documentation you access using a standard Web browser. You can browse documents online or download them as PDFs. There are links to SAP IQ videos, and links to the SAP Community Network.
For technical support, visit the Support Portal . From the Support Portal, you can report an incident for technical assistance, or contact the Support team for non-technical assistance.
SAP IQ Installation and Update Guide for Windows 12 PUBLIC Learn What's New and Changed 4 Supported Server and Client Operating Systems
SAP IQ is compatible with several platforms and operating systems.
Supported Server Operating Systems
For the latest list of supported server operating systems, see SAP Note 2669590 SAP IQ 16.1 SP 04 Supported Operating Systems and Versions.
Supported Client Operating Systems
For the latest list of supported network client versions, see SAP Note 2669590 SAP IQ 16.1 SP 04 Supported Operating Systems and Versions.
SAP IQ Installation and Update Guide for Windows Supported Server and Client Operating Systems PUBLIC 13 5 Plan the Installation
Before you install, you need to choose the type of installation and the components to install. You should also consider options for database storage, component licensing, and network configuration.
In this section:
Installation Types [page 14] Decide which installation type you need. You can install SAP IQ as a server or install only the software components that allow client connections to an SAP IQ server.
Product Components [page 16] Choose the components to install based on how you plan to use SAP IQ.
License Requirements [page 19] SAP IQ requires a product license for each product edition except the Evaluation Edition. You also need separate licenses for any optional features available for your edition.
Storage Options [page 37] Consider the storage options for your database system before installation.
Network Options [page 38] Do you plan to take advantage of SAP IQ distributed query processing? Distributed query processing can benefit from an optional high-speed interconnect. Use scalable interconnect technology to connect multiplex nodes.
Product Compatibilities [page 39] Information about the compatibility of SAP IQ with other products.
Planning Checklist [page 39] As you plan your installation, record your decisions on the planning checklist. Refer to the checklist when you respond to installation prompts.
5.1 Installation Types
Decide which installation type you need. You can install SAP IQ as a server or install only the software components that allow client connections to an SAP IQ server.
To install SAP IQ server components and the administration tool, install SAP IQ Server Suite. To install the components required for client connections to an SAP IQ, install the SAP IQ Client Suite. Record your choice in the planning checklist for future reference.
You can also choose to install certain components from either installation type. See Typical or Custom Installation? [page 17]
In this section:
Do I Need the SAP IQ Client? [page 15]
SAP IQ Installation and Update Guide for Windows 14 PUBLIC Plan the Installation If you develop applications to access data on an SAP IQ server, and your client application resides on a different platform from the SAP IQ server, you must install the appropriate SAP IQ client.
Virtualized Environments [page 16] SAP IQ is supported on virtualization engines, such as VMWare vSphere, with some restrictions.
Related Information
Served License Deployment Model [page 23] SAP IQ Database Administration Tool [page 19] Typical or Custom Installation? [page 17] SAP IQ Server Components [page 17] SAP IQ Client Components [page 18] Planning Checklist [page 39]
5.1.1 Do I Need the SAP IQ Client?
If you develop applications to access data on an SAP IQ server, and your client application resides on a different platform from the SAP IQ server, you must install the appropriate SAP IQ client.
Basically, you need an SAP IQ client installed on each machine where client applications reside. When installed on the SAP IQ server, the SAP IQ server can access SAP IQ on a remote server. For the contents of the SAP IQ Client Suite, see SAP IQ Client Components [page 18].
These examples will help you choose the right client products for your hardware and O/S platform.
If you are ... You need ... For example ...
Developing applications on one plat An SAP IQ client on each platform If you develop client applications on the form to access SAP IQ server on an where the client applications reside. Windows platform to access data in an other platform. SAP IQ server on Linux, install:
● SAP IQ client on Windows
Running queries against remote data An SAP IQ client on the platform where If you plan to run queries on your Linux sources. Queries may combine data you will run queries. In this case, you server but access data stored on both from two SAP IQ databases on different might install an SAP IQ server and an the Linux server and an HP server, in platforms. SAP IQ client on the same machine. Re stall: mote data accessed through the client ● SAP IQ client on Linux will be queried as a proxy table.
Developing a web client application. An SAP IQ client on the application If you have a web client application on server's machine, not the machine HP that queries the server on Linux, but where the browser runs. you run the app through a browser on a Windows system, install:
● SAP IQ client on HP
SAP IQ Installation and Update Guide for Windows Plan the Installation PUBLIC 15 5.1.2 Virtualized Environments
SAP IQ is supported on virtualization engines, such as VMWare vSphere, with some restrictions.
● The virtual machine environments must be officially certified and approved by the corresponding operating system platform vendor. ● The operating system running in the virtual machine is already officially certified by SAP for SAP IQ. If an issue cannot be reproduced, then the customer may be asked to reproduce the problem running natively on the certified operating system, without the use of such virtualization systems. ● The extent of support does not cover performance. SAP does not guarantee the performance of SAP IQ products running on virtual machines.
SAP IQ licenses are valid for both physical and virtual environments.
SAP IQ uses SySAM for licensing and supports its sub-capacity licensing feature. See the SySAM Users Guide for more information if you run SAP IQ in a virtualized environment.
5.2 Product Components
Choose the components to install based on how you plan to use SAP IQ.
To create a custom server or client installation, just deselect any default components that you don't want, and add those optional components that you need. See Typical or Custom Installation? [page 17]
In this section:
Typical or Custom Installation? [page 17] A typical SAP IQ installation includes all of the software components that you need, but you may add optional components or remove components to create a custom installation.
SAP IQ Server Components [page 17] The SAP IQ Server Suite groups components by feature. A typical installation installs those components marked as default. Components not marked as default are options that you may add to a custom installation.
SAP IQ Client Components [page 18] Client components are grouped by feature. Items marked as default are installed in a typical installation. Optional items can be installed in a custom installation.
SAP IQ Database Administration Tool [page 19] Use SAP IQ Cockpit 4.0, a Web-based interface, to perform SAP IQ database administration tasks.
Related Information
Planning Checklist [page 39]
SAP IQ Installation and Update Guide for Windows 16 PUBLIC Plan the Installation 5.2.1 Typical or Custom Installation?
A typical SAP IQ installation includes all of the software components that you need, but you may add optional components or remove components to create a custom installation.
For example, if you have numerous servers licensed for SAP products that require SySAM licensing, you might want to install the SySAM License Server to manage all of the licenses across your system. You must use an SAP IQ custom installation to install the SySAM License Server, which is an optional component.
SAP IQ Server Components [page 17] and SAP IQ Client Components [page 18] describe all of the default and optional components. See Served License Deployment Model [page 23] for more information about this component.
5.2.2 SAP IQ Server Components
The SAP IQ Server Suite groups components by feature. A typical installation installs those components marked as default. Components not marked as default are options that you may add to a custom installation.
SAP IQ
SAP IQ installs a high performance relational database management system and data analytics tools.
Components Default Description
SAP IQ Server X Installs server software and additional Connectivity Language Mod ules to support character sets for Eastern Europe, Turkey, and Greece.
SAP IQ Client X Installs graphical and command-line utilities used to connect to an SAP IQ Server.
SAP IQ Web Drivers X Drivers for Perl, Python, and Ruby used to connect to SAP IQ data bases from web-based or standalone applications.
SAP IQ ODBC Driver X Installs drivers for the Open Database Connectivity standard; they are used to connect to SAP IQ databases from ODBC-aware appli cations, client tools, ODBC drivers, and Web application develop ment tools.
Cockpit Framework
Cockpit Framework installs the framework in which SAP products can install components for managing and monitoring SAP resources.
SAP IQ Installation and Update Guide for Windows Plan the Installation PUBLIC 17 Components Default Description
SAP IQ Cockpit X SAP IQ Cockpit is a personalized work center for SAP IQ, which provides SAP IQ SP 04 management capabilities in a graphical en vironment.
SAP jConnect
Components Default Description
SAP jConnect for JDBC X SAP jConnect is a Type 4 JDBC driver, which is entirely Java-based. SAP jConnect is JDBC 4.0-compliant.
SySAM
Components Default Description
SySAM License Server Installs FLEXnet Licensing utilities to support your licensing model. The SySAM License Server provides the ability to create a central license server from which multiple installed SAP products can re trieve licenses.
SySAM License Utilities X The SySAM License Utilities are a set of programs that provide li cense administration, reporting and diagnostic information. It is recommended that these utilities be installed on every machine that an SAP product is installed on.
Drivers for PHP are not included in SAP IQ installation package. See http://php.net for more information.
5.2.3 SAP IQ Client Components
Client components are grouped by feature. Items marked as default are installed in a typical installation. Optional items can be installed in a custom installation.
SAP IQ
SAP IQ Installs graphical and command-line utilities used to connect to an SAP IQ Server, Web application development tools, and ODBC drivers.
SAP IQ Installation and Update Guide for Windows 18 PUBLIC Plan the Installation Components Default Notes
SAP IQ Client X Installs graphical and command-line utilities used to connect to an SAP IQ Server.
SAP IQ Web Drivers X Drivers for Perl, Python, and Ruby used to connect to SAP IQ data bases from web-based or standalone applications.
SAP IQ ODBC Driver X Installs drivers for the Open Database Connectivity standard; they are used to connect to SAP IQ databases from ODBC-aware appli cations, client tools, ODBC drivers, and Web application develop ment tools.
Drivers for PHP are not included in SAP IQ installation package. See http://php.net for more information.
SAP jConnect
Components Default Notes
SAP jConnect for JDBC X SAP jConnect is a Type 4 JDBC driver, which is entirely Java- based. SAP jConnect is JDBC 4.0-compliant.
5.2.4 SAP IQ Database Administration Tool
Use SAP IQ Cockpit 4.0, a Web-based interface, to perform SAP IQ database administration tasks.
SAP IQ Cockpit provides a view specific to your SAP IQ installation and full access to all its features.
See SAP IQ Cockpit for more details.
5.3 License Requirements
SAP IQ requires a product license for each product edition except the Evaluation Edition. You also need separate licenses for any optional features available for your edition.
Read this section to decide:
● What licenses you need. ● Whether you want to manage and distribute licenses from a network license server.
You can manage licenses using the network license server (served licenses), or manage licenses individually yourself (unserved licenses). See License Deployment [page 22].
Whether you install a licensed or evaluation edition, you have 90-day access to all features and options. To use an option beyond the 90-day evaluation period, you must purchase and install an appropriate license. The SySAM licensing mechanism lets your system administrator enable and monitor the site's use of SAP products.
SAP IQ Installation and Update Guide for Windows Plan the Installation PUBLIC 19 Because using an unlicensed option on a licensed server can cause the server to shut down when the initial grace period expires, the DBA must explicitly authorize access to an optionally licensed feature. SAP IQ will not try to check out an optional license by default. Unless the DBA grants access to an option, the option is unavailable.
Note
SAP IQ periodically checks the number of processors it can use and attempts to check out additional licenses for any increase. SAP IQ shuts down after 90 days if additional licenses are not made available within this period.
When you purchase an SAP product, you receive an e-mail message that tells you how to generate SAP IQ license keys on the Web. The e-mail message also provides specific product and licensing information. Use this information when you generate your licenses.
After installation, you can view and change the license management configuration and enable or disable optional licenses. See Verifying and Authorizing Optional Licensed Components [page 106] for information about authorizing optional features and other issues related to license management configuration.
In this section:
Evaluation Edition [page 21] The Evaluation Edition does not require a license. The Evaluation Edition is an unlicensed server, which provides full access to all features and options available in the Enterprise Edition. To run an unlicensed database beyond a 30-day evaluation period, however, you must purchase and install an appropriate license.
Express Edition [page 21] Unlike the Evaluation Edition, the Express Edition does not expire, but does place some limits on the way you deploy your server.
Enterprise Edition and Licensed Options [page 21] SAP IQ Enterprise Edition requires a CPU license and supports several licensing options.
License Deployment [page 22] Before you generate a license for SAP IQ, determine the license deployment model.
Before You Generate Licenses [page 31] Have the necessary information available before generating licenses.
Related Information
Planning Checklist [page 39]
SAP IQ Installation and Update Guide for Windows 20 PUBLIC Plan the Installation 5.3.1 Evaluation Edition
The Evaluation Edition does not require a license. The Evaluation Edition is an unlicensed server, which provides full access to all features and options available in the Enterprise Edition. To run an unlicensed database beyond a 30-day evaluation period, however, you must purchase and install an appropriate license.
5.3.2 Express Edition
Unlike the Evaluation Edition, the Express Edition does not expire, but does place some limits on the way you deploy your server.
Available at no cost, the SAP IQ Express Edition supports all options and features available in the Evaluation Edition, and includes an IQ_XE SySAM license, which is installed as part of the Express Edition server package. You won't need a SySAM license server for this edition.
Unlike the Evaluation Edition, which limits server access to a 30-day appraisal period, the IQ_XE SySAM license does not expire. However, the IQ_XE SySAM license restricts the aggregated size of all IQ main dbspaces to a size of 5 GB or less. The SAP IQ Express Edition is not eligible for production deployment and is not supported by SAP Customer Service and Support (CS&S).
5.3.3 Enterprise Edition and Licensed Options
SAP IQ Enterprise Edition requires a CPU license and supports several licensing options.
Orderable License Actual License Description
CPU IQ_CORE Restricts the number of cores (not CPUs) that a server can use.
VLDB MO IQ_VLDBMGMT Allows you to create multiple tablespaces and additional dbspaces beyond the defaults:
● You are allowed one IQ_SYSTEM_TEMP dbspace, one IQ_SYSTEM_MAIN dbspace, one IQ_SHARED_TEMP, and one additional user defined main store dbspace. ● Additional dbspaces require the IQ_VLDBMGMT license, which restricts the ability to create table partitions. An IQ_VLDBMGMT is required whenever an SAP IQ server creates or starts with two or more IQ user dbspaces.
Each VLDB license allows for 1 TB of storage. You will need to purchase one license for each additional TB of storage in the main store.
If you are not licensed for the IQ_VLDBMGMT option, SAP IQ returns a No such feature exists error when you try to create more than one ta ble partition or user dbspace.
SAP IQ Installation and Update Guide for Windows Plan the Installation PUBLIC 21 Orderable License Actual License Description
ASO IQ_SECURITY Allows you to use column encryption, ECC Kerberos and FIPS. The number of ASO licenses must match the number of cores.
MPXO IQ_MPXNODE Allows you to start secondary multiplex nodes (readers/writers). The num ber of nodes must always be less than the number of cores, as each multi plex server must have at least one core.
IDBA-PSO IQ_UDF Allows you to define and run high-performance scalar and aggregate user- defined functions.
This license is only available with approved third-party libraries.
IQ_IDA Allows you to build, deploy and run your own C/C++ V4 User-Defined Func tions (UDF).
The IQ_IDA license will function as both the InDatabase Analytics Option and Partner Solutions license.
UDA IQ_UDA Allows you to use the IQ Text Search functionality, which lets SAP IQ search unstructured and semi-structured data. An IQ_UDA also includes an IQ_LOB license. This license applies to TEXT indexes.
5.3.4 License Deployment
Before you generate a license for SAP IQ, determine the license deployment model.
● The served license model – licenses are deployed to one or more SySAM license servers. Using a license server simplifies and centralizes license administration if you run SAP IQ on several machines, as doing so provides more control over software assets. ● The unserved license model – you generate and download a separate license for each machine where the SAP IQ server runs.
In this section:
Served License Deployment Model [page 23] The license server is a lightweight application that serves licenses to products running on any operating system.
Unserved License Deployment Model [page 23] Under an unserved model, licenses are installed locally and always available.
Comparing the License Deployment Models [page 24] Compare the characteristics between the served and unserved license models to determine which setup works best for your environment.
Using SAP IQ When the License Server is Offline [page 24] Even when a SySAM-enabled product is disconnected from its license server, SySAM allows you to borrow licenses for your product to work offline.
How SySAM Checks Out Licenses [page 25]
SAP IQ Installation and Update Guide for Windows 22 PUBLIC Plan the Installation SAP SySAM related products check out licenses on start-up, and perform periodic heartbeat checks to verify that licenses remain available. If a license is unavailable, the product determines whether it can be awarded a grace period.
Common License Deployment Scenarios [page 25] Learn about some typical license server deployment scenarios and suggestions for a SySAM setup that best serves each scenario. You can mix and match the suggested configurations with other variations, to best suit your needs.
5.3.4.1 Served License Deployment Model
The license server is a lightweight application that serves licenses to products running on any operating system.
When you choose the served license deployment model, licenses are deployed to one or more SySAM license servers.
A license server can run on a low-end machine or a machine with spare cycles. For example, a license server running on a Solaris UltraSparc-60 serving 100 different licenses to 200 product instances, may use 50 MB of memory, 5 minutes of CPU time per week, and 100 MB of disk space per year.
After you install the required license servers and generate served licenses, install your products. You can configure the products to obtain licenses from one or more license servers.
Note
You cannot start the license server until there is at least one served license saved to the licenses directory on the license server host machine.
5.3.4.2 Unserved License Deployment Model
Under an unserved model, licenses are installed locally and always available.
Obtain licenses and save them individually on the machines where SAP IQ will run. You will be responsible for updating licenses when required.
SAP IQ Installation and Update Guide for Windows Plan the Installation PUBLIC 23 5.3.4.3 Comparing the License Deployment Models
Compare the characteristics between the served and unserved license models to determine which setup works best for your environment.
Unserved Served
Licenses are used only on the machine for which the license Licenses can be distributed from a network license server to was generated. SAP IQ servers running on any machine within the network.
Obtain licenses and save them individually on the machines Obtain licenses and save all of them on the license server where SAP IQ will run. host machine.
When new licenses are required for SAP IQ updates, you up When new licenses are required for SAP IQ updates, you up date and deploy each license for each machine where the date all licenses for a specific license server in a single step. SAP IQ update will run.
Licenses are installed locally and always available. Requires a functioning license server and network. If either of these fails, you install an alternate license server or fix the problem before the SAP IQ grace period expires.
If a machine where SAP IQ is running fails, you regenerate all If a machine where SAP IQ is running fails, you move the of its licenses and deploy those licenses to the replacement product to a new machine, where it acquires licenses from machine. the running license server.
If the license server host machine fails, the Manage License Hosts functionality at SMP or SPDC allows you to move its licenses to a new network license server host.
License files are distributed across each machine running License files are centrally located and managed. SAP IQ, and therefore are difficult to manage and control.
Unserved Standalone Seat (SS) licenses do not allow you to You can use SAP IQ via Remote Desktop Connection or other use SAP IQ via Remote Desktop Connection or other termi Terminal Services clients, irrespective of the type of license nal services clients. in use.
5.3.4.4 Using SAP IQ When the License Server is Offline
Even when a SySAM-enabled product is disconnected from its license server, SySAM allows you to borrow licenses for your product to work offline.
You can use the licensed product offline until the borrowed licenses expire.
When borrowed licenses expire, you reconnect to the network license server and borrow them again for the product to work offline. If you do not reborrow licenses before your currently borrowed licenses expire, the product runs only for a runtime grace period, then ceases to function.
Note
Typically, the maximum duration for which you can borrow a license is 90 days.
SAP IQ Installation and Update Guide for Windows 24 PUBLIC Plan the Installation 5.3.4.5 How SySAM Checks Out Licenses
SAP SySAM related products check out licenses on start-up, and perform periodic heartbeat checks to verify that licenses remain available. If a license is unavailable, the product determines whether it can be awarded a grace period.
The grace period starts from the time a license was last in use and persists for 90 days. At the end of the grace period, the product performs an orderly shutdown, if running, or fails to start up. If the license (or a replacement license) becomes available, the cycle continues with the heartbeat, noting the last use of the license.
In this section:
Three-License-Server Redundancy [page 25] Tolerance for temporary licensing failure is usually sufficient. However, in certain circumstances, you may choose to use “three-license-server redundancy.”
5.3.4.5.1 Three-License-Server Redundancy
Tolerance for temporary licensing failure is usually sufficient. However, in certain circumstances, you may choose to use “three-license-server redundancy.”
For example:
● A grace period is not provided for the license type Floating License (FL). ● Standby copy systems rarely qualify for a grace period because they are unlikely to have been used within the last 90 days. ● Company policy dictates the use of redundancy.
For three-license-server redundancy, use three machines that each:
● Run the same version of the SySAM license server. ● Have good intermachine communication. ● Use a separate copy of the same license files.
A product using per-processor licensing checks out a license quantity equal to the number of processors it can use. If there are not enough licenses, it applies a runtime grace period. A runtime grace period is also applied if the number of processors increases and the product is unable to check out additional licenses. The product shuts down if additional licenses are not made available within the runtime grace period. Decreasing the available number of processors while it is running does not reduce the required license quantity. You must restart the product on the correct number of processors.
5.3.4.6 Common License Deployment Scenarios
Learn about some typical license server deployment scenarios and suggestions for a SySAM setup that best serves each scenario. You can mix and match the suggested configurations with other variations, to best suit your needs.
SAP IQ Installation and Update Guide for Windows Plan the Installation PUBLIC 25 In this section:
Small Environment, Unserved Licenses [page 26] The easiest setup for this environment is to use unserved licenses, which have a simple initial setup and require little, if any, ongoing monitoring.
Single Site with Multiple Products, Served Licenses [page 28] This deployment scenario assumes you have one site, running multiple products, that requires asset management capabilities.
Multiple Sites with Security Considerations and Remote Users [page 29] This deployment scenario has multiple sites, each with multiple SAP products, with a license server at each site. This removes the dependency on network availability and latency, and can provide load balancing.
5.3.4.6.1 Small Environment, Unserved Licenses
The easiest setup for this environment is to use unserved licenses, which have a simple initial setup and require little, if any, ongoing monitoring.
This deployment scenario uses an unserved license deployment model that works best in:
● Very small environments using only a few license files that require little management. If you have more than 10 hosts, it is probably better to move to a served license deployment model, since a served license allows you to update all licenses in one step. ● Hosts that are isolated (or need to be isolated) from one network to another; for example, secure networks, and so on. ● Secure environments, where communication between hosts is limited or restricted; for example, all ports are blocked, or specific ports are not allowed to be opened on a host. ● Occasionally connected systems, such as laptops or handheld devices.
SAP IQ Installation and Update Guide for Windows 26 PUBLIC Plan the Installation Figure 1: Small Unserved License Configuration
The "Small Unserved License Configuration" figure illustrates a simple unserved license architecture with two hosts: ASTRO and ELROY. Each license file is installed locally on the same machine that runs the SySAM 2- enabled products that use that specific license file. The license is used only on the machine on which it is installed. In each license file representation, the license file HOSTID matches the unique license host identification for the machine on which the associated licensed product is installed.
To get this information, run lmutil hostid from the $SYBASE/SYSAM-2_0/bin directory, on each machine for which you want to determine the host ID.
When you log in to the SPDC or SAP Support Portal to generate licenses, enter the correct host ID for the machine where the product will run.
When using an unserved license, remember that:
● The unserved license is valid only on the machine for which it was generated. The license is node-locked to the host where your SySAM 2-enabled product is installed, and the license activates products only on that host. You cannot copy the license file to another machine and use it to run another instance of a product. ● The unserved license deployment model does not use a license server. When you start a product, it looks for a local license file. ● You must manage unserved licenses, regardless of the architecture in which they are implemented. Most licenses have a version that usually coincides with the end of your annual support agreement with SAP. To download and apply product updates and patches, when you renew your product support, update your SySAM licenses to reflect that fact. Renewing support and updating the corresponding license files on a few hosts is not difficult, but trying to update 100 or 1,000 hosts would be a formidable task.
SAP IQ Installation and Update Guide for Windows Plan the Installation PUBLIC 27 5.3.4.6.2 Single Site with Multiple Products, Served Licenses
This deployment scenario assumes you have one site, running multiple products, that requires asset management capabilities.
Typically, a served license with one license server that serves all SAP licenses works most efficiently in such an environment. The overhead of maintaining the license server is compensated by the asset management functionality and a reduction in ongoing license maintenance because of the license server.
Figure 2: Single-Site Served License Configuration
The "Single-Site Served License Configuration" figure shows one license server that is set up to grant SySAM licenses to all SAP products in use. Each instance of a product contacts the license server to acquire a license.
You can set up the license server on a separate host machine, but because the license server uses few resources, it can typically be hosted on an existing machine.
SAP IQ Installation and Update Guide for Windows 28 PUBLIC Plan the Installation 5.3.4.6.3 Multiple Sites with Security Considerations and Remote Users
This deployment scenario has multiple sites, each with multiple SAP products, with a license server at each site. This removes the dependency on network availability and latency, and can provide load balancing.
Figure 3: Multiple Sites and License Servers
The "Multiple Sites and License Servers" figure illustrates an organization with major sites in New York, London, and Tokyo. Each site uses multiple instances of multiple SAP products. A license server is installed at each site and individual product instances acquire licenses from the license server at that site.
You can configure the products to find remote license servers if the required license cannot be found on the site license server, or if the site license server is not running. To share a limited number of floating licenses across all sites while using the site license server for other licenses, set up those floating licenses on the license server where floating licenses are likely to be used frequently. At the other sites, you can set up license search paths. The redundancy provided by this configuration is limited to the number of unused licenses, including any overdraft licenses that remain on each license server.
You can also consider alternate configurations. For example, if the network communication between two sites is extremely reliable with minimal latency, you can share a license server between two sites. Smaller remote sites can share a license server with a larger site that provides the most reliable network connection, even though the larger site may not be the closest site geographically.
This setup is an extension to the multiple site case explained above. It also addresses additional considerations including security within your network, remote users, and DMZs. This setup uses a mix of license models and
SAP IQ Installation and Update Guide for Windows Plan the Installation PUBLIC 29 servers to meet your needs. Individual components of this deployment can be applied to any of the other deployment scenarios.
Figure 4: Complex, Multiple-Site Installations
The "Complex, Multiple-Site Installations" figure depicts a multiple-site deployment with multiple product setup with additional security requirements. In this example:
● The Headquarters network includes both development and production installations. ● The production installations are set up within a secure subnet within the network. ● The database and application servers that serve the Web are set up in the DMZ. ● Home office and mobile users access the software remotely through VPN. ● There is a disaster recovery center at a remote location. ● There are other secondary sites for the organization.
This example uses a single license server for Headquarters, which serves the development, production, and remote users’ needs. While the license server is shared for development and production needs, available licenses can be demarcated based on intended deployment.
● The production subnet security policies are relaxed to allow connections to the license server host and port. ● The VPN policies allow a connection to license server host and ports.
SAP IQ Installation and Update Guide for Windows 30 PUBLIC Plan the Installation If your security policies do not permit the production subnet to access a license server outside the subnet, set up a separate license server inside the subnet.
Note
Use a fixed port for the lmgrd license manager and SAP vendor daemon in such situations. Firewall and VPN policies must accommodate both lmgrd and SAP port numbers. This means that SERVER lines and VENDOR lines in all license files must specify the port numbers chosen for the license manager and SAP daemon processes. For example, a license server running on machine server_1 with the lmgrd license manager daemon, listening on port 27001 and the SAP vendor daemon listening on port 27100 should use a license file headed with the following two lines:
SERVER server_1 ANY 27001
VENDOR SAP PORT=27100
Unserved licenses are set up on the DMZ to serve licenses to product instances using the Web. This reduces the need to set up another license server or open up additional traffic through the firewall.
SAP recommends that you use a separate license server for your disaster recovery site. This ensures availability of the license server in case of a major catastrophe at the primary site.
If your disaster recovery setup includes cold-standby servers, set up the license servers in a three-server redundant cluster. This reduces the possibility of a license server being unavailable when a cold-standby server is attempting to come online. Such redundancy for license servers is typically not needed unless you are using cold-standby systems.
Each secondary or remote site can have its own license server.
5.3.5 Before You Generate Licenses
Have the necessary information available before generating licenses.
Required Information or Ac Served Li Unserved Li tion cense Model cense Model Description
License deployment model X X Decide whether to use a served or unserved license deploy ment model. Typically, this is a company-wide decision that is made only once. Therefore, this is one of the most impor tant things to determine before license generation.
Product machine host ID X Determine the host ID of the machine, or machine partition where the product will run.
License server – download and X Download the standalone license server software and install install the SySAM license server before you generate the product’s licenses, and before you install the product.
License server host ID X Determine the host ID of the machine where the license server will run.
License server host name X Determine the host name of the machine where the license server will run.
SAP IQ Installation and Update Guide for Windows Plan the Installation PUBLIC 31 Required Information or Ac Served Li Unserved Li tion cense Model cense Model Description
License server TCP/IP port X Determine the port numbers on which the license server will numbers listen for license requests.
In this section:
Determining Host IDs [page 32] Identify the host ID of the machine where the licenses will be deployed.
Access Through a Firewall or VPN [page 35] SySAM license server listens on two TCP/IP ports for incoming license requests. Therefore, firewall or VPN policies require a set-up to allow access to both ports.
License Types [page 36] SAP IQ is sold under different license types that control where you can use it. License types include in production, standby, or development and test environments.
Generating a SySAM License [page 37] Log in to SAP Service Marketplace to generate a license key for SAP IQ. Refer to the email you received for information about your account.
5.3.5.1 Determining Host IDs
Identify the host ID of the machine where the licenses will be deployed.
● For served licenses, specify the host ID of the machine where the license server will run. ● For unserved licenses, specify the physical host ID of the machine where the product will run.
If you are running a product with per-CPU or per-CHIP licensing that supports SySAM sub-capacity, and you want to run the product in a virtualized environment, use the sysamcap utility to enter the host ID for the virtual machine, partition, or resource-set.
SPDC or SMP remembers the host information so that you can select the same license server when generating additional licenses.
In this section:
Finding the Host ID for a Physical Machine [page 33] Use the lmutil utility or the appropriate operating system command to find your host ID.
Finding Host IDs for Machines with Multiple Network Adapters [page 34] On some platforms, the host ID is derived from the network adapter address.
Using Alternate Host IDs on Windows [page 35] If your Windows machine does not have a network adapter, SySAM allows you to use an alternate host ID based on the hard disk serial number.
SAP IQ Installation and Update Guide for Windows 32 PUBLIC Plan the Installation 5.3.5.1.1 Finding the Host ID for a Physical Machine
Use the lmutil utility or the appropriate operating system command to find your host ID.
The lmutil utility is included in the SySAM license server download.
To determine the host ID of the machine using lmutil, enter:
lmutil lmhostid
Platform Host ID Type Native OS Command
Windows Ethernet Address ipconfig/all
Use "Physical Address" value.
Solaris Host ID hostid
Linux Ethernet Address /sbin/ifconfig eth0
Use "HWaddr" value.
MAC OS X Ethernet Address /sbin/ifconfig eth0
Use "ether" value.
Tru-UNIX (Digital) Ethernet Address netstat -i
IBM AIX Host ID uname -m
After it returns 000276513100, remove both the first and the last two digits, and use the remaining eight digits.
HP-UX PA-RISC Host ID uname -i
Convert to hex, or prepend with #.
HP-UX Itanium Machine ID getconf CS_PARTITION_IDENT
Use "ID_STRING=" prefix.
SGI Host ID /etc/sysinfo -s
Convert to hex, or use # prefix.
Note
For Windows platforms, if your machine does not have a network adapter an alternate host ID of type Disk Serial Number is supported. See Using Alternate Host IDs on Windows [page 35].
Each host ID type has valid formats that will be checked when generating a license. Make sure the value entered matches these valid formats.
Ethernet addresses are 12-character hex values consisting of digits 0 through 9 and characters A through F. They may be entered in any of the following formats:
SAP IQ Installation and Update Guide for Windows Plan the Installation PUBLIC 33 ● 12AB34CD56EF ● 12-AB-34-CD-56-EF ● 3.12:AB:34:CD:56:EF
For some platforms, the host ID can also be entered in decimal formats; in this case, prefix the host ID with the "#" sign. For example, #1039716963
The Disk Serial Number is always entered with a "DISK_SERIAL_NUM=" prefix. For example, DISK_SERIAL_NUM=3e2e17fd
The machine ID string is always entered with an "ID_STRING=" prefix. For example, ID_STRING=9c766319- db72-d411-af62-0060b05e4c05
5.3.5.1.2 Finding Host IDs for Machines with Multiple Network Adapters
On some platforms, the host ID is derived from the network adapter address.
Context
If the machine where your product is installed or where the license server is hosted has multiple network adapters, running lmutil lmhostid returns one host ID for each network adapter, and returns output similar to this:
The FLEXlm host ID of this machine
is ""0013023c8251 0015c507ea90""
Only use ONE from the list of hostids.
It is important that you:
● Choose only one host ID to enter during license generation. ● Use the value associated with the primary wired Ethernet adapter. ● Do not use values associated with internal loopback or virtual adapters.
If you cannot determine the host ID using the lmutil lmhostid output, use the native operating system commands to get additional details.
SAP IQ Installation and Update Guide for Windows 34 PUBLIC Plan the Installation 5.3.5.1.3 Using Alternate Host IDs on Windows
If your Windows machine does not have a network adapter, SySAM allows you to use an alternate host ID based on the hard disk serial number.
Procedure
1. At a Windows command prompt on the machine where you will deploy your license, enter:
lmutil lmhostid -vsn
This returns output similar to:
The FLEXlm host ID of this machine is "DISK_SERIAL_NUM=70ba7a9d" 2. Use the complete output (DISK_SERIAL_NUM=70ba7a9d) for the host ID value requested during license generation.
5.3.5.2 Access Through a Firewall or VPN
SySAM license server listens on two TCP/IP ports for incoming license requests. Therefore, firewall or VPN policies require a set-up to allow access to both ports.
The SySAM license server consists of two processes: the license manager daemon (lmgrd) and the vendor daemon (SYBASE).
Set the ports by specifying their port numbers in the license files on the SySAM license server. For example, to force lmgrd to listen on port 27010 and the SYBASE vendor daemon to listen on port 27011, the license file header should have:
SERVER keyserver 1D1D1D1D 27010
VENDOR SYBASE PORT=27011
A SySAM enabled product only needs to know the port where lmgrd is listening. The product connects to lmgrd on that port and will then be told which port to use to connect to the SYBASE vendor daemon. This means that the product's local license file just needs to contain the following:
SERVER keyserver ANY 27010
USE_SERVER
When generating licenses at SPDC, specify the license server port to fix the port for lmgrd. Edit the license file to specify the SYBASE vendor daemon port.
When generating licenses at SMP, specify both ports. The port for lmgrd is specified as License Server Port 1, and the SYBASE vendor daemon port as License Server Port 2. For three-server-redundant configurations, you can only specify the SYBASE vendor daemon port for the primary license server; same value is used for the secondary and tertiary license servers.
SAP IQ Installation and Update Guide for Windows Plan the Installation PUBLIC 35 Note
You can specify any unused port number between 0 and 64000. On UNIX, choose a port number greater than 1024, as most port numbers less than 1024 are privileged port numbers. Do not specify a number in the range 27000 to 27009 for License Server Port 2, as ports in this range are used by the lmgrd process when no port is specified for License Server Port 1.
5.3.5.3 License Types
SAP IQ is sold under different license types that control where you can use it. License types include in production, standby, or development and test environments.
The license type determines the quantity of licenses required, such as whether a license is required for each machine; or for each CPU, or CPU chip; or per terabyte of storage.
For example, SAP IQ purchased under the CPU License (CP) type requires one license per CPU on the machine, partition, or resource set where it will run. SAP IQ purchased under the Server License (SR) type requires a single license for the machine, partition, or resource set.
Make sure you select the correct license type when you generate your SySAM license file, since your account may have the same product licensed under multiple license types.
When you generate licenses, each license type is presented on the License Information screen, such as:
License Type: CPU License (CP)
In this section:
Optional Feature Licenses [page 36] Some applications are offered as base products with optional features that require an additional separate license.
5.3.5.3.1 Optional Feature Licenses
Some applications are offered as base products with optional features that require an additional separate license.
You can mix license types. For example, you can order SAP IQ under the Server License (SR) license type and order an optional feature (such as IQ_VLDBMGMT) under the CPU License (CP) type.
Optional features are licensed only with the base product of the same product edition. For example, if you order SAP IQ, you cannot use an Evaluation Edition optional feature license with the Enterprise Edition base product. In addition, the entitled use of the license types must be compatible; for example, both types should allow use in a production environment.
SAP IQ Installation and Update Guide for Windows 36 PUBLIC Plan the Installation 5.3.5.4 Generating a SySAM License
Log in to SAP Service Marketplace to generate a license key for SAP IQ. Refer to the email you received for information about your account.
Context
When you purchase SySAM–enabled SAP products, such as SAP IQ, you must generate, download, and deploy product licenses. You will need a license whether you use the served or unserved deployment model.
● To generate your unserved license, you need the host ID and host name of the SAP IQ server. ● To generate your served license, you need the host ID and host name of the SySAM license server. ● Served licenses require a license server. If you do not plan to use an existing license server, you must install one before you install SAP IQ.
Procedure
1. Start your browser, and log in to the SAP Service Marketplace at https://support.sap.com/licensekey . 2. Follow the online instructions. 3. Save your license to a temporary location on the local file system. You must save the license file with a .lic extension.
5.4 Storage Options
Consider the storage options for your database system before installation.
For SAP IQ dbspaces in production, use a fault-tolerant file system implemented by a high-performance, redundant disk array (for example, RAID 5). For single-server systems, you can use a local file system, but multiplex systems require raw devices, ideally on a Storage Area Network device. Multiple raw disks enable SAP IQ to stripe data across devices, which improves performance.
In this section:
Avoiding Environmental Issues [page 38] Installing SAP SQL Anywhere and SAP IQ on different machines avoids potential start-up problems.
Related Information
Planning Checklist [page 39]
SAP IQ Installation and Update Guide for Windows Plan the Installation PUBLIC 37 5.4.1 Avoiding Environmental Issues
Installing SAP SQL Anywhere and SAP IQ on different machines avoids potential start-up problems.
Install SAP SQL Anywhere and SAP IQ on different host machines. When you install both products on the same machine, the environment variables for the product installed last overwrite those of the product installed first, causing start-up problems for the first product.
5.5 Network Options
Do you plan to take advantage of SAP IQ distributed query processing? Distributed query processing can benefit from an optional high-speed interconnect. Use scalable interconnect technology to connect multiplex nodes.
For best performance, use:
● A high-speed network interconnect providing a local network that connects all multiplex nodes. Use an interconnect bandwidth of 1 GB or higher or the highest bandwidth, lowest latency interconnect available. ● Two physically separate network interfaces for each multiplex node: ○ A public network for multiplex interconnection traffic and client traffic. ○ A private network for multiplex interconnect traffic only, excluding external client traffic. Currently, multiplex interconnects support only the TCP/IP standard. These two networks improve security, fault-tolerance, and performance. ● A switch that enables high-speed communication between nodes. ● Network cards that reside on different fabrics so that the multiplex survives network failure. Separate the public and private networks physically. ● Private interconnect fabrics that contain only links to machines participating in the multiplex. Private interconnect for all multiplex nodes should connect to the same switch, which connects to no other public switches or routers. ● Redundant network interface cards added to private or public networks if desired. The private and public connection information allows for multiple IP addresses on each.
In this section:
Network Clients and ODBC Kits [page 39] Network Clients and ODBC development kits are available on the SAP IQ product support page.
Related Information
Planning Checklist [page 39]
SAP IQ Installation and Update Guide for Windows 38 PUBLIC Plan the Installation 5.5.1 Network Clients and ODBC Kits
Network Clients and ODBC development kits are available on the SAP IQ product support page.
SAP IQ Network Client 16.1 SP 04 includes the 32-bit ODBC driver component in the Windows 64-bit client in order to support legacy 32-bit applications. This provides 32-bit connectivity support to 64-bit Windows. For other platforms, use the SAP IQ 16.0 32-bit ODBC drivers instead.
See the Technical Release Information on the SAP IQ 16.1 Product Availability Matrix Page .
5.6 Product Compatibilities
Information about the compatibility of SAP IQ with other products.
These SAP products are certified with this version of SAP IQ:
● jConnect for JDBC 8.0
These SAP products are certified to work as back ends in CIS functionality with this version of SAP IQ:
● SAP SQL Anywhere 17.0 ● SAP Adaptive Server Enterprise (SAP ASE) 16.0
5.7 Planning Checklist
As you plan your installation, record your decisions on the planning checklist. Refer to the checklist when you respond to installation prompts.
Question See Notes
Do you have the SAP administrator user Create the SAP IQ Account [page 45] name and password? You need this in formation to log on to the machine to run the installation.
Will you initially install a licensed or License Requirements [page 19] evaluation edition?
Do you plan to use SySAM license License Deployment [page 22] and SAP server? IQ Server Components [page 17]
Do you need the SAP IQ client? Do I Need the SAP IQ Client? [page 15]
Do you plan to use the SAP IQ Cockpit? SAP IQ Database Administration Tool [page 19] If yes, do you want to run it as a serv ice?
SAP IQ Installation and Update Guide for Windows Plan the Installation PUBLIC 39 Question See Notes
If installing SAP IQ, are the default ports Check Port Availability for SAP IQ Cock available? If the default ports are in use, pit [page 42] identify substitute ports to be specified during the installation.
Based on your answers above, which in Typical or Custom Installation? [page stallation type should you use? 17]
Where do you plan to install the SAP Storage Options [page 37] and Network IQ? What is the absolute path to the lo Options [page 38] cation?
Related Information
License Requirements [page 19] Storage Options [page 37] Product Components [page 16] SAP IQ Database Administration Tool [page 19] Network Options [page 38] Check Port Availability for SAP IQ Cockpit [page 42]
SAP IQ Installation and Update Guide for Windows 40 PUBLIC Plan the Installation 6 Preinstallation Tasks
Complete these tasks before starting the installation process. These are operating system-level tasks to be completed by the network administrator.
In this section:
Check for Operating System Patches [page 41] Check with your vendor and apply the latest operating system patches. Do not use a patch that is earlier than the version suggested for your operating system.
Increase the Swap Space [page 42] The recommended minimum swap space is 1 GB. Certain operations may cause the memory usage to grow dynamically. Changing the way SAP IQ uses buffers can dramatically change the way it uses memory.
Check Port Availability for SAP IQ Cockpit [page 42] SAP IQ Cockpit uses reserved port numbers.
Verify Network Functionality [page 42] Make sure your network devices can communicate before you install SAP IQ.
Platform-Specific Tasks [page 42] Complete these platform-specific tasks before starting the installation process.
Create the SAP IQ Account [page 45] Create an SAP IQ account to provide consistent ownership and privileges for all installation, upgrade, and administration tasks.
Download Installation Files [page 46] SAP IQ installation and update packages are available on the SAP Software Download Center.
6.1 Check for Operating System Patches
Check with your vendor and apply the latest operating system patches. Do not use a patch that is earlier than the version suggested for your operating system.
See Supported Server and Client Operating Systems [page 13].
SAP IQ Installation and Update Guide for Windows Preinstallation Tasks PUBLIC 41 6.2 Increase the Swap Space
The recommended minimum swap space is 1 GB. Certain operations may cause the memory usage to grow dynamically. Changing the way SAP IQ uses buffers can dramatically change the way it uses memory.
Depending on the load, swap requirements may exceed space allotted. Insufficient swap space may result in the system supporting fewer users, and large processes that cannot acquire sufficient swap space may be prematurely killed by the operating system.
See your operating system documentation for information about extending swap space.
6.3 Check Port Availability for SAP IQ Cockpit
SAP IQ Cockpit uses reserved port numbers.
Before proceeding, if you are planning to install SAP IQ Cockpit, verify the availability of the following ports . If already in use, identify alternate port numbers to be specified during installation.
● HTTP Port: 4282 ● HTTPS Port: 4283 ● RMI Port: 4992 ● TDS Port: 4998
6.4 Verify Network Functionality
Make sure your network devices can communicate before you install SAP IQ.
SAP IQ uses networking software whenever the client and server components are installed on different systems. Use the ping command to and from another computer to verify that the server where you plan to install SAP IQ can use TCP/IP to communicate with other devices on your network.
6.5 Platform-Specific Tasks
Complete these platform-specific tasks before starting the installation process.
In this section:
Install MS Visual C++ Redistributable Packages [page 43] Java is required to install SAP IQ. Ensure it is installed before starting the installation.
Windows Support Issues [page 43] Review these issues related to running SAP IQ on Windows 2012 R2.
SAP IQ Installation and Update Guide for Windows 42 PUBLIC Preinstallation Tasks 6.5.1 Install MS Visual C++ Redistributable Packages
Java is required to install SAP IQ. Ensure it is installed before starting the installation.
Context
There are several MS Visual C++ redistributable packages required to install SAP IQ. If not installed, an error message similar to one of the following appears, and the installation stops.
● Message 1: Windows error 14001 occurred while loading the Java VM ● Message 2: The program can't start because MDVCR100.dll is missing from your computer. Try reinstalling the program to fix this problem.
These service packs are included as part of the installation package and are found in the server\archives folder.
To install:
1. Open Windows Explorer. 2. Change to the \archives directory on the installable image. The MS Visual C++ Redistributable Packages are located in the following subdirectories: ○ ms-redist-2005 ○ ms-redist-2010 ○ ms-redist-2012 ○ ms-redist-2013 The packages must be run in order, oldest to newest, and all must be run. 3. Change to the first subdirectory, and run the following: ○ On 32-bit machines – run vcredist_x86.exe ○ On 64-bit machines – run vcredist_x86.exe and vcredist_x64.exe 4. Repeat this process until all packages are installed.
6.5.2 Windows Support Issues
Review these issues related to running SAP IQ on Windows 2012 R2.
Windows Security
User Account Control (UAC) is enabled by default and may affect the behavior of programs that expect to be able to write files, especially when the computer supports more than one user. Depending on where and how files and directories are created, a file created by one user may have permissions that do not allow another user
SAP IQ Installation and Update Guide for Windows Preinstallation Tasks PUBLIC 43 to read or write to that file. If you install SAP IQ in the default directories, files and directories that require read and write access for multiple users are set up appropriately.
SAP IQ Elevated Operations Agent
Certain actions require privilege elevation to execute when run under User Account Control. The programs dbelevate11.exeSybaseIQservice16.exe, dbelevate11.exe, and iqdsn.exe may require elevation in SAP IQ. The dbodbc16.dll and dboledb16.dll DLLs require elevation when they are registered or unregistered.
On a system with User Account Control activated, you may receive an elevation prompt for the SAP IQ elevated operations agent. The prompt is issued by the User Account Control system to confirm that you want to continue running the identified program (if logged on as an administrator) or to provide administrator credentials (if logged on as a non-administrator).
Deployment Changes
The dbelevate16.exe program is used internally by SAP IQ components to perform operations that require elevated privileges. Include this executable in deployments of SAP IQ. You need administrator privileges to run dbelevate.
SAP IQ Executables Signed
SAP IQ executables are signed by Sybase, Inc.
Using an AWE Cache
To use an Address Windowing Extensions (AWE) cache on Windows 2012, run the database server as administrator. Starting a non-elevated database server with an AWE cache results in a warning that the database server must be run as an administrator to use AWE.
Samples
Samples now correctly handle SAP IQ installation path names that contain one or more spaces.
SAP IQ Installation and Update Guide for Windows 44 PUBLIC Preinstallation Tasks Windows Services
Windows 2008-compliant services are not allowed to interact with the desktop. SAP IQ services do not interact with the desktop (even if Allow Interaction with Desktop is enabled in the service definition). You can monitor SAP IQ database servers using the dbconsole utility or SAP IQ Cockpit.
Windows 2012 R2
Some libraries required to support Windows 2012 R2 installations are not currently available in the iAnywhere installer. Use Windows 2007 compatibility mode to install Windows 2012 R2.
Open Client SDK 16.0 SP02 Requires Service Pack for SSL/TLS/FIPS Security
To use the OpenClient SDK ISQL utility with security (SSL/TLS/FIPS), install 32-bit Microsoft Visual C++ 2005 Service Pack 1 (June 2011) or later on your system.
Without the required service pack, isql -X and other 32-bit applications may fail, and you see a CT-LIBRARY message like:
ct_connect(): protocol specific layer: internal Client Library error:
There is a tds login error. The installed encryption handler returned a status that was not CS_SUCCEED.
See Microsoft Knowledge Base Article 2538242 .
6.6 Create the SAP IQ Account
Create an SAP IQ account to provide consistent ownership and privileges for all installation, upgrade, and administration tasks.
Create the SAP IQ user on every machine you plan to install SAP IQ server, SAP IQ client, or the SySAM license server on. The SAP IQ user can be a normal nonadministration user and does not require root access. Log in to machines as this user to install or administer SAP IQ.
If you have already installed other SAP software, the SAP IQ user may already exist. If so, verify that you can log in to the machine using this account. If there is no SAP IQ account on your system, see your operating system documentation for instructions for creating new user accounts.
SAP IQ Installation and Update Guide for Windows Preinstallation Tasks PUBLIC 45 6.7 Download Installation Files
SAP IQ installation and update packages are available on the SAP Software Download Center.
Context
To access the SAP IQ installation files, go to the SAP Software Download Center and select Software Downloads.
Procedure
1. Select SUPPORT PACKAGES & PATCHES By Alphabetical Index (A-Z) I SYBASE IQ SYBASE IQ 16.1 2. Choose the component to download. 3. Choose the operating system from the dropdown list, if applicable. 4. Choose the patch level to download. 5. Click the Shopping Cart icon to add the selected components to the download basket. 6. Click Download Basket and complete the download.
Next Steps
Uncompress the download image on the same machine where you plan to install SAP IQ. Do not copy an uncompressed installation archive to a secondary machine to perform the installation.
Each archive contains a single folder with the installation files. Rename these folders to make them easier to identify. For example, rename the folder with SAP IQ server installation files to server.
SAP IQ Installation and Update Guide for Windows 46 PUBLIC Preinstallation Tasks 7 Installing SySAM License Server
The SAP IQ Server Suite installation media includes the SySAM license server.
The SySAM license server is required for a served license deployment model.
See SySAM Users Guide for more information.
In this section:
Set Windows 2012 R2 Compatibility Mode for SAP IQ Installer [page 48] Configure the compatibility mode on the SAP IQ installer to prevent issues when running.
Installing SySAM in GUI Mode [page 48] Use this option to install the SySAM license server using a graphical user interface (GUI). The GUI installer is wizard-driven and supports all product editions and installation types.
Installing SySAM in Console Mode [page 49] Choose a console installation if you prefer a non-GUI interface. Installing SySAM License Manger in console mode is similar to installing in GUI mode, except that you run the installer from the command line, and enter text to select the installation options.
Starting and Stopping a SySAM License Server [page 50] You start and stop the license server from a console or command line.
Apply or Update Licenses on the SySAM License Server [page 51] Copy your served licenses to the license directory on the SySAM license server, and update the license server.
Understanding the SySAM Directory Structure [page 52] SySAM files are installed in the SYSAM-2_0 directory.
SySAM Utilities [page 53] The licensing utility program, lmutil, includes options for managing licensing activities.
Related Information
Download Installation Files [page 46] Unserved License Deployment Model [page 23]
SAP IQ Installation and Update Guide for Windows Installing SySAM License Server PUBLIC 47 7.1 Set Windows 2012 R2 Compatibility Mode for SAP IQ Installer
Configure the compatibility mode on the SAP IQ installer to prevent issues when running.
Context
This configuration is required for installations using either console or GUI mode.
Procedure
1. On the Windows server, change to the server directory within the SAP IQ installing package. 2. Right-click setup.exe and select Properties. 3. On the Compatibility tab, check Run this program in compatibility mode for: and select Windows 7 from the dropdown.
7.2 Installing SySAM in GUI Mode
Use this option to install the SySAM license server using a graphical user interface (GUI). The GUI installer is wizard-driven and supports all product editions and installation types.
Prerequisites
● The SAP IQ package has been downloaded and unpacked.
Procedure
1. Change to the setup directory where you downloaded and unpacked your SAP IQ software. 2. Start the installer:
Right-click setup.exe and select Run as Administrator and follow the instructions on the screen. 3. When prompted, specify a parent installation directory. Do not install SySAM license server into a destination directory or path that contains spaces. The GUI installer warns you if you try to install to an invalid path or if the parent install directory or path has changed since the last installation on the machine,
SAP IQ Installation and Update Guide for Windows 48 PUBLIC Installing SySAM License Server and you are about to replace the existing environment variables. If installing the SySAM license server and SAP IQ server on the same machine, do not install to a common parent directory. 4. Select Custom as the installation type. Deselect all selected options. Select SySAM License Server only. 5. Select Evaluate for the license type. 6. Complete and accept the terms of the licensing agreement. 7. Review the installation summary and adjust as needed. 8. Begin the installation.
Next Steps
For your next task, go to Apply or Update Licenses on the SySAM License Server [page 51].
Related Information
Create the SAP IQ Account [page 45] Download Installation Files [page 46]
7.3 Installing SySAM in Console Mode
Choose a console installation if you prefer a non-GUI interface. Installing SySAM License Manger in console mode is similar to installing in GUI mode, except that you run the installer from the command line, and enter text to select the installation options.
Prerequisites
● The SAP IQ package has been downloaded and unpacked.
Context
Note
To return to the previous prompt from within the console installer, type back at any time.
SAP IQ Installation and Update Guide for Windows Installing SySAM License Server PUBLIC 49 Procedure
1. From a command prompt running as administrator, change to the setup directory where you unpacked your software. 2. Start the installer and follow the instructions on the screen:
setup.exe -i console
3. When prompted, specify a parent installation directory. Do not install SySAM license server into a destination directory or path that contains spaces. The console installer does not warn you if you try to install to an invalid path or if the parent installation directory or path has changed since the last installation on the machine, and you are about to replace the existing environment variables. If installing the SySAM license server and SAP IQ server on the same machine, do not install to a common parent directory. 4. Select Custom as the installation type. 5. Type 1,7,10,12 to deselect all selected options, and then type 11 to select SySAM License Server only. 6. Select Evaluate for the license type. 7. Complete and accept the terms of the licensing agreement. 8. Review the installation summary and adjust as needed. 9. Begin the installation.
Next Steps
For your next task, go to Apply or Update Licenses on the SySAM License Server [page 51].
Related Information
Create the SAP IQ Account [page 45] Download Installation Files [page 46] SySAM Users Guide
7.4 Starting and Stopping a SySAM License Server
You start and stop the license server from a console or command line.
Prerequisites
● At least one license file (.lic) exists in the licenses directory.
SAP IQ Installation and Update Guide for Windows 50 PUBLIC Installing SySAM License Server ● If you installed your license server on Windows 7, you must run the command prompt using the Run as Administrator command to start and stop the license server.
Procedure
1. Change to the SYSAM-2_0
2. In Windows Explorer, Shift + right-click the bin directory, and choose the option that opens a command window in the selected folder. 3. Start or stop the license server:
Action Syntax
Start the license server sysam start
Stop the license server sysam stop
4. To verify that the license server is running, enter sysam status.
Note
The SySAM License Server Installer installs both IPv4-only and IPv4/IPv6 dual-stack license server binaries during installation and configures use of IPv4-only binaries.
Use the sysam configure [IPv6 | IPv4] to configure the appropriate version of the license server. For example, sysam configure IPv6 will configure use of the IPv4/IPv6 dual stack binaries. For more information, see the SySAM Users Guide published with SAP IQ documentation.
Related Information
Apply or Update Licenses on the SySAM License Server [page 51]
7.5 Apply or Update Licenses on the SySAM License Server
Copy your served licenses to the license directory on the SySAM license server, and update the license server.
Prerequisites
● The SySAM license server is running. ● You have a valid served license to apply or update. ● If you installed your license server on Windows 7, you must run the command prompt using the Run as Administrator command to start and stop the license server.
SAP IQ Installation and Update Guide for Windows Installing SySAM License Server PUBLIC 51 Procedure
1. Navigate to the
Caution
The SySAM license server and the SAP IQ server both have a SYSAM-2_0\licenses subfolder structure. If you installed both servers on the same machine, be sure to navigate to the SYSAM-2_0\licenses folder of the SySAM license server, not of the SAP IQ server.
2. Delete the temporary license file SySAMLicenseServer.lic. 3. Copy the served licenses to the folder. 4. Change to the
5. Shift + right-click the bin folder, and choose the option that opens a command window in the selected folder. 6. Type: sysam reread
Note
Stopping and starting the SySAM license server also forces the server to update the licenses.
7.6 Understanding the SySAM Directory Structure
SySAM files are installed in the SYSAM-2_0 directory.
The SYSAM-2_0 directory contains these default subdirectories and files: bin
● sysam – wrapper script to manage the license server ● lmgrd – license server manager daemon ● SYBASE – vendor daemon ● lmutil – licensing Utility program (from Flexera) ● lmtools.exe – (Windows only) GUI License Utility program (from Flexera) ● installs.exe – (Windows only) program used internally to install the SySAM Windows service that automatically starts the license server ● cpuinfo – utility program that reports the processor counts for the machine, or for the specified containment level if the SYBASE_SAM_CAPACITY environment variable is set ● sysamcap – utility program used to configure sub-capacity licensing licenses
● *.lic – license files ● SYBASE.opt – license server options file
SAP IQ Installation and Update Guide for Windows 52 PUBLIC Installing SySAM License Server locales
● unicode – localized message files for the sysamcap and cpuinfo utilities log
● SYBASE.log – license server debug log
7.7 SySAM Utilities
The licensing utility program, lmutil, includes options for managing licensing activities.
The options available in lmutil are:
● lmborrow – supports license borrowing. ● lmdiag – diagnoses license checkout problems. ● lmdown – shuts down selected license daemons. ● lmhostid – reports the system host identifier for the machine on which the command is run. ● lminstall – (not supported by SAP) converts license files to different formats. ● lmnewlog – moves the existing report log information to a new file name and starts a new report log file with the existing file name. ● lmpath – allows direct control over license file path settings. You should place all license files in the license directory rather than scattering them and modifying the license server's search path. ● lmremove – releases the failed license to the pool of free licenses. If an SAP product is still using the license, the product obtains the license again during its next heartbeat. ● lmreread – directs the license daemon to reread the license file and to start any new vendor daemons. ● lmstat – displays the license server system status. ● lmswitch – tells the license server to start writing to a new debug log file. When you restart the license server, it uses the debug log file specified in the options file, so you must ensure the old log is renamed to avoid appending to it. ● lmswitchr – switches the report log to a new file name. You should use lmnewlog to archive the report log instead. ● lmver – reports the FLEXnet licensing version of a library or binary file.
In this section:
Using SySAM Utilities [page 54] Learn how to see a list of optional parameters of SySAM utilities.
SAP IQ Installation and Update Guide for Windows Installing SySAM License Server PUBLIC 53 7.7.1 Using SySAM Utilities
Learn how to see a list of optional parameters of SySAM utilities.
Context
SAP does not support the functionality of all optional parameters.
Procedure
1. To see a full list, enter:
lmutil -help
2. To see a list of parameters for lmborrow, enter:
lmutil lmborrow -help
Note
In addition, the sysam script, also located in the bin directory, provides a wrapper for the most frequently used FLEXnet utilities. To display the help text, which provides complete instructions, enter:
sysam help
SAP IQ Installation and Update Guide for Windows 54 PUBLIC Installing SySAM License Server 8 Installing SAP IQ Server Software
SAP IQ server installation media supports GUI, console, and unattended (silent) installs. You can use the installation media to install a new SAP IQ server and selected components or to add additional components to an existing installation.
In this section:
Installing a Server in GUI Mode [page 56] Use this option to install your server software using a graphical user interface (GUI). The GUI installer is wizard-driven and supports all product editions and installation types.
Installing a Server in Console Mode [page 58] Choose a console installation if you prefer a non-GUI interface. Installing server components in console mode is similar to installing in GUI mode, except that you run the installer from the command line, and enter text to select the installation options.
Installing a Server in Unattended (Silent) Mode [page 61] Unattended or silent installations are typically used to update multiple systems. Except for the absence of the GUI screens, all actions of InstallAnywhere are the same, and the result of a server installation in silent mode is exactly the same as one done in either GUI or console mode.
Server Environment Variables [page 65] A server installation installs the SAP IQ server and selected components into a user-defined parent directory on the host machine. SAP IQ then uses environment variables, which are set by the installer to point to the different installation directories.
Finding Server Utilities and Files [page 65] SAP IQ uses environment variables to point to different installation directories.
Reviewing Server Installation Logs [page 68] The installer writes a general log to the %SYBASE% directory that records all installation activity and individual logs for each installed component. If an installation problem occurs, start with the IQ_Suite.log, then refer to the component log for specific details.
Related Information
Download Installation Files [page 46]
SAP IQ Installation and Update Guide for Windows Installing SAP IQ Server Software PUBLIC 55 8.1 Installing a Server in GUI Mode
Use this option to install your server software using a graphical user interface (GUI). The GUI installer is wizard- driven and supports all product editions and installation types.
Prerequisites
● Windows 2012 R2 compatibility mode is set. See Set Windows 2012 R2 Compatibility Mode for SAP IQ Installer [page 48]. ● The SAP IQ package has been downloaded and unpacked. ● If you plan to apply an unserved license during installation, the license file is in a location accessible to the installer. ● If you plan to apply a served license during installation, the SySAM license server must be configured and running. See Installing SySAM License Server [page 47].
Procedure
1. Change to the setup directory where you downloaded and unpacked your SAP IQ software. 2. Start the installer:
Right-click setup.exe and select Run as Administrator and follow the instructions on the screen. 3. When prompted, specify a parent installation directory. Do not install SAP IQ into the root or a destination directory or path that contains spaces.
For a new server installation, specify a new parent install directory. Do not install to an SAP IQ directory from a previous installation.
If installing the SySAM license server and SAP IQ server on the same machine, do not install to a common parent directory.
If adding components to an existing SAP IQ server, specify the existing parent installation directory. Specifying a different parent directory overwrites existing environment variables and may cause unexpected behavior.
The GUI installer warns you if you try to install to an invalid path or if the parent install directory or path has changed since the last installation on the machine, and you are about to replace the existing environment variables. 4. Do one of:
For Action
New installations Select Typical to install all default components. Select Custom to select and deselect individual components to install.
SAP IQ Installation and Update Guide for Windows 56 PUBLIC Installing SAP IQ Server Software For Action
Adding components to an existing instal Select Custom and select only the additional components to install. Dese lation lecting components already installed does not uninstall them, but can sig nificantly speed up the installation process by not reinstalling existing fea tures along with new features. To remove installed feature, see Uninstalling SAP IQ [page 129].
See Product Components [page 16] for information on available components.
5. Indicate whether you want to license SAP IQ now or evaluate the software. You can add your license later if preferred. See Licensing After Installation [page 106]. 6. Complete and accept the terms of the licensing agreement. 7. If licensing now: a. Specify one of:
To Action
Use specify license keys Change to the location of the unserved license file and se lect it.
Use previously deployed license server Specify the host name of the license server. Use the ma chine name or the IP address.
Continue installation without a license key If you are unable to enter a valid license key or connect to a license server, select this option to continue the installa tion.
b. Specify the product edition and license type being installed. c. (Optional) Configure SySAM e-mail alerts.
SySAM e-mail alerts do not contain HELO tokens, which some SMTP mail servers require to process messages correctly. If your SMTP server requires a HELO token, append the email.helo.fqdn property to the SySAM property file. The property value should be the fully qualified domain name, such as email.helo.fqdn=sap.com.
The SYSAM properties file is located in the %IQDIR16%\Sysam directory and is named
8. Review the installation summary and adjust as needed. 9. Begin the installation. 10. If installing SAP IQ Cockpit: a. Accept the default ports or change as needed.
Tip
Refer to your planning checklist.
b. Indicate whether IQ cockpit is to run as a Windows service. c. Indicate if you want to start the IQ cockpit server now. You can start it later if preferred.
SAP IQ Installation and Update Guide for Windows Installing SAP IQ Server Software PUBLIC 57 Related Information
Create the SAP IQ Account [page 45] Download Installation Files [page 46] Installing SySAM License Server [page 47] Planning Checklist [page 39] Uninstalling SAP IQ [page 129] Licensing After Installation [page 106]
8.2 Installing a Server in Console Mode
Choose a console installation if you prefer a non-GUI interface. Installing server components in console mode is similar to installing in GUI mode, except that you run the installer from the command line, and enter text to select the installation options.
Prerequisites
● Windows 2012 R2 compatibility mode is set. See Set Windows 2012 R2 Compatibility Mode for SAP IQ Installer [page 48]. ● The SAP IQ package has been downloaded and unpacked. ● If you plan to apply an unserved license during installation, the license file is in a location accessible to the installer. ● If you plan to apply a served license during installation, the SySAM license server must be configured and running. See Installing SySAM License Server [page 47].
Context
As the installer runs, refer to your planning checklist for answers to the various prompts. The prompts displayed may vary, depending on the components selected for installation.
Note
To return to the previous prompt from within the console installer, type back at any time.
Procedure
1. From a command prompt running as administrator, change to the setup directory where you unpacked your software.
SAP IQ Installation and Update Guide for Windows 58 PUBLIC Installing SAP IQ Server Software 2. Start the installer and follow the instructions on the screen:
setup.exe -i console
3. When prompted, specify a parent installation directory. Do not install SAP IQ into the root or a destination directory or path that contains spaces.
For new server installations, you must specify a new parent install directory. Do not install to an SAP IQ directory leftover from a previous installation.
If installing the SySAM license server and SAP IQ server on the same machine, do not install to a common parent directory.
If adding components to an existing SAP IQ server, specify the existing parent installation directory. Specifying a different parent directory overwrites existing environment variables and may cause unexpected behavior.
The console installer does not warn you if you try to install to an invalid path or if the parent installation directory or path has changed since the last installation on the machine, and you are about to replace the existing environment variables. 4. Choose one of these installation options:
Option Description
New instal Select Typical to install all default components. Select Custom to select and deselect individual compo lations nents to install.
For "Custom" installations, type the number of the feature to be selected or deselected. The number acts as a switch to the current setting of a feature, though the display does not update.
For example, to install the SAP IQ server only, type 7,10,12.
Note
Specifying a parent product automatically applies the switch to any child component associated with that feature. For example, typing 1 is equivalent to typing 2,4,5,6. However, if you typed 1,2,4,5,6, the 1 would deselect SAP IQ and all its children, then 2,4,5,6 would reselect each specified child feature. The net result would be that all children within SAP IQ would be installed.
Adding com Select Custom and select only the additional components to install. Deselecting components already ponents to installed does not uninstall them, but can significantly speed up the installation process by not reinstal an existing ling existing features along with new features. To remove installed feature, see Uninstalling SAP IQ [page installation 129].
See Product Components [page 16] for information on available components.
5. Indicate whether you want to license SAP IQ now or evaluate the software. You can add your license later if preferred. See Licensing After Installation [page 106]. 6. Complete and accept the terms of the licensing agreement. 7. If licensing now: a. Specify one of:
SAP IQ Installation and Update Guide for Windows Installing SAP IQ Server Software PUBLIC 59 To Action
Use specify license keys Change to the location of the unserved license file and se lect it.
Use previously deployed license server Specify the host name of the license server. Use the ma chine name or the IP address.
Continue installation without a license key If you are unable to enter a valid license key or connect to a license server, select this option to continue the installa tion.
b. Specify the product edition and license type being installed. c. (Optional) Configure SySAM e-mail alerts.
SySAM e-mail alerts do not contain HELO tokens, which some SMTP mail servers require to process messages correctly. If your SMTP server requires a HELO token, append the email.helo.fqdn property to the SySAM property file. The property value should be the fully qualified domain name, such as email.helo.fqdn=sap.com.
The SYSAM properties file is located in the %IQDIR16%\Sysam directory and is named
8. Review the installation summary and adjust as needed. Ensure that expected features are being installed. 9. Begin the installation. 10. If installing SAP IQ Cockpit: a. Accept the default ports or change as needed.
Tip
Refer to your planning checklist.
b. Indicate whether IQ cockpit is to run as a Windows service. c. Indicate if you want to start the IQ cockpit server now. You can start it later if preferred.
Related Information
Create the SAP IQ Account [page 45] Download Installation Files [page 46] Installing SySAM License Server [page 47] Planning Checklist [page 39] Uninstalling SAP IQ [page 129] Licensing After Installation [page 106]
SAP IQ Installation and Update Guide for Windows 60 PUBLIC Installing SAP IQ Server Software 8.3 Installing a Server in Unattended (Silent) Mode
Unattended or silent installations are typically used to update multiple systems. Except for the absence of the GUI screens, all actions of InstallAnywhere are the same, and the result of a server installation in silent mode is exactly the same as one done in either GUI or console mode.
In this section:
Creating a Server Response File [page 61] You create a response file by recording your responses while running a server installation. You can create the file using either GUI or console mode.
Installing a Server Using a Response File [page 63] The system uses the responses in the file to perform the server installation.
8.3.1 Creating a Server Response File
You create a response file by recording your responses while running a server installation. You can create the file using either GUI or console mode.
Prerequisites
● The SAP IQ package has been downloaded and unpacked.
Context
The response file is not created until the current installation completes. Your responses to the screen prompts, not your actual keystrokes, are recorded in the file. Give careful thought to your responses, as they will be used in every installation using the response file.
If you are using an unserved license model, you should select an evaluation license when creating a response file. You can apply the unserved license after running the silent installation. However, if you choose to license when creating the response file, the unserved license file specified in the response file must be available to the installer. If the file is not found during installation, the silent installation fails with a licensing error message.
If you are using a served license model, ensure that the SySAM License Manager is configured and running before you select a license server when creating a response file.
You can only create the response file from a command line.
SAP IQ Installation and Update Guide for Windows Installing SAP IQ Server Software PUBLIC 61 Procedure
1. From a command prompt running as administrator, change to the setup directory where you unpacked your software. 2. Start the installer, where
Mode Syntax
GUI setup.exe -r
Console setup.exe -i console -r
3. Respond to the screen prompts as you would for an attended installation.
Tip
○ Keep in mind that your responses to each prompt are being saved to the file and will be used for each unattended installation. While it is possible to edit the response file before using it, this should be kept to a minimum to prevent unexpected errors in the file from spelling errors or invalid responses, which could cause the installation to fail or not install as intended. ○ It is not recommended that you license SAP IQ with a license file when creating a response file. The license file name and location would be recorded in the response file. For an unattended installation to successfully license the SAP IQ server using this response file, the license file would need to have the same name and exist in the specified location on the machine before the installation begins.
4. Review the installation summary and adjust as needed. 5. Begin the installation.
Results
The response file is created when the installation completes.
Related Information
Create the SAP IQ Account [page 45] Download Installation Files [page 46] Installing SySAM License Server [page 47] Planning Checklist [page 39]
SAP IQ Installation and Update Guide for Windows 62 PUBLIC Installing SAP IQ Server Software 8.3.2 Installing a Server Using a Response File
The system uses the responses in the file to perform the server installation.
Prerequisites
● The SAP IQ package has been downloaded and unpacked. ● If your response file specifies an unserved license, the license file is available to the installer in the location specified in the response file. ● If you plan to apply a served license during installation, the SySAM license server is configured and running.
Context
You can use the default response file, installer.properties or a custom response file. Be careful: If you edit the information in the response file and it becomes invalid, the silent installation might fail. To override the default installation options, use the -f argument to point to a custom response file.
You can only run a silent installation from a command line.
The cursor disappears when the silent installation begins, and reappears when complete. Press Ctrl + c at any time to cancel a silent installation.
Procedure
1. From a command prompt running as administrator, change to the setup directory where you unpacked your software. 2. Start the installer using the appropriate syntax for the license type specified in the response file.
For evaluation, type:
setupConsole.exe –f
-DAGREE_TO_SAP_LICENSE=true
For licensed type:
setupConsole.exe –f
-DAGREE_TO_SAP_LICENSE=true -DSYBASE_PRODUCT_LICENSE_TYPE=license
where:
SAP IQ Installation and Update Guide for Windows Installing SAP IQ Server Software PUBLIC 63 Argument Description
-f
-i silent Required switch that starts the silent installer.
-DAGREE_TO_SAP_LICENSE=true Required argument that indicates you accept Sybase end-user license agreement.
- Required argument to install a licensed version of the software. Not re DSYBASE_PRODUCT_LICENSE_TYPE= quired for evaluation version. license
- Optional argument that deletes unnecessary files after installation. DUNINSTALL_DELETE_DATA_FILES= true
Results
If the response file references an unserved license that cannot be found, the silent installation fails with an error message.
If the response file references a SySAM license server that is not running, the installation completes, but the SAP IQ server is configured to use an evaluation license. Start the license server, then stop and restart the SAP IQ server to apply the served license.
Related Information
Create the SAP IQ Account [page 45] Download Installation Files [page 46] Installing SySAM License Server [page 47] Planning Checklist [page 39]
SAP IQ Installation and Update Guide for Windows 64 PUBLIC Installing SAP IQ Server Software 8.4 Server Environment Variables
A server installation installs the SAP IQ server and selected components into a user-defined parent directory on the host machine. SAP IQ then uses environment variables, which are set by the installer to point to the different installation directories.
Context
Environment variables can be modified, as needed.
See Environment Variables [page 95] for information on modifying environment variables.
8.5 Finding Server Utilities and Files
SAP IQ uses environment variables to point to different installation directories.
Directory Variables
SAP IQ uses environment variables to point to different installation directories.
Variable Points To Description
%SYBASE% User-defined parent instal Directory that contains the core SAP IQ server product directory lation directory. as well as the directories for selected components.
%IQDIR16% Product installation direc Directory that contains the core SAP IQ server product directo tory IQ-16_1, a subdirec ries. tory of the parent installa tion directory.
%ALLUSERSPROFILE% Windows local resources The location of these resources depends on the Windows ver directory. sion, but are usually located in the C:\ProgramData direc tory.
Parent Installation Directories
The user-defined installation directory (%SYBASE%) contains the files, scripts, and other objects required to support the server.
SAP IQ Installation and Update Guide for Windows Installing SAP IQ Server Software PUBLIC 65 Directory Contents
charsets Character sets available for compatibility with Adaptive Server Enterprise.
COCKPIT-4 SAP IQ Cockpit startup and configuration files.
collate Collation sequences available for compatibility with Adaptive Server Enterprise.
ini Various configuration files.
IQ-16_1 Subdirectories, scripts, and property files required to run the server.
jConnect-16_0 JDBC 4.0 compliant driver for SAP IQ.
jre Java runtime environment.
jutils-3_0 Version 3.0 Java-based utilities, including Ribo, a Tabular Data Streams utility.
locales Language modules for system messages and date/time formats.
log Installation log files.
OCS-16_0 Open Client tools and utilities.
Shared Objects and libraries shared by other components, including the Java Runtime Environ ment (JRE).
Sybase_Install_Registr Server registry file that holds information related to the installed products. Do not mod y ify.
sybuninstall Subdirectories for scripts that uninstall SAP IQ and SySAM.
SYSAM-2_0 SySAM licenses and utilities. This directory contains three subdirectories: bin, licenses, and log.
ThirdPartyLegal Third party license terms and agreements.
Product Installation Directories
IQ-16_1 (%IQDIR16%) is a subdirectory of the user-defined installation directory (%SYBASE%) that contains the files, scripts, and other objects required to run the server.
Directory Contents
Assembly ADO.NET and .NET assembly files.
Bin32 Libraries required for 32-bit compatibility.
SAP IQ Installation and Update Guide for Windows 66 PUBLIC Installing SAP IQ Server Software Directory Contents
Bin64 Utilities you use to start and manage your server.
DBACOCKPIT Stores query plans generated by DBA Cockpit.
demo A readme that identifies the location of the demo database and other local resources.
install Installation history file.
java Different JAR files.
logfiles SAP IQ writes log files to this directory.
lsunload Local Store Unload utility.
Scripts Sample scripts and stored procedures.
SDK Subdirectories for various language utilities.
SNMP Not supported by SAP IQ.
support A Web page with links to online resources.
Sysam Local SySAM configuration information.
unload Various unload scripts, files, and utilities.
Local Resources Directory
The %ALLUSERSPROFILE%\SAPIQ directory (ProgramData\SAPIQ) contains local resources, including the demo database, server logs, and utilities.
Directory Contents
demo Sample data and scripts for the demo database.
logfiles Server log files.
Samples Sample scripts, drivers, and utilities.
SAP IQ Installation and Update Guide for Windows Installing SAP IQ Server Software PUBLIC 67 8.6 Reviewing Server Installation Logs
The installer writes a general log to the %SYBASE% directory that records all installation activity and individual logs for each installed component. If an installation problem occurs, start with the IQ_Suite.log, then refer to the component log for specific details.
The installer also creates a set of corresponding .out files for each component .log file. These files capture different component installation activities. If the installer runs normally, these files may remain empty.
All installation log files are found in the log directory within the SAP IQ parent installation directory.
Note
Do not confuse this log directory with the logfiles directory in the %IQDIR16% directory, which contains SAP IQ log files not related to installation.
File Name Contents
conn_add_lang.log Additional Connectivity Language Modules
conn_lang.log Connectivity Language Modules
iq_agent.log Agent Plug-in
iq_client_common.log Client components
iq_client_ms.log Windows client components
iq_client_web.log Web Drivers
iq_odbc.log ODBC Driver
iq_server.log Server components
iq_shared.log Shared SAP IQ Configuration files
IQ_Suite.log SAP IQ Server Suite installation summary
IQ_Suite_Variable_Reference.log InstallAnywhere installation variables
iqcmap.log SAP IQ Cockpit installation summary
jconnect16.log SAP jConnect installation summary
jre8.log Java Runtime Environment v8 installation (SAP IQ and SAP IQ Cockpit)
lang.log Language Modules
scc_cfw.log Cockpit framework installation summary
SAP IQ Installation and Update Guide for Windows 68 PUBLIC Installing SAP IQ Server Software File Name Contents
open_client.log Open Client installation summary
scc_server.log SAP IQ Cockpit user interface installation summary
sysam_util.log SySAM License Utilities installation summary
SAP IQ Installation and Update Guide for Windows Installing SAP IQ Server Software PUBLIC 69 9 Installing SAP IQ Client Software
SAP IQ client installation media supports GUI, console, and unattended (silent) installs. You can use the installation media to install a new SAP IQ client and selected components or to add additional components to an existing installation.
In this section:
Set Windows 2012 R2 Compatibility Mode for SAP IQ Installer [page 71] Configure the compatibility mode on the SAP IQ installer to prevent issues when running.
Running the Client and Server on the Same System [page 71] Your SAP IQ server can connect to a remote SAP IQ server. In this scenario, the SAP IQ server becomes a client of the remote SAP IQ server, and requires an SAP IQ client.
Installing a Client in GUI Mode [page 71] Use this option to set up your client software in a graphical user interface (GUI) environment. The GUI installer is wizard-driven and supports all product editions and installation types.
Installing a Client in Console Mode [page 73] Choose a command-line installation if you prefer a non-windowing interface or for developing custom installation scripts. Installing the client in console mode is similar to installing in GUI mode, except that you run the installer from the command line, and enter text to select the installation options.
Installing a Client in Unattended (Silent) Mode [page 74] Unattended or silent installations are typically used to update multiple systems. Except for the absence of the GUI screens, all actions of InstallAnywhere are the same, and the result of a client installation in silent mode is exactly the same as one done in GUI mode with the same responses.
Client Environment Variables [page 78] A client installation installs the SAP IQ client and selected components into a user-defined parent directory on the host machine. SAP IQ then uses environment variables, which are set by the installer to point to the different installation directories.
Finding Client Utilities and Files [page 78] SAP IQ uses environment variables to point to different installation directories.
Reviewing Client Installation Logs [page 80] The installer writes a general log to the %SYBASE% directory that records all installation activity and individual logs for each installed component. If an installation problem occurs, start with the IQ_Client_Suite.log, then refer to the component log for specific details.
Configuring Client Connectivity [page 80] SAP IQ supports ODBC and JDBC connectivity.
Related Information
Download Installation Files [page 46]
SAP IQ Installation and Update Guide for Windows 70 PUBLIC Installing SAP IQ Client Software 9.1 Set Windows 2012 R2 Compatibility Mode for SAP IQ Installer
Configure the compatibility mode on the SAP IQ installer to prevent issues when running.
Context
This configuration is required for installations using either console or GUI mode.
Procedure
1. On the Windows server, change to the server directory within the SAP IQ installing package. 2. Right-click setup.exe and select Properties. 3. On the Compatibility tab, check Run this program in compatibility mode for: and select Windows 7 from the dropdown.
9.2 Running the Client and Server on the Same System
Your SAP IQ server can connect to a remote SAP IQ server. In this scenario, the SAP IQ server becomes a client of the remote SAP IQ server, and requires an SAP IQ client.
SAP IQ uses a shared memory segment and several semaphores for communication between the client and server on the same machine. Shared memory is the default communications mechanism when the client and server are on the same system. Shared memory is configured automatically, and starts automatically.
9.3 Installing a Client in GUI Mode
Use this option to set up your client software in a graphical user interface (GUI) environment. The GUI installer is wizard-driven and supports all product editions and installation types.
Prerequisites
● If installing the client on a Windows 2012 R2 server, compatibility mode is set. See Set Windows 2012 R2 Compatibility Mode for SAP IQ Installer [page 48]
SAP IQ Installation and Update Guide for Windows Installing SAP IQ Client Software PUBLIC 71 ● The SAP IQ package has been downloaded and unpacked.
Procedure
1. Change to the setup directory where you downloaded and unpacked your SAP IQ software. 2. Start the installer:
Right-click setup.exe and select Run as Administrator and follow the instructions on the screen. 3. When prompted, specify a parent installation directory. Do not install SAP IQ into the root or a destination directory or path that contains spaces.
For new installations, you must specify a new parent install directory. Do not install to an SAP IQ directory leftover from a previous installation.
If adding components to an existing SAP IQ server, specify the existing parent installation directory. Specifying a different parent directory overwrites existing environment variables and may cause unexpected behavior.
The GUI installer warns you if you try to install to an invalid path or if the parent install directory or path has changed since the last installation on the machine, and you are about to replace the existing environment variables. 4. Do one of:
For Action
New Installations Select Typical to install all default components. Select Custom to select and deselect individual components to install.
Adding components to an existing instal Select Custom and select only the additional components to install. Dese lation lecting components already installed does not uninstall them, but can sig nificantly speed up the installation process by not reinstalling existing fea tures along with new features. To remove installed feature, see Uninstalling SAP IQ [page 129].
See Product Components [page 16] for information on available components.
5. Complete and accept the terms of the licensing agreement. 6. Review the installation summary and adjust as needed. 7. Begin the installation.
Related Information
Create the SAP IQ Account [page 45] Download Installation Files [page 46] Installing SAP IQ Server Software [page 55] Planning Checklist [page 39] Uninstalling SAP IQ [page 129]
SAP IQ Installation and Update Guide for Windows 72 PUBLIC Installing SAP IQ Client Software 9.4 Installing a Client in Console Mode
Choose a command-line installation if you prefer a non-windowing interface or for developing custom installation scripts. Installing the client in console mode is similar to installing in GUI mode, except that you run the installer from the command line, and enter text to select the installation options.
Prerequisites
● If installing the client on a Windows 2012 R2 server, compatibility mode is set. See Set Windows 2012 R2 Compatibility Mode for SAP IQ Installer [page 48] ● The SAP IQ package has been downloaded and unpacked.
Context
Note
● If you are installing the SAP IQ client on a machine with SAP IQ server already installed, you must perform the installation using the SAP IQ server installer, not the SAP IQ client installer. See Installing SAP IQ Server Software [page 55]. ● To return to the previous prompt from within the console installer, type back at any time.
Procedure
1. Change to the setup directory where you downloaded and unpacked your SAP IQ software. 2. Start the installer and follow the instructions on the screen:
setup.exe -i console
3. When prompted, specify a parent installation directory. Do not install SAP IQ into the root or a destination directory or path that contains spaces.
For new installations, you must specify a new parent install directory. Do not install to an SAP IQ directory leftover from a previous installation.
If adding components to an existing SAP IQ server, specify the existing parent installation directory. Specifying a different parent directory overwrites existing environment variables and may cause unexpected behavior.
The console installer does not warn you if you try to install to an invalid path or if the parent installation directory or path has changed since the last installation on the machine, and you are about to replace the existing environment variables.
SAP IQ Installation and Update Guide for Windows Installing SAP IQ Client Software PUBLIC 73 4. Choose one of these installation options:
Option Description
New installa Select Typical to install all default components. Select Custom to select and deselect individual com tions ponents to install.
For "Custom" installations, type the number of the feature to be selected or deselected. The number acts as a switch to the current setting of a feature, though the display does not update.
For example, to install the client only without drivers, type 1,2. 1 deselects SAP IQ and all its children. 2 then reselects the IQ client only.
Note
Specifying a parent product automatically applies the switch to any child components associated with that feature. For example, typing 1 is equivalent to typing 2,3,4. However, if you typed 1,2,4, the 1 would deselect SAP IQ and all its children, then 2,3,4 would reselect each specified child fea ture. The net result would be that all children within SAP IQ would be installed.
Adding com Select Custom and select only the additional components to install. Deselecting components already ponents to an installed does not uninstall them, but can significantly speed up the installation process by not rein existing in stalling existing features along with new features. To remove installed feature, see Uninstalling SAP IQ stallation [page 129].
See Product Components [page 16] for information on available components.
5. Complete and accept the terms of the licensing agreement. 6. Review the installation summary and adjust as needed. Ensure that expected features are being installed. 7. Begin the installation.
Related Information
Create the SAP IQ Account [page 45] Download Installation Files [page 46] Installing SAP IQ Server Software [page 55] Planning Checklist [page 39] Uninstalling SAP IQ [page 129]
9.5 Installing a Client in Unattended (Silent) Mode
Unattended or silent installations are typically used to update multiple systems. Except for the absence of the GUI screens, all actions of InstallAnywhere are the same, and the result of a client installation in silent mode is exactly the same as one done in GUI mode with the same responses.
In this section:
Creating a Client Response File [page 75]
SAP IQ Installation and Update Guide for Windows 74 PUBLIC Installing SAP IQ Client Software You create a response file by recording your responses while running a client installation. You can create the file using either GUI or console mode.
Installing a Client Using a Response File [page 76] The system uses the responses in the file to perform the client installation.
9.5.1 Creating a Client Response File
You create a response file by recording your responses while running a client installation. You can create the file using either GUI or console mode.
Prerequisites
● The SAP IQ package has been downloaded and unpacked.
Context
The response file is not created until the current installation completes. Your responses to the screen prompts, not your actual keystrokes, are recorded in the file. Give careful thought to your responses, as they will be used in every installation using the response file.
You can only create the response file from a command line.
Procedure
1. From a command prompt running as administrator, change to the setup directory where you unpacked your software. 2. Start the installer, where
Mode Syntax
GUI setup.exe -r
Console setup.exe -i console -r
3. Respond to the screen prompts as you would for an attended installation. 4. Review the installation summary and adjust as needed.
SAP IQ Installation and Update Guide for Windows Installing SAP IQ Client Software PUBLIC 75 5. Begin the installation.
Results
The response file is created when the installation completes.
Related Information
Create the SAP IQ Account [page 45] Download Installation Files [page 46] Installing SAP IQ Server Software [page 55] Planning Checklist [page 39]
9.5.2 Installing a Client Using a Response File
The system uses the responses in the file to perform the client installation.
Prerequisites
● The SAP IQ package has been downloaded and unpacked.
Context
You can use the default response file, installer.properties or a custom response file. Be careful: If you edit the information in the response file and it becomes invalid, the silent installation might fail. To override the default installation options, use the -f argument to point to a custom response file.
You can only run a silent installation from a command line.
The cursor disappears when the silent installation begins, and reappears when complete. Press Ctrl + c at any time to cancel a silent installation.
Procedure
1. From a command prompt running as administrator, change to the setup directory where you unpacked your software.
SAP IQ Installation and Update Guide for Windows 76 PUBLIC Installing SAP IQ Client Software 2. Start the installer using the appropriate syntax for the license type specified in the response file.
For evaluation, type:
setupConsole.exe –f
-DAGREE_TO_SAP_LICENSE=true
For licensed type:
setupConsole.exe –f
-DAGREE_TO_SAP_LICENSE=true -DSYBASE_PRODUCT_LICENSE_TYPE=license
where:
Argument Description
-f
-i silent Required switch that starts the silent installer.
-DAGREE_TO_SAP_LICENSE=true Required argument that indicates you accept Sybase end-user license agreement.
- Required argument to install a licensed version of the software. Not re DSYBASE_PRODUCT_LICENSE_TYPE= quired for evaluation version. license
- Optional argument that deletes unnecessary files after installation. DUNINSTALL_DELETE_DATA_FILES= true
Related Information
Create the SAP IQ Account [page 45] Download Installation Files [page 46] Installing SAP IQ Server Software [page 55] Planning Checklist [page 39]
SAP IQ Installation and Update Guide for Windows Installing SAP IQ Client Software PUBLIC 77 9.6 Client Environment Variables
A client installation installs the SAP IQ client and selected components into a user-defined parent directory on the host machine. SAP IQ then uses environment variables, which are set by the installer to point to the different installation directories.
Context
Environment variables can be modified, as needed.
See Environment Variables [page 95] for information on modifying environment variables.
Note
You don't need to set client environment variables if the server and client are installed on the same host.
9.7 Finding Client Utilities and Files
SAP IQ uses environment variables to point to different installation directories.
Directory Variables
SAP IQ uses environment variables to point to different installation directories.
Variable Points To Description
%SYBASE% User-defined parent instal Directory that contains the core SAP IQ client product directory lation directory as well as the directories for selected components.
%IQDIR16% Product installation direc Directory that contains the core SAP IQ client product directo tory IQ-16_1, a subdirec ries. tory of the parent installa tion directory.
%ALLUSERSPROFILE% Windows local resources The location of these resources depends on the Windows ver directory sion, but are usually located in the C:\ProgramData direc tory.
SAP IQ Installation and Update Guide for Windows 78 PUBLIC Installing SAP IQ Client Software Parent Installation Directory
The user-defined directory (%SYBASE%) contains the files, scripts, and other objects required to support the client.
Directory Contents
IQ-16_1 SAP IQ client components.
jConnect-16_0 JDBC 4.0 compliant driver for SAP IQ.
Shared Shared software components.
Sybase_Install_Registry Client component registry file.
jre Java Runtime Environment directory.
jutils-3_0 Version 3.0 Java-based utilities, including Ribo, a Tabular Data Streams utility.
log Client log file directory.
ThirdPartyLegal Third-party license agreements.
sybuninstall Subdirectories for scripts that uninstall SAP IQ and SySAM.
Product Installation Directory
IQ-16_1 (%IQDIR16%) is a subdirectory of the user-defined installation directory (%SYBASE%) that contains the files, scripts, and other objects required to run the client.
Directory Contents
Assembly SAP SQL Anywhere support files.
bin
install Installation history file.
Java Different JAR files.
SDK Subdirectories for various language utilities.
support A Web page with links to online resources.
SAP IQ Installation and Update Guide for Windows Installing SAP IQ Client Software PUBLIC 79 9.8 Reviewing Client Installation Logs
The installer writes a general log to the %SYBASE% directory that records all installation activity and individual logs for each installed component. If an installation problem occurs, start with the IQ_Client_Suite.log, then refer to the component log for specific details.
The installer also creates a set of corresponding .out files for each component .log file. These files capture different component installation activities. If the installer runs normally, these files may remain empty.
All installation log files are found in the log directory within the SAP IQ parent installation directory.
Note
Do not confuse this log directory with the logfiles directory in the %IQDIR16% directory, which contains SAP IQ log files not related to installation.
File Name Contents
iq_client_common.log Client components
iq_client_ms.log Windows client components
IQ_Client_Suite.log SAP IQ Client Suite installation summary
IQ_Client_Suite_Variable_Reference.log InstallAnywhere installation variables
iq_client_web.log Web Drivers
iq_odbc.log ODBC Driver
iq_shared.log Shared SAP IQ Configuration files
jconnect16.log SAP jConnect installation summary
jre8.log Java Runtime Environment v8 installation (SAP IQ and SAP IQ Cockpit)
9.9 Configuring Client Connectivity
SAP IQ supports ODBC and JDBC connectivity.
In this section:
Connecting Using ODBC [page 81] Open Database Connectivity (ODBC) is a standard API that allows a single application to access a variety of data sources through ODBC–compliant drivers.
Connecting Using JDBC [page 84]
SAP IQ Installation and Update Guide for Windows 80 PUBLIC Installing SAP IQ Client Software JDBC and jConnect provide access to SAP IQ for Java-based applications.
Connecting Using OLE DB [page 84] SAP IQ includes an OLE DB provider as an alternative to ODBC. OLE DB is a data access model from Microsoft that uses the Component Object Model (COM) interfaces. Unlike ODBC, OLE DB does not assume that the data source uses a SQL query processor. Although OLE DB requires a Windows client, you can use OLE DB to access Windows and UNIX servers.
Connecting Using Open Client [page 84] Clients require a server object in the interfaces file to access server properties and methods. Use the SAP IQ Directory Services Editor (dsedit) to create the interfaces file entries. These instructions apply to sever installations only.
Network Issues for SAP IQ Servers [page 85] Properly configured UNIX servers run under the TCP/IP protocol, which enables non–UNIX clients to communicate with the server.
Connecting Across a Firewall [page 86] Set the CommLinks connection parameters in your application's connection string to connect across a firewall.
9.9.1 Connecting Using ODBC
Open Database Connectivity (ODBC) is a standard API that allows a single application to access a variety of data sources through ODBC–compliant drivers.
In this section:
ODBC Conformance [page 82] ODBC drivers manufactured by different vendors may vary widely in the functions they provide. SAP IQ supports ODBC 3.5.2.
Installing ODBC Drivers [page 82] Server and client installations include ODBC drivers. Platform-specific drivers are available from the SAP Product Download Center and SAP Service Marketplace.
Using UNIX or Linux-Based Query Tools Through ODBC [page 82] There are several ways to use ODBC to connect to UNIX or Linux-based query tools.
Creating an ODBC Data Source [page 83] On UNIX-like operating systems, ODBC data sources are stored in .odbc.ini. Use a text editor to update this file manually, or use the cross–platform iqdsn utility to create an ODBC data source. On Windows, use ODBC Administrator to add a new ODBC data source.
Command Line Connections to 32-Bit Applications [page 83] Use dbisql to connect to 32-bit applications from the command line.
SAP IQ Installation and Update Guide for Windows Installing SAP IQ Client Software PUBLIC 81 9.9.1.1 ODBC Conformance
ODBC drivers manufactured by different vendors may vary widely in the functions they provide. SAP IQ supports ODBC 3.5.2.
Conformance Level SAP IQ Support
Core conformance All core features.
Level 1 conformance All level 1 features, except for asynchronous execution of ODBC functions.
SAP IQ does support multiple threads sharing a single connection. The re quests from the different threads are serialized by SAP IQ.
Level 2 conformance All level 2 features, except:
● Three-part names of tables and views. This is not applicable for SAP IQ. ● Asynchronous execution of ODBC functions for specified individual state ments. ● Ability to time out login requests and queries.
Note
● Although you can use new ODBC 3.5.x features such as descriptors in your ODBC applications, ODBC 2.x applications will continue to work with SAP IQ. ● For more information about ODBC, see the ODBC Programmer's Reference, available from Microsoft Corporation as part of the ODBC software development kit, or from the Microsoft Web site at: http:// msdn.microsoft.com/en-us/library/windows/desktop/ms714177(v=vs.85).aspx .
9.9.1.2 Installing ODBC Drivers
Server and client installations include ODBC drivers. Platform-specific drivers are available from the SAP Product Download Center and SAP Service Marketplace.
9.9.1.3 Using UNIX or Linux-Based Query Tools Through ODBC
There are several ways to use ODBC to connect to UNIX or Linux-based query tools.
UNIX-like operating systems do not provide a standard ODBC driver manager, but you can use the driver manager emulation capabilities provided by the SAP IQ ODBC driver to connect to the driver.
Tools that do not require extensive driver manager services can use symbolic links to connect directly to the driver. Tools that require a driver manager may ship with a driver manager.
For information and recommendations about compatible driver managers available for specific applications, see the documentation for the application.
SAP IQ Installation and Update Guide for Windows 82 PUBLIC Installing SAP IQ Client Software 9.9.1.4 Creating an ODBC Data Source
On UNIX-like operating systems, ODBC data sources are stored in .odbc.ini. Use a text editor to update this file manually, or use the cross–platform iqdsn utility to create an ODBC data source. On Windows, use ODBC Administrator to add a new ODBC data source.
Procedure
1. From the SAP IQ 16.1 program group, choose the option appropriate for your operating system: ○ ODBC Data Source Administrator 32 bit ○ ODBC Data Source Administrator 64 bit 2. On the ODBC Data Source Administrator dialog, click Add. 3. On the Create New Data Source dialog, choose the Sybase IQ driver, then click Finish. 4. When you return to the ODBC Configuration dialog, type a Data Source Name in the Data Source Name box. 5. Click the Login tab, type a database User ID and Password in the appropriate text boxes. 6. Click the Database tab. What you do next depends on the data source location:
○ If the data source is on a remote machine, type the
After you create the data source, use ODBC Data Source Administrator to test the new data source. See online help for more information.
9.9.1.5 Command Line Connections to 32-Bit Applications
Use dbisql to connect to 32-bit applications from the command line.
To connect to a 32-bit application without using a data source, use dbisql to connect from the command line.
To connect to the iqdemo.db, use a command similar to the following:
dbisql -c "UID=DBA;PWD=
ENG=
SAP IQ Installation and Update Guide for Windows Installing SAP IQ Client Software PUBLIC 83 9.9.2 Connecting Using JDBC
JDBC and jConnect provide access to SAP IQ for Java-based applications.
Java Database Connectivity (JDBC) is a Java application programming interface (API) that provides programmatic access to SAP IQ. jConnect is an SAP utility that provides high-performance native access to all SAP products as a standard installation option.
Interactive SQL (dbisql) can use either JDBC or ODBC connectivity.
The SQL Anywhere JDBC driver is the default driver for Interactive SQL.
Note
The iAnywhere JDBC driver is deprecated.
9.9.3 Connecting Using OLE DB
SAP IQ includes an OLE DB provider as an alternative to ODBC. OLE DB is a data access model from Microsoft that uses the Component Object Model (COM) interfaces. Unlike ODBC, OLE DB does not assume that the data source uses a SQL query processor. Although OLE DB requires a Windows client, you can use OLE DB to access Windows and UNIX servers.
SAP IQ supports Dynamic (dynamic scroll), Static (insensitive) and Forward only (no–scroll) cursors, but does not support Keyset (scroll) cursors. In SAP IQ the isolation level is always 3, no matter what you specify.
SAP IQ does not support Windows CE or remote updates through a cursor.
Additional Information
See OLE DB Connection Parameters in SAP IQ Programming Reference.
9.9.4 Connecting Using Open Client
Clients require a server object in the interfaces file to access server properties and methods. Use the SAP IQ Directory Services Editor (dsedit) to create the interfaces file entries. These instructions apply to sever installations only.
Prerequisites
● You must be the owner of the SAP IQ home directory (%SYBASE%) to run dsedit
SAP IQ Installation and Update Guide for Windows 84 PUBLIC Installing SAP IQ Client Software ● Make a copy of the interfaces file before you make any changes
Procedure
1. From the command line, change to %SYBASE%\OCS-16_0\bin 2. Start dsedit. 3. On the Select a Directory Service dialog, select the interfaces file or driver (default) or select a directory service to open, and then click OK. 4. From the Directory Service Session dialog, choose Add new server entry. 5. On the Server Entry Editor dialog, enter the SAP IQ server name, then click the Add new network transport. 6. On the Network Transport Editor dialog, enter the host name and port number of the SAP IQ server and then click OK. 7. On the Server Entry Editor dialog, click OK. 8. On the Directory Service Session dialog, click Close session. 9. On the Select a Directory Service dialog, click Exit 10. On the dsedit question dialog, click Yes to confirm exit.
9.9.5 Network Issues for SAP IQ Servers
Properly configured UNIX servers run under the TCP/IP protocol, which enables non–UNIX clients to communicate with the server.
Verified TCP/IP Protocol Stacks
For SAP IQ to run properly, the protocol stack on the client and server computers must be compatible at each layer. Many vendors supply TCP/IP protocol stacks and associated software. SAP IQ communications have been explicitly verified with these TCP/IP implementations:
● TCP/IP For NetWare ● Microsoft Winsock version 2.0
Using TCP/IP with Windows
Windows ships with TCP/IP software that uses NDIS network drivers. This software allows an SAP IQ server for Windows or an SAP IQ client application to use Windows TCP/IP. Install TCP/IP Protocol from the Network Settings options on the Control Panel.
SAP IQ Installation and Update Guide for Windows Installing SAP IQ Client Software PUBLIC 85 User Datagram Protocol
There are several entries into the TCP/IP protocol stack. SAP IQ employs the User Datagram Protocol (UDP). While it is called a transport protocol here and elsewhere, UDP provides little more than a user interface to the network layer IP. In particular, UDP is not a guaranteed transmission protocol.
Tuning Performance Under TCP/IP
Although the default packet size for TCP/IP is 1460 bytes, a larger packet size may improve query response time, especially for queries that transfer a large amount of data between a client and a server process. You can set the maximum packet size using the database server command lines or CommBufferSize (CBSIZE) in the client connection string. This option may be used with the start_iq command.
9.9.6 Connecting Across a Firewall
Set the CommLinks connection parameters in your application's connection string to connect across a firewall.
There are restrictions on connections when the client application is on one side of a firewall and the server is on the other. Firewall software filters network packets according to network port. Also, it is common to disallow UDP packets from crossing the firewall.
When connecting across a firewall, you must use a set of communication parameters in the CommLinks connection parameter of your application's connection string.
● Set the UseUDP parameter to off to prevent UDP packets from being used to locate the server. You can use the short form UDP. ● Set the ClientPort parameter to a range of allowed values for the client application to use. You can then configure your firewall to allow these packets across. You can use the short form CPort. ● Set the HOST parameter to the host name on which the database server is running. You can use the short form IP. ● If your database server is not using the default port of 2638, you must specify the port it is using, in the ServerPort parameter. You can use the short form Port.
In this example, the connection string fragment:
● Restricts the client application to ports 5050 through 5060Disables UDP packets ● Connects to a server named myiq running on the machine at address myhost using the server port 2020
CommLinks=tcpip(UseUDP=OFF;ClientPort=5050-5060;Host=myhost;Port=2020;Eng=myiq )
SAP IQ Installation and Update Guide for Windows 86 PUBLIC Installing SAP IQ Client Software Additional Information
See Connection and Communication Parameters in SAP IQ Administration: Database.
SAP IQ Installation and Update Guide for Windows Installing SAP IQ Client Software PUBLIC 87 10 Postinstallation Tasks
Once your server and client software is installed, the postinstallation tasks help you verify if it is correctly configured, licensed, and running.
In this section:
(Optional) The Demo Database [page 89] The SAP IQ demo database (iqdemo.db) is a database that contains sample data about a fictional company that sells athletic clothing.
(Optional) The SAP IQ Utility Server [page 91] The utility server is a phantom database with no physical representation. It has no database file, and therefore it cannot contain data.
Setting Up Your Environment [page 92] These topics describe the installation and operating system settings used by SAP IQ.
Licensing After Installation [page 106] All product editions except the Evaluation Edition require a license. Optional features are sold and licensed separately.
Starting and Running an SAP IQ Server [page 109] Use the start_iq startup utility to start your server. start_iq is a command line utility that runs on all platforms and ensures that all required parameters are set correctly.
Stopping an SAP IQ Server [page 111] SERVER OPERATOR system privilege is the default permission level required to stop a server, but you can use the -gk startup option to change the default to ALL or NONE. Setting the permission level to ALL lets all users stop the server; setting the permission level to NONE means that no one can stop the server. In a production environment, only the Server Operator should be allowed to stop the database server.
Starting and Stopping the SAP IQ Cockpit Agent [page 113] SAP IQ Cockpit is a Web-based tool for managing and monitoring SAP IQ servers. The SAP IQ Cockpit agent must be running to log on to the SAP IQ Cockpit. Run the cockpit command to start SAP IQ Cockpit agent.
Stopping the SAP IQ Cockpit Agent [page 113] Stop the SAP IQ Cockpit agent. Once stopped, you can no longer use the SAP IQ Cockpit.
Configuration [page 114] This section outlines basic configuration concepts and procedures of an SAP IQ server.
Remove Sample Application Files [page 117] Before you deploy your server in a production environment, remove the sample client applications.
Starting Interactive SQL [page 117] Interactive SQL is a utility that ships with SAP IQ and lets you execute SQL statements, build scripts, and display database data. It is a component of the SAP IQ client software.
Verify an SAP IQ Server Is Running [page 118] Verify whether a specific SAP IQ server is running.
SAP IQ Installation and Update Guide for Windows 88 PUBLIC Postinstallation Tasks Verify SAP IQ Server Is Licensed [page 119] After you license an SAP IQ sever, verify that the license was accepted.
10.1 (Optional) The Demo Database
The SAP IQ demo database (iqdemo.db) is a database that contains sample data about a fictional company that sells athletic clothing.
Many of the examples throughout the documentation use the demo database as a data source. It is installed as part of the SAP IQ Server installation and resides on the server. You can also use the demo database to test your installation.
For a new SAP IQ installation, to successfully log on to the SAP IQ Cockpit requires that at least one server be running. Without access to the SAP IQ Cockpit, you cannot use the Create Database wizard to create your initial server. The SAP IQ demo database can be used as the initial server.
Use of the demo database is optional and has no performance impact.
Note
The demo database is not designed to be used as a production database.
In this section:
Creating the Demo Database [page 89] Use the SAP IQ script to create the demo database.
Starting and Stopping the Demo Database [page 90] You can start and stop the demo database as needed.
Removing the Demo Database [page 90] Once you have created a production database on the SAP IQ server, you may choose to remove the demo database. Removal is optional and has no performance impact on your production system if not removed.
10.1.1 Creating the Demo Database
Use the SAP IQ script to create the demo database.
Procedure
1. Do one of:
○ On the Start screen, click the App icon ( ) to display the APPS list. In the SAP section, choose Start SAP IQ Demo Database.
SAP IQ Installation and Update Guide for Windows Postinstallation Tasks PUBLIC 89 ○ Change to the %ALLUSERSPROFILE%\SAPIQ\demo directory and run run_mkiqdemo.bat. 2. Follow the prompts on the screen. Minimum password length is 6 characters.
Results
The demo database is created and started. It is called iqdemo.db and the database resides in %ALLUSERSPROFILE%\SAPIQ\demo directory.
10.1.2 Starting and Stopping the Demo Database
You can start and stop the demo database as needed.
Procedure
1. From a command line, change to the directory where you created the demo database.
%ALLUSERSPROFILE%\SAPIQ\demo
2. To start the demo database, enter:
start_iq @iqdemo.cfg iqdemo.db
3. To stop the demo database, do one of:
○ right-click the server icon in the task bar for the demo database and choose Shut down "
10.1.3 Removing the Demo Database
Once you have created a production database on the SAP IQ server, you may choose to remove the demo database. Removal is optional and has no performance impact on your production system if not removed.
In the %ALLUSERSPROFILE%\demo directory, delete all files beginning with iqdemo. Also delete the demodata folder.
SAP IQ Installation and Update Guide for Windows 90 PUBLIC Postinstallation Tasks 10.2 (Optional) The SAP IQ Utility Server
The utility server is a phantom database with no physical representation. It has no database file, and therefore it cannot contain data.
For a new SAP IQ installation, to successfully log on to the SAP IQ Cockpit requires that at least one server be running. Without access to the SAP IQ Cockpit, you cannot use the Create Database wizard to create your initial server. The SAP IQ utility server can be used as the initial server.
The utility server has no default password. It uses a temporary password, which you define during startup. The password is valid only for the duration the utility server is running. A new password must be defined each time the utility server is started.
When logged in to the utility server in the SAP IQ Cockpit console, you can use the Create Database wizard to your first database.
In this section:
Starting and Stopping the SAP IQ Utility Server [page 91] The SAP IQ utility server must be running before you can create the initial SAP IQ server and should be stopped immediately after creation is complete.
10.2.1 Starting and Stopping the SAP IQ Utility Server
The SAP IQ utility server must be running before you can create the initial SAP IQ server and should be stopped immediately after creation is complete.
Procedure
1. Change to the %SYBASE%\IQ-16_1\bin64 directory:
%SYBASE%\IQ-16_1\bin64\cockpitutildb.bat
2. Specify a temporary password for the utility server. 3. To stop the demo database, do one of:
○ right-click the server icon in the task bar, and choose Shut down "
SAP IQ Installation and Update Guide for Windows Postinstallation Tasks PUBLIC 91 10.3 Setting Up Your Environment
These topics describe the installation and operating system settings used by SAP IQ.
Depending on the operating system, these settings may be stored as environment variables, initialization file entries, or registry entries.
In this section:
Installation Directory Structure [page 92] When you install SAP IQ, several directories may be created. This section describes the directory structure.
How SAP IQ Locates Files [page 93] To start and run, SAP IQ must find and access several types of files. Several directories or files with identical names may reside on a system.
Environment Variables [page 95] SAP IQ uses environment variables to store various types of information. Environment variables can be modified, if needed, and not all variables need to be set in all circumstances.
Registry Entries [page 104] On Windows operating systems, SAP IQ uses several registry settings.
10.3.1 Installation Directory Structure
When you install SAP IQ, several directories may be created. This section describes the directory structure.
The directories created depend on which options you choose during installation and which directories already exist in your SAP IQ directory (the parent directory defined by $SYBASE).
By default, SAP IQ software is installed in a unique subdirectory under the SAP IQ parent directory. This subdirectory is called the installation directory. Other tools provided with SAP IQ have unique subdirectories under the SAP IQ parent directory. This section describes only the subdirectory structure for SAP IQ.
By default, the SAP IQ installation directory is IQ-16_1. The location of IQ-16_1 varies, depending on where you install SAP IQ. The IQ-16_1 directory is also referred to by the environment variable %IQDIR16%.
The SAP IQ installation directory holds a number of directories and files:
Demo directory (%SYBASE%\IQ-16_1\demo)
Contains a pointer to %ALLUSERSPROFILE%\SAPIQ\demo, which holds the tools required to build the iqdemo database. The iqdemo database files are iqdemo.db, iqdemo.iq, iqdemo.iqmsg, and iqdemo.iqtmp. Use mkiqdemo.bat to create the iqdemo database. The iqdemo database can be used to demonstrate problems to Technical Support. Demo data subdirectory (%SYBASE%\IQ-16_1\demo\adata)
Holds data to allow the creation of the iqdemo database. Scripts directory (%SYBASE%\IQ-16_1\scripts)
Holds some scripts used in examples and when creating catalog objects like stored procedures. Do not edit these scripts. If you edit, delete, or move these scripts, the server will not operate properly.
SAP IQ Installation and Update Guide for Windows 92 PUBLIC Postinstallation Tasks Samples directories (%ALLUSERSPROFILE%\SAPIQ\Samples)
The samples directory contains SQL samples and user-defined function (UDF) samples. The %ALLUSERSPROFILE%\SAPIQ\Samples\SQLAnywhere directory contains directories of SQL samples. The SQLAnywhere\C directory holds C++ examples that illustrate using ESQL (embedded SQL) and C with SAP SQL Anywhere. Because SAP SQL Anywhere and SAP IQ share common code, you can modify these examples for use with SAP IQ. The samples\udf directory holds sample C++ scalar and aggregate UDFs. Additional directories
Additional directories hold executables, libraries, help files, and so on. Subdirectories within IQ-16_1 containing these files include \bin64, \bin32, \install, and \java.
10.3.2 How SAP IQ Locates Files
To start and run, SAP IQ must find and access several types of files. Several directories or files with identical names may reside on a system.
Understanding how SAP IQ finds these files is important to ensure that you use the correct files. The types of files include but are not limited to:
Libraries
These may include product libraries or system libraries. File name extensions include.dll or .lib. These files are required to run SAP IQ.
If an incorrect DLL is found, a version mismatch error may occur. For example, library files might be found in %IQDIR16%\bin32 or %IQDIR16%\OCS-16_0\dll.
An empty directory, $IQDIR16%IQDIR16%\usrlib, lets you supersede default libraries with custom libraries and patches, because start_iq includes usrlib before regular library directories. SAP IQ uses both SAP Adaptive Server Enterprise and SAP SQL Anywhere libraries. If either of these products have already been installed on your system, note the directory where they are installed to avoid confusion. Interface files
Required to run SAP IQ. Configuration files
Used to specify connection parameters. Examples include default.cfg. Database files
Store the data and metadata. For example: iqdemo.db, iqdemo.iq, iqdemo.iqmsg, iqdemo.iqtmp. Log files
Store information about the current session on the server and connected database. For example, a server log might be named %ALLUSERSPROFILE%\SAPIQ\logfiles\yourservername.0006.srvlog. The database log (for example, %ALLUSERSPROFILE%\SAPIQ\demo\iqdemo.log) is created when you connect to the database. For more information about these files, see SAP IQ Administration: Database and SAP IQ Utility Reference. Product scripts
Are sample files that show how to create, populate, and upgrade databases. User files
SAP IQ Installation and Update Guide for Windows Postinstallation Tasks PUBLIC 93 Include flat files used with the LOAD command and SQL scripts used with tools such as Interactive SQL. Temporary files
Created by to store temporary information for operations like performing sorts for queries.
Some file names are specified in SQL statements and must be located at runtime. Examples of SQL statements that use file names include the following:
INSTALL statement
The name of the file that holds Java classes. LOAD TABLE statement
The name of the file from which data should be loaded. CREATE DATABASE statement
A file name is needed for this statement and similar statements that can create files.
In some cases, SAP IQ uses a simple algorithm to locate files. In other cases, a more extensive search is carried out.
In this section:
Simple File Searching [page 94] In many SQL statements such as LOAD TABLE or CREATE DATABASE, the file name is interpreted as relative to the current working directory of the database server; that is, where the server was started.
Extensive File Searching [page 94] SAP IQ programs, including the database server and administration utilities, carry out extensive searches for required files, such as DLLs or shared libraries.
10.3.2.1 Simple File Searching
In many SQL statements such as LOAD TABLE or CREATE DATABASE, the file name is interpreted as relative to the current working directory of the database server; that is, where the server was started.
Also, when a database server is started and a database file name (DBF parameter) is supplied, the path is interpreted as relative to the directory in which the server was started.
10.3.2.2 Extensive File Searching
SAP IQ programs, including the database server and administration utilities, carry out extensive searches for required files, such as DLLs or shared libraries.
In these cases, SAP IQ programs look for files in the following order:
The executable directory
The directory in which the program executable is held. Also, directories with the following paths relative to the program executable directory:
SAP IQ Installation and Update Guide for Windows 94 PUBLIC Postinstallation Tasks ● Parent of the executable directory. ● A child of the parent directory named scripts. Current working directory
When a program is started, it has a current working directory (the directory from which it is started). This directory is searched for required files. Location registry entry
On a Windows installation, SAP IQ adds a LOCATION registry entry. The indicated directory is searched, followed by the following:
● A child named scripts ● A child with the operating system name (bin32, bin, and so on) System-specific directories
This includes directories where common operating system files are held, such as the Windows directory and the Windows\system directory on Windows. CLASSPATH directories
For Java files, directories listed in the CLASSPATH environment variable are searched to locate files. PATH directories
Directories in the system path and the user’s path are searched to locate files. LIBRARY PATH directories
Directories listed in the LIBPATH environment variable are searched for shared libraries.
10.3.3 Environment Variables
SAP IQ uses environment variables to store various types of information. Environment variables can be modified, if needed, and not all variables need to be set in all circumstances.
The installation program automatically sets all environmental variables.
In this section:
Modifying Environment Variables on Windows [page 96] On Windows platforms, the installation program automatically sets all environmental variables, so no changes are necessary. However, if you must set optional variables or change defaults, use this procedure.
COCKPIT_JAVA_HOME Environment Variable [page 97] This variable specifies the location of the Java Runtime Environment used by SAP IQ Cockpit.
IQCHARSET Environment Variable [page 97] IQCHARSET sets the default character set.
IQDIR16 Environment Variable [page 98] IQDIR16 identifies the location of the SAP IQ directory and is the location for other directories and files under that directory.
IQLANG Environment Variable [page 98] IQLANG sets the default language.
SAP IQ Installation and Update Guide for Windows Postinstallation Tasks PUBLIC 95 IQLOGDIR16 Environment Variable [page 100] The IQLOGDIR16 environment variable defines the location of various log files. IQLOGDIR16 is not set by the installation program.
JAVA_HOME Environment Variable [page 100] Defines JRE home, which points to directory containing bin/java.
PATH Environment Variable [page 101] PATH is an operating system required variable that includes the directories where SAP IQ executables are located.
SQLCONNECT Environment Variable [page 101] SQLCONNECT specifies connection parameters that are used by several of the database administration utilities, such as Interactive SQL, dbinfo, and dbstop, when connecting to a database server.
SYBASE Environment Variable [page 102] SYBASE identifies the location of SAP database applications, such as SAP Open Server.
SAP_JRE8_64, SAP_JRE8_32 Environment Variables [page 103] This variable specifies the location of the Java Runtime Environment used by SAP IQ Cockpit.
SYBASE_OCS Environment Variable [page 103] SYBASE_OCS specifies the home directory for the SAP Open Server product.
10.3.3.1 Modifying Environment Variables on Windows
On Windows platforms, the installation program automatically sets all environmental variables, so no changes are necessary. However, if you must set optional variables or change defaults, use this procedure.
Procedure
1. On the Start screen, right-click This PC and select Properties.
2. Select Advanced system settings Advanced Environment Variables .
The Environment Variables dialog opens. a. If the environment variable does not already exist, click New, and type the variable name and its value in the spaces provided; then click OK to save the setting. b. If the variable does exist, select it from the list of System Variables or User Variables, click Edit, and make any modifications in the Variable Value field. Then click OK to save the setting.
Results
Note
See the Microsoft Windows documentation for an explanation of user variables and system variables.
SAP IQ Installation and Update Guide for Windows 96 PUBLIC Postinstallation Tasks Alternately, you can use a third-party application to review and set environment variables.
10.3.3.2 COCKPIT_JAVA_HOME Environment Variable
This variable specifies the location of the Java Runtime Environment used by SAP IQ Cockpit.
If not set, SAP IQ Cockpit startup checks for the location of the Java VM in the SAP_JRE8 environment variables.
Settings
COCKPIT_JAVA_HOME = %SYBASE%\shared\SAPJRE
Operating System
Required.
10.3.3.3 IQCHARSET Environment Variable
IQCHARSET sets the default character set.
The first of the following values set determines the default character set.
● IQCHARSET environment variable ● Query the operating system
If no character set information is specified, use cp850.
Setting
IQCHARSET=
SAP IQ Installation and Update Guide for Windows Postinstallation Tasks PUBLIC 97 10.3.3.4 IQDIR16 Environment Variable
IQDIR16 identifies the location of the SAP IQ directory and is the location for other directories and files under that directory.
● %IQDIR16%\logfiles is the default location for the server log and backup and restore log (the backup history file). You can override this default by setting the IQLOGDIR16 environment variable.
Setting
IQDIR16 = %SYBASE%\IQ-16_1
Operating System
Required. Set by the environment source file or the installation program. This default setting can be changed on Windows.
10.3.3.5 IQLANG Environment Variable
IQLANG sets the default language.
The first of the following values set determines the default language.
● IQLANG environment variable ● Registry as set by the installer ● Query the operating system
If no language information is set, English is the default.
Setting
IQLANG=
SAP IQ Installation and Update Guide for Windows 98 PUBLIC Postinstallation Tasks Operating System
Optional but recommended in non-English environments.
In this section:
List of Language Label Values [page 99] Valid language label values and their equivalent ISO 639 language codes. Set the two-letter ISO_639 language code in the IQ_LANG environment variable.
10.3.3.5.1 List of Language Label Values
Valid language label values and their equivalent ISO 639 language codes. Set the two-letter ISO_639 language code in the IQ_LANG environment variable.
Language ISO_639 Language Code Language Label Alternative Label
Arabic AR arabic N/A
Czech CS czech N/A
Danish DA danish N/A
Dutch NL dutch N/A
English EN us_english english
Finnish FI finnish N/A
French FR french N/A
German DE german N/A
Greek EL greek N/A
Hebrew HE hebrew N/A
Hungarian HU hungarian N/A
Italian IT italian N/A
Japanese JA japanese N/A
Korean KO korean N/A
Lithuanian LT lithuanian N/A
Norwegian NO norwegian norweg
Polish PL polish N/A
Portuguese PT portuguese portugue
Russian RU russian N/A
Simplified Chinese ZH chinese simpchin
Spanish ES spanish N/A
Swedish SV swedish N/A
SAP IQ Installation and Update Guide for Windows Postinstallation Tasks PUBLIC 99 Language ISO_639 Language Code Language Label Alternative Label
Thai TH thai N/A
Traditional Chinese TW tchinese tradchin
Turkish TR turkish N/A
Ukrainian UK ukrainian N/A
10.3.3.6 IQLOGDIR16 Environment Variable
The IQLOGDIR16 environment variable defines the location of various log files. IQLOGDIR16 is not set by the installation program.
● The server log is in the file servername.nnnn.srvlog (where nnnn is the number of times the server has been started) in the directory specified by IQLOGDIR16.
If IQLOGDIR16 is not set to a valid, write-enabled directory, then most utilities, including start_iq, use the default location %IQDIR16%\logfiles for all server logs.
Setting
IQLOGDIR16 =
Operating System
Optional.
10.3.3.7 JAVA_HOME Environment Variable
Defines JRE home, which points to directory containing bin/java.
Used if the location of the Java VM is not set in the SAP_JRE8 environment variables.
JAVA_HOME is commonly created when installing a VM.
The Java VM location specified in JAVA_HOME takes precedence over any location defined during installation. If JAVA_HOME fails to locate the Java VM, SAP IQ does not load a Java VM.
SAP IQ Installation and Update Guide for Windows 100 PUBLIC Postinstallation Tasks Settings
JAVA_HOME = %SYBASE%\shared\JRE
Operating System
Required for all platforms.
10.3.3.8 PATH Environment Variable
PATH is an operating system required variable that includes the directories where SAP IQ executables are located.
The installation program modifies PATH.
PATH takes the place of the LIBRARY_PATH variable, so executables and DLLs are located using the PATH variable.
Setting
PATH =
Operating System
Required for all platforms.
10.3.3.9 SQLCONNECT Environment Variable
SQLCONNECT specifies connection parameters that are used by several of the database administration utilities, such as Interactive SQL, dbinfo, and dbstop, when connecting to a database server.
The SQLCONNECT environment variable is optional, and is not set by the installation program.
This string is a list of parameter settings, of the form parameter=
The number sign “#” is an alternative to the equals sign; use it if you are setting the connection parameters string in the SQLCONNECT environment variable. Using “=” inside an environment variable setting is a syntax error. The = sign is allowed only in Windows.
SAP IQ Installation and Update Guide for Windows Postinstallation Tasks PUBLIC 101 Note
Specifying connection parameters in SQLCONNECT rather than on the command line offers greater security on UNIX systems. It prevents users from being able to display your password with ps -ef. This is especially useful if you run Interactive SQL or other utilities in quiet mode. Note that specifying connection parameters in SQLCONNECT rather than on the command line is more secure, but is not entirely secure. Because the password is in plain text, it is possible for hostile action to extract it from the environment context. For more information, see Connection and Communication Parameters Reference in SAP IQ Administration: Database.
Settings
SQLCONNECT =
Operating System
Optional.
10.3.3.10 SYBASE Environment Variable
SYBASE identifies the location of SAP database applications, such as SAP Open Server.
Setting
SYBASE =
Operating System
Required for all platforms.
SAP IQ Installation and Update Guide for Windows 102 PUBLIC Postinstallation Tasks 10.3.3.11 SAP_JRE8_64, SAP_JRE8_32 Environment Variables
This variable specifies the location of the Java Runtime Environment used by SAP IQ Cockpit.
On startup, SAP IQ Cockpit checks COCKPIT_JAVA_HOME for Java version definition. If COCKPIT_JAVA_HOME is undefined, SAP IQ Cockpit checks for installed JREs in this order:
● SAP_JRE8_64 ● SAP_JRE8 ● SAP_JRE8_32
SAP IQ Cockpit then sets COCKPIT_JAVA_HOME to the first value it finds in this list.
Setting
To manually set the JRE environment variable:
COCKPIT_JAVA_HOME=%SYBASE%\shared\SAPJRE-8_(minor_version)_64BIT or:
COCKPIT_JAVA_HOME=%SYBASE%\shared\SAPJRE-8_(minor_version)_32BIT
10.3.3.12 SYBASE_OCS Environment Variable
SYBASE_OCS specifies the home directory for the SAP Open Server product.
The installation program sets SYBASE_OCS when it installs Open Client/Server Software Developers Kit.
Setting
SYBASE_OCS = IQ-16_1
Operating System
Required for Windows platform only.
SAP IQ Installation and Update Guide for Windows Postinstallation Tasks PUBLIC 103 10.3.4 Registry Entries
On Windows operating systems, SAP IQ uses several registry settings.
These settings are made for you by the software, and in general operation, you should not need to access the registry. The settings are provided here if you modify your operating environment.
Caution
Modifying the registry is not recommended, as incorrect changes might damage your system.
In this section:
Current User and Local Machine Settings [page 104] Some operating systems, such as Windows, hold two levels of system settings: user settings and local machine settings.
Registry Structure [page 105] On Windows, you can access the Registry directly using the Registry Editor.
Registry Settings on Installation [page 105] The installation program automatically makes these registry settings in the SAP IQ registry.
10.3.4.1 Current User and Local Machine Settings
Some operating systems, such as Windows, hold two levels of system settings: user settings and local machine settings.
Current user settings are specific to an individual user and are used only when that user is logged on. Local machine settings are global to the machine and are available no matter which user is logged on;. You must have administrator permissions on your machine to make local machine settings.
SAP IQ permits the use of both current user and local machine settings. For Windows, these settings are held in the HKEY_CURRENT_USER registry and HKEY_LOCAL_MACHINE registry, respectively.
The SAP IQ installation lets you choose whether the settings it makes are for the current user only or at the local machine level.
If you make settings in both current user and local machine registries, the current user setting takes precedence over the local machine setting.
If you are running an SAP IQ program as a service on Windows, ensure that the settings are made at the local machine level.
Services can continue to run under a special account when you log off a machine, as long as you do not shut the machine down entirely. Services can be made independent of individual accounts and need access to local machine settings.
In general, use local machine settings.
SAP IQ Installation and Update Guide for Windows 104 PUBLIC Postinstallation Tasks 10.3.4.2 Registry Structure
On Windows, you can access the Registry directly using the Registry Editor.
Note
Read Only Mode protects your Registry data from accidental changes. To use it, open the Registry Editor, select Edit | Permissions, and then check Read permission.
The SAP IQ registry entry is held in the HKEY_LOCAL_MACHINE key, in the following location:
SOFTWARE > SAP IQ 16.1
In this section:
Starting the Registry Editor [page 105] Start the registry editor to access the Windows registry.
10.3.4.2.1 Starting the Registry Editor
Start the registry editor to access the Windows registry.
Procedure
1. Select Start Run . 2. In the Open box, type:
regedt32
10.3.4.3 Registry Settings on Installation
The installation program automatically makes these registry settings in the SAP IQ registry.
Location In the SAP IQ registry, this entry holds the installation directory location. For example:
Location:REG_SZ:C:\Program Files\Sybase
\IQ-16_1
The SAP IQ registry includes other entries for installed applications.
SAP IQ Installation and Update Guide for Windows Postinstallation Tasks PUBLIC 105 10.4 Licensing After Installation
All product editions except the Evaluation Edition require a license. Optional features are sold and licensed separately.
Whether you install a licensed or evaluation edition, you have 30-day access to all features and options. To use an option beyond the 90-day evaluation period, you must purchase and apply an appropriate served or unserved license.
Using an unlicensed option on a licensed server can throw the server into grace mode, which can cause the server to shut down when the grace period expires. The DBA or other equivalent user must explicitly authorize access to an optionally licensed feature. A server will not attempt to check out an optional license by default. Unless the DBA grants access to an option, the option will not be available.
In this section:
Verifying and Authorizing Optional Licensed Components [page 106] Your license controls the optional components licensed on an SAP IQ server. After applying the license, use the sp_iqlmconfig to allow or disallow the feature.
Applying an Unserved License [page 107] You can update an SAP IQ server from an evaluation license to an unserved license.
Applying a Served License [page 108] You can update an SAP IQ server from an evaluation license to a served license.
10.4.1 Verifying and Authorizing Optional Licensed Components
Your license controls the optional components licensed on an SAP IQ server. After applying the license, use the sp_iqlmconfig to allow or disallow the feature.
To verify your licensed components, connect to the server, start Interactive SQL (dbisql), and run sp_iqlmconfig without parameters to return a set of properties and values that indicate the state of your licenses:
Property Value
------Edition EE License Type DT Application Type IQ IQ_CORE License Count in use 2 (CPU core based) Optional license in use : IQ_UDA No Optional license in use : IQ_LOB No Optional license in use: IQ_SECURITY No Optional license in use: IQ_MPXNODE No Optional license in use: IQ_VLDBMGMT No IQ_VLDBMGMT License Count in use 0 Optional license in use: IQ_UDF No Optional license in use: IQ_IDA No Optional license in use: IQ_URIDA No Optional license in use: IQ_TS_FSF No Email Severity NONE SMTP Host smtp SMTP Port 25 Email Sender
Email Recipients
SAP IQ Installation and Update Guide for Windows 106 PUBLIC Postinstallation Tasks Authorizing Optional Features
Run sp_iqlmconfig with the allow or disallow parameter to enable or disable an optional license. The ALL keyword enables or disables all optional licenses, except IQ_VLDBMGT:
sp_iqlmconfig 'allow', 'ALL' // enable all, except IQ_VLDBMGT
sp_iqlmconfig 'disallow', 'IQ_SECURITY' // disable IQ_SECURITY
Use the IQ_VLDBMGT and
sp_iqlmconfig 'allow', 'IQ_VLDBMGT', '8' // increase by 8
sp_iqlmconfig 'disallow', 'IQ_VLDBMGT', '2' // decrease by 2
See the sp_iqlmconfig stored procedure in SAP IQ SQL Reference for information about authorizing optional features and other issues related to license management configuration.
License Server Issues
All license server status and error messages are written to the SYBASE.log in the log directory. To diagnose issues with a license server, check the %SYBASE%\SYSAM-2_0\log\SYBASE.log file. You can use iqdemo.db to perform this task.
A line that begins with “Checked out license...” indicates a successful license configuration. If you see a Sysam: FLEXnet Licensing error: message, check with your SAP representative to resolve the issue.
See Managing the License Server Debug Log and Troubleshooting SySAM Errors in the SySAM Users Guide.
10.4.2 Applying an Unserved License
You can update an SAP IQ server from an evaluation license to an unserved license.
Context
If an unserved license is not applied before the evaluation period ends, the server shuts down and cannot be started until a valid license is applied. If an unserved license is incorrectly applied during the evaluation period, the server continues to function in evaluation mode. After application, always verify the unserved license is being used.
Procedure
1. Stop any running databases. 2. Navigate to %SYBASE%\SYSAM-2_0.
SAP IQ Installation and Update Guide for Windows Postinstallation Tasks PUBLIC 107 3. If it doesn't already exist, create a folder named licenses. The folder name must be exact, both spelling and case. 4. Copy the unserved license to SYSAM-2_0\SYSAM-2_0\licenses. 5. Restart the database. 6. Review the .iqmsg file to verify the server is using an unserved license.
Related Information
Verify SAP IQ Server Is Licensed [page 119]
10.4.3 Applying a Served License
You can update an SAP IQ server from an evaluation license to a served license.
Prerequisites
The SySAM License Server is running and licensed.
Context
If a served license is not applied before the evaluation period ends, the server shuts down and cannot be started until a valid license is applied. If a served license is incorrectly applied during the evaluation period, the server continues to function in evaluation mode. After application, always verify the served license is being used.
Procedure
1. Stop any running databases. 2. Navigate to %SYBASE%\SYSAM-2_0\ 3. If it doesn't already exist, create a folder named licenses. The folder name must be exact, both spelling and case. 4. In the licenses folder, create a text file with the extension .lic. Add the following two lines to the file:
SERVER
USE_SERVER
SAP IQ Installation and Update Guide for Windows 108 PUBLIC Postinstallation Tasks 5. Restart the database. 6. Review the .iqmsg file to verify the server is using a served license.
If the server is not using the served licenses, make sure the served license is applied to the SySAM license server. See Apply or Update Licenses on the SySAM License Server [page 51]
Related Information
Apply or Update Licenses on the SySAM License Server [page 51] Verify SAP IQ Server Is Licensed [page 119]
10.5 Starting and Running an SAP IQ Server
Use the start_iq startup utility to start your server. start_iq is a command line utility that runs on all platforms and ensures that all required parameters are set correctly.
Starting a Server or Database
To use start_iq to start a server or database from the command line, change to a directory where the configuration and database files are located, and use this command format:
start_iq [
[
A startup command may include several startup parameters:
●
Default Startup Parameters start_iq uses a default configuration file (%IQDIR16%\scripts\default.cfg) to set the default start-up parameters.
SAP IQ Installation and Update Guide for Windows Postinstallation Tasks PUBLIC 109 Parameter Value Description
–c 48 MB Catalog store cache size.
–gc 20 Checkpoint interval.
–gd all Allows all users to start the database by connecting.
–gl all Allows all users to load or unload tables.
–gm 10 Default number of connections.
–gp 4096 Catalog store page size.
–ti 4400 Client timeout set to 72 hours. Prevents users with long queries from being logged off over a long weekend.
Configuration Files
To override the default start-up parameters, store your options in a configuration file. To start a server with a configuration file:
start_iq @
This command starts the database and sets parameters named in the (optional) configuration (.cfg) file.
On the start_iq command line, the last option you specify takes precedence, so to override your configuration file, list any options you want to change after the configuration file name. For example:
start_iq @iqdemo.cfg –x 'tcpip{port=1870}' iqdemo.db
The –x parameter here overrides connection information in the iqdemo.cfg file.
A configuration file for the demo database (iqdemo.cfg) is located in the %ALLUSERSPROFILE%\SAPIQ \demo directory as an example.
Default Server Directories
The directory where the server is started becomes the default directory for all server files created by SAP IQ.
Startup and Server Logs
SAP IQ writes start-up and server logs in the %ALLUSERSPROFILE%\SAPIQ\logfiles directory:
● ● Startup information is saved in the iq_startup_nt.log file. ● Server status is logged in the servername.nnnn.srvlog file.
SAP IQ Installation and Update Guide for Windows 110 PUBLIC Postinstallation Tasks The
Note
If SAP SQL Anywhere is installed on the same subnet as SAP IQ, the server must have a unique name. Both SAP SQL Anywhere and SAP IQ servers default to the port 2638.
Use a new port number for each server. Set each new port number in the %IQDIR16%\scripts \default.cfg file. Change the following line in each IQ database configuration file (for example, %ALLUSERSPROFILE%\SAPIQ\demo\iqdemo.cfg) to update the port number:
–x tcpip{port=2638}
Additional Information
See start_iq Server Options in SAP IQ Utility Reference
10.6 Stopping an SAP IQ Server
SERVER OPERATOR system privilege is the default permission level required to stop a server, but you can use the -gk startup option to change the default to ALL or NONE. Setting the permission level to ALL lets all users stop the server; setting the permission level to NONE means that no one can stop the server. In a production environment, only the Server Operator should be allowed to stop the database server.
Do not shut down a server while it is still connected to one or more clients. If you try this, you get a warning that any uncommitted transactions will be lost. Disconnect or close all the clients and try again.
Server Shutdown Commands
Several commands shut down the database server.
SAP IQ Installation and Update Guide for Windows Postinstallation Tasks PUBLIC 111 Command Description
dbstop Stops a server or database. The syntax is:
dbstop [
Where:
●
STOP ENGINE STOP ENGINE is a SQL statement that stops a database server. The syntax is as follows, where UNCONDITIONALLY stops a database server, even if there are client connections to the server:
STOP ENGINE
Server Shutdown Methods
There are several methods to shut down or stop a server.
Method Action
Command line Run the dbstop command.
Desktop Right-click the server icon in the system tray, and choose Shutdown
Service Manager If you started the server as a Windows service:
1. On the Control Panel, choose Administrative Tools Services . 2. Choose the SAP IQ service, then click Stop the service.
Interactive SQL Run the stop engine command to stop a named database server.
Additional Information
● See STOP ENGINE Statement in SAP IQ SQL Reference ● See dbstop Database Shutdown Utility and stop_iq Database Shutdown Utility in the SAP IQ Utility Reference ● See Stopping Servers in SAP IQ Administration: Database
SAP IQ Installation and Update Guide for Windows 112 PUBLIC Postinstallation Tasks 10.7 Starting and Stopping the SAP IQ Cockpit Agent
SAP IQ Cockpit is a Web-based tool for managing and monitoring SAP IQ servers. The SAP IQ Cockpit agent must be running to log on to the SAP IQ Cockpit. Run the cockpit command to start SAP IQ Cockpit agent.
Prerequisites
If you configured SAP IQ Cockpit to run as a service, and it is already running, you may skip this task.
Context
From a command prompt window, type:
%SYBASE%\COCKPIT-4\bin\cockpit.bat
Results
Messages on the progress of the launch appear in a command window. When SAP IQ Cockpit runs, the command window becomes the SAP IQ Cockpit console; you can issue commands to get status information for SAP IQ Cockpit and its ports, plug-ins, and services.
See the SAP IQ Cockpit guide for details on using this administration tool.
10.8 Stopping the SAP IQ Cockpit Agent
Stop the SAP IQ Cockpit agent. Once stopped, you can no longer use the SAP IQ Cockpit.
Context
In the command prompt window containing the cockpit prompt, type:
shutdown
If the command prompt window has been closed, open a new window and type:
%SYBASE%\COCKPIT-4\bin\cockpit.bat -stop
SAP IQ Installation and Update Guide for Windows Postinstallation Tasks PUBLIC 113 Results
See the SAP IQ Cockpit guide for details on using this administration tool.
10.9 Configuration
This section outlines basic configuration concepts and procedures of an SAP IQ server.
In this section:
Using Configuration Files [page 114] Use a configuration file to store server startup options.
Running SAP IQ as a Windows Service [page 115] Running SAP IQ as a Windows service starts the server whenever you restart your computer. Windows services run in the background as long as Windows is running.
10.9.1 Using Configuration Files
Use a configuration file to store server startup options.
To start a server or database with a configuration file, change to a directory where you have write privileges, and use the following command format:
start_iq @
If a startup parameter is passed from the command line and the same parameter exists in the .cfg file, the value in the command line overrides the value in .cfg file.
Configuration files can contain line breaks, and can include any set of options, including the @data option. Use a number sign (#) to designate lines as comments. An ampersand (&) character that appears by itself at the end of a line indicates that the previous token is continued on the next line. See the SAP IQ Utility Reference for a complete list of startup parameters.
Default Configuration File
When you start a server and do not include any command line parameters or specify a configuration file, SAP IQ retrieves the start-up parameters from a default configuration file, default.cfg, in the %IQDIR16% \scripts directory. The default.cfg file is also the source of parameters for the Service Manager and multiplex configurations. You can maintain consistency by editing parameters in default.cfg.
To increase the amount of virtual memory, change the parameters in default.cfg. To reduce the virtual memory that other programs use, add swap space to machines or reduce SAP IQ memory demands (cache sizes, thread count, stack size, etc.).
SAP IQ Installation and Update Guide for Windows 114 PUBLIC Postinstallation Tasks Security and Configuration Files
You can use the dbfhide (File Hiding) utility to encrypt your configuration files. If you specify log file parameters (-o
start_iq @encrypt_params @other_params or
start_iq @encrypt_params -n myserv -c 400 -o %IQDIR16%\logfile\myserv.log
10.9.2 Running SAP IQ as a Windows Service
Running SAP IQ as a Windows service starts the server whenever you restart your computer. Windows services run in the background as long as Windows is running.
In this section:
Creating a New Windows Service [page 115] Run SAP IQ as a Windows service to start the server whenever you restart your computer. Services run in the background as long as Windows is running.
Suppressing Windows Event Log Messages [page 116] If you run the database server as a Windows service, you can set the SAP SQL Anywhere registry entry to suppress event log entries.
Granting Administrator Privilege to the SAP IQ Service [page 117] Assign Administrator privileges to an SAP IQ service when raw device access is required.
10.9.2.1 Creating a New Windows Service
Run SAP IQ as a Windows service to start the server whenever you restart your computer. Services run in the background as long as Windows is running.
Procedure
1. Start SAP IQ Service Manager . 2. Choose Create a New Service. 3. Name the new service. 4. Add the appropriate start-up parameters.
Include the full path to the database file. The server cannot start without a valid database path name.
SAP IQ Installation and Update Guide for Windows Postinstallation Tasks PUBLIC 115 5. Click Apply. 6. Restart Windows.
Because Window service manager reads environmental variables only at system startup, you must restart Windows after you configure SAP IQ as a Windows service.
Results
Note
● Copy any input files that you use to load your databases into the directory where the service starts, not where the database files are located. On most systems, the services start-up defaults to the < %SYSTEMROOT%>\system32 directory. ● To use SAP IQ as a Windows service when raw device access is required, you must grant the service Administrator privileges. ● Use Modify an Existing Service or Delete an Existing Service to change or delete SAP IQ services.
10.9.2.2 Suppressing Windows Event Log Messages
If you run the database server as a Windows service, you can set the SAP SQL Anywhere registry entry to suppress event log entries.
Procedure
To control event log entries, set the EventLogMask key, which is of type REG_DWORD.
The value is a bitmask containing the internal bit values for the different types of event messages:
errors EVENTLOG_ERROR_TYPE 0x0001
warnings EVENTLOG_WARNING_TYPE 0x0002
information EVENTLOG_INFORMATION_TYPE 0x0004
If the EventLogMask, for example, is set to 0, no messages appear at all. Setting EventLogMask to 1 logs all errors messages, but suppresses informational and warning messages. The default setting (no entry present) logs all message types.
SAP IQ Installation and Update Guide for Windows 116 PUBLIC Postinstallation Tasks 10.9.2.3 Granting Administrator Privilege to the SAP IQ Service
Assign Administrator privileges to an SAP IQ service when raw device access is required.
Procedure
1. On the Control Panel, click Administrative Tools Services . 2. On the Services dialog, right-click Sybase IQ, choose Properties. 3. On Properties, choose Automatic as the Startup type. 4. Click the Log On tab, then click This account. 5. Assign the account to a user with Administrative privileges. In This account, type the administrator’s user ID, then enter and confirm the user’s password. 6. Click OK to close Properties.
7. Click File Close .
10.10 Remove Sample Application Files
Before you deploy your server in a production environment, remove the sample client applications.
The SAP IQ Server Suite installation may include directories that contain sample client applications, which are included for training purposes only. Remove the %IQDIR16%\SybaseIQ\Samples directory before you deploy your server in a production environment.
10.11 Starting Interactive SQL
Interactive SQL is a utility that ships with SAP IQ and lets you execute SQL statements, build scripts, and display database data. It is a component of the SAP IQ client software.
Prerequisites
The Interactive SQL component is installed. See Installing SAP IQ Client Software [page 70].
SAP IQ Installation and Update Guide for Windows Postinstallation Tasks PUBLIC 117 Context
To use Interactive SQL to connect to a database, it must be running. Enter the connection parameters to the database. Interactive SQL does not accept @filename parameters. Exit codes are 0 (success) or nonzero (failure).
Interactive SQL uses the deprecated iAnywhere JDBC driver.
If the options specified do not include user ID and password, the Connect window opens, allowing you to enter the required information.
Procedure
1. Do one of:
○ In a command shell, type:
dbisql [
○ From the Start menu, select Run, and type:
dbisql [
○ In File Explorer, change to the %IQDIR16%\bin64 directory and run dbisql.exe. 2. On the Connect dialog, enter the parameters for the database and click Connect.
Results
See the SAP IQ Interactive SQL Guide for more information on using Interactive SQL.
Related Information
Installing SAP IQ Client Software [page 70]
10.12 Verify an SAP IQ Server Is Running
Verify whether a specific SAP IQ server is running.
There are two ways to check if an SAP IQ server is running.
SAP IQ Installation and Update Guide for Windows 118 PUBLIC Postinstallation Tasks Task Manger
Open Task Manger and select the Processes tab. iqsrv16.exe appears once on the list for each running server.
Note
If multiple iqsrv16.exe appear, you cannot identify the names of the servers from the Processes tab.
Taskbar
On the taskbar, click the arrow to show hidden icons. An icon appears for each running server. If you hover over the icon, the name of the database appears.
Tip
By default, the server icon is hidden. Customize the taskbar to always display the Sybase IQ Network Server icon.
10.13 Verify SAP IQ Server Is Licensed
After you license an SAP IQ sever, verify that the license was accepted.
Prerequisites
The license file is checked when you start the SAP IQ server. Ensure the server has been restarted at least once since the license was applied.
Procedure
1. On the SAP IQ server, navigate to the data directory for the server. For example, for the initial database, navigate to
%ALLUSERSPROFILE%\SAPIQ\demo
2. Open the iqdemo.iqmsg file in a text editor. 3. Search the file for Using licenses from.
SAP IQ Installation and Update Guide for Windows Postinstallation Tasks PUBLIC 119 Results
If the server is successfully licensed, using either a served or unserved license, the message Using licenses from:... appears.
If the server is using an evaluation license, the message Checked out graced license... appears.
If a valid license cannot be found, the message Cannot find license file. appears. Verify:
● The license file is in the licenses folder. ● The path to the license file is %SYBASE% ● licenses is correctly spelled and is plural, not singular.
SAP IQ Installation and Update Guide for Windows 120 PUBLIC Postinstallation Tasks 11 What's Next?
Now that you have completed the installation and postinstallation tasks, you are ready to create your production database.
Create Your Production Database
Prerequisites
● The initial database is running. See Starting and Stopping the Demo Database [page 90].
Note
Alternately, you can start the utility database (utility.db) instead of the initial database. For information on the utility database, see SAP IQ Administration: Database.
Procedure
1. Review the Getting Started With SAP IQ guide. It provides the general flow of post-installation tasks you perform to get started with SAP IQ. 2. Create your simplex or multiplex production database using either Interactive SQL or SAP IQ Cockpit. See the SAP IQ Interactive SQL Guide or SAP IQ Cockpit guides. 3. Create users or implement LDAP. See the SAP IQ Administration: User Management and Security guide. 4. Create groups and assign privileges and users. See the SAP IQ Administration: User Management and Security guide. 5. Review the Database Administration Workflow documented in SAP IQ Administration: Database to: ○ Create the production database ○ Create tables in your database ○ Create indexes for your tables ○ Load data into your tables 6. Review the
SAP IQ Installation and Update Guide for Windows What's Next? PUBLIC 121 12 Troubleshooting Your Installation
Find solutions to common installation problems.
If you don't find your issue in the troubleshooting topics, see SAP Note 2551563 – SAP IQ 16.1 SP 03 Release Note for a list of known issues.
In this section:
What to do When the Installation Fails [page 122] Installation fails with an error. You are unsure what to do next.
Licensing [page 124] This section describes licensing-related issues.
Do Not Install SAP IQ into the Same Directory as Other Products [page 125] Do not install SAP IQ 16.1 into the same directory as other SAP IQ products.
Client Suite Installation Finishes, but with Errors [page 125] You receive an error message when installing the client suite.
Uninstalling in Silent Mode does not Echo any Response [page 126] Issue: Running uninstall.exe in silent mode causes installation problems.
Database Upgrade Issues [page 126] Important information about database upgrades.
SAP IQ and Other SAP Products [page 127] Issues you should know when you install SAP IQ with other SAP products.
Installing New System Tables Requires ALTER DATABASE UPGRADE PROCEDURE ON [page 128] To install new system tables, you must run ALTER DATABASE UPGRADE PROCEDURE ON on existing databases after installing SAP IQ 16.1.
12.1 What to do When the Installation Fails
Installation fails with an error. You are unsure what to do next.
Solution
Check the install log: %SYBASE%\log\IQ_Suite.log
The install log can help you trace the install progress and troubleshoot failed installations.
The installer also writes individual logs for components included as part of the install to the %SYBASE% directory.
SAP IQ Installation and Update Guide for Windows 122 PUBLIC Troubleshooting Your Installation Check the other troubleshooting topics in this section for topics matching the issues reported in the install log.
In this section:
Installation Fails with Error Messages [page 123] [CR #749835] Launching the installer returns a Windows error.
Installation on Windows 2012 R2 Fails [page 124] The installer fails or freezes during installation on Windows 2012 R2.
Installation from a Remote Directory Fails [page 124] [CR #650505] Running the installer from a remote directory may not install the MSVC++ setup files properly and the installation will fail.
12.1.1 Installation Fails with Error Messages
[CR #749835] Launching the installer returns a Windows error.
The error message can be one of the following:
● Message 1: Windows error 14001 occurred while loading the Java VM ● Message 2: The program can't start because MDVCR120.dll is missing from your computer. Try reinstalling the program to fix this problem.
Solution
If you get either error, install the Microsoft Visual C++ Redistributable Package MFC Security Updates, which are included as part of the installation package.
To install:
1. Open Windows Explorer. 2. Change to the \archives directory on the installable image. The MS Visual C++ Redistributable Packages are located in these subdirectories: ○ ms-redist-2005 ○ ms-redist-2008 ○ ms-redist-2010 ○ ms-redist-2012 ○ ms-redist-2013 You must install the packages from each subdirectory, oldest to newest, regardless of your server version. 3. Change to the appropriate subdirectory, and run the following: ○ On 32-bit machines – run vcredist_x86.exe ○ On 64-bit machines – run vcredist_x86.exe and vcredist_x64.exe
Microsoft Visual C++ Redistributable Package MFC Security Updates are also available as a free download from the Microsoft Download Center at: http://www.microsoft.com/en-us/download/details.aspx?id=26347
SAP IQ Installation and Update Guide for Windows Troubleshooting Your Installation PUBLIC 123 12.1.2 Installation on Windows 2012 R2 Fails
The installer fails or freezes during installation on Windows 2012 R2.
Solution
See Set Windows 2012 R2 Compatibility Mode for SAP IQ Installer [page 48].
12.1.3 Installation from a Remote Directory Fails
[CR #650505] Running the installer from a remote directory may not install the MSVC++ setup files properly and the installation will fail.
Solution
Manually run the MSVC++ setup files and map the remote directory to a drive letter.
12.2 Licensing
This section describes licensing-related issues.
Installer does not Prompt for License File Information
You run the installer, but the installer does not prompt for any license file information.
Solution
This occurs when you launch the installer using a relative path.
To resolve this issue, launch the installer from the directory where it is located, or launch the installer using an absolute path.
SAP IQ Installation and Update Guide for Windows 124 PUBLIC Troubleshooting Your Installation 12.3 Do Not Install SAP IQ into the Same Directory as Other Products
Do not install SAP IQ 16.1 into the same directory as other SAP IQ products.
Installing SAP IQ 16.1 into the same directory with older SAP products may render some or all of these products unusable.
Caution
(Windows only) Do not uninstall any of the products installed into the same directory.
Related Information
Avoiding Environmental Issues [page 38]
12.4 Client Suite Installation Finishes, but with Errors
You receive an error message when installing the client suite.
The error message is: The installation of SAP IQ Client Suite 16.1 SPxx (64-bit) us finished, but some errors occurred during the install. Please check the installer log file.
The log file contains an error similar to:
Install Uninstaller: SAP IQ Client Suite 16.1 SPxx (64-bit)
(Install All Uninstaller Components)
Status: ERROR
Solution
When installing, you selected an existing directory instead of a new directory.
Set the $SYBASE environment variable.
SAP IQ Installation and Update Guide for Windows Troubleshooting Your Installation PUBLIC 125 12.5 Uninstalling in Silent Mode does not Echo any Response
Issue: Running uninstall.exe in silent mode causes installation problems.
Running uninstall.exe in silent mode is an undocumented uninstallation option: uninstall.exe -i silent
The uninstaller does not echo any response in this mode. The lack of user-interaction can lead to unanticipated problems.
Solution:
Uninstall from the Control Panel.
12.6 Database Upgrade Issues
Important information about database upgrades.
For detailed information about upgrading SAP IQ, see Upgrade to SAP IQ 16.1 SP 04 [page 132].
Shut Down All Products That Use %SYBASE% Before Upgrade
[CR #750748] The SYBASE variable identifies the location of the common parent directory shared by SAP applications like SAP ASE and SAP Open Client.
Failure to shut down all products that use %SYBASE% may generate signal 11 (SIGSEGV) errors when you upgrade SAP IQ.
Solution
Shut down all SAP applications, restart the SAP IQ server, and retry the upgrade.
Drop All JOIN and All LD Indexes
[CR #702052] On multiplex, drop all logical servers named AUTO, COORDINATOR, ALL or DEFAULT.
If you do not drop these objects and try to run an ALTER DATABASE UPGRADE in SAP IQ 16.1, the upgrade fails and the server returns a message that indicates that a database upgrade is not possible when these objects are in use.
SAP IQ Installation and Update Guide for Windows 126 PUBLIC Troubleshooting Your Installation Recovery Information
To recover from a failed upgrade, shut down the 16.1 server, open the database with SAP IQ 15.x, and drop all LD and all JOIN indexes as well as any named logical servers before proceeding with the migration.
Upgrade Invalidates Data Source Names
In SAP IQ 16.x, 64-bit drivers are now in the bin64 directory, instead of x64. Therefore, when migrating from 12.x to 16.x, you may need to update registries and applications to locate libraries. For example, win32\dbodbc12.dll is now in bin32.
If upgrading from 15.x to 16.x the directory names remain the same, but the driver library has changed from dbodbc11.dll (from SAP IQ 15.0 to 15.3) or dbodbc12.dll (from SAP IQ 15.4) to dbodbc16.dll.
Block Number Issues May Cause Corruption
Issues with certain block numbers may cause corruption in upgraded databases. For more information, see SAP Note 2034975 – SAP IQ: IQ block numbers & Tokenized FPs > 4 bytes program error .
12.7 SAP IQ and Other SAP Products
Issues you should know when you install SAP IQ with other SAP products.
GUI Installation Hangs with .com.zerog.registry.xml File
[CR #736702] InstallAnywhere uses a temporary registry file (.com.zerog.registry.xml) to track software installations. InstallAnywhere normally deletes this file, but in some cases, the registry may become corrupt and cause the installer or uninstaller to hang.
Solution
If this occurs, force quit InstallAnywhere, rename .com.zerog.registry.xml, and re-run the installation or uninstallation.
This file is located on the C:\ or D:\ root directory.
SAP IQ Installation and Update Guide for Windows Troubleshooting Your Installation PUBLIC 127 Installer Hangs When Installing SAP IQ Into the Same Directory as SAP IQ InfoPrimer (IQIP)
[CR #688696] SAP products share a common parent directory (%SYBASE%), but individual products are installed in separate subdirectories.
Solution
Do not install SAP IQ and SAP IQIP into the same directory. Create a subdirectory under %SYBASE% when you install SAP IQIP. For example, install the IQIP server into %SYBASE%\IQIPS-15_3 (or install the IQIP Development Tool to %SYBASE%\IQIPD-15_3), which is actually the default directory of IQIP on Windows, and then install SAP IQ to %SYBASE%.
12.8 Installing New System Tables Requires ALTER DATABASE UPGRADE PROCEDURE ON
To install new system tables, you must run ALTER DATABASE UPGRADE PROCEDURE ON on existing databases after installing SAP IQ 16.1.
For syntax, see SAP IQ SQL Reference guide.
SAP IQ Installation and Update Guide for Windows 128 PUBLIC Troubleshooting Your Installation 13 Uninstalling SAP IQ
Uninstall SAP IQ server and/or client.
In this section:
Set Windows 2012 R2 Compatibility Mode for SAP IQ Uninstaller [page 129] Configure the compatibility mode on the SAP IQ installer to prevent issues when running.
Uninstalling SAP IQ Software [page 130] To uninstall SAP IQ, run the uninstaller from the GUI or command line. Instructions apply to IQ server and client software installed on the same host.
13.1 Set Windows 2012 R2 Compatibility Mode for SAP IQ Uninstaller
Configure the compatibility mode on the SAP IQ installer to prevent issues when running.
Context
This configuration is required for uninstallations using either console or GUI mode.
Procedure
1. On the Windows server, change to the %SYBASE%\sybuninistall\IQSuite directory. 2. Right-click uninstall.exe and select Properties. 3. On the Compatibility tab, check Run this program in compatibility mode for: and select Windows 7 from the dropdown.
SAP IQ Installation and Update Guide for Windows Uninstalling SAP IQ PUBLIC 129 13.2 Uninstalling SAP IQ Software
To uninstall SAP IQ, run the uninstaller from the GUI or command line. Instructions apply to IQ server and client software installed on the same host.
Context
The uninstall process removes features installed by InstallAnywhere, using any mode. It does not remove files and folders created after the installation. These files and folders must be manually removed.
Using GUI Mode
Procedure
1. On the Control Panel, choose Programs and Features. 2. Choose SAP IQ from the program list and click Uninstall/Change. 3. To remove all installed SAP IQ components, choose Complete Uninstall. To uninstall select components, choose Uninstall Specific Features.
Using Console Mode
Procedure
1. From the command line, change to %SYBASE%\sybuninstall\IQSuite. 2. Start the installer:
Type uninstall -i console and follow the instructions on the screen. 3. To remove all installed SAP IQ components, choose Completely remove all features and components. To uninstall select components, choose Choose specific features that were installed by InstallAnywhere.
SAP IQ Installation and Update Guide for Windows 130 PUBLIC Uninstalling SAP IQ Using Unattended (Silent) Mode
Context
An unattended uninstall can only be run from the command line. The silent uninstaller displays no status messages. User files are not deleted by default. To delete user files, include the - DUNINSTALL_DELETE_DATA_FILES=true flag to the uninstall command.
Procedure
1. From the command line, change to %SYBASE%\sybuninstall\IQSuite. 2. Start the installer:
Type ./uninstall -i silent -DUNINSTALL_DELETE_DATA_FILES=true and follow the instructions on the screen.
SAP IQ Installation and Update Guide for Windows Uninstalling SAP IQ PUBLIC 131 14 Upgrade to SAP IQ 16.1 SP 04
This support package includes updates to features currently installed on your system.
SAP IQ 16.1 SP 04 is a complete installation package. A previous release of the software is not a prerequisite for this support package. See the cover letter included as part of this release for a list of enhancements. The cover letter is found in the server folder on the installation media.
Note
SAP IQ 16.1 SP 01 increased the minimum password length from three to six characters. After performing a database upgrade, existing passwords from a pre-SAP IQ 16.1 SP 01 database continue to work, even if they do not meet the new minimum password length. The new minimum password length is enforced when modifying existing or creating new passwords. Users are strongly encouraged to change nonconforming passwords to benefit from this security change.
In this section:
Supported Upgrade Scenarios [page 132] Your upgrade path to SAP IQ 16.1 SP 04 depends on your current version of SAP IQ.
SAP IQ 16.x Upgrades [page 133] Upgrade instructions for sites running SAP IQ 16.x.
SAP IQ 15.4.x Upgrades [page 138] Upgrade instructions for sites running SAP IQ 15.4.x.
SAP IQ Database Administration Tool [page 199] SAP IQ Cockpit provides a personalized work center to administer the SAP IQ database.
SAP IQ 12.7 Upgrade and Database Migration [page 199] Updating an SAP IQ 12.7 catalog requires a database file migration, not a simple database upgrade. Migration tools bundled with SAP IQ can recreate the legacy database schema and database options.
Hardware Changes [page 236] Perform these steps to move your software to a new hardware platform.
14.1 Supported Upgrade Scenarios
Your upgrade path to SAP IQ 16.1 SP 04 depends on your current version of SAP IQ.
Starting Version Upgrade Scenario
SAP IQ 16.x 1. Perform a full backup of the existing system. 2. Upgrade directly to SAP IQ 16.1.x. See SAP IQ 16.x Upgrades [page 133].
SAP IQ Installation and Update Guide for Windows 132 PUBLIC Upgrade to SAP IQ 16.1 SP 04 Starting Version Upgrade Scenario
SAP IQ 15.4.x 1. Perform a full backup of the existing system. 2. Upgrade to SAP IQ 16.1.x. See SAP IQ 15.4.x Upgrades [page 138]. 3. Verify that the system updated successfully.
SAP IQ 12.7.x 1. Perform a full backup of the existing system. 2. Upgrade to SAP IQ 16.1.x. See SAP IQ 16.x Upgrades [page 133].. 3. Migrate your 12.7 database. See SAP IQ 12.7 Upgrade and Database Mi gration [page 199]. 4. Verify that the system migrated successfully.
14.2 SAP IQ 16.x Upgrades
Upgrade instructions for sites running SAP IQ 16.x.
In this section:
SAP IQ 16.x Pre-upgrade Tasks [page 133] Complete these tasks before upgrading 16.x.
Install SAP IQ 16.1 SP 04 [page 136] Simplex and multiplex installation procedures.
Upgrade the 16.x Database [page 136] Upgrade your database before you perform database read-write operations.
SAP IQ 16.x Postupgrade Tasks [page 137] Complete these tasks after upgrading your 16.x database.
14.2.1 SAP IQ 16.x Pre-upgrade Tasks
Complete these tasks before upgrading 16.x.
In this section:
Update SySAM License Server [page 134] If you are using SySAM license server, and are updating from SAP IQ 16.0 SP 10 or earlier, you must upgrade your SySAM license server to at least version 2.4 before updating SAP IQ.
Download Installation Files [page 134] SAP IQ installation and update packages are available on the SAP Software Download Center.
Prepare Your 16.x IQ System [page 135] Some steps differ for simplex and multiplex servers. See the cover letter for release-specific instructions.
SAP IQ Installation and Update Guide for Windows Upgrade to SAP IQ 16.1 SP 04 PUBLIC 133 14.2.1.1 Update SySAM License Server
If you are using SySAM license server, and are updating from SAP IQ 16.0 SP 10 or earlier, you must upgrade your SySAM license server to at least version 2.4 before updating SAP IQ.
Context
SAP IQ 16.1 SP 04 requires SySAM license server 2.4. Use of an older license server with SAP IQ may result in startup failure, with the error: FlexNet Licensing error:-5,414.
The SySAM server is included in the SAP IQ installation package.
To verify the current version of your SySAM license server, perform the following.
Procedure
1. On the SySAM license server, in a console window, change to the SYSAM-2_0
sysam version
Results
The output indicates the versions of the SySAM License Server and FlexNet Licensing. If the SySAM License Server version is older than 2.4, you must upgrade the SySAM License Server before upgrading to SAP IQ 16.1 SP 04. The SySAM License server requires FlexNet Licensing version 11.14.0.0. Upgrading the SySAM License server also upgrades the FlexNet Licensing version to the required minimum version. See SySAM Users Guide for details on updating.
14.2.1.2 Download Installation Files
SAP IQ installation and update packages are available on the SAP Software Download Center.
Context
To access the SAP IQ installation files, go to the SAP Software Download Center and select Software Downloads.
SAP IQ Installation and Update Guide for Windows 134 PUBLIC Upgrade to SAP IQ 16.1 SP 04 Procedure
1. Select SUPPORT PACKAGES & PATCHES By Alphabetical Index (A-Z) I SYBASE IQ SYBASE IQ 16.1 2. Choose the component to download. 3. Choose the operating system from the dropdown list, if applicable. 4. Choose the patch level to download. 5. Click the Shopping Cart icon to add the selected components to the download basket. 6. Click Download Basket and complete the download.
Next Steps
Uncompress the download image on the same machine where you plan to install SAP IQ. Do not copy an uncompressed installation archive to a secondary machine to perform the installation.
Each archive contains a single folder with the installation files. Rename these folders to make them easier to identify. For example, rename the folder with SAP IQ server installation files to server.
14.2.1.3 Prepare Your 16.x IQ System
Some steps differ for simplex and multiplex servers. See the cover letter for release-specific instructions.
Procedure
1. Back up your current installation, and save copies of any changes you made to default login and post-login scripts. Make sure the backups are readable. 2. Check with your operating system vendor for information about the latest operating system patches. Use the recommended operating system patch. Do not use a patch that is earlier than the version suggested for your operating system. 3. In Interactive SQL, run sp_iqcheckoptions on each database, and capture the output. sp_iqcheckoptions generates a list of current database values and options. Use these values to restore your database settings after you upgrade. 4. Validate your license against each database to ensure that your license maintenance support is in (or near) compliance. A server without a maintenance contract for more than a year will not run. Validating your licenses ensures that your database functions correctly after you install the SP. See the SySAM Users Guide for validation procedures. 5. Do one of the following:
SAP IQ Installation and Update Guide for Windows Upgrade to SAP IQ 16.1 SP 04 PUBLIC 135 Option Description
SAP IQ server Shut down the server.
Multiplex Shut down all multiplex nodes.
6. Uninstall SAP IQ.
14.2.2 Install SAP IQ 16.1 SP 04
Simplex and multiplex installation procedures.
Procedure
1. Use the appropriate utility to extract the support package to a directory on the file system. 2. Install the support package. Do not install to the same directory as other SAP Products. On multiplex servers, install the support package on each node separately. 3. From the command line, change to %SYBASE%\IQ-16_1\bin64. 4. Check the version string on the server to verify that the support package installed correctly:
start_iq -v2
The results should match the version string in the cover letter. 5. Restart the server or multiplex.
14.2.3 Upgrade the 16.x Database
Upgrade your database before you perform database read-write operations.
Context
Note
SAP IQ 16.1 SP 01 increased the minimum password length from three to six characters. After performing a database upgrade, existing passwords from a pre-SAP IQ 16.1 SP 01 database continue to work, even if they do not meet the new minimum password length. The new minimum password length is enforced when modifying existing or creating new passwords. Users are strongly encouraged to change nonconforming passwords to benefit from this security change.
SAP IQ Installation and Update Guide for Windows 136 PUBLIC Upgrade to SAP IQ 16.1 SP 04 Procedure
1. Do one of the following:
Option Description
SAP IQ server In the configuration file, set the -iqro 1 startup flags, then start the SAP IQ server.
Multiplex In the configuration file, set the -iqmpx_sn 1 and -iqro 1 startup flags, then start the coordina tor on the SAP IQ multiplex.
2. Start Interactive SQL and connect to the database. 3. Use ALTER DATABASE UPGRADE to upgrade the database.
ALTER DATABASE UPGRADE instantiates all binaries and schema changes. To roll back to a previous version, you must restore from backup. 4. Run sp_iqcheckdb ('allocation database') to verify that there are no errors. 5. Do one of the following:
Option Description
SAP IQ server Shut down and restart the server normally (without the -iqro 1 startup flags).
Multiplex Shut down and restart the coordinator normally (without the -iqmpx_sn 1 and -iqro 1 startup flags). Synchronize and restart all multiplex secondary servers.
6. Back up the database.
14.2.4 SAP IQ 16.x Postupgrade Tasks
Complete these tasks after upgrading your 16.x database.
In this section:
Point-in-Time Recovery Changes [page 138] Migrating a database from SAP IQ 16.0 SP 08 or later to SAP IQ 16.1 SP 04 automatically disables point-in-time recovery. To re-enable point-in-time recovery, complete all steps in this procedure, including a FULL, INCREMENTAL, or INCREMENTAL SINCE FULL backup.
Query Performance Enhancements [page 138] SAP IQ 16.1 SP 03 introduces the feature zone maps to potentially improve query performance.
SAP IQ Installation and Update Guide for Windows Upgrade to SAP IQ 16.1 SP 04 PUBLIC 137 14.2.4.1 Point-in-Time Recovery Changes
Migrating a database from SAP IQ 16.0 SP 08 or later to SAP IQ 16.1 SP 04 automatically disables point-in-time recovery. To re-enable point-in-time recovery, complete all steps in this procedure, including a FULL, INCREMENTAL, or INCREMENTAL SINCE FULL backup.
Procedure
1. Set the IQ_POINT_IN_TIME_RECOVERY_LOGGING option to ON:
SET OPTION PUBLIC.IQ_POINT_IN_TIME_RECOVERY_LOGGING = 'ON'
2. Identify the directory where you want to open the new point-in-time recovery logs:
ALTER DBSPACE IQ_SYSTEM_LOG RENAME
The
BACKUP DATABASE ...
TO archive_device ...
14.2.4.2 Query Performance Enhancements
SAP IQ 16.1 SP 03 introduces the feature zone maps to potentially improve query performance.
To take advantage of this feature after upgrading to SAP IQ 16.1 SP 04 requires you to rebuild some FP indexes.
For details, see "Zone Maps" in the SAP IQ Performance and Tuning Guide.
14.3 SAP IQ 15.4.x Upgrades
Upgrade instructions for sites running SAP IQ 15.4.x.
In this section:
SAP IQ 15.4.x Pre-upgrade tasks [page 139] Complete these tasks before upgrading 15.4.x.
Install SAP IQ 16.1 SP 04 [page 142]
SAP IQ Installation and Update Guide for Windows 138 PUBLIC Upgrade to SAP IQ 16.1 SP 04 Simplex and multiplex installation procedures.
Upgrade 15.4.x Database [page 143] Upgrade your database before you perform database read-write operations.
SAP IQ 15.4.x Postupgrade Tasks [page 144] Complete these tasks after upgrading your 15.4.x database.
14.3.1 SAP IQ 15.4.x Pre-upgrade tasks
Complete these tasks before upgrading 15.4.x.
In this section:
Update SySAM License Server [page 139] If you are using SySAM license server, and are updating from SAP IQ 16.0 SP 10 or earlier, you must upgrade your SySAM license server to at least version 2.4 before updating SAP IQ.
Download Installation Files [page 140] SAP IQ installation and update packages are available on the SAP Software Download Center.
Before You Begin [page 141] This support package includes changes to the system tables and database schema. Objects no longer supported by SAP IQ 16.1 must be removed or modified before a database upgrade.
Prepare your IQ 15.4.x System [page 142] Some steps differ for simplex and multiplex servers. See the cover letter for release-specific instructions.
14.3.1.1 Update SySAM License Server
If you are using SySAM license server, and are updating from SAP IQ 16.0 SP 10 or earlier, you must upgrade your SySAM license server to at least version 2.4 before updating SAP IQ.
Context
SAP IQ 16.1 SP 04 requires SySAM license server 2.4. Use of an older license server with SAP IQ may result in startup failure, with the error: FlexNet Licensing error:-5,414.
The SySAM server is included in the SAP IQ installation package.
To verify the current version of your SySAM license server, perform the following.
SAP IQ Installation and Update Guide for Windows Upgrade to SAP IQ 16.1 SP 04 PUBLIC 139 Procedure
1. On the SySAM license server, in a console window, change to the SYSAM-2_0
sysam version
Results
The output indicates the versions of the SySAM License Server and FlexNet Licensing. If the SySAM License Server version is older than 2.4, you must upgrade the SySAM License Server before upgrading to SAP IQ 16.1 SP 04. The SySAM License server requires FlexNet Licensing version 11.14.0.0. Upgrading the SySAM License server also upgrades the FlexNet Licensing version to the required minimum version. See SySAM Users Guide for details on updating.
14.3.1.2 Download Installation Files
SAP IQ installation and update packages are available on the SAP Software Download Center.
Context
To access the SAP IQ installation files, go to the SAP Software Download Center and select Software Downloads.
Procedure
1. Select SUPPORT PACKAGES & PATCHES By Alphabetical Index (A-Z) I SYBASE IQ SYBASE IQ 16.1 2. Choose the component to download. 3. Choose the operating system from the dropdown list, if applicable. 4. Choose the patch level to download. 5. Click the Shopping Cart icon to add the selected components to the download basket. 6. Click Download Basket and complete the download.
SAP IQ Installation and Update Guide for Windows 140 PUBLIC Upgrade to SAP IQ 16.1 SP 04 Next Steps
Uncompress the download image on the same machine where you plan to install SAP IQ. Do not copy an uncompressed installation archive to a secondary machine to perform the installation.
Each archive contains a single folder with the installation files. Rename these folders to make them easier to identify. For example, rename the folder with SAP IQ server installation files to server.
14.3.1.3 Before You Begin
This support package includes changes to the system tables and database schema. Objects no longer supported by SAP IQ 16.1 must be removed or modified before a database upgrade.
Prerequisites
In SAP IQ 16.1, continuous NBit dictionary compression replaces FP(1), FP(2), and FP(3) byte dictionary compression. Flat FP indexes require more storage space than in earlier releases due to different architecture. Plan for increased storage space requirements.
Procedure
1. Use the DISCONNECT statement to disconnect all users from the 15.x server. 2. Drop all JOIN and all LD indexes from the 15.x database. 3. Update DATE columns that contain a time portion.
There is a known issue that affects any partition defined on a DATE column that contains a time portion: ○ Use ALTER TABLE MERGE to combine the partition with the next partition. ○ Use ALTER TABLE SPLIT to divide the resulting partition into a definition with the same criteria, but no time portion. 4. Drop and re-create all SAP IQ 15.2 TEXT indexes that have not already been dropped and re-created as part of a version 15.2 ESD upgrade.
TEXT indexes created in SAP IQ 15.2 are incompatible with later versions of SAP IQ. 5. Shut down the SAP IQ 15.x server or multiplex.
If the server stops responding during shutdown, do not proceed to the next step. Restart the database and shut it down again. Proceed to the next task only on a clean shutdown.
SAP IQ Installation and Update Guide for Windows Upgrade to SAP IQ 16.1 SP 04 PUBLIC 141 14.3.1.4 Prepare your IQ 15.4.x System
Some steps differ for simplex and multiplex servers. See the cover letter for release-specific instructions.
Procedure
1. Download the support package from the SAP Software Download Center . 2. Back up your current installation, and save copies of any changes you made to default login and post-login scripts. Make sure the backups are readable. 3. Check with your operating system vendor for information about the latest operating system patches. Use the recommended operating system patch. Do not use a patch that is earlier than the version suggested for your operating system. 4. In Interactive SQL, run sp_iqcheckoptions on each database, and capture the output. sp_iqcheckoptions generates a list of current database values and options. Use these values to restore your database settings after you upgrade. 5. Validate your license against each database to ensure that your license maintenance support is in (or near) compliance. A server without a maintenance contract for more than a year will not run. Validating your licenses ensures that your database functions correctly after you install the SP. See the SySAM Users Guide for validation procedures. 6. Uninstall SAP IQ.
14.3.2 Install SAP IQ 16.1 SP 04
Simplex and multiplex installation procedures.
Procedure
1. Use the appropriate utility to extract the support package to a directory on the file system. 2. Install the support package. Do not install to the same directory as other SAP Products. On multiplex servers, install the support package on each node separately. 3. From the command line, change to %SYBASE%\IQ-16_1\bin64. 4. Check the version string on the server to verify that the support package installed correctly:
start_iq -v2
The results should match the version string in the cover letter. 5. Restart the server or multiplex.
SAP IQ Installation and Update Guide for Windows 142 PUBLIC Upgrade to SAP IQ 16.1 SP 04 14.3.3 Upgrade 15.4.x Database
Upgrade your database before you perform database read-write operations.
Context
Note
SAP IQ 16.1 SP 01 increased the minimum password length from three to six characters. After performing a database upgrade, existing passwords from a pre- SAP IQ 16.1 SP 01 database continue to work, even if they do not meet the new minimum password length. The new minimum password length is enforced when modifying existing or creating new passwords. Users are strongly encouraged to change nonconforming passwords to benefit from this security change.
Procedure
1. Do one of the following:
Option Description
SAP IQ server In the configuration file, set the -gm 1 and -iqro 1 startup flags, then start the SAP IQ server.
Multiplex In the configuration file, set the -iqmpx_sn 1, -gm 1, and -iqro 1 startup flags, then start the coordinator on the SAP IQ multiplex.
2. Start Interactive SQL and connect to the database. 3. Use DROP INDEX to drop all LD and JOIN indexes. 4. Upgrade the database.
ALTER DATABASE UPGRADE instantiates all binaries and schema changes. To roll back to a previous version, you must restore from backup. 5. Run sp_iqcheckdb ('allocation database') to verify that there are no errors. 6. Do one of the following:
Option Description
SAP IQ server Shut down and restart the server normally (without the -gm 1 and -iqro 1 startup flags).
Multiplex Shut down and restart the coordinator normally (without the -iqmpx_sn 1, -gm 1, and -iqro 1 startup flags). Synchronize and restart all multiplex secondary servers.
7. Back up the database.
SAP IQ Installation and Update Guide for Windows Upgrade to SAP IQ 16.1 SP 04 PUBLIC 143 14.3.4 SAP IQ 15.4.x Postupgrade Tasks
Complete these tasks after upgrading your 15.4.x database.
In this section:
Query Performance Enhancements [page 144] SAP IQ 16.1 SP 03 introduces the feature zone maps to potentially improve query performance.
Database Status Post Upgrade [page 144] SAP IQ 16.1 databases upgraded from 15.x are initially set to run in 15.x compatibility mode. You must explicitly change several compatibility settings to complete the upgrade to 16.1.
Conceptual Changes Between 15.4.x and 16.x [page 147] There are several significant conceptual changes between 15.4.x and 16.x with respect to system procedures, logical servers and the security model. Review these changes before using SAP IQ16.1SP 04.
14.3.4.1 Query Performance Enhancements
SAP IQ 16.1 SP 03 introduces the feature zone maps to potentially improve query performance.
To take advantage of this feature after upgrading to SAP IQ 16.1 SP 04 requires you to rebuild some FP indexes.
For details, see "Zone Maps" in the SAP IQ Performance and Tuning Guide.
14.3.4.2 Database Status Post Upgrade
SAP IQ 16.1 databases upgraded from 15.x are initially set to run in 15.x compatibility mode. You must explicitly change several compatibility settings to complete the upgrade to 16.1.
Indexes
● Continuous NBit dictionary compression replaces FP(1), FP(2), and FP(3) byte dictionary compression. FP(1), FP(2), and FP(3) indexes roll over to NBit(8), NBit(16), and NBit(24), respectively. All data types except LOB (both character and binary) and BIT data types may be NBit columns. If FP_NBIT_IQ15_COMPATIBILITY is OFF, IQ UNIQUE determines whether the column loads as Flat FP or NBit. ● New tiered HG index structure decouples load performance from HG index size. In 15.x, load throughput could degrade as the amount of data in an HG index increased. As the index grew, loading the same amount of data could take more time. The new tiered structure decouples load performance from the HG index size to increase throughput. The CREATE_HG_WITH_EXACT_DISTINCTS option determines whether newly created HG indexes are tiered or non-tiered. If this option is ON, all new HG indexes are non-tiered. To take advantage of the new
SAP IQ Installation and Update Guide for Windows 144 PUBLIC Upgrade to SAP IQ 16.1 SP 04 structure, set this option to OFF. Use sp_iqrebuildindex to convert non-tiered HG indexes to tiered HG, and vice versa.
Column Constraints
IQ UNIQUE determines whether the column loads as Flat FP or NBit.
In SAP IQ 16.1, IQ UNIQUE explicitly defines the expected cardinality of a column and determines whether the column loads as Flat FP or NBit. Columns retain their IQ UNIQUE value during a 15.x to 16.1 database upgrade.
Setting IQ UNIQUE to 0 loads the column as Flat FP. Columns without an IQ UNIQUE constraint or columns with an IQ UNIQUE
Database Options
The following database options control NBit behavior and HG indexes.
Option Description
FP_NBIT_IQ15_COMPATIB Provides tokenized FP support similar to that available in 15.x. This option is ON by de ILITY fault in all 16.1 databases upgraded from 15.x and OFF in all newly created 16.1 databases.
● If this option is ON, the database engine uses the MINIMIZE_STORAGE, FP_LOOKUP_SIZE, and FP_LOOKUP_SIZE_PPM options to optimize column stor age. These options are ignored in 16.1. ● If this option is OFF, the database engine ignores 15.x options and columns conform to SAP IQ 16.1 NBit storage options.
Set this option to OFF to take advantage of NBit column compression.
CREATE_HG_WITH_EXACT_ Determines whether new HG indexes explicitly created with a CREATE INDEX com DISTINCTS mand, or implicitly creating or altering a table with a PRIMARY KEY or a FOREIGN KEY declaration, are tiered or non-tiered. This option is ON in 16.1 databases upgraded from 15.x and all newly created 16.1 databases. If this option is ON, all new HG indexes are non- tiered. To take advantage of the new tiered HG index structure, set this option to OFF.
Use sp_iqrebuildindex to convert non-tiered HG indexes to tiered HG, and vice versa.
CREATE_HG_AND_FORCE_P Governs 16.1 delete behavior for tiered HG indexes. This option determines whether SAP HYSICAL_DELETE IQ performs a physical delete immediately or defers the delete to a point later in the load.
CREATE_HG_AND_FORCE_PHYSICAL_DELETE is ON by default, which instructs SAP IQ to perform physical deletes.
SAP IQ Installation and Update Guide for Windows Upgrade to SAP IQ 16.1 SP 04 PUBLIC 145 Option Description
REVERT_TO_V15_OPTIMIZ Forces the query optimizer to mimic SAP IQ 15.x behavior. REVERT_TO_V15_OPTIMIZER ER is ON by default in all 16.1 databases upgraded from 15.x. REVERT_TO_V15_OPTIMIZER is OFF by default in all newly created SAP IQ 16.1 databases.
If you plan to use SAP IQ 16.1 hash partitioning features, set the REVERT_TO_V15_OPTI MIZER to OFF.
Startup Options
Some load operations may require more memory than the 2 GB default provides. If memory requirements exceed the default, use the -iqlm startup option to increase the memory that SAP IQ can dynamically request from the OS. Set -iqlm as a switch as part of the command or configuration file that starts the server.
Generally, large memory requirements represent one third of the total available physical memory allocated to SAP IQ. To ensure adequate memory for the main and temporary IQ stores, set the -iqlm, -iqtc, and -iqmc startup parameters so that each parameter receives one third of all available physical memory allocated to SAP IQ.
In most cases, you should allocate 80% of total physical memory to SAP IQ to prevent SAP IQ processes from being swapped out. Adjust actual memory allocation to accommodate other processes running on the same system. For example, on a machine with 32 cores and 128 GB of total available physical memory, you would allocate 100 GB (approximately 80% of the 128 GB total) to SAP IQ processes. Following the general rule, you would set the -iqlm, -iqtc, and -iqmc parameters to 33 GB each.
Object Names
Reserved words cannot be used as object names.
An SAP IQ 15.x database could contain tables, columns, and other objects named row. In SAP IQ 16.1, row is a reserved word and cannot be used as an object name.
To use a reserved word as an object name, enclosed the object name in brackets (regardless of the QUOTED_IDENTIFIER setting) or double quotes (if QUOTED_IDENTIFIER='ON' [default]):
// QUOTED_IDENTIFIER ON | OFF
select * from [row]; alter table row2 rename [row] to col_row; // QUOTED_IDENTIFIER='ON' select "row" from row2;
alter table "row" rename rownew;
Stored Procedures
Use these stored procedures to review and change column constraints and indexes.
SAP IQ Installation and Update Guide for Windows 146 PUBLIC Upgrade to SAP IQ 16.1 SP 04 Procedure Name Description
sp_iqcolumnmetadata Returns index metadata for all columns in one or more tables.
sp_iqindexmetadata Returns details about column indexes, including the index types (Flat FP, NBit, HG, and tiered HG), distinct counts, IQ UNIQUE value, and NBit dictionary size.
sp_iqrebuildindex Rebuilds FP indexes (Flat FP as NBit, or NBit as Flat FP) and HG indexes (single HG as tiered HG, or tiered HG as single HG). Before you can insert or update new data, you must rebuild all columns greater than 255 bytes wide.
The index_clause can reset IQ UNIQUE
sp_iqrebuildindex also enables read-write access to columns that contain large object (LOB) data. LOB columns migrated from 15.x databases are read-only until you run sp_iqrebuildindex.
The estimated cardinality for NBit columns with an IQ UNIQUE value below or equal to the FP_NBIT_AUTOSIZE_LIMIT is stored as 0 regardless of the FP_NBIT_IQ15_COM PATIBILITY setting. This affects the value returned from sp_iqindexmetadata.
sp_iqindexrebuildwideda Identifies wide columns that you must rebuild before they are available for read/write ta activities. sp_iqindexrebuildwidedata also generates a list of statements that you can use to rebuild the columns.
This applies to CHAR, VARCHAR, BINARY, and VARBINARY columns wider than 255 characters, as well as all Long Varchar and Long Binary columns.
Related Information sp_iqcheckdb Procedure sp_iqcolumnmetadata Procedure sp_iqindexmetadata Procedure sp_iqrebuildindex Procedure sp_iqrebuildindexwide Procedure
14.3.4.3 Conceptual Changes Between 15.4.x and 16.x
There are several significant conceptual changes between 15.4.x and 16.x with respect to system procedures, logical servers and the security model. Review these changes before using SAP IQ16.1SP 04.
In this section:
System Procedures [page 148] Enhanced role-based security changes the way privileged system procedures run.
Logical Servers [page 152] An SAP IQ 16.1 multiplex database upgrade changes the way users access multiplex servers. Starting with SAP IQ 15.4, logical servers provide the only means to access the multiplex server nodes.
SAP IQ Installation and Update Guide for Windows Upgrade to SAP IQ 16.1 SP 04 PUBLIC 147 Role-Based Security Model [page 152] New SAP IQ 16.x role-based security replaces the authority-based security model.
14.3.4.3.1 System Procedures
Enhanced role-based security changes the way privileged system procedures run.
In this section:
System Procedure Changes [page 148] Prior to SAP IQ 16.1, privileged system procedures ran with the privileges of its owner, typically the dbo system role; this is called the SYSTEM PROCEDURE DEFINER model. In 16.x, privileged system procedures run with the privileges of the person executing it; this is called the SYSTEM PROCEDURE INVOKER model.
Pre-16.x Privileged System Procedures [page 149] A list of pre-16.x privileged system procedures.
Regrant EXECUTE Privilege [page 151] When you upgrade a database, there is a set of privileged system procedures for which you must regrant the EXECUTE privilege if the upgraded database continues to use the SYSTEM PROCEDURE DEFINER security model.
14.3.4.3.1.1 System Procedure Changes
Prior to SAP IQ 16.1, privileged system procedures ran with the privileges of its owner, typically the dbo system role; this is called the SYSTEM PROCEDURE DEFINER model. In 16.x, privileged system procedures run with the privileges of the person executing it; this is called the SYSTEM PROCEDURE INVOKER model.
Note
This behavior change applies to SAP IQ privileged system procedures only, and not to user-defined stored procedures.
In the SYSTEM PROCEDURE DEFINER model, when you grant a user explicit EXECUTE object-level privilege on a system procedure, any privileges required to run any authorized tasks associated with the system procedure are automatically inherited from the owner (definer of the system procedure).
In the SYSTEM PROCEDURE INVOKER model, the EXECUTE object-level privilege for each system procedure is granted to the PUBLIC role. Since, by default, every user is a member of the PUBLIC role, every user automatically inherits the required EXECUTE object-level privilege. Any additional system privileges needed to run the system procedure are not inherited; you must now directly or indirectly grant them to the user.
This behavior change might create a loss of functionality on custom stored procedures and applications that explicitly grant EXECUTE object-level privilege on system procedures. For this reason, the default upgrade process for pre- 16.x database uses a combination of the two models. Privileged system procedures that existed in IQ versions earlier than 16.x continue to run using the SYSTEM PROCEDURE DEFINER model, while any privileged system procedures introduced in 16.x or later use the SYSTEM PROCEDURE INVOKER model.
SAP IQ Installation and Update Guide for Windows 148 PUBLIC Upgrade to SAP IQ 16.1 SP 04 You can override the default upgrade behavior so that all privileged system procedures for all versions use only the SYSTEM PROCEDURE INVOKER model if the potential loss of functionality is not a concern. If you are unsure of potential loss of functionality, upgrade your database to use the default behavior, then investigate. If you determine that it is not an issue, and you want all system procedures to run using the SYSTEM PROCEDURE INVOKER model, use the ALTER DATABASE statement to change the default security model. When you override the default upgrade behavior, the EXECUTE object-level privilege to run privileged system procedures is revoked from all users and roles and granted to the PUBLIC role.
To specify a security model, use the CREATE DATABASE statement, ALTER DATABASE UPGRADE statement, or the Initialization utility (iqinit).
Once a database is upgraded to SAP IQ 16.1 , the default upgrade behavior for any subsequent upgrades (for example to 16.1 SP 02, SP 03, and so on) is to continue to use the current security model.
There is a small subset of pre- 16.x privileged system procedures that has always run with the privileges of the user running the procedure, rather than the owner of the procedure. In addition to EXECUTE object-level privilege on the system procedure, you must be granted additional system privileges that are specific to the system procedure.
When running privileged system procedures using the SYSTEM PROCEDURE DEFINER model, the DBO system role is typically the owner of the procedures. By default, the dbo system role is granted the SYS_AUTH_DBA_ROLE compatibility role. This ensures that the role is indirectly granted all privileges necessary to execute system procedures. Migrating the SYS_AUTH_DBA_ROLE compatibility role can result in the dbo system role losing the ability to execute privileged system procedures. See Implications of Migrating Compatibility Roles [page 197] for details.
14.3.4.3.1.2 Pre-16.x Privileged System Procedures
A list of pre-16.x privileged system procedures.
Privileged System Procedures Using the Combined Security Model
For these privileged system procedures, if the database is configured to use SYSTEM PROCEDURE DEFINER, you only need EXECUTE object-level privilege on the procedure to run it. If the database is configured to use SYSTEM PROCEDURE INVOKER, you also need the individual system privileges required by each procedure. Refer to SAP IQ SQL Reference for the system privileges required to run each system procedure.
SAP IQ Installation and Update Guide for Windows Upgrade to SAP IQ 16.1 SP 04 PUBLIC 149 ● sa_audit_string ● sp_iqdbspace ● sp_iqmpxinfo ● sa_checkpoint_execute ● sp_iqdbspaceinfo ● sp_iqmpxversioninfo ● sa_disable_auditing_type ● sp_iqdbspaceobjectinfo ● sp_iqobjectinfo ● sa_disk_free_space ● sp_iqdbstatistics ● sp_iqpkeys ● sa_enable_auditing_type ● sp_iqdroplogin ● sp_iqprocedure ● sa_external_library_unload ● sp_iqemptyfile ● sp_iqprocparm ● sa_flush_cache ● sp_iqestdbspaces ● sp_iqrebuildindex ● sa_list_external_library ● sp_iqestspace ● sp_iqrename ● sa_server_option ● sp_iqevent ● sp_iqrestoreaction ● sa_procedure_profile ● sp_iqfile ● sp_iqrowdensity ● sa_procedure_profile_summary ● sp_iqhelp ● sp_iqsetcompression ● sa_table_page_usage ● sp_iqindex ● sp_iqsharedtempdistrib ● sa_validate ● sp_iqindex_alt ● sp_iqshowcompression
● sp_iq_reset_identity ● sp_iqindexadvice ● sp_iqshowpsexe ● sp_iqaddlogin ● sp_iqindexfragmentation ● sp_iqspaceinfo ● sp_iqbackupdetails ● sp_iqindexinfo ● sp_iqspaceused ● sp_iqbackupsummary ● sp_iqindexmetadata ● sp_iqstatistics ● sp_iqcardinality_analysis ● sp_iqindexsize ● sp_iqstatus ● sp_iqcheckdb ● sp_iqindexuse ● sp_iqsysmon ● sp_iqcheckoptions ● sp_iqlmconfig ● sp_iqtable ● sp_iqclient_lookup ● sp_iqlocks ● sp_iqtablesize ● sp_iqcolumn ● sp_iqmodifyadmin ● sp_iqtableuse ● sp_iqcolumnuse ● sp_iqmodifylogin ● sp_iqtransaction ● sp_iqconnection ● sp_iqmpxcheckdqpconfig ● sp_iqunusedcolumn ● sp_iqconstraint ● sp_iqmpxdumptlvlog ● sp_iqunusedindex ● sp_iqcontext ● sp_iqmpxfilestatus ● sp_iqunusedtable ● sp_iqconstraint ● sp_iqmpxincconnpoolinfo ● sp_iqversionuse ● sp_iqcontext ● sp_iqmpxincheartbeatinfo ● sp_iqview ● sp_iqcursorinfo ● sp_iqcopyloginpolicy ● sp_iqwho ● sp_iqdatatype ● sp_iqmpxincconnpoolinfo ● sp_iqworkmon ● sp_iqdbsize ● sp_iqmpxincheartbeatinfo
Privileged System Procedures Using Invoker Privileges
These pre-16.x privileged system procedures run with the privileges of the user who is running the procedure, not the owner of the procedure, regardless of the security model setting. Therefore, in addition to the EXECUTE object-level privilege on the system procedure, which is, by default, granted through membership in PUBLIC role, you must also be granted the additional system privileges required by the system procedure. See the SAP IQ SQL Reference for the system privileges required to run each system procedure.
● sa_describe_shapefile ● sa_get_user_status ● sa_locks ● sa_performance_diagnostics ● sa_report_deadlocks ● sa_text_index_stats
SAP IQ Installation and Update Guide for Windows 150 PUBLIC Upgrade to SAP IQ 16.1 SP 04 14.3.4.3.1.3 Regrant EXECUTE Privilege
When you upgrade a database, there is a set of privileged system procedures for which you must regrant the EXECUTE privilege if the upgraded database continues to use the SYSTEM PROCEDURE DEFINER security model.
The system procedures for which you must regrant the privilege are:
● sa_audit_string ● sa_checkpoint_execute ● sa_disable_auditing_type ● sa_disk_free_space ● sa_enable_auditing_type ● sa_external_library_unload ● sa_flush_cache ● sa_list_external_library ● sa_server_option ● sa_procedure_profile ● sa_procedure_profile_summary ● sa_table_page_usage ● sa_validate
To determine the security model of your upgraded database, execute:
select IF ((HEXTOINT(substring(db_property('Capabilities'),
1,length(db_property('Capabilities'))-20)) & 8) = 8) THEN 1 ELSE 0 END IF
A value of 1 indicates the database is using the SYSTEM PROCEDURE INVOKER model. A value of 0 indicates that the database is using the SYSTEM PROCEDURE DEFINER.
The MANAGE ANY OBJECT PRIVILEGE system privilege is required to grant the EXECUTE object-level privilege.
To grant the privilege, execute:
GRANT EXECUTE
ON [
TO
Related Information
Pre-16.x Privileged System Procedures [page 149]
SAP IQ Installation and Update Guide for Windows Upgrade to SAP IQ 16.1 SP 04 PUBLIC 151 14.3.4.3.2 Logical Servers
An SAP IQ 16.1 multiplex database upgrade changes the way users access multiplex servers. Starting with SAP IQ 15.4, logical servers provide the only means to access the multiplex server nodes.
Upgrading a multiplex database creates an appropriate logical server for each server-specific login policy. Login policies are updated to use a logical server configuration that provides access to the same set of multiplex servers as prior to upgrade.
If a login policy does not allow access to any node (such as when the base setting of LOCKED is ON and there are no multiplex server-level overrides), the login policy is set to a system-defined logical server, NONE, instead of creating a new logical server. NONE indicates that the login policy does not allow access to any multiplex server.
If a login policy has no explicit setting for the LOCKED option, either at the base level or via a multiplex server- level override, no logical server is created for that policy. Such a login policy inherits the logical server assignment of the root login policy.
● Membership configuration of a logical server provides access to the same multiplex nodes as the corresponding 15.x login policy. If the login policy allowed access to the current coordinator server, a logical membership of the coordinator is also added to the logical server. ● Logical server names are derived from login policy names. If the login policy name is fewer than 126 characters, the logical server follows this naming convention: LS_
See Manage Resources Through Logical Servers in SAP IQ Administration: Multiplex.
14.3.4.3.3 Role-Based Security Model
New SAP IQ 16.x role-based security replaces the authority-based security model.
In this section:
What Happened to Authorities, Permissions, and Groups? [page 154] SAP IQ 16.x introduces a role-based security model. Earlier versions used authorities, permissions, object-level permissions, and groups. The role-based security model uses roles, system privileges, object-level privileges, and user-extended roles.
Authorities Become Compatibility Roles [page 155]
SAP IQ Installation and Update Guide for Windows 152 PUBLIC Upgrade to SAP IQ 16.1 SP 04 When you upgrade to 16.1, users who are granted authorities in the earlier version are automatically granted an equivalent compatibility role. If users could previously administer the authority, they can administer the compatibility role in 16.0.
Permissions Become Privileges [page 156] SAP IQ versions earlier than 16.x used object-level permissions such as ALTER and SELECT for tables and views. These permissions are now called object-level privileges.
Groups Become Roles [page 156] When you upgrade an IQ database earlier than 16.0, each group is converted to an equivalent user- extended role of the same name. Members of the original group are automatically granted the new role and all of its underlying system privileges. Authorities and object-level permissions granted to the original group are converted to equivalent compatibility roles and system privileges and are granted to the user-extended role.
Change to Concept of a Super-User (DBA Authority) [page 157] In SAP IQ versions earlier than 16.x, the DBA user was often considered a super-user by virtue of being granted the DBA authority. The DBA user continues to exist in 16.x, however, the concept has changed.
Changes to the GRANT Statement Syntax [page 158] The GRANT syntax for authorities, permissions, and groups is supported, but deprecated. If you have applications that use the pre- 16.x GRANT statement syntax, modify them to use the new syntax for roles and privileges.
Changes to the REVOKE Statement Syntax [page 160] The REVOKE syntax for authorities, permissions, and groups is supported but deprecated. If you have applications that use the pre- 16.x REVOKE statement syntax, modify them to use the new syntax for roles and privileges.
Changes to REMOTE DBA [page 162] The REMOTE DBA authority is replaced by the SYS_RUN_REPLICATION_ROLE system role. This role allows user to administer replication.
Changes in Inheritance Behavior [page 162] In SAP IQ versions earlier than 16.0, when you granted the DBA, REMOTE DBA, BACKUP, RESOURCE, and VALIDATE authorities to a group, the underlying permissions were not inherited by members of the group.
Changes in Administering the Database Publisher [page 163] In 16.x, the PUBLISH authority is replaced by the PUBLIC.db_publisher database option. You change the publisher by changing the database option.
Compatibility Roles [page 163] Compatibility roles exist for backward compatibility with versions of SAP IQ earlier than 16.0 that support authority-based security.
Backward Compatibility in SAP IQ 16.1 [page 198] Grant and revoke syntax for role-based security differs significantly from authority-based security. However, SAP IQ 16.1 is fully backward compatible with authority-based syntax.
Stored Procedure to Map Authorities to System Roles [page 198] The sp_auth_sys_role_info stored procedure generates a report, which maps each authority to a corresponding system role name.
Connecting to SAP IQ 15.x Databases with SAP IQ 16.x [page 199] Role-based syntax is not supported in SAP IQ 15.x databases.
SAP IQ Installation and Update Guide for Windows Upgrade to SAP IQ 16.1 SP 04 PUBLIC 153 14.3.4.3.3.1 What Happened to Authorities, Permissions, and Groups?
SAP IQ 16.x introduces a role-based security model. Earlier versions used authorities, permissions, object-level permissions, and groups. The role-based security model uses roles, system privileges, object-level privileges, and user-extended roles.
Note
You can use an SAP IQ 16.x server with an IQ database from an earlier version (pre- 16.x). When you do, full backward compatibility is provided for that database, and its security model is not changed.
In pre- 16.x, authorities are database-level permissions. For example, a user with BACKUP authority can back up the database. Some authorities bundle object-level permissions. For example, a user with PROFILE authority can perform application profiling and database tracing tasks, which involve using system procedures that are not otherwise available for use. You cannot create new authorities, alter the permissions they comprised, or drop them. You can grant administrative rights (WITH GRANT), but cannot limit the grant to administrator rights only.
In 16.x, roles replace authorities, with the added benefit that you can create new roles, alter the system privileges granted, and drop them. Roles and privileges provide a more granular control when granting system privileges to users. You can also grant roles to users with administrative rights only. A user can then grant and revoke the role, but cannot exercise the underlying privileges.
In pre- 16.x, permissions allowed you to create, modify, query, use, or delete database objects such as tables, views, and users.
In 16.x, system privileges replace permissions in functionality. Every privileged operation that you can perform on a database object now has a grantable system privilege. You can grant system privileges individually to users or to a role.
In 16.x, the meaning of permissions has changed. In pre- 16.x versions, a permission meant a grantable capability. Now, permission means the result of an evaluation of whether an operation can be performed. For example, you have permission to alter the table if you are the owner or you have the ALTER ANY TABLE system privilege.
In pre- 16.x, groups were a collection of one or more users whose authorities and permissions were determined at the group level. A user was granted group status, and then other users were granted membership in that group.
In 16.x, the group paradigm is achieved using user-extended roles. If you have a user with a set of privileges that you want to grant to other users, you extend the user to become a user-extended role, and then grant that role to other users.
Upgrading a pre- 16.x database automatically converts your existing authority, permission, and group hierarchy into an equivalent role, privilege, and user-extended role hierarchy. Every pre- 16.x authority has a compatibility role. These roles are easily identifiable because their names start with SYS_AUTH. Compatibility roles contain the system privileges required to perform the same operations as the corresponding previous authority.
To take full advantage of the control and granularity of privileges available with role-based security, SAP recommends that, after migration, you review the compatibility role grants of each user and adjust membership and system privilege grants as necessary.
SAP IQ Installation and Update Guide for Windows 154 PUBLIC Upgrade to SAP IQ 16.1 SP 04 14.3.4.3.3.2 Authorities Become Compatibility Roles
When you upgrade to 16.1, users who are granted authorities in the earlier version are automatically granted an equivalent compatibility role. If users could previously administer the authority, they can administer the compatibility role in 16.0.
The naming convention for each compatibility role retains the original authority name, but is prefaced with "SYS_AUTH_" and suffixed with "_ROLE". For example, the authority BACKUP becomes the role SYS_AUTH_BACKUP_ROLE, authority RESOURCE becomes role SYS_AUTH_RESOURCES_ROLE, and so on.
You cannot modify compatibility roles. However, you can migrate them to a user-defined role, and then modify them. When you migrate a compatibility role to a user-defined role, all users who are granted the compatibility role are granted the new user-defined role. Once each underlying system privilege is granted to at least one other role, you can drop the compatibility role. To restore compatibility roles, use the CREATE ROLE statement.
SQL statements are backward compatibility to support applications that grant or revoke authorities. However, the old syntax is deprecated and SAP recommends that you changed your applications to use the new SQL syntax for roles.
This table shows each authority and its equivalent compatibility role.
Authority Compatibility Role Description
BACKUP SYS_AUTH_BACKUP_ROL Allows a user to back up databases and transaction logs with E archive or image backups by using the BACKUP DATABASE statement or dbbackup utility.
DBA SYS_AUTH_DBA_ROLE Allows users to perform all possible privileged operations. Users with the SYS_AUTH_DBA_ROLE role can create data SYS_AUTH_SA_ROLE base objects and assign ownership of these objects to other SYS_AUTH_SSO_ROLE user IDs, change table structures, create new user IDs, revoke permissions from users, back up the database, and so on.
Of the possible privileged operations that the SYS_AUTH_DBA_ROLE compatibility role can perform, the SYS_AUTH_SA_ROLE compatibility role allows the user to per form all database administration-related activities, such as cre ating tables, and backing up data.
Of the possible privileged operations that the SYS_AUTH_DBA_ROLE compatibility role can perform, the SYS_AUTH_SSO_ROLE compatibility role allows the user to perform the security and access-related administration activi ties, such as creating users, and granting privileges on objects.
PROFILE SYS_AUTH_PRO Allows a user to perform profiling, tracing, and diagnostic oper FILE_ROLE ations.
READCLIENTFILE SYS_AUTH_READCLIENT Allows a user to read files on the client computer, for example FILE_ROLE when loading data from a file on a client computer.
READFILE SYS_AUTH_READ Allows a user to use the OPENSTRING clause in a SELECT FILE_ROLE statement to read a file.
SAP IQ Installation and Update Guide for Windows Upgrade to SAP IQ 16.1 SP 04 PUBLIC 155 Authority Compatibility Role Description
REMOTE DBA SYS_RUN_REPLICA Allows a SQL Remote user to perform replication activities by TION_ROLE system role using the dbremote and dbmisync utilities. It does not, however, allow administration of replication. SYS_REPLICATION_AD MIN_ROLE system role The SYS_REPLICATION_ADMIN_ROLE system role is provided for replication administration.
RESOURCE SYS_AUTH_RE Allows a user to create database objects, such as tables, views, SOURCE_ROLE stored procedures, and triggers.
VALIDATE SYS_AUTH_VALI Allows a user to perform database, table, index, and checksum DATE_ROLE validation by using the VALIDATE statement or dbvalid utility.
WRITECLIENTFILE SYS_AUTH_WRITE Allows a user to write to files on a client computer, for example, CLIENTFILE_ROLE when using the UNLOAD TABLE statement to write data to a client computer.
WRITEFILE SYS_AUTH_WRITE Allows a user to execute the xp_write_file system proce FILE_ROLE dure.
In an authority-based security model, there was no way to limit the grant if a user did not need all of the permissions vested in an authority. This resulted in users often being granted more permissions than necessary, a potential security concern. The role-based security model addresses this concern by allowing system privileges to be granted at a granular level.
Since the migration process ensures that all existing privileges are preserved at the user and group level, SAP recommends that, after migration, you review the compatibility role grants for each user and adjust membership as necessary.
14.3.4.3.3.3 Permissions Become Privileges
SAP IQ versions earlier than 16.x used object-level permissions such as ALTER and SELECT for tables and views. These permissions are now called object-level privileges.
When you upgrade your database, users granted permissions are automatically granted the equivalent object- level privileges.
SQL statements that grant or revoke object-level permissions/privileges still work.
In addition to object-level privileges, there are now grantable system privileges for every authorized operation.
14.3.4.3.3.4 Groups Become Roles
When you upgrade an IQ database earlier than 16.0, each group is converted to an equivalent user-extended role of the same name. Members of the original group are automatically granted the new role and all of its underlying system privileges. Authorities and object-level permissions granted to the original group are converted to equivalent compatibility roles and system privileges and are granted to the user-extended role.
SAP IQ Installation and Update Guide for Windows 156 PUBLIC Upgrade to SAP IQ 16.1 SP 04 If an authority was inheritable, grantees of the new user-extended role inherit the underlying system privileges of the equivalent compatibility role. If the authority was not inheritable, the grantees of the user-extended role do not inherit the underlying system privileges of the equivalent compatibility role. If the legacy group had a password, only the extended user of the user-extended role inherits the underlying system privileges of the compatibility role that is not inheritable.
System groups become system roles with the same name.
Group/System Role Description
dbo This role owns many system stored procedures, views, and tables.
diagnostics This role owns the diagnostic tables and views, and can perform operations on them.
PUBLIC This role has SELECT permission on the system tables. Any new user ID is automatically granted the PUBLIC role.
ra_systabgroup This role allows users to perform replication server functionality.
SYS This role owns the system tables and views (IQ catalog) for the database, and can per form operations on them.
SYS_SPATIAL_ADMIN_ROLE This role allows users to create, alter, or drop spatial objects.
14.3.4.3.3.5 Change to Concept of a Super-User (DBA Authority)
In SAP IQ versions earlier than 16.x, the DBA user was often considered a super-user by virtue of being granted the DBA authority. The DBA user continues to exist in 16.x, however, the concept has changed.
In SAP IQ versions earlier than 16.x, you created a super-user by granting a user DBA authority. Users with DBA authority can perform any privileged task in the system. When you upgrade your database to 16.x, any users granted DBA authority are granted the equivalent SYS_AUTH_DBA_ROLE compatibility role and become a super-user. After migration, the super-user itself must be managed to preserve its super-user abilities.
When you create a new role without specify an administrator, users with the MANAGE ROLES system privilege (global administrators) can administer the role. Since MANAGE ROLES is one of the system privileges granted to the SYS_AUTH_DBA_ROLE compatibility role, super-users can administer new roles.
However, if you create a new role and assign administrators, administration is then limited to only those administrators; global administrators, and thus super-users, cannot administer the role. You must explicitly assign the super-user as an administrator of the role.
You can migrate the SYS_AUTH_DBA_ROLE compatibility role to a user-defined role, and eventually drop it. Since the ability of the super-user to perform any privileged task is dependent on the SYS_AUTH_DBA_ROLE compatibility role, before you drop the SYS_AUTH_DBA_ROLE compatibility role, you must grant the super- user membership in the new user-defined role or grant each of the underlying system privileges directly or indirectly to the super-user.
SAP IQ Installation and Update Guide for Windows Upgrade to SAP IQ 16.1 SP 04 PUBLIC 157 14.3.4.3.3.6 Changes to the GRANT Statement Syntax
The GRANT syntax for authorities, permissions, and groups is supported, but deprecated. If you have applications that use the pre- 16.x GRANT statement syntax, modify them to use the new syntax for roles and privileges.
In SAP IQ versions earlier than 16.x, DBA, REMOTE DBA, RESOURCE, and VALIDATE authorities were not inheritable. When you upgrade your database to 16.x, the WITH NO SYSTEM PRIVILEGE INHERITANCE clause ensures that inheritance behavior remains consistent with earlier releases.
Users granted DBA and REMOTE DBA authorities could grant them to others. In 16.x, the WITH ADMIN clause is introduced to ensure that administration rights behavior remains consistent with previous releases.
The following table shows non-inheritable authorities:
Pre-16.x Syntax New Syntax
GRANT DBA GRANT ROLE SYS_AUTH_DBA_ROLE
TO
WITH ADMIN OPTION
WITH NO SYSTEM PRIVILEGE INHERITANCE
GRANT REMOTE DBA GRANT ROLE SYS_RUN_REPLICATION_ROLE
TO
WITH NO ADMIN OPTION
WITH NO SYSTEM PRIVILEGE INHERITANCE
GRANT BACKUP GRANT ROLE SYS_AUTH_BACKUP_ROLE
TO
WITH NO SYSTEM PRIVILEGE INHERITANCE
GRANT RESOURCE GRANT ROLE SYS_AUTH_RESOURCE_ROLE
TO
WITH NO SYSTEM PRIVILEGE INHERITANCE
GRANT VALIDATE GRANT ROLE SYS_AUTH_VALIDATE_ROLE
TO
WITH NO SYSTEM PRIVILEGE INHERITANCE
The following table shows inheritable authorities:
Pre-16.x Syntax New Syntax
GRANT Multiplex Admin GRANT ROLE
TO
TO
SAP IQ Installation and Update Guide for Windows 158 PUBLIC Upgrade to SAP IQ 16.1 SP 04 Pre-16.x Syntax New Syntax
GRANT Operator GRANT ROLE SYS_AUTH_OPERATOR_ROLE
TO
GRANT Perms Admin GRANT ROLE SYS_AUTH_PERMS_ADMIN_ROLE
TO
GRANT PROFILE GRANT ROLE SYS_AUTH_PROFILE_ROLE
TO
GRANT READCLIENTFILE GRANT ROLE
TO
TO
GRANT READFILE GRANT ROLE SYS_AUTH_READFILE_ROLE
TO
GRANT Space Admin GRANT ROLE SYS_AUTH_SPACE_ADMIN_ROLE
TO
GRANT Spatial Admin GRANT ROLE SYS_AUTH_SPATIAL_ADMIN_ROLE
TO
GRANT WRITECLIENTFILE GRANT ROLE
TO
TO
GRANT WRITEFILE GRANT ROLE SYS_AUTH_WRITEFILE_ROLE
TO
No change GRANT CONNECT TO
[ IDENTIFIED BY
GRANT GROUP TO
FOR USER
GRANT MEMBERSHIP IN GROUP GRANT ROLE
TO
No change; however, you can also set the new PUBLIC op GRANT PUBLISH TO tion, db_publisher:
PUBLIC.db_publisher=
SAP IQ Installation and Update Guide for Windows Upgrade to SAP IQ 16.1 SP 04 PUBLIC 159 Pre-16.x Syntax New Syntax
No change GRANT
ON [
TO
[ WITH GRANT OPTION ]
ALL [ PRIVILEGES ] | ALTER | DELETE | INSERT
| REFERENCES [ (
| SELECT [ (
| UPDATE [ (
No change GRANT EXECUTE ON [
{
TO
No change GRANT INTEGRATED LOGIN
TO
AS USER
No change GRANT KERBEROS LOGIN
TO
AS USER
No change GRANT CREATE
ON
TO
14.3.4.3.3.7 Changes to the REVOKE Statement Syntax
The REVOKE syntax for authorities, permissions, and groups is supported but deprecated. If you have applications that use the pre- 16.x REVOKE statement syntax, modify them to use the new syntax for roles and privileges.
Pre-16.x Syntax New Syntax
No change REVOKE CONNECT FROM
REVOKE GROUP FROM
FROM USER
WITH REVOKE
SAP IQ Installation and Update Guide for Windows 160 PUBLIC Upgrade to SAP IQ 16.1 SP 04 Pre-16.x Syntax New Syntax
REVOKE MEMBERSHIP IN REVOKE ROLE
GROUP
FROM
REVOKE
FROM
BACKUP SYS_AUTH_BACKUP_ROLE | DBA | SYS_AUTH_DBA_ROLE | Multiplex Admin | SYS_AUTH_MULTIPLEX_ADMIN_ROLE | Operator | SYS_AUTH_OPERATOR_ROLE | Perms Admin | SYS_AUTH_PERMS_ADMIN_ROLE | PROFILE | SYS_AUTH_PROFILE_ROLE | READCLIENTFILE | SYS_READCLIENTFILE_ROLE | READFILE | SYS_AUTH_READFILE_ROLE | REMOTE DBA | SYS_RUN_REPLICATION_ROLE | RESOURCE | ALL | SYS_AUTH_RESOURCE_ROLE | Space Admin | SYS_AUTH_SPACE_ADMIN_ROLE | Spatial Admin | SYS_AUTH_SPATIAL_ADMIN_ROLE | User Admin | SYS_AUTH_USER_ADMIN_ROLE | VALIDATE | SYS_AUTH_VALIDATE_ROLE | WRITECLIENTFILE | SYS_AUTH_WRITECLIENTFILE_ROLE
| WRITEFILE | SYS_AUTH_WRITEFILE_ROLE
No change; however, you can also set the new PUBLIC op REVOKE PUBLISH FROM
SET OPTION PUBLIC.db_publisher=grantee
No change, except to naming convention. Object-level per REVOKE
FROM
permission ::=
ALL [ PRIVILEGES ] | ALTER | DELETE | INSERT
| REFERENCES [ (
| SELECT [ (
| UPDATE [ (
No change REVOKE EXECUTE ON [
{
FROM
No change REVOKE INTEGRATED LOGIN
FROM
SAP IQ Installation and Update Guide for Windows Upgrade to SAP IQ 16.1 SP 04 PUBLIC 161 Pre-16.x Syntax New Syntax
No change REVOKE KERBEROS LOGIN
FROM
AS USER
No change REVOKE CREATE ON
FROM
14.3.4.3.3.8 Changes to REMOTE DBA
The REMOTE DBA authority is replaced by the SYS_RUN_REPLICATION_ROLE system role. This role allows user to administer replication.
The GRANT REMOTE DBA statement syntax is still supported but deprecated. Change your applications to grant this new role.
14.3.4.3.3.9 Changes in Inheritance Behavior
In SAP IQ versions earlier than 16.0, when you granted the DBA, REMOTE DBA, BACKUP, RESOURCE, and VALIDATE authorities to a group, the underlying permissions were not inherited by members of the group.
In 16.0, the default behavior when granting SYS_AUTH_DBA_ROLE, SYS_RUN_REPLICATION_ROLE, SYS_AUTH_BACKUP_ROLE, SYS_AUTH_RESOURCE_ROLE, and SYS_AUTH_VALIDATE_ROLE (formerly DBA, REMOTE DBA, BACKUP, RESOURCE, and VALIDATE) to a user-defined role allows members of the user-defined role to inherit the underlying system privileges of the role. The WITH NO SYSTEM INHERITANCE clause retains the non-inheritance behavior.
To retain the non-inheritance behavior of these roles after upgrading, include the WITH NO SYSTEM PRIVILEGE INHERITANCE clause in the GRANT ROLE statement, if you have applications that you are changing to use the new GRANT syntax, and want to preserve the non-inheritance behavior.
Note
The WITH NO SYSTEM PRIVILEGE INHERITANCE clause is supported only with these specific roles; any other use results in an error.
For example, you grant User1 the ALTER ANY OBJECT system privilege. You extend User1 to become a role and grant User1 to User2. You want to grant the SYS_AUTH_DBA_ROLE role to User1, but you do not want User2 to inherit the system privileges vested to SYS_AUTH_DBA_ROLE. Execute:
GRANT ROLE SYS_AUTH_DBA_ROLE TO User1 WITH NO SYSTEM PRIVILEGE INHERITANCE;
SAP IQ Installation and Update Guide for Windows 162 PUBLIC Upgrade to SAP IQ 16.1 SP 04 14.3.4.3.3.10 Changes in Administering the Database Publisher
In 16.x, the PUBLISH authority is replaced by the PUBLIC.db_publisher database option. You change the publisher by changing the database option.
In IQ versions earlier than 16.x, the database publisher was controlled by using the GRANT PUBLISH and REVOKE PUBLISH statements. You determine the current publisher by querying the CURRENT PUBLISHER special value. The GRANT PUBLISH and REVOKE PUBLISH syntax is still supported, but deprecated.
You can also still query the CURRENT PUBLISHER to determine the current publisher.
The SET ANY SYSTEM OPTION system privilege is required to set PUBLIC.db_publisher.
14.3.4.3.3.11 Compatibility Roles
Compatibility roles exist for backward compatibility with versions of SAP IQ earlier than 16.0 that support authority-based security.
You can grant, revoke, and under specific conditions, delete compatibility roles. You cannot modify any of the underlying system privileges. However, you can migrate compatibility roles to user-defined roles, and then modify the underlying system privileges. When you migrate a compatibility role, all grantees of the compatibility role are automatically granted the user-defined role.
Use the compatibility roles SYS_AUTH_SA_ROLE and SYS_AUTH_SSO_ROLE to administer and grant all individual system privileges in a new database. The union of the system privileges of these two roles is granted to the compatibility role SYS_AUTH_DBA_ROLE. By default, SYS_AUTH_DBA_ROLE is granted to the DBA user with administrative privileges. Thus, all system privileges are initially granted to the DBA user.
You can grant users to, and revoke users from, compatibility roles.
In this section:
Grant Compatibility Roles [page 164] Granting a compatibility role is semantically equivalent to granting each of its underlying system privileges and roles.
Revoking a Compatibility Role [page 193] Revoke a compatibility role from a user or role.
Migrating a Compatibility Role [page 194] Migrate all underlying system privileges of a compatibility role to a user-defined role.
Dropping a Compatibility Role [page 195] All compatibility roles, with the exception of SYS_AUTH_SA_ROLE and SYS_AUTH_SSO_ROLE can be dropped. SYS_AUTH_SA_ROLE and SYS_AUTH_SSO_ROLE are automatically dropped when SYS_AUTH_DBA_ROLE is dropped.
Re-creating a Compatibility Role [page 196] Re-creates a dropped compatibility role.
Implications of Migrating Compatibility Roles [page 197]
SAP IQ Installation and Update Guide for Windows Upgrade to SAP IQ 16.1 SP 04 PUBLIC 163 Some system roles are indirectly granted the system privileges necessary to execute privileged tasks through membership in compatibility roles.
14.3.4.3.3.11.1 Grant Compatibility Roles
Granting a compatibility role is semantically equivalent to granting each of its underlying system privileges and roles.
In this section:
Granting SYS_AUTH_SA_ROLE [page 165] Allows users to perform authorized tasks pertaining to data and system administration responsibilities.
Granting SYS_AUTH_SSO_ROLE [page 168] Allows users to perform authorized tasks pertaining to security and access control responsibilities.
Granting SYS_AUTH_DBA_ROLE [page 169] Allows users to perform all authorized tasks.
Granting SYS_AUTH_BACKUP_ROLE [page 174] Allows users to perform all backups.
Granting SYS_AUTH_MULTIPLEX_ADMIN_ROLE [page 175] Allows users to perform authorized tasks to manage multiplex.
Granting SYS_AUTH_OPERATOR_ROLE [page 177] Allows users to checkpoint databases, drop connections (including those for users with SYS_AUTH_DBA_ROLE), back up databases, and monitor the system.
Granting SYS_AUTH_PERMS_ADMIN_ROLE [page 179] Allows users to manage data privileges, groups, authorities, and passwords.
Granting SYS_AUTH_PROFILE_ROLE [page 180] Allows users to enable or disable server tracing for application profiling.
Granting SYS_AUTH_READFILE_ROLE [page 182] Allows users to read to a file that is resident on the server machine.
Granting SYS_AUTH_READCLIENTFILE_ROLE [page 183] Allows users to read to a file that is resident on the client machine.
Granting SYS_AUTH_RESOURCE_ROLE [page 184] Allows users to create new database objects, such as tables, views, indexes, or procedures.
Granting SYS_AUTH_SPACE_ADMIN_ROLE [page 186] Allows users to manage dbspaces.
Granting SYS_AUTH_USER ADMIN_ROLE [page 188] Allows users to manage external logins, login policies, and other users.
Granting SYS_AUTH_VALIDATE_ROLE [page 189] Allows users to validate or check tables, materialized views, indexes, or databases in the system store. The objects can be owned by any user.
Granting SYS_AUTH_WRITEFILE_ROLE [page 191] Allows users to write to a file that is resident on the server machine.
SAP IQ Installation and Update Guide for Windows 164 PUBLIC Upgrade to SAP IQ 16.1 SP 04 Granting SYS_AUTH_WRITECLIENTFILE_ROLE [page 192] Allows users to write to a file that is resident on the client machine.
14.3.4.3.3.11.1.1 Granting SYS_AUTH_SA_ROLE
Allows users to perform authorized tasks pertaining to data and system administration responsibilities.
Prerequisites
Administrative privilege over SYS_AUTH_SA_ROLE role.
Context
You can grant this role with or without administrative rights. When granted with administrative rights, you can manage (grant and revoke) the role, as well as use any of the underlying system privileges. When granted with administrative rights only, you can manage the role, but not use its underlying system privileges. Finally, when granted with no administrative rights, you can only use its underlying system privileges.
Procedure
To grant the SYS_AUTH_SA_ROLE role, execute one of these statements:
Administrative Option Statement
With full administrative rights GRANT ROLE SYS_AUTH_SA_ROLE TO
WITH ADMIN OPTION
With administrative rights only GRANT ROLE SYS_AUTH_SA_ROLE TO
WITH ADMIN ONLY OPTION
With no administrative rights GRANT ROLE SYS_AUTH_SA_ROLE TO
WITH NO ADMIN OPTION
In this section:
System Privileges Granted to SYS_AUTH_SA_ROLE [page 166] Each system privilege is granted with full administrative rights.
SAP IQ Installation and Update Guide for Windows Upgrade to SAP IQ 16.1 SP 04 PUBLIC 165 14.3.4.3.3.11.1.1.1 System Privileges Granted to SYS_AUTH_SA_ROLE
Each system privilege is granted with full administrative rights.
● ACCESS SERVER LS ● ALTER ANY INDEX ● ALTER ANY MATERIALIZED VIEW ● ALTER ANY OBJECT ● ALTER ANY PROCEDURE ● ALTER ANY SEQUENCE ● ALTER ANY TEXT CONFIGURATION ● ALTER ANY TABLE ● ALTER ANY TRIGGER ● ALTER ANY VIEW ● ALTER DATABASE ● ALTER DATATYPE ● BACKUP DATABASE ● CHECKPOINT ● COMMENT ANY OBJECT ● CREATE ANY INDEX ● CREATE ANY MATERIALIZED VIEW ● CREATE ANY MUTEX SEMAPHORE ● CREATE ANY OBJECT ● CREATE ANY PROCEDURE ● CREATE ANY SEQUENCE ● CREATE ANY TABLE ● CREATE ANY TEXT CONFIGURATION ● CREATE ANY TRIGGER ● CREATE ANY VIEW ● CREATE DATABASE VARIABLE ● CREATE DATATYPE ● CREATE EXTERNAL REFERENCE ● CREATE MATERIALIZED VIEW ● CREATE MESSAGE ● CREATE PROCEDURE ● CREATE PROXY TABLE ● CREATE TABLE ● CREATE TEXT CONFIGURATION ● CREATE VIEW ● DEBUG ANY PROCEDURE ● DELETE ANY TABLE ● DROP ANY INDEX ● DROP ANY MATERIALIZED VIEW ● DROP ANY MUTEX SEMAPHORE
SAP IQ Installation and Update Guide for Windows 166 PUBLIC Upgrade to SAP IQ 16.1 SP 04 ● DROP ANY OBJECT ● DROP ANY PROCEDURE ● DROP ANY SEQUENCE ● DROP ANY TABLE ● DROP ANY TEXT CONFIGURATION ● DROP ANY VIEW ● DROP DATATYPE ● DROP MESSAGE ● EXECUTE ANY PROCEDURE ● INSERT ANY TABLE ● LOAD ANY TABLE ● MANAGE ANY DATABASE VARIABLE ● MANAGE ANY DBSPACE ● MANAGE ANY EVENT ● MANAGE ANY EXTERNAL ENVIRONMENT ● MANAGE ANY EXTERNAL OBJECT ● MANAGE ANY MIRROR SERVER ● MANAGE ANY SPATIAL OBJECT ● MANAGE ANY STATISTICS ● MANAGE ANY WEB SERVICE ● MANAGE LISTENERS ● MANAGE MULTIPLEX ● MANAGE PROFILING ● MANAGE ANY PROPERTY HISTORY ● MANAGE REPLICATION ● MONITOR ● READ CLIENT FILE ● READ FILE ● REORGANIZE ANY OBJECT ● SELECT ANY TABLE ● SELECT PUBLIC DATABASE VARIABLE ● SERVER OPERATOR ● SET ANY PUBLIC OPTION ● SET ANY SYSTEM OPTION ● SET ANY USER DEFINED OPTION ● TRUNCATE ANY TABLE ● UPDATE ANY MUTEX SEMAPHORE ● UPDATE ANY TABLE ● UPDATE PUBLIC DATABASE VARIABLE ● UPGRADE ROLE ● USE ANY SEQUENCE ● VALIDATE ANY OBJECT ● WRITE CLIENT FILE ● WRITE FILE
SAP IQ Installation and Update Guide for Windows Upgrade to SAP IQ 16.1 SP 04 PUBLIC 167 14.3.4.3.3.11.1.2 Granting SYS_AUTH_SSO_ROLE
Allows users to perform authorized tasks pertaining to security and access control responsibilities.
Prerequisites
Administrative privilege over SYS_AUTH_SSO_ROLE role.
Context
You can grant this role with or without administrative rights. When granted with administrative rights, you can manage (grant and revoke) the role, as well as use any of the underlying system privileges. When granted with administrative rights only, you can manage the role, but not use its underlying system privileges. Finally, when granted with no administrative rights, you can only use its underlying system privileges.
Procedure
To grant the role, execute one of these statements:
Administrative Option Statement
With full administrative rights GRANT ROLE SYS_AUTH_SSO_ROLE TO
WITH ADMIN OPTION
With administrative rights only GRANT ROLE SYS_AUTH_SSO_ROLE TO
WITH ADMIN ONLY OPTION
With no administrative rights GRANT ROLE SYS_AUTH_SSO_ROLE TO
WITH NO ADMIN OPTION
In this section:
System Privileges Granted to SYS_AUTH_SSO_ROLE [page 169] Each system privilege is granted with full administrative rights only unless noted.
SAP IQ Installation and Update Guide for Windows 168 PUBLIC Upgrade to SAP IQ 16.1 SP 04 14.3.4.3.3.11.1.2.1 System Privileges Granted to SYS_AUTH_SSO_ROLE
Each system privilege is granted with full administrative rights only unless noted.
● ACCESS USER PASSWORD ● ALTER ANY OBJECT OWNER ● ANY USER ● CHANGE PASSWORD ● DROP CONNECTION ● MANAGE ANY OBJECT PRIVILEGES ● MANAGE ANY LDAP SERVER ● MANAGE ANY LOGIN POLICY ● MANAGE ANY USER ● MANAGE AUDITING ● MANAGE ROLES ● SET ANY SECURITY OPTION ● SET USER (granted with the administrative rights only)
14.3.4.3.3.11.1.3 Granting SYS_AUTH_DBA_ROLE
Allows users to perform all authorized tasks.
Prerequisites
Administrative privilege over SYS_AUTH_DBA_ROLE role.
Context
This role indirectly grants all compatibility roles, and some system roles, to a user. It is the union of the underlying system privileges of each of these roles that makes the SYS_AUTH_DBA_ROLE role the "super" role.
You can grant this role with or without administrative rights. When granted with administrative rights, you can manage (grant and revoke) the role, as well as use any of the underlying system privileges. When granted with administrative rights only, you can manage the role, but not use its underlying system privileges. Finally, when granted with no administrative rights, you can only use its underlying system privileges.
Note
When migrating from SAP IQ 15.4 and earlier, the concept of inheritance of the underlying system privileges of this system role represents a change in behavior in SAP IQ 16.0 or later. For SAP IQ 15.4 and earlier behavior, use the WITH NO SYSTEM PRIVILEGE INHERITANCE clause.
SAP IQ Installation and Update Guide for Windows Upgrade to SAP IQ 16.1 SP 04 PUBLIC 169 The WITH ADMIN ONLY OPTION clause is invalid when using the WITH NO SYSTEM PRIVILEGE INHERITANCE clause. The WITH NO ADMIN OPTION clause is valid, but not required, as it is semantically equivalent to the WITH NO SYSTEM PRIVILEGE INHERITANCE clause.
Procedure
To grant the SYS_AUTH_DBA_ROLE role, execute one of these statements:
Administrative Option Statement
With full administrative rights GRANT ROLE SYS_AUTH_DBA_ROLE TO
WITH ADMIN OPTION
With administrative rights only GRANT ROLE SYS_AUTH_DBA_ROLE TO
WITH ADMIN ONLY OPTION
With no administrative rights GRANT ROLE SYS_AUTH_DBA_ROLE TO
WITH NO ADMIN OPTION
With full administrative rights,but no system GRANT ROLE SYS_AUTH_DBA_ROLE TO
WITH ADMIN OPTION privilege inheritance WITH NO SYSTEM PRIVILEGE INHERITANCE
In this section:
Roles Granted to SYS_AUTH_DBA_ROLE [page 170] System and compatibility roles granted to the SYS_AUTH_DBA_ROLE role.
System Privileges Granted to SYS_AUTH_DBA_ROLE [page 171] Through the granting of all compatibility roles and select system roles, system privileges are indirectly granted to the SYS_AUTH_DBA_ROLE role. The underlying system privileges of the SYS_AUTH_SA_ROLE and SYS_AUTH_SSO_ROLE roles are indirectly granted with full administrative rights. All other compatibility roles and system roles are indirectly granted with administrative rights only.
14.3.4.3.3.11.1.3.1 Roles Granted to SYS_AUTH_DBA_ROLE
System and compatibility roles granted to the SYS_AUTH_DBA_ROLE role.
These compatibility roles are granted with full administrative rights:
● SYS_AUTH_SA_ROLE ● SYS_AUTH_SSO_ROLE
SAP IQ Installation and Update Guide for Windows 170 PUBLIC Upgrade to SAP IQ 16.1 SP 04 These compatibility roles are granted with administrative rights only:
● SYS_AUTH_RESOURCE_ROLE ● SYS_AUTH_BACKUP_ROLE ● SYS_AUTH_VALIDATE_ROLE ● SYS_AUTH_READFILE_ROLE ● SYS_AUTH_PROFILE_ROLE ● SYS_AUTH_READCLIENTFILE_ROLE ● SYS_AUTH_WRITECLIENTFILE_ROLE ● SYS_AUTH_WRITEFILE_ROLE ● SYS_AUTH_USER_ADMIN_ROLE ● SYS_AUTH_SPACE_ADMIN_ROLE ● SYS_AUTH_MULTIPLEX_ADMIN_ROLE ● SYS_AUTH_OPERATOR_ROLE ● SYS_AUTH_PERMS_ADMIN_ROLE
These system roles are granted with administrative rights only:
● SYS_SPATIAL_ADMIN_ROLE ● diagnostics ● rs_systabgroup ● SYS ● DBO ● PUBLIC
14.3.4.3.3.11.1.3.2 System Privileges Granted to SYS_AUTH_DBA_ROLE
Through the granting of all compatibility roles and select system roles, system privileges are indirectly granted to the SYS_AUTH_DBA_ROLE role. The underlying system privileges of the SYS_AUTH_SA_ROLE and SYS_AUTH_SSO_ROLE roles are indirectly granted with full administrative rights. All other compatibility roles and system roles are indirectly granted with administrative rights only.
● ACCESS USER PASSWORD ● ACCESS SERVER LS ● ALTER ANY INDEX ● ALTER ANY MATERIALIZED VIEW ● ALTER ANY OBJECT ● ALTER ANY OBJECT OWNER ● ALTER ANY PROCEDURE ● ALTER ANY SEQUENCE ● ALTER ANY TABLE ● ALTER ANY TEXT CONFIGURATION ● ALTER ANY TRIGGER ● ALTER ANY VIEW ● ALTER DATABASE
SAP IQ Installation and Update Guide for Windows Upgrade to SAP IQ 16.1 SP 04 PUBLIC 171 ● ALTER DATATYPE ● BACKUP DATABASE ● CHANGE PASSWORD ● CHECKPOINT ● COMMENT ANY OBJECT ● CREATE ANY INDEX ● CREATE ANY MATERIALIZED VIEW ● CREATE ANY MUTEX SEMAPHORE ● CREATE ANY OBJECT ● CREATE ANY PROCEDURE ● CREATE ANY SEQUENCE ● CREATE ANY TABLE ● CREATE ANY TEXT CONFIGURATION ● CREATE ANY TRIGGER ● CREATE ANY VIEW ● CREATE DATABASE VARIABLE ● CREATE DATATYPE ● CREATE EXTERNAL REFERENCE ● CREATE MATERIALIZED VIEW ● CREATE MESSAGE ● CREATE PROCEDURE ● CREATE PROXY TABLE ● CREATE TABLE ● CREATE TEXT CONFIGURATION ● CREATE VIEW ● DEBUG ANY PROCEDURE ● DELETE ANY TABLE ● DROP ANY INDEX ● DROP ANY MATERIALIZED VIEW ● DROP ANY MUTEX SEMAPHORE ● DROP ANY OBJECT ● DROP ANY PROCEDURE ● DROP ANY SEQUENCE ● DROP ANY TABLE ● DROP ANY TEXT CONFIGURATION ● DROP ANY VIEW ● DROP CONNECTION ● DROP DATATYPE ● DROP MESSAGE ● EXECUTE ANY PROCEDURE ● LOAD ANY TABLE ● INSERT ANY TABLE ● MANAGE ANY DATABASE VARIABLE ● MANAGE ANY DBSPACE ● MANAGE ANY EVENT
SAP IQ Installation and Update Guide for Windows 172 PUBLIC Upgrade to SAP IQ 16.1 SP 04 ● MANAGE ANY EXTERNAL ENVIRONMENT ● MANAGE ANY EXTERNAL OBJECT ● MANAGE ANY LDAP SERVER ● MANAGE ANY LOGIN POLICY ● MANAGE ANY MIRROR SERVER ● MANAGE ANY OBJECT PRIVILEGES ● MANAGE ANY PROPERTY HISTORY ● MANAGE ANY SPATIAL OBJECT ● MANAGE ANY STATISTICS ● MANAGE ANY USER ● MANAGE ANY WEB SERVICE ● MANAGE AUDITING ● MANAGE LISTENERS ● MANAGE MULTIPLEX ● MANAGE PROFILING ● MANAGE REPLICATION ● MANAGE ROLES ● MONITOR ● READ CLIENT FILE ● READ FILE ● REORGANIZE ANY OBJECT ● SELECT ANY TABLE ● SELECT PUBLIC DATABASE VARIABLE ● SERVER OPERATOR ● SET ANY PUBLIC OPTION ● SET ANY SECURITY OPTION ● SET ANY SYSTEM OPTION ● SET ANY USER DEFINED OPTION ● SET USER (granted with administrative rights only) ● TRUNCATE ANY TABLE ● UPDATE ANY MUTEX SEMAPHORE ● UPDATE ANY TABLE ● UPDATE PUBLIC DATABASE VARIABLE ● UPGRADE ROLE ● USE ANY SEQUENCE ● VALIDATE ANY OBJECT ● WRITE CLIENT FILE ● WRITE FILE
SAP IQ Installation and Update Guide for Windows Upgrade to SAP IQ 16.1 SP 04 PUBLIC 173 14.3.4.3.3.11.1.4 Granting SYS_AUTH_BACKUP_ROLE
Allows users to perform all backups.
Prerequisites
Administrative privilege over SYS_AUTH_BACKUP_ROLE.
Context
You can grant this role with or without administrative rights. When granted with administrative rights, you can manage (grant and revoke) the role, as well as use any of the underlying system privileges. When granted with administrative rights only, you can manage the role, but not use its underlying system privileges. Finally, when granted with no administrative rights, you can only use its underlying system privileges.
Note
When migrating from SAP IQ 15.4 and earlier, the concept of inheritance of the underlying system privileges of this system role represents a change in behavior in SAP IQ 16.0 or later. For SAP IQ 15.4 and earlier behavior, use the WITH NO SYSTEM PRIVILEGE INHERITANCE clause.
The WITH ADMIN ONLY OPTION and WITH ADMIN OPTION clauses are invalid when using the WITH NO SYSTEM PRIVILEGE INHERITANCE clause. The WITH NO ADMIN OPTION clause is valid, but not required, as it is semantically equivalent to the WITH NO SYSTEM PRIVILEGE INHERITANCE clause.
Procedure
To grant the SYS_AUTH_BACKUP_ROLE role, execute one of the following statements:
Administrative Option Statement
With full administrative GRANT ROLE SYS_AUTH_BACKUP_ROLE TO
rights WITH ADMIN OPTION
With administrative rights GRANT ROLE SYS_AUTH_BACKUP_ROLE TO
only WITH ADMIN ONLY OPTION
With no administrative GRANT ROLE SYS_AUTH_BACKUP_ROLE TO
rights WITH NO ADMIN OPTION
SAP IQ Installation and Update Guide for Windows 174 PUBLIC Upgrade to SAP IQ 16.1 SP 04 Administrative Option Statement
With no system privilege in GRANT ROLE SYS_AUTH_BACKUP_ROLE TO
heritance WITH NO SYSTEM PRIVILEGE INHERITANCE
Example
This example grants the SYS_AUTH_BACKUP_ROLE to Mary with administrative rights and inheritance of the underlying system privileges of the role.
GRANT ROLE SYS_AUTH_BACKUP_ROLE TO Mary WITH ADMIN OPTION
This example grants the SYS_AUTH_BACKUP_ROLE to Joe with neither administrative rights nor inheritance of the roles underlying system privileges.
GRANT ROLE SYS_AUTH_BACKUP_ROLE TO Joe
WITH NO SYSTEM PRIVILEGE INHERITANCE
In this section:
System Privileges Granted to SYS_AUTH_BACKUP_ROLE [page 175] The BACKUP DATABASE system privilege is granted with no administrative rights.
14.3.4.3.3.11.1.4.1 System Privileges Granted to SYS_AUTH_BACKUP_ROLE
The BACKUP DATABASE system privilege is granted with no administrative rights.
14.3.4.3.3.11.1.5 Granting SYS_AUTH_MULTIPLEX_ADMIN_ROLE
Allows users to perform authorized tasks to manage multiplex.
Prerequisites
Administrative privilege over SYS_AUTH_MULTIPLEX_ADMIN_ROLE.
SAP IQ Installation and Update Guide for Windows Upgrade to SAP IQ 16.1 SP 04 PUBLIC 175 Context
You can grant this role with or without administrative rights. When granted with administrative rights, you can manage (grant and revoke) the role, as well as use any of the underlying system privileges. When granted with administrative rights only, you can manage the role, but not use its underlying system privileges. Finally, when granted with no administrative rights, you can only use its underlying system privileges.
Procedure
To grant the SYS_AUTH_MULTIPLEX_ADMIN_ROLE role, execute one of the following statements:
Administrative Option Statement
With full administrative rights GRANT ROLE SYS_AUTH_MULTIPLEX_ADMIN_ROLE TO
WITH ADMIN OPTION
With administrative rights only GRANT ROLE SYS_AUTH_MULTIPLEX_ADMIN_ROLE TO
WITH ADMIN ONLY OPTION
With no administrative rights GRANT ROLE SYS_AUTH_MULTIPLEX_ADMIN_ROLE TO
WITH NO ADMIN OPTION
Example
This example grants the SYS_AUTH_MULTIPLEX_ADMIN_ROLE to Mary, with no administrative rights:
GRANT ROLE SYS_AUTH_MULTIPLEX_ADMIN_ROLE TO Mary WITH NO ADMIN OPTION
In this section:
System Privileges Granted to SYS_AUTH_MULTIPLEX_ADMIN_ROLE [page 177] The ACCESS SERVER LS and MANAGE MULTIPLEX system privileges are granted with the no administrative rights.
SAP IQ Installation and Update Guide for Windows 176 PUBLIC Upgrade to SAP IQ 16.1 SP 04 14.3.4.3.3.11.1.5.1 System Privileges Granted to SYS_AUTH_MULTIPLEX_ADMIN_ROLE
The ACCESS SERVER LS and MANAGE MULTIPLEX system privileges are granted with the no administrative rights.
14.3.4.3.3.11.1.6 Granting SYS_AUTH_OPERATOR_ROLE
Allows users to checkpoint databases, drop connections (including those for users with SYS_AUTH_DBA_ROLE), back up databases, and monitor the system.
Prerequisites
Administrative privilege over SYS_AUTH_OPERATOR_ROLE.
Context
You can grant this role with or without administrative rights. When granted with administrative rights, you can manage (grant and revoke) the role, as well as use any of the underlying system privileges. When granted with administrative rights only, you can manage the role, but not use its underlying system privileges. Finally, when granted with no administrative rights, you can only use its underlying system privileges.
Note
When migrating from SAP IQ 15.4 and earlier, the concept of inheritance of the underlying system privileges of this system role represents a change in behavior in SAP IQ 16.0 or later. For SAP IQ 15.4 and earlier behavior, use the WITH NO SYSTEM PRIVILEGE INHERITANCE clause.
The WITH ADMIN ONLY OPTION and WITH ADMIN OPTION clauses are invalid when using the WITH NO SYSTEM PRIVILEGE INHERITANCE clause. The WITH NO ADMIN OPTION clause is valid, but not required, as it is semantically equivalent to the WITH NO SYSTEM PRIVILEGE INHERITANCE clause.
Procedure
To grant the SYS_AUTH_OPERATOR_ROLE role, execute one of the following statements:
SAP IQ Installation and Update Guide for Windows Upgrade to SAP IQ 16.1 SP 04 PUBLIC 177 Administrative Option Statement
With full administrative rights GRANT ROLE SYS_AUTH_OPERATOR_ROLE
TO
WITH ADMIN OPTION
With administrative rights only GRANT ROLE SYS_AUTH_OPERATOR_ROLE
TO
WITH ADMIN ONLY OPTION
With no administrative rights GRANT ROLE SYS_AUTH_OPERATOR_ROLE
TO
WITH NO ADMIN OPTION
With no system privilege inheri GRANT ROLE SYS_AUTH_OPERATOR_ROLE
TO
Example
This example grants the SYS_AUTH_OPERATOR_ROLE to Mary with administrative rights and inheritance of the underlying system privileges of the role:
GRANT ROLE SYS_AUTH_OPERATOR_ROLE TO Mary WITH ADMIN OPTION
This example grants the SYS_AUTH_OPERATOR_ROLE to Joe with neither administrative rights or inheritance of the underlying system privileges of the role:
GRANT ROLE SYS_AUTH_OPERATOR_ROLE TO Joe
WITH NO SYSTEM PRIVILEGE INHERITANCE
In this section:
System Privileges Granted to SYS_AUTH_OPERATOR_ROLE [page 178] Each system privilege is granted with no administrative rights.
14.3.4.3.3.11.1.6.1 System Privileges Granted to SYS_AUTH_OPERATOR_ROLE
Each system privilege is granted with no administrative rights.
● ACCESS SERVER LS ● BACKUP DATABASE ● CHECKPOINT ● DROP CONNECTION ● MONITOR
SAP IQ Installation and Update Guide for Windows 178 PUBLIC Upgrade to SAP IQ 16.1 SP 04 14.3.4.3.3.11.1.7 Granting SYS_AUTH_PERMS_ADMIN_ROLE
Allows users to manage data privileges, groups, authorities, and passwords.
Prerequisites
Administrative privilege over SYS_AUTH_PERMS_ADMIN_ROLE.
Context
You can grant this role with or without administrative rights. When granted with administrative rights, you can manage (grant and revoke) the role, as well as use any of the underlying system privileges. When granted with administrative rights only, you can manage the role, but not use its underlying system privileges. Finally, when granted with no administrative rights, you can only use its underlying system privileges.
Procedure
To grant the SYS_AUTH_PERMS_ADMIN_ROLE role, execute one of the following statements:
Administrative Option Statement
With full administrative rights GRANT ROLE SYS_AUTH_PERMS_ADMIN_ROLE
TO
WITH ADMIN OPTION
With administrative rights only GRANT ROLE SYS_AUTH_PERMS_ADMIN_ROLE
TO
WITH ADMIN ONLY OPTION
With no administrative rights GRANT ROLE SYS_AUTH_PERMS_ADMIN_ROLE
TO
WITH NO ADMIN OPTION
Example
This example grants the SYS_AUTH_PERMS_ADMIN_ROLE to Mary, with only administrative rights:
GRANT ROLE SYS_AUTH_PERMS_ADMIN_ROLE TO Mary WITH ADMIN ONLY OPTION
In this section:
Roles Granted to SYS_AUTH_PERMS_ADMIN_ROLE [page 180]
SAP IQ Installation and Update Guide for Windows Upgrade to SAP IQ 16.1 SP 04 PUBLIC 179 Compatibility roles granted with full administrative rights.
System Privileges Granted to SYS_AUTH_PERMS_ADMIN_ROLE [page 180] Each system privilege is granted with no administrative rights.
14.3.4.3.3.11.1.7.1 Roles Granted to SYS_AUTH_PERMS_ADMIN_ROLE
Compatibility roles granted with full administrative rights.
● SYS_AUTH_BACKUP_ROLE ● SYS_AUTH_OPERATOR_ROLE ● SYS_AUTH_USER_ADMIN_ROLE ● SYS_AUTH_SPACE_ADMIN_ROLE ● SYS_AUTH_MULTIPLEX_ADMIN_ROLE ● SYS_AUTH_RESOURCE_ROLE ● SYS_AUTH_VALIDATE_ROLE ● SYS_AUTH_PROFILE_ROLE ● SYS_AUTH_READFILE_ROLE ● SYS_AUTH_READCLIENTFILE_ROLE ● SYS_AUTH_WRITEFILE_ROLE ● SYS_AUTH_WRITECLIENTFILE_ROLE
14.3.4.3.3.11.1.7.2 System Privileges Granted to SYS_AUTH_PERMS_ADMIN_ROLE
Each system privilege is granted with no administrative rights.
● CHANGE PASSWORD ● MANAGE ANY OBJECT PRIVILEGES ● MANAGE ROLES
14.3.4.3.3.11.1.8 Granting SYS_AUTH_PROFILE_ROLE
Allows users to enable or disable server tracing for application profiling.
Prerequisites
Administrative privilege over SYS_AUTH_PROFILE_ROLE.
SAP IQ Installation and Update Guide for Windows 180 PUBLIC Upgrade to SAP IQ 16.1 SP 04 Context
You can grant this role with or without administrative rights. When granted with administrative rights, you can manage (grant and revoke) the role, as well as use any of the underlying system privileges. When granted with administrative rights only, you can manage the role, but not use its underlying system privileges. Finally, when granted with no administrative rights, you can only use its underlying system privileges. By default, the SYS_AUTH_PROFILE_ROLE is granted the diagnostics system role with no administrative rights.
Procedure
To grant the SYS_AUTH_PROFILE_ROLE role, execute one of the following statements:
Administrative Option Statement
With full administrative rights GRANT ROLE SYS_AUTH_PROFILE_ROLE
TO
WITH ADMIN OPTION
With administrative rights only GRANT ROLE SYS_AUTH_PROFILE_ROLE
TO
WITH ADMIN ONLY OPTION
With no administrative rights GRANT ROLE SYS_AUTH_PROFILE_ROLE
TO
WITH NO ADMIN OPTION
Example
This example grants the SYS_AUTH_PROFILE_ROLE to Mary, with administrative rights:
GRANT ROLE SYS_AUTH_PROFILE_ROLE TO Mary WITH ADMIN OPTION
In this section:
System Privileges Granted to SYS_AUTH_PROFILE_ROLE [page 182] The MANAGE PROFILING system privilege is granted with no administrative rights.
SAP IQ Installation and Update Guide for Windows Upgrade to SAP IQ 16.1 SP 04 PUBLIC 181 14.3.4.3.3.11.1.8.1 System Privileges Granted to SYS_AUTH_PROFILE_ROLE
The MANAGE PROFILING system privilege is granted with no administrative rights.
14.3.4.3.3.11.1.9 Granting SYS_AUTH_READFILE_ROLE
Allows users to read to a file that is resident on the server machine.
Prerequisites
Administrative privilege over SYS_AUTH_READFILE_ROLE.
Context
You can grant this role with or without administrative rights. When granted with administrative rights, you can manage (grant and revoke) the role, as well as use any of the underlying system privileges. When granted with administrative rights only, you can manage the role, but not use its underlying system privileges. Finally, when granted with no administrative rights, you can only use its underlying system privileges.
Procedure
To grant the SYS_AUTH_READFILE_ROLE role, execute one of the following statements:
Administrative Option Statement
With full administrative rights GRANT ROLE SYS_AUTH_READFILE_ROLE
TO
WITH ADMIN OPTION
With administrative rights only GRANT ROLE SYS_AUTH_READFILE_ROLE
TO
WITH ADMIN ONLY OPTION
With no administrative rights GRANT ROLE SYS_AUTH_READFILE_ROLE
TO
WITH NO ADMIN OPTION
SAP IQ Installation and Update Guide for Windows 182 PUBLIC Upgrade to SAP IQ 16.1 SP 04 Example
This example grants the SYS_AUTH_READFILE_ROLE to Mary, with no administrative rights:
GRANT ROLE SYS_AUTH_READFILE_ROLE TO Mary WITH NO ADMIN OPTION
In this section:
System Privileges Granted to SYS_AUTH_READFILE_ROLE [page 183] The READ FILE system privilege is granted with no administrative rights.
14.3.4.3.3.11.1.9.1 System Privileges Granted to SYS_AUTH_READFILE_ROLE
The READ FILE system privilege is granted with no administrative rights.
14.3.4.3.3.11.1.10 Granting SYS_AUTH_READCLIENTFILE_ROLE
Allows users to read to a file that is resident on the client machine.
Prerequisites
Administrative privilege over SYS_AUTH_READCLIENTFILE_ROLE.
Context
You can grant this role with or without administrative rights. When granted with administrative rights, you can manage (grant and revoke) the role, as well as use any of the underlying system privileges. When granted with administrative rights only, you can manage the role, but not use its underlying system privileges. Finally, when granted with no administrative rights, you can only use its underlying system privileges.
Procedure
To grant the SYS_AUTH_READCLIENTFILE_ROLE role, execute one of the following statements:
SAP IQ Installation and Update Guide for Windows Upgrade to SAP IQ 16.1 SP 04 PUBLIC 183 Administrative Option Statement
With full administrative rights GRANT ROLE SYS_AUTH_READCLIENTFILE_ROLE
TO
WITH ADMIN OPTION
With administrative rights only GRANT ROLE SYS_AUTH_READCLIENTFILE_ROLE
TO
WITH ADMIN ONLY OPTION
With no administrative rights GRANT ROLE SYS_AUTH_READCLIENTFILE_ROLE
TO
WITH NO ADMIN OPTION
Example
This example grants the SYS_AUTH_READCLIENTFILE_ROLE to Mary, with only administrative rights:
GRANT ROLE SYS_AUTH_READCLIENTFILE_ROLE TO Mary WITH ADMIN ONLY OPTION
In this section:
System Privileges Granted to SYS_AUTH_READCLIENTFILE_ROLE [page 184] The READ CLIENT FILE system privilege is granted with no administrative rights.
14.3.4.3.3.11.1.10.1 System Privileges Granted to SYS_AUTH_READCLIENTFILE_ROLE
The READ CLIENT FILE system privilege is granted with no administrative rights.
14.3.4.3.3.11.1.11 Granting SYS_AUTH_RESOURCE_ROLE
Allows users to create new database objects, such as tables, views, indexes, or procedures.
Prerequisites
Administrative privilege over SYS_AUTH_RESOURCE_ROLE.
SAP IQ Installation and Update Guide for Windows 184 PUBLIC Upgrade to SAP IQ 16.1 SP 04 Context
You can grant this role with or without administrative rights. When granted with administrative rights, you can manage (grant and revoke) the role, as well as use any of the underlying system privileges. When granted with administrative rights only, you can manage the role, but not use its underlying system privileges. Finally, when granted with no administrative rights, you can only use its underlying system privileges.
Note
When migrating from SAP IQ 15.4 and earlier, the concept of inheritance of the underlying system privileges of this system role represents a change in behavior in SAP IQ 16.0 or later. For SAP IQ 15.4 and earlier behavior, use the WITH NO SYSTEM PRIVILEGE INHERITANCE clause.
The WITH ADMIN ONLY OPTION and WITH ADMIN OPTION clauses are invalid when using the WITH NO SYSTEM PRIVILEGE INHERITANCE clause. The WITH NO ADMIN OPTION clause is valid, but not required, as it is semantically equivalent to the WITH NO SYSTEM PRIVILEGE INHERITANCE clause.
Procedure
To grant the SYS_AUTH_RESOURCE_ROLE role, execute one of the following statements:
Administrative Option Statement
With full administrative rights GRANT ROLE SYS_AUTH_RESOURCE_ROLE
TO
WITH ADMIN OPTION
With administrative rights only GRANT ROLE SYS_AUTH_RESOURCE_ROLE
TO
WITH ADMIN ONLY OPTION
With no administrative rights GRANT ROLE SYS_AUTH_RESOURCE_ROLE
TO
WITH NO ADMIN OPTION
With no system privilege inheritance GRANT ROLE SYS_AUTH_RESOURCE_ROLE
TO
WITH NO SYSTEM PRIVILEGE INHERITANCE
Example
This example grants the SYS_AUTH_RESOURCE_ROLE to Mary with administrative rights and inheritance of the underlying system privileges of the role:
GRANT ROLE SYS_AUTH_RESOURCE_ROLE TO Mary WITH ADMIN OPTION
SAP IQ Installation and Update Guide for Windows Upgrade to SAP IQ 16.1 SP 04 PUBLIC 185 This example grants the SYS_AUTH_RESOURCE_ROLE to Joe with neither administrative rights nor inheritance of the roles underlying system privileges:
GRANT ROLE SYS_AUTH_RESOURCE_ROLE TO Joe
WITH NO SYSTEM PRIVILEGE INHERITANCE
In this section:
System Privileges Granted to SYS_AUTH_RESOURCE_ROLE [page 186] Each system privilege is granted with no administrative rights.
14.3.4.3.3.11.1.11.1 System Privileges Granted to SYS_AUTH_RESOURCE_ROLE
Each system privilege is granted with no administrative rights.
● CREATE TABLE ● CREATE PROXY TABLE ● CREATE VIEW ● CREATE MATERIALIZED VIEW ● CREATE PROCEDURE ● CREATE DATATYPE ● CREATE MESSAGE ● CREATE TEXT CONFIGURATION ● CREATE ANY SEQUENCE ● CREATE ANY TRIGGER ● ALTER ANY TRIGGER ● CREATE ANY OBJECT
14.3.4.3.3.11.1.12 Granting SYS_AUTH_SPACE_ADMIN_ROLE
Allows users to manage dbspaces.
Prerequisites
Administrative privilege over SYS_AUTH_SPACE_ADMIN_ROLE.
SAP IQ Installation and Update Guide for Windows 186 PUBLIC Upgrade to SAP IQ 16.1 SP 04 Context
You can grant this role with or without administrative rights. When granted with administrative rights, you can manage (grant and revoke) the role, as well as use any of the underlying system privileges. When granted with administrative rights only, you can manage the role, but not use its underlying system privileges. Finally, when granted with no administrative rights, you can only use its underlying system privileges.
Procedure
To grant the SYS_AUTH_SPACE_ADMIN_ROLE role, execute one of the following statements:
Administrative Option Statement
With full administrative rights GRANT ROLE SYS_AUTH_SPACE_ADMIN_ROLE
TO
WITH ADMIN OPTION
With administrative rights only GRANT ROLE SYS_AUTH_SPACE_ADMIN_ROLE
TO
WITH ADMIN only OPTION
With no administrative rights GRANT ROLE SYS_AUTH_SPACE_ADMIN_ROLE
TO
WITH no ADMIN OPTION
Example
This example grants the SYS_AUTH_SPACE_ADMIN_ROLE to Mary, with no administrative rights:
GRANT ROLE SYS_AUTH_SPACE_ADMIN_ROLE TO Mary WITH NO ADMIN OPTION
In this section:
System Privileges Granted to SYS_AUTH_SPACE_ADMIN_ROLE [page 188] The ACCESS SERVER LS and MANAGE ANY DBSPACE system privileges are granted with no administrative rights.
SAP IQ Installation and Update Guide for Windows Upgrade to SAP IQ 16.1 SP 04 PUBLIC 187 14.3.4.3.3.11.1.12.1 System Privileges Granted to SYS_AUTH_SPACE_ADMIN_ROLE
The ACCESS SERVER LS and MANAGE ANY DBSPACE system privileges are granted with no administrative rights.
14.3.4.3.3.11.1.13 Granting SYS_AUTH_USER ADMIN_ROLE
Allows users to manage external logins, login policies, and other users.
Prerequisites
Administrative privilege over SYS_AUTH_USER ADMIN_ROLE.
Context
You can grant this role with or without administrative rights. When granted with administrative rights, you can manage (grant and revoke) the role, as well as use any of the underlying system privileges. When granted with administrative rights only, you can manage the role, but not use its underlying system privileges. Finally, when granted with no administrative rights, you can only use its underlying system privileges.
Procedure
To grant the SYS_AUTH_USER ADMIN_ROLE role, execute one of the following statements:
Administrative Option Statement
With full administrative rights GRANT ROLE SYS_AUTH_USER_ADMIN_ROLE TO
WITH ADMIN OPTION
With administrative rights only GRANT ROLE SYS_AUTH_USER_ADMIN_ROLE TO
WITH ADMIN only OPTION
With no administrative rights GRANT ROLE SYS_AUTH_USER_ADMIN_ROLE TO
WITH no ADMIN OPTION
SAP IQ Installation and Update Guide for Windows 188 PUBLIC Upgrade to SAP IQ 16.1 SP 04 Example
This example grants the SYS_AUTH_USER_ADMIN_ROLE to Mary, with administrative rights:
GRANT ROLE SYS_AUTH_USER_ADMIN_ROLE TO Mary WITH ADMIN OPTION
In this section:
System Privileges Granted to SYS_AUTH_USER_ADMIN_ROLE [page 189] The MANAGE ANY LOGIN POLICY and MANAGE ANY USER system privileges are granted with no administrative rights.
14.3.4.3.3.11.1.13.1 System Privileges Granted to SYS_AUTH_USER_ADMIN_ROLE
The MANAGE ANY LOGIN POLICY and MANAGE ANY USER system privileges are granted with no administrative rights.
14.3.4.3.3.11.1.14 Granting SYS_AUTH_VALIDATE_ROLE
Allows users to validate or check tables, materialized views, indexes, or databases in the system store. The objects can be owned by any user.
Prerequisites
Administrative privilege over SYS_AUTH_VALIDATE_ROLE.
Context
You can grant this role with or without administrative rights. When granted with administrative rights, you can manage (grant and revoke) the role, as well as use any of the underlying system privileges. When granted with administrative rights only, you can manage the role, but not use its underlying system privileges. Finally, when granted with no administrative rights, you can only use its underlying system privileges.
Note
When migrating from SAP IQ 15.4 and earlier, the concept of inheritance of the underlying system privileges of this system role represents a change in behavior in SAP IQ 16.0 or later. For SAP IQ 15.4 and earlier behavior, use the WITH NO SYSTEM PRIVILEGE INHERITANCE clause.
SAP IQ Installation and Update Guide for Windows Upgrade to SAP IQ 16.1 SP 04 PUBLIC 189 The WITH ADMIN ONLY OPTION and WITH ADMIN OPTION clauses are invalid when using the WITH NO SYSTEM PRIVILEGE INHERITANCE clause. The WITH NO ADMIN OPTION clause is valid, but not required, as it is semantically equivalent to the WITH NO SYSTEM PRIVILEGE INHERITANCE clause.
Procedure
To grant the SYS_AUTH_VALIDATE_ROLE role, execute one of the following statements:
Administrative Option Statement
With full administrative rights GRANT ROLE SYS_AUTH_VALIDATE_ROLE
TO
WITH ADMIN OPTION
With administrative rights only GRANT ROLE SYS_AUTH_VALIDATE_ROLE
TO
WITH ADMIN ONLY OPTION
With no administrative rights GRANT ROLE SYS_AUTH_VALIDATE_ROLE
TO
WITH NO ADMIN OPTION
With no system privilege inheritance GRANT ROLE SYS_AUTH_VALIDATE_ROLE
TO
WITH NO SYSTEM PRIVILEGE INHERITANCE
Example
This example grants the SYS_AUTH_VALIDATE_ROLE to Mary with administrative rights and inheritance of the underlying system privileges of the role:
GRANT ROLE SYS_AUTH_VALIDATE_ROLE TO Mary WITH ADMIN OPTION
This example grants the SYS_AUTH_VALIDATE_ROLE to Joe with neither administrative rights nor inheritance of the roles underlying system privileges:
GRANT ROLE SYS_AUTH_VALIDATE_ROLE TO Joe
WITH NO SYSTEM PRIVILEGE INHERITANCE
In this section:
System Privileges Granted to SYS_AUTH_VALIDATE_ROLE [page 191] The VALIDATE ANY OBJECT system privilege is granted with no administrative rights.
SAP IQ Installation and Update Guide for Windows 190 PUBLIC Upgrade to SAP IQ 16.1 SP 04 14.3.4.3.3.11.1.14.1 System Privileges Granted to SYS_AUTH_VALIDATE_ROLE
The VALIDATE ANY OBJECT system privilege is granted with no administrative rights.
14.3.4.3.3.11.1.15 Granting SYS_AUTH_WRITEFILE_ROLE
Allows users to write to a file that is resident on the server machine.
Prerequisites
Administrative privilege over SYS_AUTH_WRITEFILE_ROLE.
Context
You can grant this role with or without administrative rights. When granted with administrative rights, you can manage (grant and revoke) the role, as well as use any of the underlying system privileges. When granted with administrative rights only, you can manage the role, but not use its underlying system privileges. Finally, when granted with no administrative rights, you can only use its underlying system privileges.
Procedure
To grant the role, execute one of the following statements:
Administrative Option Statement
With full administrative rights GRANT ROLE SYS_AUTH_WRITEFILE_ROLE
TO
WITH ADMIN OPTION
With administrative rights only GRANT ROLE SYS_AUTH_WRITEFILE_ROLE
TO
WITH ADMIN ONLY OPTION
With no administrative rights GRANT ROLE SYS_AUTH_WRITEFILE_ROLE
TO
WITH NO ADMIN OPTION
SAP IQ Installation and Update Guide for Windows Upgrade to SAP IQ 16.1 SP 04 PUBLIC 191 Example
This example grants the SYS_AUTH_WRITEFILE_ROLE to Mary, with no administrative rights:
GRANT ROLE SYS_AUTH_WRITEFILE_ROLE TO Mary WITH NO ADMIN OPTION
In this section:
System Privileges Granted to SYS_AUTH_WRITEFILE_ROLE [page 192] The WRITE FILE system privilege is granted with no administrative rights.
14.3.4.3.3.11.1.15.1 System Privileges Granted to SYS_AUTH_WRITEFILE_ROLE
The WRITE FILE system privilege is granted with no administrative rights.
14.3.4.3.3.11.1.16 Granting SYS_AUTH_WRITECLIENTFILE_ROLE
Allows users to write to a file that is resident on the client machine.
Prerequisites
Administrative privilege over SYS_AUTH_WRITECLIENTFILE_ROLE.
Context
You can grant this role with or without administrative rights. When granted with administrative rights, you can manage (grant and revoke) the role, as well as use any of the underlying system privileges. When granted with administrative rights only, you can manage the role, but not use its underlying system privileges. Finally, when granted with no administrative rights, you can only use its underlying system privileges.
Procedure
To grant the SYS_AUTH_WRITECLIENTFILE_ROLE role, execute one of the following statements:
SAP IQ Installation and Update Guide for Windows 192 PUBLIC Upgrade to SAP IQ 16.1 SP 04 Administrative Option Statement
With full administrative rights GRANT ROLE SYS_AUTH_WRITECLIENTFILE_ROLE
TO
WITH ADMIN OPTION
With administrative rights only GRANT ROLE SYS_AUTH_WRITECLIENTFILE_ROLE
TO
WITH ADMIN ONLY OPTION
With no administrative rights GRANT ROLE SYS_AUTH_WRITECLIENTFILE_ROLE
TO
WITH NO ADMIN OPTION
Example
This example grants the SYS_AUTH_WRITECLIENTFILE_ROLE to Mary, with only administrative rights:
GRANT ROLE SYS_AUTH_WRITECLIENTFILE_ROLE TO Mary WITH ADMIN ONLY OPTION
In this section:
System Privileges Granted to SYS_AUTH_WRITECLIENTFILE_ROLE [page 193] The SWRITE CLIENT FILE system privilege is granted with no administrative rights.
14.3.4.3.3.11.1.16.1 System Privileges Granted to SYS_AUTH_WRITECLIENTFILE_ROLE
The SWRITE CLIENT FILE system privilege is granted with no administrative rights.
14.3.4.3.3.11.2 Revoking a Compatibility Role
Revoke a compatibility role from a user or role.
Prerequisites
Administrative privilege over the compatibility role being revoked.
SAP IQ Installation and Update Guide for Windows Upgrade to SAP IQ 16.1 SP 04 PUBLIC 193 Procedure
To revoke a compatibility role, execute one of these statements:
Administrative Option Statement
Administrative rights only REVOKE ADMIN OPTION FOR ROLE
FROM
Membership in the role and REVOKE ROLE
any administrative rights FROM
14.3.4.3.3.11.3 Migrating a Compatibility Role
Migrate all underlying system privileges of a compatibility role to a user-defined role.
Prerequisites
Administrative privilege over the role being migrated, and the MANAGE ROLES system privilege.
Context
Compatibility roles are immutable, but you can migrate them in their entirety to a new user-defined role. Once migrated, the compatibility role is automatically dropped. This process is systematically equivalent to individually granting each underlying system privilege to a user-defined role, then manually dropping the compatibility role.
During migration:
● A new user-defined role is created. ● All system privileges currently granted to the migrating role are granted to the new user-defined role. ● All users and roles currently granted to the migrating role are granted to the new user-defined role. ● Administrators of the compatibility role continue to be the administrators of the new migrated role. ● The compatibility role is dropped.
You cannot use ALTER ROLE to individually migrate the SYS_AUTH_SA_ROLE and SYS_AUTH_SSO_ROLE compatibility roles. These two compatibility roles are automatically migrated when SYS_AUTH_DBA_ROLE is migrated.
The name of the new role cannot already exist, or begin with the prefix SYS_ and end with the suffix _ROLE when migrating a compatibility role.
SAP IQ Installation and Update Guide for Windows 194 PUBLIC Upgrade to SAP IQ 16.1 SP 04 Procedure
To migrate a compatibility role, execute one of these statements:
Compatibility Role Statement
SYS_AUTH_DBA_ROLE ALTER ROLE
MIGRATE TO
Any other compatibility role ALTER ROLE
MIGRATE TO
Example
The following statement migrates SYS_AUTH_DBA_ROLE to the new roles Custom_DBA_Role, Custom_SA_Role, and Custom_SSO_Role, respectively.
ALTER ROLE SYS_AUTH_DBA_ROLE
MIGRATE TO Custom_DBA_Role, Custom_SA_Role, Custom_SSO_Role
This statement migrates the SYS_AUTH_OPERATOR_ROLE role to the new role Custom_Operator_role.
ALTER ROLE SYS_AUTH_OPERATOR_ROLE
MIGRATE TO Custom_Operator_Role
In both examples, all users, underlying system privileges, and roles granted to the original roles are automatically migrated to the new roles, then SYS_AUTH_DBA_ROLE, SYS_AUTH_SA_ROLE, SYS_AUTH_SSO_ROLE and SYS_AUTH_OPERATOR_ROLE are dropped.
14.3.4.3.3.11.4 Dropping a Compatibility Role
All compatibility roles, with the exception of SYS_AUTH_SA_ROLE and SYS_AUTH_SSO_ROLE can be dropped. SYS_AUTH_SA_ROLE and SYS_AUTH_SSO_ROLE are automatically dropped when SYS_AUTH_DBA_ROLE is dropped.
Prerequisites
● Administrative privilege over the role being dropped. ● Each of the system privileges granted to a compatibility role is granted to at least one user-defined role.
SAP IQ Installation and Update Guide for Windows Upgrade to SAP IQ 16.1 SP 04 PUBLIC 195 Context
The WITH REVOKE clause is only required when dropping a compatibility role that is currently granted to users or roles. You can re-create any dropped compatibility role. See Re-creating a Compatibility Role [page 196].
Procedure
To delete a compatibility role, execute one of these statements:
Drop Condition Statement
Compatibility role not currently granted to any user or role. DROP ROLE
Compatibility role currently granted to users or roles. DROP ROLE
*
Related Information
Re-creating a Compatibility Role [page 196]
14.3.4.3.3.11.5 Re-creating a Compatibility Role
Re-creates a dropped compatibility role.
Prerequisites
● MANAGE ROLES system privilege. ● Administrative privileges on all of the system privileges granted to the compatibility role being re-created.
Context
Re-creating SYS_AUTH_DBA_ROLE is semantically equivalent to re-creating both the SYS_AUTH_SA_ROLE and SYS_AUTH_SSO_ROLE roles; you cannot re-create these two roles separately.
When you re-create any compatibility role other than SYS_AUTH_DBA_ROLE, administrative privileges on the re-created compatibility role are automatically granted to SYS_AUTH_DBA_ROLE, as long as it still exists.
SAP IQ Installation and Update Guide for Windows 196 PUBLIC Upgrade to SAP IQ 16.1 SP 04 When you re-create any compatibility role other than SYS_AUTH_DBA_ROLE, or SYS_AUTH_PERMS_ADMIN_ROLE, administrative privileges on the re-created compatibility role are automatically granted to SYS_AUTH_PERMS_ADMIN_ROLE, as long as it still exists.
Procedure
To re-create a compatibility role, execute: CREATE ROLE
14.3.4.3.3.11.6 Implications of Migrating Compatibility Roles
Some system roles are indirectly granted the system privileges necessary to execute privileged tasks through membership in compatibility roles.
You cannot revoke the underlying system privileges of a compatibility role; you must first migrate it to a user- defined role. Only then can you revoke individual underlying system privileges from the new role and grant them to other user-defined roles per the organization's security requirements. This enforces separation of duties.
You can migrate compatibility roles automatically or manually. The method of migration can impact the ability of a system role or the DBO system role to continue performing authorized tasks. Regardless of the migration method used, once a compatibility role or the SYS_AUTH_DBA_ROLE role is dropped, if you revoke a system privilege from the new user-defined role and grant it to another user-defined role, you must do one of the following to ensure that system roles especially the dbo system role, retains all the system privileges required to execute the applicable privileged tasks or multiplex management stored procedures:
● Grant each system privilege revoked from the migrated user-defined role directly to the applicable system roles or dbo role; or ● Grant membership in the user-defined role to which the system privileges are granted to the applicable system roles or dbo system role.
The system roles that are members of compatibility roles, and might potentially be impacted by migration include:
System Role Compatibility Role
dbo SYS_AUTH_DBA_ROLE
SYS_AUTH_RESOURCE_ROLE
SYS_RUN_REPLICATION_ROLE SYS_AUTH_DBA_ROLE
SAP IQ Installation and Update Guide for Windows Upgrade to SAP IQ 16.1 SP 04 PUBLIC 197 Automatic Migration
The ALTER ROLE statement creates a new user-defined role, automatically grants all underlying system privileges of the compatibility role to the new user-defined role, makes each member of the compatibility role a member of the new user-defined role, then drops the compatibility role.
Automatic migration assumes that the destination user-defined role does not already exist and that all system privileges are migrated to the same new user-defined role.
Manual Migration
Use the CREATE ROLE statement to create a new user-defined role. Use the GRANT statement to grant each underlying system privilege to one or more users or roles. Use the DROP statement to drop the compatibility role once all underlying system privileges are granted to at least one other user or role.
Members of the migrated compatibility role are not automatically granted membership in the new user-defined role. As a result, members of some system roles may no longer be able to perform the expected privileged tasks once the compatibility role is dropped. You must grant membership in the new user-defined role to the affected system roles or directly grant the required system privileges to affected members.
14.3.4.3.3.12 Backward Compatibility in SAP IQ 16.1
Grant and revoke syntax for role-based security differs significantly from authority-based security. However, SAP IQ 16.1 is fully backward compatible with authority-based syntax.
SAP IQ 16.1 provides well-documented mappings and stored procedures to assist in transition. All stored procedures, functions, and queries created in pre- 16.0 databases will continue to run after upgrading.
14.3.4.3.3.13 Stored Procedure to Map Authorities to System Roles
The sp_auth_sys_role_info stored procedure generates a report, which maps each authority to a corresponding system role name.
A separate row is generated for each authority. No privilege is required to execute the procedure.
SAP IQ Installation and Update Guide for Windows 198 PUBLIC Upgrade to SAP IQ 16.1 SP 04 14.3.4.3.3.14 Connecting to SAP IQ 15.x Databases with SAP IQ 16.x
Role-based syntax is not supported in SAP IQ 15.x databases.
When using SAP IQ 16.x to connect to a 15.x database, only authority-based syntax is valid. Using role-based syntax returns errors. For example, GRANT ROLE returns an error message; GRANT MEMBERSHIP IN GROUP does not.
Beyond this limitation, there should be no change in functionality and no noticeable change in performance using SAP IQ 16.x with a 15.x database.
14.4 SAP IQ Database Administration Tool
SAP IQ Cockpit provides a personalized work center to administer the SAP IQ database.
The SAP IQ Cockpit Framework is installed as part of an SAP IQ server installation. It provides a view specific to SAP IQ and full access to 16.1 SP 04 features.
The SAP IQ Cockpit Framework manages communication between an SAP IQ Cockpit command and control agent, SAP IQ server, and Web client. The SAP IQ Cockpit agent continually broadcasts information about the server to subscribing clients via the SAP IQ Cockpit framework. Messages from the Web client pass through the SAP IQ Cockpit framework to the agent, which in turn, processes the request on the SAP IQ server.
SAP IQ Cockpit activities range from simple resource monitoring to complete SAP IQ 16.1 SP 04 database administration.
See SAP IQ Cockpit.
14.5 SAP IQ 12.7 Upgrade and Database Migration
Updating an SAP IQ 12.7 catalog requires a database file migration, not a simple database upgrade. Migration tools bundled with SAP IQ can recreate the legacy database schema and database options.
In this section:
Preparing to Migrate [page 200] Perform these tasks before you migrate your database.
Migration Utilities [page 201] Utilities and support tools bundled with SAP IQ.
Migration Issues [page 208] SAP IQ no longer supports some legacy features. Run iqunload in schema unload mode to generate a script (reload.sql) that contains the entire database schema. Compare the contents of this file to find unsupported syntax and metadata.
SAP IQ Installation and Update Guide for Windows Upgrade to SAP IQ 16.1 SP 04 PUBLIC 199 Unloading Legacy Schemas [page 216] To unload legacy schema, run iqunload in schema unload mode (iqunload -n ) on the same machine as the legacy schema.
Migrating Legacy Databases [page 216] Run iqunload in database migration mode (iqunload -au) to migrate a legacy database.
Postmigration Tasks [page 233] SAP IQ 16.1 databases upgraded from 12.7 are initially set to run in 15.x compatibility mode. To complete the change from 15.x to 16.1, you must explicitly change several 15.x compatibility settings to complete the 16.1 upgrade.
14.5.1 Preparing to Migrate
Perform these tasks before you migrate your database.
Procedure
1. Upgrade to SAP IQ 12.7 ESD #5. All migration paths assume that you are migrating from SAP IQ 12.7 ESD #5 as a minimum. 2. Regenerate any sort-key values. SAP IQ 12.7 SORTKEY function uses a different sort-key value than SAP IQ 15 and later. 3. Review the collation. SAP IQ no longer supports custom collations. Custom collations are preserved in database rebuilds only if you rebuild the database in a single step. Use a collation included with SAP IQ 15.0 or later. 4. Back up your current installation and save copies of any changes you made to default login and post login scripts. Create your backups on removable media, like tape, DVD, or CD. Make sure the backups are readable. 5. Review and understand the database migration utilities. Use iqunload to re-create the schema for your database or migrate your 12.7 database. iqlsunload utility is available to move 12.7 local stores for 12.7 multiplex servers. 6. Use DROP TABLE statements to drop all global temporary tables before you run the iqunload utility. You can recreate the global temporary tables after migration. 7. Drop all servers of type asejdbc before you run the iqunload utility.
The asejdbc server class is deprecated. Servers of type asejdbc must be dropped prior to running iqunload. 12.7 databases with remote server definitions based on the asejdbc driver will not have these definitions migrated to by the iqunload tool and will not give an error at the beginning of an unload saying that you need to drop any asejdbc servers (if there are any present). 8. Resolve potential migration errors. SAP IQ no longer supports some 12.7 features and objects. Update these objects before you migrate the database. 9. Use sp_iqcheckdb to verify that your 12.7 database is clean and error free. For information on sp_iqcheckdb output, see Administration: Backup, Restore, and Data Recovery > System Recovery and Database Repair.
SAP IQ Installation and Update Guide for Windows 200 PUBLIC Upgrade to SAP IQ 16.1 SP 04 14.5.2 Migration Utilities
Utilities and support tools bundled with SAP IQ.
In this section:
iqunload for SAP IQ 12.7 Database Migration [page 201] A command line utility for SAP IQ 12.7 database migration to re-create the legacy catalog on the new database catalog in the current installation.
iqlsunload for Local Store Unload [page 204] In current multiplex configurations, multiple nodes can write to the main store, which eliminates the need for local stores. iqlsunload is a command line utility that you can use to unload a 12.7 local store. iqlsunload is used only in 12.7 ESD #5 multiplex migrations.
Support Processes [page 207] Running iqunload in migration mode (-au) starts iqunlspt and iqsrv16.
14.5.2.1 iqunload for SAP IQ 12.7 Database Migration
A command line utility for SAP IQ 12.7 database migration to re-create the legacy catalog on the new database catalog in the current installation. iqunload does not change SAP IQ data and temp dbspaces. The utility preserves all legacy database options and applies them to the new database. SAP IQ ignores any legacy options that no longer apply to the current version of the software.
Note
If you are reloading a 12.7 database, remove any square brackets or back quotes in identifiers; otherwise, the reload fails.
Syntax
iqunload [
Parameters
The iqunload utility takes one or more options.
-ap size
(Optional) sets the page size for the new catalog store. -au
Required for migration mode. Migrates the database.
You cannot specify an -n argument when you specify -au.
SAP IQ Installation and Update Guide for Windows Upgrade to SAP IQ 16.1 SP 04 PUBLIC 201 -c "keyword = value, ..."
(Required) supplies database connection parameters. You must specify DBF=
(Optional) recalculates computed columns in the database. -ms_filename
Optional for simplex migration; required for multiplex migration. Use -ms_filename to specify a file name for the new empty IQ_SYSTEM_MAIN store created during the migration.
If not specified, the default new main store is a file system file called new_main_store.iq. -ms_reserve
(Optional) specifies the size of the new IQ_SYSTEM_MAIN reserve, in MB. If unspecified, defaults to zero. -ms_size
(Optional) specifies the size of the new IQ_SYSTEM_MAIN store, in MB, based on the database size. The minimum, assuming a default page size, is 200 MB. If you specify an –ms_size value smaller than the computed value, SAP IQ uses the computed value; otherwise the specified value is used. -n
Required for schema unload only. Unloads the schema definition only. The -n parameter requires 12.7 ESD #5 or later.
You cannot specify an -au argument when you specify -n. -new_startline "server startup switches"
(Optional) specifies startup switches for the new server that is the migration target. For a complete list of server startup switches, see start_iq Database Server Startup Utility in the SAP IQ Utility Reference. -o file_name
(Optional) logs output messages to
(Optional) suppresses messages and windows. -r file_name
(Optional) specifies the file name. -t list
(Optional) outputs listed tables only. Can specify OwnerName.TableName or TableName alone. -ul
(Optional) unloads password hashes. -v
(Optional) returns verbose messages. -y
(Optional) replaces existing reload schema SQL script with new output without confirmation.
SAP IQ Installation and Update Guide for Windows 202 PUBLIC Upgrade to SAP IQ 16.1 SP 04 Examples
● Migrates a simplex database to a current server:
iqunload –au –c
"UID=DBA;PWD=
● Unloads a legacy database schema and renames the generated SQL script to test2_reload.sql:
iqunload –n -c
"UID=DBA;PWD=
ENG=myserver_test2" –r "D:\test\unload_dir\test2_reload.sql"
● Migrates database test3.db. The START connection parameter specifies switches for starting the database being reloaded. The -new_startline parameter specifies switches for starting the utility_db to create the new catalog store:
iqunload –au -c
"UID=DBA;PWD=
START=–ch 128M –iqmc 50" –new_startline "–ch 256M –iqtc 400"
Do not include -iqnotemp
iqunload –au –c
"UID=DBA;PWD=
Usage iqunload has two working modes: schema unload and migration.
Schema Unload Mode iqunload requires an -n argument to start in schema unload mode. Schema unload mode unloads a 12.7 ESD #5 database schema, and generates a script (reload.sql) that can re-create the schema for a database in a current version of the software. A -c argument is required for connection parameters:
iqunload -n -c "UID=DBA;PWD=
Schema unload mode re-creates the schema, but does not migrate data. To migrate data, extract the legacy data and load the new database.
Migration Mode iqunload requires an -au argument to start in migration mode. iqunload migration mode interfaces with the 12.7 support engine (iqunlspt) and the current database server (iqsrv16):
● Start the legacy database and generate the schema ● Start the current SAP IQ server ● Create a new database and apply the legacy schema
SAP IQ Installation and Update Guide for Windows Upgrade to SAP IQ 16.1 SP 04 PUBLIC 203 General Usage
● Insufficient cache memory causes migration errors. iqunload uses default values for various cache sizes (catalog cache, main buffer cache, temp cache). If the legacy database requires higher cache values, use the –ch and -cl options as part of the START connection parameter to increase the cache size. ● During database migration, the server creates a message file (*.iqmsg.R) as it reloads the generated schema. This file is normally deleted as part of a cleanup operation for successful migrations. If the migration fails during the reload stage, cleanup does not occur, and *.iqmsg.R remains in the unload directory. *.iqmsg.R may contain information that can help solve your migration problems. ● iqunload writes some temporary files to the $IQTMP16 (for UNIX) or %IQTMP16% (for Windows) directory, which must be a valid directory name. ● Users with wide tables (large numbers of column/null values) should not decrease the catalog store page size for database migration. ● If the legacy database contains invalid views, SAP IQ completes the migration but issues warnings. A warning may occur, for example, if the tables involved in a view are dropped. ● If the legacy database is encrypted, use the DBKEY connection parameter to provide the encryption key. The migrated database uses the same encryption key.
Permissions
DBA authority
Parent topic: Migration Utilities [page 201]
Related Information iqlsunload for Local Store Unload [page 204] Support Processes [page 207]
14.5.2.2 iqlsunload for Local Store Unload
In current multiplex configurations, multiple nodes can write to the main store, which eliminates the need for local stores. iqlsunload is a command line utility that you can use to unload a 12.7 local store. iqlsunload is used only in 12.7 ESD #5 multiplex migrations. iqlsunload is bundled with all versions of SAP IQ starting with 12.7 ESD #5.
Syntax
iqlsunload [
:[
SAP IQ Installation and Update Guide for Windows 204 PUBLIC Upgrade to SAP IQ 16.1 SP 04 Parameters
The iqlsunload utility takes one or more options.
-al (Optional) unloads IQ local store schema and data. -c "keyword=value;..." (Optional) supplies database connection parameters. -h (Optional) prints out the syntax (help) for the utility. -o filename (Optional) logs output messages, including errors, to
Example
This example unload local stores from a database called mpxtest2, extracting any table data to the directory W:\\mydevice\\test_dir\\unload_dir:
iqlsunload -o iqunload_624.out -al
-c "UID=DBA;PWD=SQL;ENG=myserver_mpxtest02"
W:\\mydevice\\test_dir\\unload_dir
Usage
● Use double slashes as a file separator, not single slashes. ● Run iqlsunload from the %IQDIR16%\lsunload directory to pick up updated libraries before resolving any IQ 12.7 libraries.
Unloaded Objects
Running iqlsunload with an -al argument unloads these persistent objects:
● Base tables ● Global temporary tables ● Indexes ● Domains (user-defined data types) ● Constraints (column check constraint, table constraint, primary key, foreign key, unique, default, IQ unique, not null)
SAP IQ Installation and Update Guide for Windows Upgrade to SAP IQ 16.1 SP 04 PUBLIC 205 ● Views ● Stored procedures and functions ● Messages ● Remote servers and external logins ● Events
Empty User Names
SAP IQ no longer allow users with empty user names. You cannot drop or migrate users with empty user names the 12.6 or 12.7 server. The schema reload operation warns that an empty user name has been encountered and that the user will not be re-created. The reload operation ignores such users and any associated objects.
Unloading Tables iqlsunload ignores any system tables or nonexistent tables:
● If you extract table schema and data only, the legacy database collation must match the collation of the current database collation. ● If you do not qualify table names with owner names, iqlsunload extracts table data from all tables with that table name.
Output Files iqlsunload generates these output files:
● reload_schema.sql – re-creates schema for unloaded objects (either objects from local store or tables selected by the user.) This script is executed against a node that writes to the multiplex. This node can be either the existing writer node, or a writer or coordinator for the multiplex after migration, depending on where you plan to re-create the schema. ● extract_data.sql – extracts table data for the unloaded tables from the local store. Execute this script in Interactive SQL while connected to the query node from which it was generated. When this script executes, it generates the data files into the directory data. ● reload_data.sql – loads extracted table data. This script is executed on the node where you ran reload_schema.sql, and reloads the data extracted from the extract_data.sql file.
Permissions
DBA
Parent topic: Migration Utilities [page 201]
Related Information iqunload for SAP IQ 12.7 Database Migration [page 201] Support Processes [page 207]
SAP IQ Installation and Update Guide for Windows 206 PUBLIC Upgrade to SAP IQ 16.1 SP 04 14.5.2.3 Support Processes
Running iqunload in migration mode (-au) starts iqunlspt and iqsrv16.
iqunlspt
iqunlspt is a self-contained subset of the SAP IQ 12.7 (ESD #5) database engine. It runs as a background process and provides support for legacy database unloads. iqunlspt starts on your legacy database with these options as defaults:
iqunlspt.exe -iqnotemp 100 -iqro 1 -c 48MB -gc 20 -gd
all -gk all -gl all -gm 1 -gu all -ti 4400 -x shmem .
If your database requires special switches or memory setting, iqunlspt accepts additional startup arguments. See the Utility Guide.
Default cache settings are sufficient for most migrations. At migration, data queries execute against the system catalogs, not IQ data, so the iqunlspt engine needs lower cache levels than complex queries or multiple concurrent users. The amount of time required to start the legacy database is the same as to start iqunlspt. This time is included in the iqunload startup time.
iqsrv16
iqunload starts iqsrv16 with these options:
iqsrv16 -gp 4096 -c 40p -gc 20 -gd all -gk all -gl all
-gm 1 -gu all -qi -qs -ti 4400 iqsrv16 also includes the -n parameter followed by a special randomly generated server name. The -c 40p setting provides a larger cache for the catalog store, allowing the server engine to execute many schema DDL statements. Both server start commands use the default values for -iqmc and -iqtc. If the legacy server requires larger startup values, use the -c switch to increase the server cache memory.
Parent topic: Migration Utilities [page 201]
Related Information
iqunload for SAP IQ 12.7 Database Migration [page 201] iqlsunload for Local Store Unload [page 204]
SAP IQ Installation and Update Guide for Windows Upgrade to SAP IQ 16.1 SP 04 PUBLIC 207 14.5.3 Migration Issues
SAP IQ no longer supports some legacy features. Run iqunload in schema unload mode to generate a script (reload.sql) that contains the entire database schema. Compare the contents of this file to find unsupported syntax and metadata.
In this section:
Unsupported Objects [page 208] Check the schema for objects SAP IQ no longer supports.
Troubleshooting Syntax Changes [page 209] Review the reload script (reload.sql) for legacy syntax that can cause iqunload to fail.
Schema Size [page 211] Increase the cache memory to migrate large and extremely large schemas.
Output Logs [page 212] Check the output logs to isolate migration problems.
Data Storage Changes [page 213] SAP IQ16.1 migration creates a new catalog store and changes some legacy options.
Post-Migration Files [page 215] iqunload generates a set of files derived from the legacy database.
14.5.3.1 Unsupported Objects
Check the schema for objects SAP IQ no longer supports.
Object Details Action
Invalid database, table, or Table names cannot contain double quote charac Change the object name. user names ters. User names and database names cannot con tain double quote characters, single quote, or semi colon characters. User names and database names cannot start or end with a space.
Reserved logical server A logical server cannot be named ALL, AUTO, COOR Drop the logical server before upgrading. names DINATOR, DEFAULT, OPEN, or SERVER.
Join indexes Join indexes are no longer supported.iqunload Drop all join indexes before migrating does not run if the database to be migrated contains data. join indexes.
See "iqunload Utility" in the SAP IQ Utility Reference..
LD indexes LD indexes are no longer supported. Drop all LD indexes before migrating data.
SAP IQ Installation and Update Guide for Windows 208 PUBLIC Upgrade to SAP IQ 16.1 SP 04 Object Details Action
Database with BLANK iqunload searches BLANK PADDING OFF data Drop these indexes and constraints be PADDING OFF bases for any indexes that would become invalid af fore the schema reloads and re-create ter migration. iqunload fails and lists indexes and the indexes and constraints after constraints that must be dropped and in which order. schema reload has been completed.
Unenforced constraints iqunload fails and lists unenforced constraints Drop unenforced constraints before pro that must be dropped. ceeding with migration.
Old 1-byte FP or old 2- Databases created with SAP IQ 12.4.2 or earlier may Allow iqunload to check for these and byte FP indexes have these indexes. Because these indexes were au list them. Rebuild these indexes using tomatically created by SAP IQ, you cannot drop and sp_iqrebuildindex before migra re-create them; you must rebuild them. tion. The rebuilt indexes are upgraded.
See "sp_iqrebuildindex Procedure" in the SAP IQ SQL Reference.
Parent topic: Migration Issues [page 208]
Related Information
Troubleshooting Syntax Changes [page 209] Schema Size [page 211] Output Logs [page 212] Data Storage Changes [page 213] Post-Migration Files [page 215]
14.5.3.2 Troubleshooting Syntax Changes
Review the reload script (reload.sql) for legacy syntax that can cause iqunload to fail.
Problem Solution
A DECLARE LOCAL TEMPORARY TABLE statement in a Remove the owner name. procedure or trigger causes a syntax error if the table name is prefixed with an owner name.
SAP IQ Installation and Update Guide for Windows Upgrade to SAP IQ 16.1 SP 04 PUBLIC 209 Problem Solution
If a CREATE TRIGGER statement does not include an owner Prefix the table name with the owner name. name for the table on which the trigger is defined, and the table must be qualified with an owner when referenced by the user executing the reload.sql file, the statement fails with a '