Document release date: August 2011
Software release date: August 2011
Legal notices
Warranty
The only warranties for HP products and services are set forth in the express
warranty statements accompanying such products and services. Nothing herein
should be construed as constituting an additional warranty. HP shall not be liable
for technical or editorial errors or omissions contained herein.
The information contained herein is subject to change without notice.
Restricted rights legend
Confidential computer software. Valid license from HP required for possession,
use or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer
Software, Computer Software Documentation, and Technical Data for
Commercial Items are licensed to the U.S. Government under vendor's standard
commercial license.
Licensing
The use of HP products is governed by the terms and conditions of the applicable
End User License Agreement (EULA).
Using HP Database Archiving and HP TRIM in conjunction with one another
provides a powerful means of safely retiring old, legacy data and applications
within the bounds of your existing records management policies.
This tutorial is designed to help you get started using HP Database Archiving to
move eligible data from your production database into a structured records
management system, HP TRIM.
This guide provides information about:
•an example cartridge that employs HP TRIM classifications
•steps for designing the example cartridge using an existing data model
•creation of a sample business flow that invokes the cartridge
•deployment of the example business flow
•execution of the example business flow
Intended audience
Prerequisites
•querying the archive
This guide is intended for:
•Archive developers building cartridges for structured records management
Prerequisites for using this product include:
•Knowledge of the operating system
•Database knowledge
•Application knowledge
•Knowledge of HP TRIM and structured records management
HP Structured Records Management Solution Tutorial5
New and revised information
This document includes the following new and revised features in the HP SRMS
software:
•HP TRIM is now supported on 64-bit machines
•For SRMS, you must apply hot fix 16 with HP Database Archiving 6.30
For more information about the hot fix, refer to http://quixy.deu.hp.com/hotfix
•The default HP TRIM installation path is now changed to
Files\Hewlett-Packard\HP TRIM
•To check the memory leak errors for SRMS add-ins, a new check box is added
on the External Link dialog.
Related documentation
NOTE This documentation is written to the latest patch version. If you have not
installed the latest patch, there may be items in this documentation that do not
apply to your environment.
HP TRIM documentationFor more information about HP TRIM, refer to:
http://www.hp.com/go/imhub/trimdoc
HP Database ArchivingFor more information about HP Database Archiving, refer to:
ttp://www.hp.com/go/imhub/dbadoc
h
C:\Program
Document conventions and symbols
ConventionElement
[ ] Indicates that the enclosed element is optional
and may be left out.
{ } Indicates that you must specify one of the listed
options.
| Separates alternatives.
6About this document
ConventionElement
<parameter_name> You must supply a value for a variable
parameter.
... •Indicates a repetition of the preceding
parameter.
•Example continues after omitted lines.
Medium blue text: Figure 1Cross-reference links and e-mail addresses
Medium blue, underlined text
(http://www.hp.com
Bold
)
Web site addresses
•Key names
•GUI elements that are clicked or selected,
such as menu and list items, buttons, and
check boxes
ItalicsText emphasis
Monospace
•File and directory names
•Text displayed on the screen, such as system
output and application messages
•Code syntax
Monospace, italicYou must supply a value.
•Code variables
•Command-line variables
CAUTION Indicates that failure to follow directions could result in damage to
equipment or loss of data.
NOTE Provides additional information.
TIP Provides helpful hints and shortcuts.
RECOMMENDATION Provides guidance from HP for a best practice or for
optimum performance.
Subscription service
HP strongly recommends that customers sign up online using the Subscriber's
choice web site:
http://www.hp.com/go/e-updates
HP Structured Records Management Solution Tutorial7
Support
•Subscribing to this service provides you with e-mail updates on the latest
product enhancements, versions of drivers, and firmware documentation
updates as well as instant access to numerous other product resources.
•After signing up, you can quickly locate your products under Product
Category.
You can visit the HP Software Support web site at:
http://www.hp.com/go/hpsoftwaresupport
HP Software Support Online provides an efficient way to access interactive
technical support tools. As a valued support customer, you can benefit by using
the support site to:
•Search for knowledge documents of interest
•Submit and track support cases and enhancement requests
•Download software patches
•Manage support contracts
•Look up HP support contacts
•Review information about available services
•Enter into discussions with other software customers
•Research and register for software training
Most of the support areas require that you register as an HP Passport user and sign
in. Many also require a support contract.
To find more information about access levels and register for HP Passport, go to:
This chapter provides you with a conceptual overview of the archive building
process and the tutorial itself.
This chapter includes:•Tutorial overview (page 9)
•Tutorial prerequisites (page 9)
•Structured records management (page 11)
•Database archiving concepts (page 14)
•Records management concepts (page 14)
•Summary and next steps (page 14)
Tutorial overview
This tutorial is designed to introduce you to archiving data with HP Database
Archiving and managing the archived data files in HP TRIM. The tutorial walks
you through the following high level tasks using the sample Demarc database
objects:
•Designing a database to file cartridge, based on an existing data model.
•Specifying which HP TRIM classifications to apply to the data extracted by
the cartridge.
•Creating a business flow to call the cartridge.
•Creating an environment.
•Creating Web Console users.
•Deploying the business flow.
•Running the business flow from the Web Console.
•Confirming the results of the business flow.
•Changing the business flow and redeploying it.
•Querying the archive.
Tutorial prerequisites
Before starting this tutorial, ensure all of the following have been completed:
HP Structured Records Management Solution Tutorial9
•HP TRIM 7.10, HP Database Archiving software 6.30 with hot fix 7, and
RQS 6.30 with hot fix 11 have been installed and configured in your
environment by HP Enterprise Services for structured records management
(HP TRIM Enabler Pack).
•You have created a classification for the sales orders from DEMARC similar
to the following:
•You have installed a database that is supported by HP Database Archiving
software 6.30. For details, see the HP Database Archiving software Installation manual.
The steps and screen images in this tutorial assume a SQL Server database for
the HP TRIM repository and an Oracle database as the source database for HP
Database Archiving. If you use other databases, you can still follow the steps,
but you may encounter some small differences in the steps and/or the
appearance of the product.
•You have run the Web Console to set up a repository and at least one
environment for the source database.
For detailsSee Chapter 5, Starting and configuring the Web Console, of the HP Database
Archiving software Runtime guide.
•You have noted all of the following:
— database administrator user name
— database administrator password
— HP Database repository user name (for example, obt_rep)
— HP Database repository password
— encryption key
10Chapter 1: Structured records management concepts
Structured records management
Records management traditionally concerned itself with information printed on
paper. These records included:
•narrative papers such as correspondence, memos, and policies.
•non-narrative papers, such as inventories, general ledgers, and customer
registers.
When records management moved into the digital age, it took control of the
electronic equivalents of narrative papers, namely unstructured information.
Records management tended to neglect the more structured, non-narrative
information because it was seemingly managed by the line of business
applications that generated, used, and stored it.
The costs and risks of infinite retention
Over time, corporations and organizations came to understand that simply
allowing structured records to accumulate in databases indefinitely lead to both
increased costs and risks:
•Maintaining very old, infrequently-accessed data and systems for the sole
purpose of potential legal discovery is extremely expensive. Such data and
systems invariably become a major drain on data center resources and
personnel.
•Keeping data indefinitely can, in some cases, put your corporation or
organization at greater legal risk. Very few of the applications or their
underlying databases provide features to manage the data from a records
management point of view. Hence, structured records are often kept far longer
than they would be if standard corporate retention policies were applied to
them in a systematic way.
HP Structured Records Management Solution (SRMS)
The best solution to structured records management is to extract older,
infrequently accessed data from the source applications into an open,
standards-based format (XML) for future ease of access. This standard format can
then be ingested into the corporate records management system for long term
management and eventual disposal according to corporate policy.
Extracting and purging inactive data from the source systems brings many
benefits:
•Systems become more performant with a smaller footprint and reduced
backup volumes.
•Legacy systems can be retired.
•Database management costs are reduced.
•Saved resources may be re-purposed for other, more current applications and
databases.
HP Structured Records Management Solution Tutorial11
Used together, HP Database Archiving and HP TRIM provide just such a solution
with its many associated benefits.
Figure 1Structured records management workflow
1Define
This step defines the data model and the rules for the data to be extracted.
Unlike unstructured information, which is stored in relatively well defined
containers in the shape of files, structured data is stored in a set of tables,
some of which are active data tables and some of which serve as lookup
tables. The modeling allows an administrator to define what data and links
make up the records so that the extracted data has integrity and usability.
Criteria and rules can be defined for the selection of the data, as well as for
exceptions that will exclude data from extraction. Once the model and rules
are defined they can be used and re-used many times over.
2Classify
Not all data required to manage the records may be inherent in the source data
itself. Records management relies on descriptive data to manage the context
in which the data was created and used. The classify step allows the
administrator to select a target in the records management classification
scheme, as well as to assign additional metadata properties that will be used to
describe and manage the extracted data in the records management system.
Like the definition step, the classification step is part of the preparatory design
and serves many extracts of a certain type of data from that point onward.
3Extract
The result of the define and classify steps is a combination of data model,
rules, and attributes that you use to extract data unattended from the source
system. It is common practice to run the extract as a scheduled process,
although you can also run it manually. Once the extract is initiated it selects
the eligible data based on the model and rules, and exports it along with the
associated attributes to an XML file. The resulting extract consists of a
descriptive summary file and the individual data files containing the records.
For each file type, an XSD schema description is exported. The descriptive
metadata for the records management system is created in a tab delimited text
file. Once all the files are exported, the extraction script calls the HP TRIM
loader to ingest the data into the records management system.
12Chapter 1: Structured records management concepts
NOTE The extraction process also can create an MD5 hash of each exported
file and includes this in the summary file. These hashes can be used to
validate that the files loaded into HP TRIM are identical to the files generated
by HP Database Archiving.
TIP You have the option to remove the data from the source system
immediately upon its extraction or at some later time (deferred deletion). In
deferred deletion, the administrator defines a point in time after extraction
when the record is removed from the source system. Deferred deletion allows
records to be extracted as soon as they become static but while they are still
used in day-to-day queries in the source system. If a record is ever deleted
prematurely from the source system, a reload option allows the data to be
extracted from HP TRIM and loaded back into the original source in an
automated process.
4Ingest
The ingest step creates a folder inside the records management system to
group all the files created by the extract. The folder is placed in the
classification that was selected during the classify step and uses the metadata
attributes contained in the tab delimited file created by the extract step.
Once the folder is created the importer loads all the XML, XSD, and the log
files for the ingest step into the folder. As for the folder, it uses the predefined
metadata attributes from the classify step to create profiles for each of the
files. Once the import concludes, the import step can perform a validation of
the records’ contents against the MD5 values generated by the extract step
and store the details of this validation. The hash validation can also be
invoked manually at a later stage.
5Manage
The manage step is the same for structured records as it is for unstructured
information. The same HP TRIM structures, rules, and features are used for
both, including metadata and content searching, addition and removal of
holds, and security and auditing features.
In the case of SRMS, since the records are structured, you typically will want
to run SQL queries against them rather than a standard search. To address this
requirement, you can extract batches of records from HP TRIM and
automatically register them with the Records Query Server (RQS). Using
RQS (also known as the Archive Query Server), you can query the archive
XML files using any ODBC, JDBC, or OLEDB compliant SQL query tool.
6Dispose
The disposal of records in the records management system uses the same
features that are applied to unstructured records. A retention period can be
defined for the record and, when that period is up, the record is marked as
destroyed. Once a record is marked as destroyed, a check is run to confirm
whether the original record in the source system was destroyed as well. If not,
the user will be prompted to execute a deferred deletion from the source
system at that point.
HP Structured Records Management Solution Tutorial13
Scalability
In order to achieve optimum performance and scalability with SRMS, you may
spread the configuration across multiple machines where necessary. HP TRIM
runs only on MS Windows, but HP Database Archiving can run on UNIX or MS
Windows. The following SRMS configurations are possible:
•MS Windows only. In this case, all of the machines in the configuration are
MS Windows systems. Note that one of the machines in this configuration
must have HP TRIM and HP Database Archiving installed on them.
•MS Windows and UNIX. In this case, HP TRIM is installed on an MS
Windows system and HP Database Archiving is installed on a UNIX system.
Since the products are on disparate operating systems, you will need to call
the SRMS Loader differently from the Groovy script in your business flow.
NOTE RQS must be installed on the same machine as HP TRIM.
Database archiving concepts
For conceptual information about HP Database Archiving, refer to the HP
Database Archiving software Concepts guide.
Records management concepts
For conceptual information about HP TRIM, refer to the HP TRIM online help.
Summary and next steps
In this chapter you learned about:
•the overall structure of the tutorial
•the prerequisites for building the tutorial
•HP Structured Records Management Solution
•where to look for conceptual information about HP Database Archiving
You are now ready to begin the tutorial.
14Chapter 1: Structured records management concepts
2Configuring the Demarc data
To follow the instructions in this tutorial, you must have the sample Demarc data
set loaded in your database.
This chapter explains how to obtain and load the Demarc data.
This chapter includes:•Loading the Demarc data (page 15)
•Summary and next steps (page 16)
Loading the Demarc data
The example in this tutorial is based upon the Demarc data set. You must install
this schema and populate it before you can start the tutorial.
TIP Typically, you will install the Demarc data set into a database that is separate
from the HP TRIM database.
To load the data into your database, perform the following steps:
1Install and configure the database of your choice. See Tutorial prerequisites
(page 9) for information about which databases you can use.
NOTE The demo data loader does not support Oracle RAC or SQL Server
Windows authentication.
2Install and configure HP Database Archiving software as per the HP
Database Archiving software Installation guide.
3Change to the bin directory where you installed HP Database Archiving. For
NOTE The generic option is for JDBC/ODBC data sources.
5Respond to the prompts. Default values are displayed next to the prompts
inside of square brackets [ ]. It may take a few minutes for the scripts to
complete running.
TIP If you want to use a schema name other than DEMARC, enter the desired
name when prompted for demo schema/username.
TIP Note that SQL Server database names are case sensitive. Hence, if you
accept the default name, you must use DEMARC when referencing it.
6To confirm that the scripts executed properly, check the log files located in
<install_dir>\obt\demo for any errors:
—
—
—
—
7If you have an ad hoc query tool, you can use it to confirm the presence of
DEMARC and its tables.
Summary and next steps
In this chapter, you learned:
•how to run the scripts to load the sample data into the database you plan to use
for the tutorial.
The next step is to import a project that you can modify for structured records
management.
ngfloadlog.log for DB2
ogfloadlog.log for Oracle
sgfloadlog.log for SQL Server
ygfloadlog.log for Sybase
16Chapter 2: Configuring the Demarc data
3Creating an archive definition
This structured records management tutorial is based upon the same data model
used in the general HP Database Archiving tutorial in Tutorial: Designing and deploying archive modules. This chapter walks you through the process of
importing the solution project for the general tutorial. In subsequent chapters, you
will modify this project for the structured records management case.
This chapter includes:•Importing an existing project (page 17)
•Creating a connection to the HP TRIM database (page 18)
•Summary and next steps (page 20)
Importing an existing project
The general tutorial solution project shipped with HP Database Archiving
contains the data model you need for this structured records management tutorial.
Rather than recreating the model from scratch, you can simply import that
existing project.
To import the tutorial solution project:
TIP If you successfully built the tutorial project yourself as described in Tutorial:
Designing and deploying archive modules, you can simply open that project and
skip to Chapter 4, Creating a cartridge.
1Launch Designer.
— On MS Windows, from the Start menu, open Designer by selecting
Database Archiving > Designer
— On Linux, use the designer desktop link, if you opted to create the links at
install time. Otherwise, navigate to <install dir>
./designer.sh
When you start Designer for the very first time, you are automatically
prompted to create a new project.
The first field is the project Name. The second field is the Database
connection used to get the table definitions.
.
/obt/bin and type:
HP
TIP If you are not prompted to create a new project, select File > New Project.
Or, you can click the New Project icon.
HP Structured Records Management Solution Tutorial17
In the Name field, type DEMARC Orders App v1 SRMS as the name of your
new project.
2For Database, if you already created a connection to the database with
DEMARC, choose that connection from the pull-down list. Otherwise, click
New to set up a database connection for DEMARC.
3Once the New Project dialog box is filled out, click OK.
4Select File > Import. The Import dialog box displays.
5Choose Existing Designer project from the list.
6Click Next. The Import Existing Project dialog box appears.
7Browse to the location of the tutorial solution project. On MS Windows, it can
be found in <install dir>
<install dir>
8Select tutorial_soln_<db_type>.hdp, where <db_type> is your database
oracle, sqlserver, sybase, neoview).
type (
9Click Open. You should now have a complete, working version of the tutorial
/obt/demo/project.
\obt\demo\project. On UNIX, it can be found in
solution project, which you can modify for structured records management.
Creating a connection to the HP TRIM database
In order to retrieve and apply classifications from HP TRIM, HP Database
Archiving requires a connection to the HP TRIM database. When the HP TRIM
Enabler Pack was implemented by HP Enterprise Services for you, they defined a
name for this connection. You need to create a connection with this name in
Designer. If you do not have the connection name or details for HP TRIM, contact
your DBA or HP TRIM administrator.
If you are uncertain of the connection name or details, consult your DBA or
HP TRIM administrator.
5Choose the Database Type, for example, SQL Server.
6Click Next.
7Enter the database connection details for the HP TRIM database.
HP Structured Records Management Solution Tutorial19
TIP Typically, a special user will have been created for this purpose. This user
must have SELECT privileges on the TSFILEPLAN table. If you are not sure
what user name and password to use for the HP TRIM database, contact your
DBA or HP TRIM administrator.
8Click Finish.
9Click Close.
Summary and next steps
In this chapter you learned to:
•Import a project and create a connection to the HP TRIM database
The next step is to create a cartridge to actually archive and classify the data.
20Chapter 3: Creating an archive definition
4Creating a cartridge
Once you have a working data model and a connection to HP TRIM, you can
begin to create, convert, and classify cartridges.
This chapter includes:•Creating a cartridge (page 21)
•Navigating in the cartridge editor (page 23)
•Previewing the cartridge (page 23)
•Classifying extracted data (page 25)
•Summary and next steps (page 27)
Creating a cartridge
A cartridge is the mechanism by which HP Database Archiving specifies a
versioned instance of an archive model for one type of archiving. In your cartridge
definition, you can select settings such as the following:
•The type of archive operation to perform (database to database or database to
file, and archive or copy)
•Which rules to apply
•How to treat transactional and chaining objects
•How to treat lookup objects
•HP TRIM classifications to apply
For this tutorial, create a cartridge that archives from a database to a file (an XML
file).
1Go to File > New Cartridge.
2In the New Cartridge dialog box, type Orders_D2F_SRMS as the Name.
3Select Database to File as the Type.
4If it is not already selected, select the Model radio button.
Advanced conceptModel means that the cartridge is based upon a defined data model with
relationships. This type of cartridge is typically used for ongoing archive
operations.
Schema means that the cartridge is based upon the database schema rather
than a defined data model with relationships. This type of cartridge is
typically used for database retirement or the cleanup of orphan tables.
Related informationHP Database Archiving software Developer’s guide.
HP Structured Records Management Solution Tutorial21
5If it is not already selected, select Orders as the model.
6Optionally, click Annotation to add a comment. Click OK to exit the
Annotation dialog box when you are done.
7Click OK.
8Click OK. The Database to File Cartridge editor appears.
22Chapter 4: Creating a cartridge
Navigating in the cartridge editor
If you look carefully at the bottom of the editor, you see a number of tabs, which
correspond to the different parts of the cartridge you can edit. The first tab,
Overview, is an overview of the cartridge. Each section on the page has a title that
acts as a hyperlink to the corresponding tab.
At the top of each page, you will find a link called
returns you to the Overview page.
Any change you make in any page is immediately reflected in the Overview page.
For the purposes of this tutorial, you need not make any modifications to the
default settings of the cartridge.
Previewing the cartridge
You can preview your cartridge to confirm it is behaving as you intended.
1In the toolbar, click the Preview tool.
2In the Parameter Values dialog box, leave the default values and click OK.
Back to Overview, which
HP Structured Records Management Solution Tutorial23
Loading...
+ 53 hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.