Skip to Content

Restoring data by using the console

This topic explains the use of console to execute the restore process and view the detailed status of the restore process.

Before you begin

Before you restore the reports data warehouse data, ensure that the following prerequisites are met:

  • Ensure that you are using database versions supported by TrueSight Server Automation - Data Warehouse. See System requirements for supported database versions.
  • Back up your reports data warehouse to prevent data loss in case of failure during the archival process. For information about backing up your data warehouse, see your database documentation.
  • Ensure that you have read/write permissions in the directory in which you want to store the archived files.

  • Run extract, transform, and load (ETL) for all sites and ensure that the runs are complete. 

    Warning

    Note

    Run ETL just before running the archive utility to ensure that no new ETL scripts are run.

  • (Oracle only) Ensure that the following privileges are assigned to the reports data warehouse user:

    • GRANT CREATE ANY DIRECTORY TO datawarehouseUser
    • GRANT DROP ANY DIRECTORY TO datawarehouseUser
    • GRANT EXP_FULL_DATABASE TO datawarehouseUser
    • GRANT IMP_FULL_DATABASE TO datawarehouseUser 
    • GRANT EXECUTE ON utl_file TO datawarehouseUser

    These privileges are required only during archival and restore processes for importing or exporting the warehouse database. The privileges can be revoked after the archival/restore process is completed.

  • (Microsoft SQL Server only) Assign the sysadmin role to the reports data warehouse user. You can revoke this role assignment when the archival and restore operations are complete.  

  • (SQL Server only) If you are running the archive utility for the first time, ensure that you have enabled the xp_cmdshell server configuration option. This option enables system administrators to control whether the xp_cmdshell extended stored procedure can be executed on a system. By default, this option is disabled. It must be enabled to perform the delete operation on archived files. To enable the option, run the xp_configure system stored procedure on the reports data warehouse as a data warehouse user with the sysadmin role, as follows:

    EXEC sp_configure 'show advanced options', 1

    GO


    -- To update the currently configured value for advanced options.

    RECONFIGURE

    GO


    -- To enable the feature.

    EXEC sp_configure 'xp_cmdshell', 1

    GO


    -- To update the currently configured value for this feature.

    RECONFIGURE

    GO
Warning

Note

After the data has been restored successfully, the archived data is deleted from the secondary storage space.

To restore the reports warehouse data

  1. Launch the TrueSight Server Automation - Data Warehouse console.

    Perform the following steps to access the console:
    1. To view the home page for the console on Microsoft Windows or UNIX systems, click Start > Programs > TrueSight Server Automation - Data Warehouse > Console.
      Alternatively, you can enter the following address into a web browser: 
      https://reportsServer:portNumber/tssa-dw
      • reportsServer is the server that hosts TrueSight Server Automation - Data Warehouse. 
      • portNumber is the web server secure port that you specified during installation. 
    2. In the User Name and Password fields, enter the TrueSight Server Automation - Data Warehouse Administrator (DWAdmin) credentials. By default, the password is hidden. To view the password, click ViewPassword.png.
    3. In Site, select a site. The Primary Site is the default site.
    4. In Authentication Method, select a authentication method. SRP is the default authentication method.
    5. Click LOG IN.

  2. From the ETL Management menu, select Database Archive/Restore.

    Warning

    Note

    The ETL Management menu appears in the user interface only if the product has been configured.

  3. On the Archival Settings page, click the Run Restore link.

  4. On the Configure Restore Settings page, configure the restore settings. This page contains the following fields:

    Field definitions

    Field

    Description

    Domain Name

    Domain for which you want to restore data

    Restore Period

    Period for which you want to restore data for a domain

    Note: You must consider the space available on the reports data warehouse database server while setting the restore period for the domains. For example, if you want to restore data for a long period, such as 36 months, you must ensure that adequate space is available.

    Restore

    Click this button to start the restore process.

    Reset

    Click this button to revert to the previous settings.

    Warning

    Note

    Click Reset to revert to the previous settings.

     

  5. Click the Restore button to start the restore process.
    A restore job is created that runs the restore process.

To view status information about a restore job

  1. Launch the TrueSight Server Automation - Data Warehouse console.

    Perform the following steps to access the console:
    1. To view the home page for the console on Microsoft Windows or UNIX systems, click Start > Programs > TrueSight Server Automation - Data Warehouse > Console.
      Alternatively, you can enter the following address into a web browser: 
      https://reportsServer:portNumber/tssa-dw
      • reportsServer is the server that hosts TrueSight Server Automation - Data Warehouse. 
      • portNumber is the web server secure port that you specified during installation. 
    2. In the User Name and Password fields, enter the TrueSight Server Automation - Data Warehouse Administrator (DWAdmin) credentials. By default, the password is hidden. To view the password, click ViewPassword.png.
    3. In Site, select a site. The Primary Site is the default site.
    4. In Authentication Method, select a authentication method. SRP is the default authentication method.
    5. Click LOG IN.

  2. From the ETL Management menu, select Restore Status. The Restore Status Summary page displays summarized status of a restore job, which is created when you run the restore process. This page displays the following information for a restore job: 

    The [confluence_table-plus] macro is a standalone macro and it cannot be used inline.

  3. To see the detailed status of a restore job, click the job name. 

    The Restore Status Details page displays the detailed status of a restore job, which is created when you run the restore process. This page appears when you click a restore job on the Restore Status Summary page. It displays the the domain-vise status of the restore job:

    Column definition

    Column

    Description

    Domain

    Name of the domain for which the restore job is running

    Restore From

    Month and year starting with which the restore job is restoring the domain

    Restore To

    Month and year ending with which the restore job is restoring the domain

    Status

    Status of the restore job, as follows:

    • success.png indicates that restore job completed successfully.
    • error.png indicates that the restore job failed.
    • running.gif indicates that the restore job is running.
    • waiting.gif indicates that the restore job is waiting.

    Start Time

    Date and time when the restore job started

    End Time

    Date and time when the restore job ended

    Duration

    Time taken to restore the domain

    Error Message

    Error message for a failure

    Warning

    Note

    Use the Refresh icon to see the latest state of the restore job for a domain.

    To see the detailed status of a restore job for a domain, click the domain name in the Domain column. The Restore Status Details page displays the following information:

    Column definition

    Column

    Description

    Table Name

    Name of the restore table

    Restore Period(MM-YYYY)

    Month and year for which the restore job is restoring the table

    Step

    Name of the step being executed during execution of the restore job

    Note: If the reports data warehouse does not trace any data to restore, the steps are displayed only till Metadata Processing, which indicates that domain tables are getting validated against prerequisites of the restoration process.

    Status

    Status of the restore job, as follows:

    • success.png indicates that the restore job completed successfully.
    • error.png indicates that the restore job failed.
    • running.gif indicates that the restore job is running.
    • waiting.gif indicates that the restore job is waiting.

    Start Time

    Date and time stamp when the restore job started

    End Time

    Date and time stamp when the restore job ended

    Duration(HH:MM:SS)

    Time taken to execute the restore job for that table

    Rows processed

    Numbers of rows processed in the restore table

    Error Message

    Error message for a failure

    You can use the Search field on this page to search for restore tables.


Related topics

Rerunning-a-failed-archival-or-restore-session
Stopping-an-archival-or-restore-process

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

TrueSight Smart Reporting 19.01