Archiving data by using the console

This topic explains the use of console to execute the archival process for one-time run and to view the detailed status of the archival process.

Before you begin

Before you archive the reports data warehouse data by using the TrueSight Server Automation - Data Warehouse console, 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. 

  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

To archive reports data 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 .
   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.

   Note

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

3. On the Configure Archive Settings page, configure the archival settings.

   Notes

   The Configure Archival Settings page appears only when you run the archival process for the first time. For subsequent archival process runs, the Archival Settings page appears, on which you can change your archival settings again.

   Click Reset to revert to the previous settings.

   The Configure Archival Settings page enables you to configure the following parameters to run the archival process. 

   Field definitions

   Field	Description
   Archive Directory Location	Directory on the Database Server hosting the Reports Data Warehouse Database where you want to store the archived data. The archive directory location must exist on a local drive.
   Domain name	Domain for which you want to archive data
   Retention Period (Months)	Number of months for which you want to retain data for a domain Notes: The retention period for the JOB ACTIVITY domain must be the maximum. All other domains can have their retention period equal to or smaller than this domain. You must consider the space available in the secondary storage location while setting the retention periods for the domains. For example, if you want to retain data only for a short period, such as 3 months, you must ensure that the secondary storage location has adequate space to store the archived files.

   The settings saved on this page are also used by the archival job when you run that job from TrueSight Server Automation. For more details, see Archiving-data-by-using-TrueSight-Server-Automation-jobs.

4. Click Save. 

5. On the Archival Settings page, verify the settings. 

   The Archival Settings page shows the archival settings that you configured on the Configure Archival Settings page. Also, this page provides the following links:

   Link definition

   Link	Description
   Run Archive Now	Enables you to run the archival process immediately To schedule an archival process, see running archival using TrueSight Server Automation jobs.
   Change Retention Period	Enables you to change the retention period and archive directory location
   Run Restore	Enables you to configure restore settings, such as the domain name and its restore period

   Note

   To change the settings, click the Change Retention Period link. The Configure Archival Settings page appears.

6. Click the Run Archive Now link. 
7. When you are prompted for confirmation, click Yes.
   An archival job is created that runs the archival process.  

To view status information about a archive 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 .
   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 Archival Status. 

3. The Archival Status Summary page displays the summarized status of the archival job and is created when you run the archival process. This page displays the following information for an archival job:

   Column definitions

   Column	Description
   Job Name	Name of the archival job To see the detailed status of an archival job, click the job name.
   Status	Status of the archival job, as follows: indicates that the archival job completed successfully. indicates that the archival job failed.  indicates that the archival job is running.  indicates that the archival job is waiting.
   Start Time	Date and time when the archival job started
   End Time	Date and time when the archival job ended
   Duration(HH:MM:SS)	Time for the archival job to run

4. (Optional) To view detailed status of an archival job, click the job name in the Archival Status Summary page. 
   The Archival Status Details page displays the detailed status of an archival job and is created when you run the archival process. It displays the domain-wise status of the archival job.

   Column definition

   Column	Description
   Domain	Name of the domain for which the archival job was run
   Retention months	Retention period for a domain (months)
   Status	Status of the archival job, as follows:  indicates that the archival job completed successfully.  indicates that the archival job failed.  indicates that the archival job is running.  indicates that the archival job is waiting.
   Start Time	Date and time when the archival job started
   End Time	Date and time when the archival job ended
   Duration(HH:MM:SS)	Time for archiving the domain
   Error Message	Error message for a failure

   Note

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

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

   Column definition

   Column	Description
   Table name	Name of the archival table
   Archival Period (MM-YYYY)	Month and year for which the archival job is archiving the table
   Step	Name of the step being executed during execution of the archival job Note: If the reports data warehouse does not contain any data to archive, the steps are displayed only till Metadata Processing, which indicates that domain tables are getting validated against prerequisites of the archival process.
   Status	Status of the step, as follows:  indicates that the archival job completed successfully.  indicates that the archival job failed.  indicates that the archival job is running.  indicates that the archival job is waiting.
   Start Time	Date and time when the archival job started
   End Time	Date and time when the archival job ended
   Duration(HH:MM:SS)	Time for the archival job for that table
   Rows processed	Number of rows processed in the archival table
   Error Message	Error message for a failure

Related topics

Archiving-data-by-using-TrueSight-Server-Automation-jobs
Rerunning a failed archival or restore session
Stopping-an-archival-or-restore-process