Ctrl+K

User Guide for SAP IQ

User Guide for SAP IQ#

Overview#

This guide introduces how to install and configure the ADPS agent and how to properly use ADPS to back up and restore SAP IQ.

The backup and restore features supported by ADPS include:

  • Backup sources

    Single or multiple databases

  • Backup types

    Full backup, incremental backup, and cumulative incremental backup

  • Backup targets

    Standard storage pool, deduplication storage pool, local storage pool, tape library pool, object storage service pool, and LAN-free pool

  • Backup schedules

    Immediate, one-time, hourly, daily, weekly, and monthly.

  • Data processing

    Data compression, data encryption, multiple channels, reconnection, and speed limit

  • Restore types

    Point-in-time restore and recovery testing

  • Restore targets

    Original host and different host

  • Restore options

    Reconnection time, resumption buffer size, speed limit, precondition, pre-script, and post-script

Planning and preparation#

Before you install the agent, check the following prerequisites:

  1. You have already installed and configured other backup components, including the backup server and the storage server.

  2. You have created a user with roles of operator and administrator on the ADPS console. Log in to the console with this user to back up and restore the resource.

Note

The administrator role can install and configure agents, activate licenses, and authorize users. The operator role can create backup/restore jobs and conduct copy data management (CDM).

Install and configure the agent#

To back up and restore SAP IQ, first install the ADPS agent on the host where SAP IQ resides.

Verify the compatibility#

Before you install the agent, ensure that the environment of the host where SAP IQ resides is on the Aurreum Data Protection Suite’s compatibility lists.

Supported SAP IQ versions include:

  • SAP IQ 15.4/16.0/16.1

Install the agent#

The ADPS agent can be installed on Linux. You can select the installation method according to your environment.

Linux#

For Linux OS, ADPS agent supports online and offline installation. We recommend online installation.

  1. Online installation: ADPS provides curl and wget commands for installation.

  2. Offline installation: See Offline installation in Aurreum Data Protection Suite Agent Installation Guide.

To install the agent online, do the following:

  1. Log in to the ADPS console.

  2. From the menu, click Resource > Resource. The Resource page appears.

  3. From the toolbar, click the Install agent icon. The Install agent window appears.

  4. In the Install agent window, do the following:

    (1) From the Select system list, select Linux.

    (2) From the Component list, select SAP ASE. The curl and wget commands appear in the window.

    (3) If you want to delete the downloaded package automatically after the installation, select the Delete installation package checkbox.

    (4) If you enable Ignore SSL errors, the installation will ignore certificate errors and so on. If you disable the option, the installation will prompt you to enter Y/N to continue or discontinue the process when an error occurs.

  5. Click the Copy icon to copy the curl or wget command.

  6. Log in to the Linux host as user root. Paste the command in the terminal and press Enter to start the installation. Example:

curl "http://IP:50305/d2/update/script?modules=sybase&location=http%3A%2F%2FIP%3A50305&access_key=572bd4dbb395fd320a30fe9729a21db8&rm=&tool=curl" | sh

  1. Wait for the installation to complete.

Activate licenses and authorize users#

After the agent installation, go back to the Resource page. The host with the agent installed appears on the page. Before you back up and restore SAP IQ, register the host, activate the backup license, and authorize users.

To activate licenses and authorize users, do the following:

  1. From the menu, click Resource > Resource. The Resource page appears.

  2. On the Resource page, select the host where SAP IQ resides. Click the Register icon. After the registration, the Activate window appears.

  3. In the Activate window, select the SAP IQ backup license, and click Submit. After the activation, the Authorize window appears.

    Note

    If you are prompted with “No enough licenses”, contact the administrator to add licenses.

  4. In the Authorize window, select user groups to authorize access to the resource. Click Submit.

    Note

    With many agents, install them first, then batch register, batch activate, and batch authorize the agents and resources for convenience. For details, see Batch register/Batch activate/Batch authorize in Aurreum Data Protection Suite Administrator’s Guide.

Backup#

Backup types#

ADPS provides three common backup types for SAP IQ:

  • Full backup

    Backs up the whole database.

  • Incremental backup

    Backs up all transactions that have changed since the last backup of any type.

  • Cumulative incremental backup

    Backs up all transactions that have changed since the last full backup.

Backup policies#

ADPS provides six backup schedule types: immediate, one-time, hourly, daily, weekly, and monthly.

  • Immediate: ADPS will immediately start the job after it is created.

  • One-time: ADPS will perform the job at the specified time once only.

  • Hourly: ADPS will perform the job periodically at the specified hour/minute intervals within the time range according to the setting.

  • Daily: ADPS will perform the job periodically at the specified time and day intervals.

  • Weekly: ADPS will perform the job periodically at the specified time and week intervals.

  • Monthly: ADPS will perform the job periodically at the specified dates and times.

You can set an appropriate backup policy based on your situation and requirements. Usually, we recommend the following common backup policy:

  1. Perform a full backup once a week when the application traffic is relatively small (Example: on the weekend) to ensure that you have a recoverable point in time every week.

  2. Perform a cumulative incremental backup or incremental backup every day when the application traffic is relatively small (Example: at 2 a.m.) to ensure that you have a recoverable point in time every day, which can save storage space and backup time.

Before you begin#

Before you back up and restore SAP IQ, check the following:

  1. Check storage pools

    (1) From the menu, click Storage > Storage pool. The Storage pool page appears.

    (2) Check whether the display area has any storage pools. If no, create a storage pool and authorize it for the current user. For details, see Add a storage pool in Aurreum Data Protection Suite Administrator’s Guide.

Log in to the instance#

Before you create a backup or restore job, configure Open Client for SAP IQ and log in to the SAP IQ instance on the console.

To configure Open Client, do the following:

  1. Use the database user to execute the dscp command and execute open to enter the InterfacesDriver configuration.

  2. Use add SERVERNAME to add service. The SERVERNAME should be configured as the “Server Name” of the dblocate -d command.

  3. Configure “Transport Address” as the “Address” of the dblocate -d command. The format is hostname/localhost followed by the port on which the iqsrv service listens. See following:

    [sybase@centos78 data]# dblocate -d
SQL Anywhere Server Enumeration Utility Version 16.0.0.809
Server Name           Address
-----------           -------
iqdemo_server       centos78:2638

[sybase@centos78 data]# dscp
>> open
ok
Session 1 InterfacesDriver>> add iqdemo_server
Service: [ASE]
Transport Type: [tcp]
Transport Address: centos78 2638
Transport Type: [tcp]
Transport Address:
Security Mechanism [] :
HA Failoverserver:
Retry Count:
Retry Delay:
Added iqdemo_server

Session 1 InterfacesDriver>> quit
[sybase@centos78 data]#

After configuring the Open Client, log in to the instance on the ADPS console. To log in to the resource, do the following:

  1. From the menu, click Resource > Resource. The Resource page appears.

  2. From the host list, find the host where SAP IQ resides. If you have many hosts, use the search bar to find the host quickly. Click the host to expand its resource list.

  3. Click Login beside the resource. The Login window appears.

  4. In the Login window, enter the User and Password of the database user, click Login.

  5. If your information is correct, you will be prompted that you have logged in to the resource successfully.

Create a backup job#

To create a backup job, do the following:

  1. From the menu, click Backup. The backup job wizard appears.

  2. At the Hosts and resources step, select the host where SAP IQ resides and select the resource. The wizard goes to the next step automatically.

  3. At the Backup source step, do the following:

    (1) From the Backup type list, select a backup type.

    (2) In the Backup source section, select the databases that you want to back up.

  4. At the Backup target step, select a storage pool. Click Next.

  5. At the Backup schedule step, set the job schedule. For details, see Backup policies. Click Next.

    • Select Immediate. ADPS performs the job immediately after it is created.

    • Select One time and set the start time for the job.

    • Select Hourly. Set the start time, end time, and time interval for job execution. The unit can be hour(s) or minute(s).

    • Select Daily. Set the start time and enter the time interval for job execution. The unit is day(s).

    • Select Weekly. Set the start time, enter the time interval, and select the specific dates in a week for job execution. The unit is week.

    • Select Monthly. Set the start time and months for job execution. You can select the natural dates in one month or select the specific dates in one week.

  6. At the Backup options step, set the common and advanced options according to your needs. For details, see Backup options. Click Next.

  7. At the Finish step, set the job name and confirm the job information. Click Submit.

  8. After the submission, you will be redirected to the Job page automatically. On this page, you can start, modify, and delete the job.

Backup options#

ADPS provides the following backup options for SAP IQ:

  • Common options

Backup common options#

Option

Description

Limitations

Compression

Fast is enabled by default.
- None: No compression during the backup job.
- Tunable: Customizes the compression level. The Advanced Compression license is required.
- Fast: Uses the fast compression algorithms to compress data during the backup job.

Channels

It can improve job efficiency. The default value is 1 and the value ranges from 1 to 64.
We recommend a value the same as the number of CPU cores. If the value exceeds the core number, the efficiency improvement will not be obvious.

  • Advanced options

Backup advanced options#

Option

Description

Limitations

Reconnection time

The value ranges from 1 to 60 minutes. The job continues after the abnormal reset occurs in the network within the set time.

Resumption buffer size

Specifies the resumption buffer size. The default value is 10 MiB. The bigger the resumption buffer size is, the more physical storage will be consumed. However, a bigger resumption buffer size can prevent data loss when the throughput of the business system is high.

Speed limit

Limits data transfer speed or disk read/write speed for different time periods. The unit can be KiB/s, MiB/s, and GiB/s.

Precondition

Checked before the job starts. The job execution will be aborted and the job state will be idle when the precondition is invalid.

Pre-/Post-script

The pre-script is executed after the job starts and before the resource is backed up. The post-script is executed after the resource is backed up.

Restore#

Restore types#

For different needs, ADPS provides several restore types for SAP IQ, including:

  • Point-in-time restore

    When a disaster occurs in a SAP IQ database, you can perform a point-in-time restore job to restore the database to a specified point-in-time state. You can restore to the original or a different host.

  • Recovery testing

    Restores the latest backup sets to another instance on the original host or a different host hourly, daily, weekly, and monthly.

Before you begin#

To restore SAP IQ to a different host, install the agent on that host, activate the licenses, and authorize user access to the resource.

Create a point-in-time restore job#

To create a point-in-time restore job, do the following:

  1. From the menu, click Restore. The restore job wizard appears.

  2. At the Hosts and resources step, select the host where SAP IQ resides and select the resource. The wizard goes to the next step automatically.

  3. At the Backup sets step, do the following:

    (1) From the Restore type list, select Point-in-time restore.

    (2) From the Database list, select a database for the restore job.

    (3) From the Backup sets list, select a backup set.

    (4) Click Next.

  4. At the Restore target step, select a restore target. The wizard automatically goes to the next step.

  5. At the Restore schedule step, set the job schedule. Click Next.

    • Select Immediate. ADPS will perform the job immediately after its creation.

    • Select One time and set the start time for the job.

  6. At the Restore options step, set the options according to your needs. See Restore options. Click Next.

  1. At the Finish step, set the job name and confirm the job information. Click Submit.

  2. After the submission, you will be redirected to the Job page. You can start, modify, and delete the job.

Create a recovery testing job#

To create a recovery testing job, do the following:

  1. From the menu, click Restore. The restore job wizard appears.

  2. At the Hosts and resources step, select the host where SAP IQ resides and select the resource. The wizard goes to the next step automatically.

  3. At the Backup sets step, do the following:

    (1) From the Restore type list, select Recovery testing.

    (2) In the Restore source section, select one or more databases for the restore job.

    (3) Click Next.

  4. At the Restore target step, select a restore target. The wizard automatically goes to the next step. The restore target supports other instances on the original or a different host.

  5. At the Restore schedule step, set the job schedule. Click Next.

    • Select Hourly. Set the start time, end time, and time interval to specify the time range for job execution. The unit can be hour(s) or minute(s).

    • Select Daily. Set the start time and enter the time interval for job execution. The unit is day(s).

    • Select Weekly. Set the start time, enter the time interval, and select the specific dates in a week for job execution. The unit is week.

    • Select Monthly. Set the start time and months for job execution. You can select the natural dates in one month or select the specific dates in one week.

  6. At the Restore options step, set the options according to your needs. See Restore options. Click Next.

  7. At the Finish step, set the job name and confirm the job information. Click Submit.

  8. After the submission, you will be redirected to the Job page. You can start, modify, and delete the job.

Restore options#

ADPS provides the following restore options for SAP IQ:

  • Common options:

Restore common options#

Option

Description

Limitations

utility_db username

Enter the user name of the utility_db user. The default user name is DBA.

Password

Enter the password for the corresponding utility_db user.

  • Advanced options:

Restore advanced options#

Option

Description

Limitations

Reconnection time

The value ranges from 1 to 60 minutes. The job continues after the abnormal reset occurs in the network within the set time.

Resumption buffer size

Specifies the resumption buffer size. The default value is 10 MiB. The bigger the resumption buffer size is, the more physical storage will be consumed. However, a bigger resumption buffer size can prevent data loss when the throughput of the business system is high.

Speed limit

Limits data transfer speed or disk read/write speed for different time periods. The unit can be KiB/s, MiB/s, and GiB/s.

Precondition

Checked before the job starts. The job execution will be aborted and the job state will be idle when the precondition is invalid.

Pre-/Post-script

The pre-script is executed after the job starts and before the resource is restored. The post-script is executed after the resource is restored.

Backup and restore#

ADPS supports the backup and restore of SAP IQ Multiplex cluster. Before you back up and restore the SAP IQ Multiplex cluster, bind nodes into a cluster on the console.

Before you begin#

See Install and configure the agent and Activate license and authorize users to complete the environment deployment on each node.

Bind nodes into a cluster#

To bind nodes into a cluster on the console, do the following:

  1. From the menu, click Resource > Cluster. The Cluster page appears.

  2. From the toolbar, click the + icon. The Cluster binding window appears.

  3. In the Cluster binding window, do the following:

    (1) In the Name field, enter a name for the cluster.

    (2) From the Primary node list, select the Coordinator node in the Multiplex cluster.

    (3) From the Type list, select N-to-1.

    (4) From the Nodes list, select a secondary node in the cluster. You can click x to remove the selected node.

    (5) Click Submit.

Backup and restore#

When a switchover occurs, the new Coordinator node will take over the backup job automatically. To create a SAP IQ Multiplex cluster backup/restore job, see Create a backup job and Restore.

Limitations#

Limitations#

Feature

Limitations

Restore

- Restore across different versions and platforms is not supported.
- To restore to a different host, the target instance should have the same shared store path.

Glossary#

Glossary#

Term

Description

fast compression

A compression method that uses fast compression algorithms to compress data during the backup job.
Contents