ibm cognos command center plug-in for file utilities version

IBM Cognos Command CenterPlug-in for File UtilitiesVersion 10.2.0

User Guide

��

NoteBefore using this information and the product it supports, read the information in “Notices” on page 17.

Product Information

This document applies to IBM Cognos Command Center 10.2.0 and may also apply to subsequent releases.

Licensed Materials - Property of IBM

© Copyright IBM Corporation 2008, 2013.US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contractwith IBM Corp.

Contents

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v

Chapter 1. File utilities plug-in overview . . . . . . . . . . . . . . . . . . . . . . 1

Chapter 2. Installing the file utilities plug-in . . . . . . . . . . . . . . . . . . . . 3

Chapter 3. File utilities plug-in configuration . . . . . . . . . . . . . . . . . . . . 5

Chapter 4. File utilities plug-in task reference . . . . . . . . . . . . . . . . . . . 7

Notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

© Copyright IBM Corp. 2008, 2013 iii

iv IBM Cognos Command Center Plug-in for File Utilities Version 10.2.0: User Guide

Introduction

The guide provides information that is intended for users and administrators ofIBM® Cognos® Command Center®.

Audience

The guide assumes that the reader is knowledgeable about Cognos CommandCenter concepts and general use of the product. For more information, see the IBMCognos Command Center Administration Guide.

Finding information

To find IBM Cognos product documentation on the web, including all translateddocumentation, access the IBM Cognos Command Center Information Center(http://pic.dhe.ibm.com/infocenter/ccc/v10r2m0/index.jsp). Release notes arepublished directly to Information Centers, and include links to the latest technotesand APARs.

You can also access PDF versions of the product documentation from the productdisks or from the IBM Cognos Command Center documentation web page(http://www.ibm.com/support/docview.wss?uid=swg27039519).

Accessibility features

This product does not currently support accessibility features that help users witha physical disability, such as restricted mobility or limited vision, to use thisproduct.

Forward-looking statements

This documentation describes the current functionality of the product. Referencesto items that are not currently available may be included. No implication of anyfuture availability should be inferred. Any such references are not a commitment,promise, or legal obligation to deliver any material, code, or functionality. Thedevelopment, release, and timing of features or functionality remain at the solediscretion of IBM.

© Copyright IBM Corp. 2008, 2013 v

http://pic.dhe.ibm.com/infocenter/ccc/v10r2m0/index.jsp

http://www.ibm.com/support/docview.wss?uid=swg27039519

vi IBM Cognos Command Center Plug-in for File Utilities Version 10.2.0: User Guide

Chapter 1. File utilities plug-in overview

The file utilities plug-in provides a set of task types that perform standard fileoperations.

Compatibility

The file utilities plug-in is compatible with the following IBM Cognos CommandCenter components:

IBM Cognos Command Center Client10.1 or higher.

IBM Cognos Command Center Server10.1 or higher.

IBM Cognos Command Center Agent10.1 or higher on UNIX and the Microsoft Windows operating system.

On UNIX, a Java™ 1.6 environment must be available.

The plug-in requires a Java environment to be present on the agent hosts. OnWindows, the IBM Cognos Command Center 10.1 agent (or higher) comes withJava, and on UNIX, Java must be installed separately. For more information, seethe IBM Cognos Command Center Agent for UNIX Installation Guide.

© Copyright IBM Corp. 2008, 2013 1

2 IBM Cognos Command Center Plug-in for File Utilities Version 10.2.0: User Guide

Chapter 2. Installing the file utilities plug-in

You can install the IBM Cognos Command Center file utilities plug-in from themenu of the IBM Cognos Command Center client.

Procedure1. Click Tools > Manage Plugin Tasks.2. In the Manage Plugin Tasks window, select the File Utilities Plugin.x.x.zip

file in the INSTALLDIR\Plugins directory.3. Click Load file. After the plug-in is installed, the File Utilities task and related

tasks are available on the Add Task menu in the Process Editor.


Chapter 3. File utilities plug-in configuration

No special computing resource is required to use the tasks in the file utilitiesplug-in.


Chapter 4. File utilities plug-in task reference

The File Utilities tasks have arguments that you can specify.

Change encoding

The Change Encoding task changes the encoding of a text file. The result can bestored in a new file, or the source file can be overwritten.

Table 1. Task arguments for the Change Encoding task

Argument Description

Source file Name of the source file to be re-encoded.

Sourceencoding

The encoding of the source file.

The default value is Auto detect.

Target file Name of the target file to store the encoding in. Leave empty to overwritethe source file with the result.

Targetencoding

The encoding to use.

The default value is Unicode.

Checksum

The Checksum task calculates the checksum of a column in a file with the optionof filtering out rows that are based on the content of another column.

Table 2. Task arguments for the Checksum task


File name Name of the file to calculate the checksum for.

Delimiter The delimiter that separates columns.

The default value is Comma ','

Column The column number to sum. The first column is number 1.

The default value is 1.

Filter type The type of filter to apply. Leave as None to have no filter.

The default value is None

Filter column The column number to filter on. The first column is number 1.

Filterexpression

A regular expression for the filter to match.

Filterexpressionsyntax

The syntax for the filter expression. It is one of

v Exact finds exact matches.

v Glob uses the ? wildcard to specify any character and * to specify asequence of characters.

v Regular expression uses standard regular expression syntax for findingmatches.

The default value is Regular expression.


Table 2. Task arguments for the Checksum task (continued)


Ignore case If true, filter matching is case-insensitive.

The default value is True.

Copy

The Copy task copies files or directories on the server.

Table 3. Task arguments for the Copy task


Source The name of the files and directories to copy. Use the wildcard characters *and ? to specify multiple files or directories.

Destination The destination file or directory. When you copy multiple files, only adirectory is allowed.

Overwrite If checked, overwrite existing files. If cleared, the task exits withoutoverwriting existing files.

The default value is cleared.

Delete

The Delete task deletes files or directories.

Table 4. Task arguments for the Delete task


File name Name of the files and directories to delete. Use the wildcard characters *and ? to match multiple files or directories.

Recursive If checked, delete directories and their contents recursively. If cleared, thetask fails to delete a non-empty directory.


Force Force the deletion of the files. This option is similar to the "-f" option of theUNIX "rm" command.


Delete directory

The Delete Directory task deletes empty directories.

Table 5. Task argument for the Delete Directory task


Path Name of the directories to delete. Use the wildcard characters * and ? tomatch multiple directories.

Delete less days

The Delete Less Days task deletes files in directories that have not been modifiedin the last n days.


Table 6. Task arguments for the Delete Less Days task


Path The path to delete. Wildcards are allowed.

Days Files that have not been modified within this number of days are deleted.

Recursive If checked, delete directories and their contents recursively. If cleared, thetask fails to delete a non-empty directory.


Force Force the deletion of the files. This option is similar to the "-f" option of theUNIX "rm" command.

Detect Unicode

The Detect Unicode task determines whether a file is using one of the Unicodeencodings. Here is the list of Unicode encodings:v UTF-7v UTF-8v UTF-16v UTF-32

The task succeeds if the file is encoded in Unicode. Otherwise, the task returns theerror Not Unicode.

Table 7. Task argument for the Detect Unicode task


File name Name of the file to determine the encoding of.

Dir

The Dir task lists the content of a directory on the server.

Table 8. Task arguments for the Dir task


Directory The directory for which to list the contents.

Output format Format of the task output.

v Full includes header and summary information.

v Brief outputs only the matching file or directory names.

The default value is Full.

Extract List

The Extract List task extracts a list of values from a column-based file andoptionally filters the result that is based on values in a filter column. The file caneither have variable length columns that are delimited with a single characterdelimiter, or have fixed-length columns.

By capturing the output from this task in an extract list post task action, it ispossible to iterate over this list when you run a subsequent Iterate over list task inCognos Command Center.

Chapter 4. File utilities plug-in task reference 9

Table 9. Task arguments for the Extract List task


File name The name of the file to extract a list from.

Delimiter The column delimiter.

The default value is Tab.

Column The column to sum. The first column is numbered 1.


Column width The width of the column to select. Only used when the delimiter is fixedwidth.


Filter type Optional filter that specifies what rows to include or exclude from the sum.

The default value is None.

Filter column Optional filter column. First column is numbered 1. The value is ignored ifthe filter type is None.


Filter columnwidth

The width of the filter column to select. Only used when the delimiter isfixed width.


Filterexpression

Optional filter expression. Rows are included or excluded from the list thatis based on a match with this expression.

Filterexpressionsyntax

The syntax for the filter expression. It is one of





Suppressduplicates

If true, duplicate elements are removed from the list.

The default value is False.

Sort mode Specifies how the extracted list elements are sorted.

The default value is No sorting.

Ignore case If true, filter matching and record sorting are case-insensitive.

Filter by time

The Filter by Time task scans log files that are based on a time stamp. The taskreceives a time stamp and information about how to identify time stamps on eachlog line. It then skips lines from the file until it meets a line with a date that islater or equal to the supplied time stamp. This line and all remaining lines are thencopied into a destination file, creating a log snippet that can then be furtherinspected for error messages.


Table 10. Task arguments for the Filter by Time task


Input file The name of the file to scan.

Output file The name of the output file.

Allowoverwrite

If true, an existing output file is overwritten.


Time This parameter is the cutoff time and only files that follow the first linewith a date that is later or equal to this time are included in the output.

The time parameter can be given in one of the following formats:

v MM/dd/yyyy hh:mm:ss tt. For example 5/23/2012 02:23:0 AM

v MM/dd/yyyy hh:mm tt. For example 5/23/2012 02:23 AM

v MM/dd/yyyy HH:mm:ss. For example 5/23/2012 14:23:00

v MM/dd/yyyy HH:mm. For example 5/23/2012 14:23

For more information about these formats, see the description of theTimestamp format argument.

Typically, the $(Date) system variable is used. For example,$(Date{MM/dd/yy HH:mm})

The default value is $(Process [last].Start {MM/dd/yy HH:mm}).

Prefixexpression

An optional regular expression (using the standard Java regular expressionsyntax) for the string preceding the time stamp on each log line.

Prefixexpressionsyntax

The syntax for the prefix expression. It is one of





Ignore case If false, ignores the case of characters when you search for the prefixpattern.

The default value is True.


Table 10. Task arguments for the Filter by Time task (continued)


Timestampformat

The format of the time stamp on the log lines. The format is specified byusing a date and time pattern string.

v y - Year (2 or 4 digits).

v M - Month in year (1-12).

v MM - Month in year (01-12).

v MMM - Abbreviated month in year (Jan-Dec).

v MMMM - Month in year (January-December).

v d - Day in month (1-31).

v dd - Day in month (01-31).

v ddd - Abbreviated day in month (Mon-Sun).

v dddd - Day in month (Monday-Sunday).

v tt - AM/PM marker (AM, PM).

v H - 24 hour clock (0-23).

v HH - 24 hour clock (00-23).

v h - 12 hour clock (1-12).

v hh - 12 hour clock (01-12).

v m - Minute in hour (1-59).

v mm - Minute in hour (01-59).

v s - Second in minute (1-59).

v ss - Second in minute (01-59).

v zzz - Minutes and seconds offset from GMT (- 07:00).

v K - Time zone information (PST).

The format is a combination of pattern characters and separators like / - : .and space. For example, ddd MMM dd HH:mm:ss yyyy matches Mon Sep7 04:45:12 2012.


Timestampoffset

An optional time zone offset that can be added to the time stamps beforecomparison with the supplied time. This is useful if the time stamps in thefile are in a local time without any time zone information.


Contextlength

The number of lines that precede the first matching line that are to beincluded in the output.

For example, assume that the first matching line is the <time> element.

<log><severity>debug</severity><time>2012-07-21 23:12:01</time><message>Processed ’backup.scr’</message></log>

In this case, setting the context length to 2 causes the <log> and<severity> elements to be included in the output.



Find

The Find task searches for a text string in a file or in a set of files.

Table 11. Task arguments for the Find task


Files Specifies the file or set of files to search.

Pattern The text string to find.

Pattern syntax The syntax for the pattern.



v Regex uses standard regular expression syntax for finding matches.

The default value is Exact.

Case sensitive If false, ignores the case of characters when you search for the pattern.


Make directory

The Make Directory task creates a directory on the server.

Table 12. Task argument for the Make Directory task


Directory The name of the directory to create.

Move

The Move task moves files and directories on the server.

Table 13. Task arguments for the Move task


Source Name of the files or directories to move. Use the wildcard characters * and? to match multiple files or directories.

Destination The new location of the files or directories. When you move multipleitems, the destination must be a directory on the server.

Overwrite If checked, overwrite existing files. When cleared, the task exits withoutoverwriting existing files.


Replace

The Replace task searches for and replaces text in a file.

The result of the search and replace operation is either written to a new destinationfile, or the task can perform an in-file replacement that overwrites the source filewith the result.


You can search for and replace text in multiple files within a single task by usingwildcards. In this case, the task supports only in-file replacement, and thedestination file argument must be left empty.

Table 14. Task arguments for the Replace task


Source The name of the file to search. Use wildcards to specify multiple files.

Destination The name of the destination file. The task fails if the file exists.

Leave empty to perform an in-file replacement, overwriting the source file.

Allowoverwrite

If true, an existing destination file is overwritten.


Find The text string to find.

Replace The text string to insert at the matching locations.

Find syntax The syntax for the find pattern.



v Regex uses standard regular expression syntax for finding matches.

The default value is Exact.

Case sensitive If false, ignores the case of characters when you search for the pattern.


Tar

The Tar task creates a tar archive.

Table 15. Task arguments for the Tar task


Outputarchive

Name of the archive to create. If necessary, a ".tar" extension is added tothe name.

Source files Name of files or directories to add to the tar archive. Use semicolons orwildcards to specify multiple files or directories.

Overwrite If true, an existing archive is overwritten by this task.


Unzip

The Unzip task extracts a .zip or .gzip archive.

Table 16. Task arguments for the Unzip task


Archive The name of the archive to extract.

Destinationdirectory

The name of the directory to extract the archive to. The directory is createdif it does not exist.


Table 16. Task arguments for the Unzip task (continued)


Compression The compression format for the archive.

v Auto detect determines the compression format that is based on theextension.

v Gzip forces the format to .gzip regardless of the file extension.

v Zip forces the format to .zip regardless of the file extension.

The default value is Auto detect.

Overwrite If true, existing files are overwritten when you extract the archive.


Untar

The Untar task extracts a tar archive.

Table 17. Task arguments for the Untar task


Archive The name of the tar archive to extract.

Destinationdirectory

The name of the directory to extract the archive to. The directory is createdif it does not exist.

Overwrite If true, existing files are overwritten when you extract the archive.


Zip

The Zip task creates an archive. The compression format is derived from theextension of the output archive.

Table 18. Task arguments for the Zip task


Outputarchive

The name of the archive to create. The archive format is derived from thefile extension.

v gzip, .gz creates a .gzip archive.

v .zip,.z creates a .zip archive.

v .tgz creates a gzipped tar archive.

Source files The name of files or directories to add to the .zip file. Use semicolons orwildcards to specify multiple files or directories.

Overwrite If true, an existing archive is overwritten by this task.



Notices

This information was developed for products and services offered worldwide.

IBM may not offer the products, services, or features discussed in this document inother countries. Consult your local IBM representative for information on theproducts and services currently available in your area. Any reference to an IBMproduct, program, or service is not intended to state or imply that only that IBMproduct, program, or service may be used. Any functionally equivalent product,program, or service that does not infringe any IBM intellectual property right maybe used instead. However, it is the user's responsibility to evaluate and verify theoperation of any non-IBM product, program, or service. This document maydescribe products, services, or features that are not included in the Program orlicense entitlement that you have purchased.

IBM may have patents or pending patent applications covering subject matterdescribed in this document. The furnishing of this document does not grant youany license to these patents. You can send license inquiries, in writing, to:

IBM Director of LicensingIBM CorporationNorth Castle DriveArmonk, NY 10504-1785U.S.A.

For license inquiries regarding double-byte (DBCS) information, contact the IBMIntellectual Property Department in your country or send inquiries, in writing, to:

Intellectual Property LicensingLegal and Intellectual Property LawIBM Japan Ltd.19-21, Nihonbashi-Hakozakicho, Chuo-kuTokyo 103-8510, Japan

The following paragraph does not apply to the United Kingdom or any othercountry where such provisions are inconsistent with local law: INTERNATIONALBUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS"WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED,INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OFNON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULARPURPOSE. Some states do not allow disclaimer of express or implied warranties incertain transactions, therefore, this statement may not apply to you.

This information could include technical inaccuracies or typographical errors.Changes are periodically made to the information herein; these changes will beincorporated in new editions of the publication. IBM may make improvementsand/or changes in the product(s) and/or the program(s) described in thispublication at any time without notice.

Any references in this information to non-IBM Web sites are provided forconvenience only and do not in any manner serve as an endorsement of those Websites. The materials at those Web sites are not part of the materials for this IBMproduct and use of those Web sites is at your own risk.


IBM may use or distribute any of the information you supply in any way itbelieves appropriate without incurring any obligation to you.

Licensees of this program who wish to have information about it for the purposeof enabling: (i) the exchange of information between independently createdprograms and other programs (including this one) and (ii) the mutual use of theinformation which has been exchanged, should contact:

IBM Software GroupAttention: Licensing3755 Riverside DrOttawa, ON K1V 1B7Canada

Such information may be available, subject to appropriate terms and conditions,including in some cases, payment of a fee.

The licensed program described in this document and all licensed materialavailable for it are provided by IBM under terms of the IBM Customer Agreement,IBM International Program License Agreement or any equivalent agreementbetween us.

Any performance data contained herein was determined in a controlledenvironment. Therefore, the results obtained in other operating environments mayvary significantly. Some measurements may have been made on development-levelsystems and there is no guarantee that these measurements will be the same ongenerally available systems. Furthermore, some measurements may have beenestimated through extrapolation. Actual results may vary. Users of this documentshould verify the applicable data for their specific environment.

Information concerning non-IBM products was obtained from the suppliers ofthose products, their published announcements or other publicly available sources.IBM has not tested those products and cannot confirm the accuracy ofperformance, compatibility or any other claims related to non-IBM products.Questions on the capabilities of non-IBM products should be addressed to thesuppliers of those products.

All statements regarding IBM's future direction or intent are subject to change orwithdrawal without notice, and represent goals and objectives only.

This information contains examples of data and reports used in daily businessoperations. To illustrate them as completely as possible, the examples include thenames of individuals, companies, brands, and products. All of these names arefictitious and any similarity to the names and addresses used by an actual businessenterprise is entirely coincidental.

If you are viewing this information softcopy, the photographs and colorillustrations may not appear.


Trademarks

IBM, the IBM logo and ibm.com are trademarks or registered trademarks ofInternational Business Machines Corp., registered in many jurisdictions worldwide.Other product and service names might be trademarks of IBM or other companies.A current list of IBM trademarks is available on the Web at “ Copyright andtrademark information ” at www.ibm.com/legal/copytrade.shtml.

The following terms are trademarks or registered trademarks of other companies:v Microsoft, Windows, Windows NT, and the Windows logo are trademarks of

Microsoft Corporation in the United States, other countries, or both.v UNIX is a registered trademark of The Open Group in the United States and

other countries.v Java and all Java-based trademarks and logos are trademarks or registered

trademarks of Oracle and/or its affiliates.

Notices 19

http://www.ibm.com/legal/copytrade.shtml

http://www.ibm.com/legal/copytrade.shtml

ibm cognos command center plug-in for file utilities version

Documents