storage_prog Utility

The storage_prog utility can provide the administrator with many useful statistics. Using storage_prog, you will be able to analyze the growth rate of your DocuVault and answer a variety of questions that will help you manage your Cypress environment. One of the most popular uses of storage_prog is to determine long-term disk storage requirements. Based on the information generated by storage_prog, you may meet these objectives:

verify that you have adequate disk space for the foreseeable future

identify when additional disk space may be needed
identify when to move documents from the DocuVault’s primary disk to DocuVault partitions stored in a secondary disk storage environment (DocuVault partition feature).

Benefits of storage_prog

A key challenge for Cypress Administrators is managing DocuVault disk space. If you are to reliably verify or predict disk space requirements, you must know the answers to these questions:

How many documents am I printing or viewing through Cypress?
How long are these documents being retained?
How much disk space do these documents consume?

Without storage_prog, it would be difficult to answer these questions accurately, plus involve considerable effort to calculate estimates. The storage_prog utility provides customers with a fast, simple, and robust tool for measuring DocuVault activity, both in the past and into the future. Using the information generated by storage_prog, you will be able to make informed decisions based on actual information at your site.

Using storage_prog, you will be able to generate reports to answer these questions:

How much is my DocuVault growing each month?
How much disk space will I regain next month from scheduled document deletions?
What is my daily transaction count of non-temporary documents?
Are my document retention times set correctly?
What’s the average size of a typical document?

storage_prog Data

When you execute storage_prog, you also specify the number of days you want to analyze (as related to the current date). There is no practical limit to the number of days you may specify. However, the more days you specify, the longer it may take storage_prog to complete. Depending on the information being reported, you will see detailed daily activity for the specified number of days before the current date (past) or after the current date (future).

Reports may be displayed within a command prompt window, or be written to a comma-separated value (.csv) file.

All information within a storage_prog report is relative to content still stored in the DocuVault on the date you run the storage_prog report. For example, a storage_prog report would list the number of documents created on August 19, 2004 that were still in the DocuVault on the date the storage_prog report was created. It would not reflect the total number of documents created on August 19, 2004.

There is no need to report on documents no longer in the DocuVault as the disk space used to store “temporary” documents will be automatically reused by Cypress.

The storage_prog report is divided into four separate areas, each designed to answer different types of questions:

Report Area	Description
Created Past	Provides daily document creation totals for the specified number of days before the current date.
Deleted Future	Provides daily document deletion totals for the specified number of days after the current date.
Cumulative Past	Provides cumulative, daily document creation totals for the specified number of days before the current date. Specifically, the information listed for each day represents storage totals for documents created that day, and all preceding days.
Cumulative Future	Provides cumulative daily DocuVault storage totals reflecting document deletion for the specified number of days after the current date. Specifically, this area uses DocuVault storage totals for the current date, then provides daily storage totals based on scheduled document deletions over the next specified number of days.

Data Omitted from the storage_prog Report

The storage_prog utility provides information related to storing documents and analyzing document creation and deletion activities. It does not provide information related to Cypress resources, as resources generally consume much less disk space. Resources omitted from the storage_prog report include these:

•

font storage and utilization

•

forms

•

index tables (i.e., system indexes, data indexes, full text indexes)

•

stock definitions

•

recipient definitions

•

device definitions

•

report (and subreport) definitions

Executing storage_prog

The storage_prog utility should be executed from a command prompt window on the Cypress Server, but may also be executed from a network-connected workstation when working with smaller DocuVaults. When working with larger DocuVaults, we recommend using storage_prog from the Cypress Server for faster performance. When you install Cypress, storage_prog is copied to this directory at the Cypress Server:

x:\cypress\server

where x is the appropriate drive letter.

To run the storage_prog utility

Enter this command:

storage_prog <num_of_days> <DocuVault name> <csv_file_name>

where

•

<num of days> corresponds to the number of days to sample.

•

<DocuVault name> corresponds to the name of the DocuVault that you wish to analyze.

•

<csv_file_name> corresponds to the path, name, and file extension of the comma-separated text file that storage_prog should create.

As of version 6.0, hyphens (-) and forward-slashes (/) are optional in command lines.

The <DocuVault name> parameter is case-sensitive, and if either the <DocuVault name> or <csv_file_name> parameters contain spaces, you should enclose the values in quotation marks.

If you do not specify a comma-separated text file name, storage_prog will write the output to the command prompt window instead of to a file.

For example, if you wish to create a storage report based on the past ten days of activity on the CompanyABC DocuVault and display the report in the command prompt window, you would enter this command:

storage_prog 10 CompanyABC

If you wish to create a storage report based on the past and future 30 days of activity on the Production 1 DocuVault and write the report to a storage_usage.csv file, you would enter this command:

storage_prog 30 “Production 1” d:\storage_usage.csv

Determining Monthly DocuVault Net Growth

The net growth of a DocuVault can be calculated by identifying the total amount of disk storage required to create and store documents over one month and subtracting the disk space resulting from scheduled document deletions.

To perform the calculation

Run storage_prog and analyze data for 30 days.

You should run this report at a time that will provide you with a representative sample of monthly activity. For example, your sample period should include all peak printing days, but avoid over-sampling (e.g., including peak print runs twice).

In the Created Past area of the storage_prog report, add all values in the DDOC_size column to determine the total disk space from document creation.

In the Deleted Future area of the storage_prog report, add all values in the DDOC_size column to determine total disk space to be regained.

Subtract the number you arrived at in step 2 from the number you arrived at in step 3. This will tell you how much your DocuVault has increased in size over the sample period.

Identifying Long-Term Disk Space Requirements

Disk space requirements may be estimated using Cumulative Past and Deleted Future totals from the storage_prog report.

To identify long-term disk space requirements

Run storage_prog, and enter a number of days that is representative of your normal document creation and deletion activity, such as 60. Be sure to specify a *.csv file that the report can be written to.

Open the .csv file in Excel. This formula describes how you can calculate the average amount that your DocuVault grows each day (Average Daily DocuVault Growth). This value considers all documents, JTICs, DTICs, and messages that are created and deleted every day.

To arrive at the Total Bytes Created Past number, look at Created Past area of the storage_prog report. Add each day’s values for DDOC_size, JTIC_size, DTIC_size, and MSG_size and create a grand total for the sample period.

To arrive at the Total Bytes Deleted Future number, look at the Deleted Future area of the storage_prog report. Add each day’s values for DDOC_size, JTIC_size, DTIC_size, and MSG_size and create a grand total for the sample period.

Next, subtract Total Bytes Deleted Future from Total Bytes Created Past, and divide that value by the number of days in the sample period to derive the Average Daily DocuVault Growth. In this sample, the Average Daily DocuVault Growth is 30MB.

Calculate your long-term storage requirements by multiplying the Average Daily DocuVault Growth by the number of days you wish to project. For example, if your ADDG is 30 MB and you want to determine how much disk space you’ll need in 5 years, you would estimate 55 GB of disk space. This is the formula:

Determining If Document Retention Times Are Set Correctly

You can quickly determine if documents are being retained as expected by examining the DDOC_cnt column within the Cumulative Past area.

If your goal is to minimize or disable archiving, the values should be minimal, or equal to zero.

If your goal is to archive a substantial number of documents, the values should be consistent with your expectations and progressively increase with time.

Determining the Size of an Average Document

Although there is no such thing as an average document, having a general understanding of your average document size can be very useful for predicting storage requirements for new applications, and for many other purposes.

To determine the average document size

Run storage_prog and analyze data for 180 days, or longer. Although a longer sample period typically produces more generalizable results, be careful not to over-sample, such as including year-end printing activities that would unfairly skew the data.

In the Created Past area, add all values in the DDOC_size column to determine the total disk space from document creation.

In the Created Past area, add all values in the DDOC_cnt to determine the total number of documents created in the sample period.

Divide the number you arrived at in step 1 by the number you arrived at in step 2. This will provide you with the average document size based on all documents created in your sample period.

This table defines each data field appearing in the storage_prog report. For added clarity, each field is defined separately as it pertains to each of storage_prog’s four report areas:

•

Created Past (actual daily creation totals in the past)

•

Deleted Future (scheduled daily deletion totals in the future)

•

Cumulative Past (actual daily storage totals in the past)

•

Cumulative Future (scheduled daily storage totals in the future)

Report Field	Report Area	Description
DocuVault Name	N/A	name of the specified DocuVault
Report Creation Date	N/A	date the report was created
Date	N/A	date for which the statistics on this line apply
DDOC_cnt	Created Past	number of documents created and stored in a DocuVault on this day
	Deleted Future	projected number of documents to be deleted from a DocuVault on this day
	Cumulative Past	number of documents stored in a DocuVault on this day
	Cumulative Future	projected number of documents that will be stored in a DocuVault on this day, based on current DocuVault storage and scheduled document deletions
Page_cnt	Created Past	number of pages created and stored in a DocuVault on this day
	Deleted Future	projected number of pages to be deleted from a DocuVault on this day
	Cumulative Past	number of pages stored in a DocuVault on this day
	Cumulative Future	projected number of pages that will be stored in a DocuVault on this day, based on current DocuVault storage and scheduled document deletions
DDOC_size (KB) Totals reflect document content, header data, and data index values on the page. Indexing tables are not reflected.	Created Past	total disk space needed to store documents created on this day
	Deleted Future	projected disk space regained on this day as a result of scheduled document deletions
	Cumulative Past	total disk space needed for document storage on this day
	Cumulative Future	projected disk space needed for document storage on this day, based on current DocuVault storage and scheduled document deletions
JTIC_cnt	Created Past	number of JTICs (job tickets) created and stored in a DocuVault on this day. This value will typically be “0” since most JTICs will already have completed or have been purged.
	Deleted Future	projected number of JTICs to be deleted from a DocuVault on this day
	Cumulative Past	total number of JTICs stored in a DocuVault on this day
	Cumulative Future	projected number of JTICs that will be stored in a DocuVault on this day, based on current DocuVault storage and scheduled JTIC deletions
JTIC_size (KB)	Created Past	total disk space needed to store JTICs created on this day
	Deleted Future	projected disk space regained on this day as a result of scheduled JTIC deletions
	Cumulative Past	total disk space needed to store JTICs on this day
	Cumulative Future	projected disk space needed to store JTICs on this day, based on current DocuVault storage and scheduled JTIC deletions
DTIC_cnt	Created Past	number of DTICs (document tickets) created in a DocuVault on this day
	Deleted Future	projected number of DTICs to be deleted from a DocuVault on this day
	Cumulative Past	number of DTICs stored in a DocuVault on this day
	Cumulative Future	projected number of DTICs that will be stored in a DocuVault on this day, based on current DocuVault storage and scheduled DTIC deletions
DTIC_size (KB)	Created Past	total disk space needed to store DTICs created on this day
	Deleted Future	projected disk space regained on this day as a result of scheduled DTIC deletions
	Cumulative Past	total disk space needed to store DTICs on this day
	Cumulative Future	projected disk space needed to store documents on this day, based on current DocuVault storage and scheduled DTIC deletions
MSG_cnt	Created Past	number of History Log messages created and stored in a DocuVault on this day
	Deleted Future	projected number of History Log messages to be deleted from a DocuVault on this day
	Cumulative Past	number of History Log messages stored in a DocuVault on this day
	Cumulative Future	projected number of History Log messages that will be stored in a DocuVault on this day, based on current DocuVault storage and scheduled History Log message deletions
MSG_size (KB)	Created Past	total disk space needed to store History Log messages created on this day
	Deleted Future	projected disk space regained on this day as a result of scheduled History Log message deletions
	Cumulative Past	total disk space needed to store History Log messages on this day
	Cumulative Future	projected disk space needed to store History Log messages on this day, based on current DocuVault storage and scheduled History Log message deletions