Description and syntax
The ARSADMIN program provides the following functions:
- Unload
- The Unload function can be used to delete the storage objects
and index data that were loaded into the system during input processing.
To use the Unload function, you must specify a load ID. The Load ID
represents the database rows and storage objects that were created
when an input file was loaded into the system.
To get a load ID, in the Windows client, right-click a report and get a partial load ID, then search in the system log for an
87message to find the full load ID.You would typically use the Unload function to manually remove an input file (report) from the system. You can also use the Unload function to delete data that was created during testing. You must specify the user ID of a user that is permitted to delete documents from the application group. The ARSADMIN program searches the system log for the specified Load ID. If the Load ID is not found in the system log, the unload will fail unless you specify the -Q parameter.
- Import
- The Import function
can be used to import migrated index data from archive storage to
the database. When Content Manager OnDemand determines
that a query requires index data that has been migrated to archive
storage, then a message is sent to stdout (UNIX servers) or the console (Windows servers) and saved in the system
log. An administrator must use the ARSADMIN program
to import the required table or tables into the database. After the
index data has been imported, the user can try the query again. Note: Importing migrated index data requires additional space in the database, additional log file storage, and additional temporary space.
- Store
- The Store function can be used to copy storage objects from one storage location to another. For example, you could copy a storage object from cache storage to a primary storage node.
- Retrieve
- The Retrieve function can be used to retrieve a storage object from a specified location. For example, you could retrieve a storage object from cache storage or a primary storage node. After retrieving a storage object, you could use the Decompress function to extract a specific document from the storage object file.
- Compress
- The Compress function is used to compress input files in preparation for creating storage
objects.The Compress function can also be used to estimate the amount of storage space required to store an input file in the system:
- To estimate the amount of storage required to load an input file that contains logical items, such as bills, invoices, or statements, first extract a representative sample of data from an input file. Then compress the sample with the -l parameter. Divide the size of the compressed output file by the number of bytes of input data that you compressed. The result is the compression ratio achieved.
- To estimate the amount of storage required to store an input file that contains transaction data, first extract a representative sample of data from an input file. Then compress the sample with the -l parameter. Divide the size of the compressed output file by the size of the input file. The result is the compression ratio achieved.
- Decompress
- The Decompress function can be used to extract a specific document from a storage object file. The document can then be sent to a printer or viewed with the appropriate viewing program. You must first create the storage object file with the Retrieve function. Storage objects whose applications are defined to use Large Object cannot be decompressed by using this command.
- ICU
- The ICU function converts a document from one code page to another code page. The icu function would be used if a document is stored in OnDemand in one code page and then is retrieved and uncompressed on a system that uses a different code page than what the document was stored in; the file would then need to be converted.
