IBM Cognos Command Center Version 10.2.4: Administration Guidepublic.dhe.ibm.com/software/data/cognos/documentation/... · 2017-03-15 · IBM Cognos Command Center components

IBM Cognos Command CenterVersion 10.2.4

Administration Guide

IBM

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

Product Information

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

Licensed Materials - Property of IBM

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

Contents

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viiIBM Cognos Command Center components . . . . . . . . . . . . . . . . . . . . . . . . viiiSystem objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix

Chapter 1. What's new in IBM Cognos Command Center. . . . . . . . . . . . . . . 1New features in IBM Cognos Command Center version 10.2.4 . . . . . . . . . . . . . . . . . . . 1New features in IBM Cognos Command Center version 10.2.3 . . . . . . . . . . . . . . . . . . . 2New features in IBM Cognos Command Center version 10.2.2 . . . . . . . . . . . . . . . . . . . 7

REST API now added . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Integrating TM1 and Cognos Command Center using JavaTI . . . . . . . . . . . . . . . . . . 7New tasks for the IBM Cognos Business Intelligence plug-in . . . . . . . . . . . . . . . . . . 8New tasks available for the Cognos Command Center plug-in for Cognos TM1 10.2.2 . . . . . . . . . . 8

New features in IBM Cognos Command Center version 10.2.1 . . . . . . . . . . . . . . . . . . . 8IBM Cognos Business Intelligence plug-in . . . . . . . . . . . . . . . . . . . . . . . . 8Test operation for the email, TM1, Essbase 11, and IBM Cognos Business Intelligence plug-ins . . . . . . . 8New warning task state. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Modified task types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

New features in IBM Cognos Command Center version 10.2.0.1 . . . . . . . . . . . . . . . . . . 9Plug-in documentation in one location. . . . . . . . . . . . . . . . . . . . . . . . . . 9New plug-in available for Cognos Integration Server . . . . . . . . . . . . . . . . . . . . . 9New plug-in available for Oracle Essbase 11 . . . . . . . . . . . . . . . . . . . . . . . . 9New tasks available for the Cognos Command Center plug-in for Cognos TM1 . . . . . . . . . . . . 9Support for Oracle HFM 11.1.2.3 . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Chapter 2. IBM Cognos Command Center client . . . . . . . . . . . . . . . . . . 11Application toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Application menu bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

File menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Edit menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Tools menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Window menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Help menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Process overview and details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Setup and design . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Chapter 3. Automations setup and design . . . . . . . . . . . . . . . . . . . . 17Ecosystems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Environments and variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Computing resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Ecosystem audit log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Process properties and variables . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Adding, deleting, and reordering tasks . . . . . . . . . . . . . . . . . . . . . . . . . 25Task properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Setting a warning for a task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Task types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Email notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Process audit log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38File Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Triggers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Agents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Migrating to Cognos Command Center . . . . . . . . . . . . . . . . . . . . . . . . . . 47Migrating to Cognos Command Center by using Point and Run. . . . . . . . . . . . . . . . . 47Migrating to Cognos Command Center by using Upload Existing . . . . . . . . . . . . . . . . 48

© Copyright IBM Corp. 2008, 2017 iii

Migrating to Cognos Command Center by using Rewrite to Simplify . . . . . . . . . . . . . . . 48

Chapter 4. Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49Creating users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49Creating roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Chapter 5. Labels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Creating labels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Chapter 6. Export and import . . . . . . . . . . . . . . . . . . . . . . . . . . 53Exporting Cognos Command Center objects . . . . . . . . . . . . . . . . . . . . . . . . 55Importing Cognos Command Center objects . . . . . . . . . . . . . . . . . . . . . . . . 55

Chapter 7. Run and monitor automations . . . . . . . . . . . . . . . . . . . . . 57Running a process manually. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57Scheduling a process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Chapter 8. Cognos Command Center plug-ins . . . . . . . . . . . . . . . . . . . 59Installing the Cognos Command Center plug-ins . . . . . . . . . . . . . . . . . . . . . . . 59Setting up a computing resource in the Cognos Command Center server . . . . . . . . . . . . . . . 60Cognos Command Center plug-in for Cognos Business Intelligence. . . . . . . . . . . . . . . . . 60

IBM Cognos Business Intelligence plug-in configuration . . . . . . . . . . . . . . . . . . . 60IBM Cognos Business Intelligence plug-in task reference . . . . . . . . . . . . . . . . . . . 61

Cognos Command Center plug-in for Cognos Integration Server . . . . . . . . . . . . . . . . . 62IBM Cognos Integration Server plug-in configuration . . . . . . . . . . . . . . . . . . . . 62IBM Cognos Integration Server plug-in task reference . . . . . . . . . . . . . . . . . . . . 63

Cognos Command Center plug-in for email . . . . . . . . . . . . . . . . . . . . . . . . 63Email plug-in configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64Email plug-in task reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

Cognos Command Center plug-in for file utilities . . . . . . . . . . . . . . . . . . . . . . 65File utilities plug-in configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . 65File utilities plug-in task reference . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

Cognos Command Center plug-in for FTP . . . . . . . . . . . . . . . . . . . . . . . . . 75FTP plug-in configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76FTP plug-in task reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

Cognos Command Center plug-in for FTPS. . . . . . . . . . . . . . . . . . . . . . . . . 78FTPS plug-in configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79FTPS plug-in task reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

Cognos Command Center plug-in for Oracle EPM Monitoring . . . . . . . . . . . . . . . . . . 81Oracle EPM Monitoring plug-in configuration . . . . . . . . . . . . . . . . . . . . . . . 82Oracle EPM Monitoring plug-in task reference. . . . . . . . . . . . . . . . . . . . . . . 82

Cognos Command Center plug-in for Oracle Essbase 9 . . . . . . . . . . . . . . . . . . . . . 83Oracle Essbase 9 plug-in configuration . . . . . . . . . . . . . . . . . . . . . . . . . 83Oracle Essbase 9 plug-in task reference . . . . . . . . . . . . . . . . . . . . . . . . . 84

Cognos Command Center plug-in for Oracle Essbase 11 . . . . . . . . . . . . . . . . . . . . 95Oracle Essbase 11 plug-in configuration . . . . . . . . . . . . . . . . . . . . . . . . . 96Oracle Essbase 11 plug-in task reference . . . . . . . . . . . . . . . . . . . . . . . . . 96

Cognos Command Center plug-in for Oracle FDM . . . . . . . . . . . . . . . . . . . . . . 103Oracle FDM plug-in configuration . . . . . . . . . . . . . . . . . . . . . . . . . . 103Oracle FDM plug-in task reference . . . . . . . . . . . . . . . . . . . . . . . . . . 104

Cognos Command Center plug-in for Oracle HFM . . . . . . . . . . . . . . . . . . . . . . 108Oracle HFM plug-in configuration . . . . . . . . . . . . . . . . . . . . . . . . . . 108Oracle HFM plug-in task reference . . . . . . . . . . . . . . . . . . . . . . . . . . 109

Cognos Command Center plug-in for Oracle HFM 11.1.2.4 . . . . . . . . . . . . . . . . . . . 120Oracle HFM 11.1.2.4 plug-in configuration. . . . . . . . . . . . . . . . . . . . . . . . 120Important information for upgrading to the Oracle HFM 11.1.2.4 plug-in . . . . . . . . . . . . . 121Oracle HFM 11.1.2.4 plug-in task reference . . . . . . . . . . . . . . . . . . . . . . . 122

Cognos Command Center plug-in for Oracle Hyperion Planning . . . . . . . . . . . . . . . . . 129Oracle Hyperion Planning plug-in configuration. . . . . . . . . . . . . . . . . . . . . . 130Oracle Hyperion Planning plug-in task reference . . . . . . . . . . . . . . . . . . . . . 131

iv IBM Cognos Command Center Version 10.2.4: Administration Guide

Cognos Command Center reporting automation for QlikView plug-in . . . . . . . . . . . . . . . 136Reporting Automation for QlikView plug-in configuration . . . . . . . . . . . . . . . . . . 136Reporting Automation for QlikView plug-in task reference . . . . . . . . . . . . . . . . . . 137

Cognos Command Center for SFTP plug-in overview . . . . . . . . . . . . . . . . . . . . . 138SFTP plug-in configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138SFTP plug-in task reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

Cognos Command Center plug-in for system utilities . . . . . . . . . . . . . . . . . . . . . 141System utilities plug-in configuration . . . . . . . . . . . . . . . . . . . . . . . . . 141System utilities plug-in task reference . . . . . . . . . . . . . . . . . . . . . . . . . 141

Cognos Command Center plug-in for Cognos TM1 9.5.2 . . . . . . . . . . . . . . . . . . . . 143IBM Cognos TM1 9.5.2 plug-in configuration . . . . . . . . . . . . . . . . . . . . . . . 144IBM Cognos TM1 Plug-in task reference . . . . . . . . . . . . . . . . . . . . . . . . 144

Cognos Command Center plug-in for Cognos TM1 10.2.2 . . . . . . . . . . . . . . . . . . . 146IBM Cognos TM1 10.2.2 plug-in configuration . . . . . . . . . . . . . . . . . . . . . . 146IBM Cognos TM1 10.2.2 Plug-in task reference . . . . . . . . . . . . . . . . . . . . . . 147

Chapter 9. IBM Cognos Command Center Command Line Client . . . . . . . . . . 153What's new in the command line client. . . . . . . . . . . . . . . . . . . . . . . . . . 153

New features in version 10.2.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153New features in version 10.2.0.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . 153New features in version 10.2.2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154New features in version 10.2.3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156List of Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156Common Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157Return values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157

Command reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157Export. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158Export file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158Import file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159List plugins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160Load plugins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160Pause . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160Purge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161Set-schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162Stop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162Test. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

Chapter 10. IBM Cognos Command Center Web Client . . . . . . . . . . . . . . 165Web client overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

Chapter 11. IBM Cognos Command Center Web Services . . . . . . . . . . . . . 167What's new?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167Configuring the Web Services interface . . . . . . . . . . . . . . . . . . . . . . . . . . 167

Security for the Web Services interface . . . . . . . . . . . . . . . . . . . . . . . . . 168Service reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168

PauseProcess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168QueryProcess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169ResumeProcess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169StartProcess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170StopProcess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170

Web Services Description Language . . . . . . . . . . . . . . . . . . . . . . . . . . . 170Testing the Web Services interface . . . . . . . . . . . . . . . . . . . . . . . . . . . 171Using the Cognos Command Center REST API . . . . . . . . . . . . . . . . . . . . . . . 172

Configuring Cognos Command Center for the REST API . . . . . . . . . . . . . . . . . . . 172Cognos Command Center HTTP request structure . . . . . . . . . . . . . . . . . . . . . 172Cognos Command Center HTTP response structure . . . . . . . . . . . . . . . . . . . . 173Cognos Command Center REST authentication . . . . . . . . . . . . . . . . . . . . . . 173

Contents v

Cognos Command Center REST command reference . . . . . . . . . . . . . . . . . . . . 174

Chapter 12. IBM Cognos Command Center samples. . . . . . . . . . . . . . . . 189Importing the Cognos Command Center samples . . . . . . . . . . . . . . . . . . . . . . 189

Chapter 13. Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . 191IBM Cognos Command Center log files . . . . . . . . . . . . . . . . . . . . . . . . . 191Software version information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

Viewing the version number of an agent . . . . . . . . . . . . . . . . . . . . . . . . 191

Notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197

vi IBM Cognos Command Center Version 10.2.4: Administration Guide

Introduction

Cognos® Command Center® provides a centralized, fully integrated, secure, andextensible environment for automating informatics systems.

It reduces maintenance costs and simplifies workflow processes by providing asingle managed repository for the script files that are deployed throughout your ITinfrastructure.

The key features and benefits of Cognos Command Center include the following:v A secure user interface with user access management.v A complete event history of all automation activities.v A centralized repository of all automation artifacts, including different versions.v A single point of view for all alerts, diagnostics, and application event logs.v Scheduling and monitoring of tasks across applications, servers, and operating

systems.v Smartphone and web browser user interfaces for process monitoring and control.

Audience

The Administration Guide provides detailed product concepts and information thatis intended for users and administrators of IBM® Cognos Command Center.

The guide assumes that the reader is knowledgeable about Cognos CommandCenter concepts and general use of the product.

The administration guide does not cover product installation or other configurationinformation as it relates to RDBMS systems. A number of features requireconfiguration for your specific system. For more information, see the PostInstallation Configuration chapter in the IBM Cognos Command Center InstallationGuide.

Finding information

To find product documentation on the web, including all translateddocumentation, access IBM Knowledge Center (http://www.ibm.com/support/knowledgecenter).

You can also access PDF versions of the product documentation from the IBMCognos Command Center documentation web page (http://WWW.ibm.com/support/docview.wss?uid=swg27047151).

Accessibility features

IBM Cognos Command Center does not currently support accessibility featuresthat help users with a physical disability, such as restricted mobility or limitedvision, to use this product.

© Copyright IBM Corp. 2008, 2017 vii

http://www.ibm.com/support/knowledgecenter

http://WWW.ibm.com/support/docview.wss?uid=swg27047151

http://WWW.ibm.com/support/docview.wss?uid=swg27047151

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.

IBM Cognos Command Center componentsIBM Cognos Command Center software components include the server, therepository, agents, user interfaces, and the active message queue.

Server The central component of IBM Cognos Command Center. It handles all theprocessing logic, scheduling, event listening, and connections to thevarious agents, the repository, and alert email servers.

RepositoryA relational database that holds all system data, event history, and securityinformation. The repository can be co-hosted on the server computer or ona different server.

AgentsSmall footprint programs that are installed on all computers that runprocess tasks.

User InterfacesInclude a Windows client interface and a browser interface. The client isthe primary interface for users and administrators of Cognos CommandCenter. The Windows client provides full design, administration, andmonitoring features. You can use the browser version to run and monitorprocesses.

Active Message QueueHandles communication between the Cognos Command Center server andagents and is a key component in a high availability configuration.

IBM Cognos Command Center also provides integration with SMTP servers toprovide email alert integration and event-based processing of automation requests.

The following graphic shows the IBM Cognos Command Center components.

viii IBM Cognos Command Center Version 10.2.4: Administration Guide

System objectsIBM Cognos Command Center objects include ecosystems, computing resources,agents, file resources, and processes

EcosystemsDefine a set of computing resources, environment variables, processes, andfile resources. An ecosystem makes it easy to organize your system intoresources that are shared or that need a common layer of security access.Each ecosystem can be defined with one or more environments so that youcan further organize your system.

Computing ResourcesAn operating system or application interface that uses agents to runautomation tasks. Scripts, plug-in tasks, executable files, or specificapplications are associated with each computing resource type.

AgentsA small footprint software application that is installed on each computerwhere automation processes are to be run.

File ResourcesReusable file-like objects that contain scripts, batch files, executable files,archives, or any text or data that is loaded into the repository.

ProcessesA group of automation tasks, such as the execution of a script, that can berun manually or according to a schedule.

Figure 1. IBM Cognos Command Center components

Introduction ix

Access to Cognos Command Center system objects is managed by user levelsecurity. Each user is assigned one or more roles. Each role defines access toenvironments, processes, and file resources.

The following shows examples of three ecosystems.

Cognos Command Center User Interfaces

The IBM Cognos Command Center provides two interfaces: a Windows client, anda web client.

The Windows client is the primary user application for users and administrators.

You can use the web client to run and monitor automation processes from moststandard browsers and smartphones. For more information, see the IBM CognosCommand Center Web Client User Guide.

Figure 2. Examples of three Cognos Command Center ecosystems

x IBM Cognos Command Center Version 10.2.4: Administration Guide

Chapter 1. What's new in IBM Cognos Command Center

To plan your upgrade and deployment strategies and the training requirements foryour users, learn what features are new, changed, deprecated, or removed.

For information about new features in past releases, if available, access IBMKnowledge Center (http://www.ibm.com/support/knowledgecenter).

For information about upgrading, see the IBM Cognos Command Center InstallationGuide.

For an up-to-date list of environments that are supported by IBM Cognos products,including information about operating systems, patches, browsers, web servers,directory servers, database servers, and application servers, see the SupportedSoftware Environments page (http://www.ibm.com/support/docview.wss?uid=swg27047154).

New features in IBM Cognos Command Center version 10.2.4In Cognos Command Center version 10.2.4, there are several new features.

The Command Line Client, Web Client, and Web Services UserGuides are now incorporated in the Administration Guide

In previous versions, information about the command line client, web client, andweb services was contained in separate user guides. This information is nowconveniently located in the Administration Guide.

For more information, see Chapter 9, “IBM Cognos Command Center CommandLine Client,” on page 153, Chapter 10, “IBM Cognos Command Center WebClient,” on page 165, and Chapter 11, “IBM Cognos Command Center WebServices,” on page 167.

No need for Command Center agents in the Cloud to call back tothe on-premises message queue

To eliminate the opening of a port in the on-premises firewall, the CCQueue inIBM Cloud now resides next to the CCAgent. This results in the on-premisesCCServer and Cloud CCAgent having access to the CCQueue in IBM Cloud.

TM1® 10.2.2.2 plug-in adds operations that provide TM1 objectsto TM1 task input fields

The way the task fields in the TM1 10.2.2.2 plug-in are completed has beensimplified.

For more information, see “Cognos Command Center plug-in for Cognos TM110.2.2” on page 146.

The Java™ version is updated

In this release, Java is updated to version 1.8.

© Copyright IBM Corp. 2008, 2017 1



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

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


Export and importing

You can now include agents in your exports, making it easier to export a completeCommand Center environment. For more information, see Chapter 6, “Export andimport,” on page 53.

The following graphic shows how you can select items to export, such as agents orecosystems, in the Select Export Items box.

2 IBM Cognos Command Center Version 10.2.4: Administration Guide

New task actions

There is a new Extract string from variable pre- and post-task action. Use thisaction to select a substring from a variable using the same criteria as for theExtract string from output post-task action.

The following graphic shows how you can select the Target variable to set theExtract string in the Task Action Properties box.

Figure 3. An example showing Export agents selected

Chapter 1. What's new in IBM Cognos Command Center 3

There is also a new Send Email post-task action.

The following graphic shows how you can specify an action and an addressee inthe Task Action Properties box.

Figure 4. An example of the Extract string from variable task action


For more information, see the Operation types table in “Task properties” on page26.

System management task enhancements

There is a new system management task, List Audit Log, that you can use toinclude audit information in your automations.

The following graphic shows how you can specify design actions, process runactions, and object types to audit.

Figure 5. An example of the Send mail task action


For the List Object Permissions and List User Access system management tasks,you can now include permissions and user role information in the task output.

For more information, see “System Management tasks” on page 35.

Figure 6. An example of the List Audit Log system management task

Figure 7. An example of the List User Access output


Plug-in changes

A new plug-in for FTPS (FTP over SSL) has been added to Command Center,making to easy to exchange information between cloud and on-premise systems.For more information, see “Cognos Command Center plug-in for FTPS” on page78.

A new plug-in for Oracle HFM 11.1.2.4 has been added to Command Center. Formore information, see “Cognos Command Center plug-in for Oracle HFM 11.1.2.4”on page 120.

Attention: Regarding the TM1 9.5.2 plug-in: because the end of service for TM19.5.2 is 30 September 2015, TM1 9.5.2 is no longer supported, but only TM1 10.1and up.

Command Line Client

The option to export agents and the option to export users and roles have beenadded to the Export command.

Also, a new set-schedule command to enable or disable one or more schedules hasbeen added.

For more information, see the Command Line Client User Guide.


REST API now addedThe Cognos Command Center REST API is now added.

Use this API to send HTTP Secure (HTTPS) requests to the Cognos CommandCenter server to run the following Cognos Command Center tasks:v Logging on to, and off from, the Cognos Command Center server.v Retrieving all ecosystems, environments, and processes available to the currently

logged on user.v Retrieving all process variables for a process.v Retrieving the last run of a process.v Starting a new run of a process.v Retrieving, restarting, pausing, or stopping a specific process run.

For more information, see the IBM Cognos Command Center Web Services User Guide.

Integrating TM1 and Cognos Command Center using JavaTIIf you have the required skills, you can create an action button in IBM CognosTM1 to control Cognos Command Center processes.

For more information, see the topic Integrating TM1 and Cognos Command Centerusing JavaTI (https://www.ibm.com/developerworks/community/wikis/home?lang=en#!/wiki/c3887f55-5ade-474e-a00b-94cd34f5ef45/page/07fceb18-906f-4a2a-8861-a368ff684847) on the IBM developerWorks website.


https://www.ibm.com/developerworks/community/wikis/home?lang=en#!/wiki/c3887f55-5ade-474e-a00b-94cd34f5ef45/page/07fceb18-906f-4a2a-8861-a368ff684847

https://www.ibm.com/developerworks/community/wikis/home?lang=en#!/wiki/c3887f55-5ade-474e-a00b-94cd34f5ef45/page/07fceb18-906f-4a2a-8861-a368ff684847

New tasks for the IBM Cognos Business Intelligence plug-inAdditional tasks have been added to the IBM Cognos Business Intelligence plug-in.

For more information, see “Cognos Command Center plug-in for Cognos BusinessIntelligence” on page 60.

New tasks available for the Cognos Command Center plug-infor Cognos TM1 10.2.2

In 10.2.2, there are two TM1 plug-ins: IBM Cognos TM1 9.5.2 and IBM CognosTM1 10.2.2. New tasks have been added to the plug-in for Cognos TM1 10.2.2.

The IBM Cognos TM1 9.5.2 plug-in supports the same tasks as Cognos CommandCenter 10.2.1 and covers TM1 versions without the TM1 REST API. The TM1 10.2.2plug-in is introduced in Cognos Command Center 10.2.2 and covers only RESTAPI TM1 installations.

Task types have been added for filtering logs, reading and writing cell data,checking the TM1 server, and more.

For more information, see “Cognos Command Center plug-in for Cognos TM110.2.2” on page 146.


IBM Cognos Business Intelligence plug-inAn IBM Cognos Business Intelligence plug-in has been added. The plug-inprovides a set of task types for the automation of common Cognos BI tasks.

For more information, see “Cognos Command Center plug-in for Cognos BusinessIntelligence” on page 60.

Test operation for the email, TM1, Essbase 11, and IBMCognos Business Intelligence plug-ins

You can now quickly determine that the computing resource configuration is valid.

The following plug-ins now have a Test button on the Computing Resource tab inthe Ecosystem Editor:v Essbase 11 plug-inv Email plug-inv TM1 plug-inv Cognos BI plug-in

New warning task stateThe Warning state uses a new state icon to display that a task or processcompleted with success, but that there may be an issue worth investigating.

A new post-task action is added to the process and task states, such as Running,Completed, Failed, and Paused. For more information, see “Setting a warning for atask” on page 29.


Modified task typesSeveral task types in IBM Cognos Command Center have been modified.v In earlier versions of Cognos Command Center, you could not run a process that

prompts for variables because the Run Process task type did not allow variables.The Run Process task type now has a Process parameters attribute that consistsof a list of {name, value} pairs.For more information, see the Run process section in “Task types” on page 30.

v In the System Utilities plug-in, there is a new action in the Manage WindowsService task type in addition to Start and Stop - the Forced Stop action.Sometimes the Windows service does not stop because the underlying Windowsprocess is not stopping. The stop command fails (and the Windows Serviceenters a Stopping state). In this case, you can use Forced Stop to find the processID for this process and activate the Windows taskkill command.For more information, see “System utilities plug-in task reference” on page 141.

New features in IBM Cognos Command Center version 10.2.0.1In Cognos Command Center version 10.2.0.1, there are five new features: a singlelocation for plug-in documentation, a new plug-in for Cognos Integration Server, anew plug-in for Oracle Essbase 11, new tasks for the Cognos Command Centerplug-in for Cognos TM1, and plug-in support for Oracle HFM 11.1.2.3.

Plug-in documentation in one locationIn previous versions, each plug-in had its own separate document. The informationfrom the separate documents is now incorporated in the Administration Guide.

You can find the plug-in documentation here: Chapter 8, “Cognos CommandCenter plug-ins,” on page 59.

New plug-in available for Cognos Integration ServerYou can now use a plug-in to run Cognos Integration Server selections from withinIBM Cognos Command Center.

For more information, see “Cognos Command Center plug-in for CognosIntegration Server” on page 62.

New plug-in available for Oracle Essbase 11A new Oracle Essbase 11 plug-in has been added, providing a set of task types forthe automation of common Essbase tasks.

The existing Oracle Essbase plug-in is renamed to the Cognos Command Centerplug-in for Oracle Essbase 9.

For more information, see “Cognos Command Center plug-in for Oracle Essbase11” on page 95.

New tasks available for the Cognos Command Center plug-infor Cognos TM1

New tasks have been added to the plug-in for Cognos TM1.

New task types have been added allowing TM1 chores to be run as a task, plusmore task types for listing and deleting various kinds of server objects.


For more information, see “IBM Cognos TM1 Plug-in task reference” on page 144.

Support for Oracle HFM 11.1.2.3The Cognos Command Center plug-in for Oracle HFM plug-in is split into twoplug-ins, and now supports Oracle HFM 11.1.2.3.


Chapter 2. IBM Cognos Command Center client

The IBM Cognos Command Center client is a Windows-based user interface thatyou can use to define, maintain, and manage the entire system.

In addition to the client, there is a browser-based user interface for running andmonitoring your processes. For more information, see Chapter 10, “IBM CognosCommand Center Web Client,” on page 165.

Attention: The ability for a user to view or edit system objects or run processes iscontrolled by user-level security. Depending on your user credentials, you mightnot be able to access some of the elements that are described in this document.

The client has a navigation tree on the left and a dual-mode multi-documentworkspace on the right. For ease of use, the workspace can be set to view in tabmode or in Windows Multiple Documents Interface mode.

Tab mode has the following interactivity:v Tabs can be dragged to new locations on the tab control.v Tabs can be closed with the [x] icon.v Tabs have a pop-up menu.

In Windows Multiple Document Interface mode, the user interface is composed ofthe following components:

Menu BarAn application menu for file, edit, tools, and help operations.

Tool Bar A set of buttons above the workspace pane for common user activity.

Workspace PaneThe right pane has tabs or windows, depending on the mode you select,for editing and viewing system objects.

Navigation PaneThe left pane has a navigation tree for selecting system objects. These itemsalso have right-mouse pop-up menus.

The navigation tree has four root folders for system design and management, eachwith a hierarchy of subobjects. By clicking the expand or contract icons, you cansee a list of the objects that belong to each component. You can double-click objectnodes, such as ecosystem, agent, process, user, to open for viewing and editing.You can also right-mouse click any item in the tree for pop-up menu operations,such as creating a new object, copying, and deleting.

The four system areas:

Process OverviewRuns, schedules, and monitors defined processes.

Setup and DesignCreates, edits, and maintains ecosystems, processes, file resources, triggers,and agents.


SecurityCreates, edits, and maintains users and system access roles.

Labels Creates and manages specific snapshots of selected system automationobjects.

Application toolbarThe application toolbar contains a set of tool icons that provide easy access tocommon user activities.

The following table describes the tool icons:

Table 1. Tool icons

Item Description

Creates an object. This command is enabled when an object folder is selected,for example the Users folder.

Saves an edited or new object. This command is enabled when an edited or newobject is selected.

Cancels editing an object. This command is enabled when an edited or newobject is selected. Cancel reloads the original object data and updates the userinterface.

Imports a previously saved export file.

Exports automation objects to an external file.

Sets the application to tab mode.

Sets the application to window mode.

Sets focus to the last viewed tab or window. Similar to a web browser back iconand useful for jumping back and forth between items.

Sets focus to the next viewed tab or window. Similar to a web browser forwardicon and useful for jumping back and forth between items.

Application menu barThe application menu contains five items to help you work with IBM CognosCommand Center.

File High-level system operations.

Edit Common edit operations for text and system objects.

Tools System configuration and log activities.

WindowControls for the workspace mode and a list of all open documents andviewers.

Help License and help activities.

File menuThe File menu contains high-level items that perform operations on system objectsand the application.


New Creates an object of the type that is selected in the application navigationtree.

Save Saves the focused object.

Save AsSaves a copy of the focused object with a new name.

RenameRenames the focused, non-edited, object.

Export Exports a subset of your implementation to an external file.

ImportImports a previously saved export file.

Exit Exits the application.

Edit menuYou can use the Edit menu to perform common editing operations.

Cut Cuts the selected text or navigation object, placing it on the Windowsclipboard.

Copy Copies the selected text or navigation object to the Windows clipboard.

Paste Pastes the contents of the clipboard to the selected text field or objectfolder in the navigation tree.

Attention: You can cut a process or trigger from one ecosystem and pasteit into another one. If the paste operation fails, the process or trigger is stillin the paste buffer, so you can repaste the process or trigger back into theoriginal ecosystem.

Delete Deletes the selected text or navigation object.

Tools menuThe Tools menu provides a set of windows for configuring, controlling, auditing,and monitoring the IBM Cognos Command Center server.

System ConfigurationUse to manage IBM Cognos Command Center server configurationsettings:v Authentication defines settings for using an external user authentication

server, like an LDAP server, instead of the embedded system.v Email defines required settings to enable email alerts from the IBM

Cognos Command Center server.v Event Listener defines settings to enable an outside application to start,

stop, or pause IBM Cognos Command Center processes. Only relevant ifyou purchase the Event Listener license option.

v General defines miscellaneous server and system settings.v Queue defines settings for IBM Cognos Command Center server failover.

Only relevant if you purchase the High Availability Server licenseoption.

v Web Service Listener defines settings that enable the IBM CognosCommand Center server web services.

Chapter 2. IBM Cognos Command Center client 13

Manage Event ListenerUse to view any request activity for IBM Cognos Command Center processrequests that come from applications that use the Event Listener interface.

Manage Plugin TasksUse to view, add, and delete plug-in task packages.

System LogUse to view the IBM reg Server log. This log is a diagnostic tool for IBMCognos Command Center server problems and is used to view serverruntime activity.

System Audit LogUse to view the system audit log. Lists all audited activity and provides anextensive set of filters.

Window menuYou can use the Window menu to view and set the workspace user interface style.

Tab ViewUse to toggle the workspace between Tab and Windows mode.

Windows ViewUse to switch the workspace into Windows mode with one of theseoptions:v Cascadev Tile Verticallyv Tile Horizontally

Open Workspace ViewsThis is a list of all open workspace views. You can select one these viewsto bring it into focus.

Help menuUse the Help menu to find information about your IBM Cognos Command Centerinstallation.

Help ContentsUse to access this administration guide.

Manage LicenseUse to view the IBM Cognos Command Center license status.

About Shows the product information.

Process overview and detailsYou can use the Process Overview tab to run, schedule, and monitor IBM CognosCommand Center processes. User access rights define the processes in the tab.

You can use filters to define the subset of items that you are interested in.

Process Filters the page content to a specific ecosystem, environment, or process.

Status Filters page content to one or more status values.

Run Filters page content that is based on whether processes are scheduled ornot scheduled.


The following table shows the buttons on the tab that control the selected process.

Table 2. Tab control icons

Icon Description

Starts an inactive process or resume a paused process.

Pauses an active process.

Stops an active or paused process.

The following table shows the color coded icons in the first column that you canuse to quickly visualize the process status.

Table 3. Process status icons

Icon Description

The last run of the process failed.

The last run of the process was manually canceled.

The current run of the process is paused because of a potential failurecondition or a manual intervention.

The last run of the process succeeded.

The process is running.

The process has never been run.

The last run of the process completed successfully, but one or more taskscompleted with a warning.

You can click a process link name or double-click a process name in the navigationtree to view process run details.

The following table shows the items found in the page header of the process.

Table 4. Items in the process page header

Item Description

EnvironmentTabs(optional)Opens theschedulewindow forthis process.

For multi-environments ecosystems, each environment is represented by atab. Tabs are not present for single-environment ecosystems.

Run detailsdata

Start or resume, pause, and stop.

Controlbuttons

The current run of the process is paused because of a potential failurecondition or a manual intervention.

Edit Opens the editor for this process.

Schedule Opens the schedule window for this process.

The main page contains the following tabs:

Chapter 2. IBM Cognos Command Center client 15

Run detailsShows a tree and table of detailed task by task results from the latest runof the process.

The lower part of the view shows information for the currently selectedtask.

Run history Shows all runs of this process. The Started column has links to a ProcessDetails window that provides specifics about the run and its auditinformation.

Setup and designYou can use the Setup and Design tab to create, edit, and manage automationobjects that are used by the IBM Cognos Command Center server.v Ecosystems contain processes and file resources.v Agents are used by all ecosystems.


Chapter 3. Automations setup and design

The most important step in setting up IBM Cognos Command Center automationsis to decide how you want to organize your automation systems into ecosystemsand environments.

This design is influenced by, and affects, how you define processes, how thelifecycle of automations is managed and how to define security roles for yourusers.

A key first question to answer is how to set up Cognos Command Center to dealwith the development, test, and production instances of your applications. You canmanage these instances in one of two ways, depending on your own company'spolicies on how systems are managed:v A single IBM Cognos Command Center server automates across all instances of

development, test, and production servers.v A boundary or firewall exists between development, test, and production

servers. In this case, a separate Cognos Command Center server installation isrequired for Production, and one or more extra Cognos Command Centerservers can be installed to handle development and test server instances.

Single-server instance

When a single Cognos Command Center server is used to manage acrossdevelopment, test, and production instances of your systems, then there are twodesign options for ecosystems and environments. The first design option is todefine development, test, production environments for each ecosystem.

For example, the following graphic shows a single-server design option forecosystems and environments.


Because each Cognos Command Center process and file resource is shared acrossevery environment of an ecosystem, this configuration is the simplest to deploy.For example, the current version of a process that is called Backup can be runagainst either development or test or production instances. The shortcoming of thisdesign, however, is that it does not allow for sand-boxing and testing changes thatare made to processes or file resources. When a change is made to the Backupprocess, it is immediately shared across development, test, and productioninstances.

An alternative design would be to have a separate ecosystem for development andproduction instances.

For example, the following graphic shows a single-server design option with aseparate ecosystem for development and production instances.

Figure 8. Example of a single-server design option for ecosystems and environments


In this example, an ecosystem that is called FinPlan is defined as multipleecosystems: FinPlanDev, and FinPlanProd. You can use this separation to changethe process and file resources in the development environment, then test and verifythat everything works as expected. After the process and file resource objectschanges are verified, then you can copy and paste these ecosystems into yourproduction environment.

Multiple-server instances

In this case, a separate Cognos Command Center server is installed for each ofyour development, test, and production instances.

Figure 9. Example of a single-server design option

Chapter 3. Automations setup and design 19

The following graphic shows a multiple-server design option with a separateCognos Command Center server installed for each development, test, andproduction instance.


You can use this separation to change process and file resources on thedevelopment and test servers, and verify that everything works as expected. Afterthe process and file resource objects changes are verified, then you can copy these

Figure 10. Example of a multiple-server design option


objects onto the production server by using the export and import feature ofCognos Command Center.

EcosystemsAn ecosystem encapsulates a set of computing resources, environment variables,processes, and file resources.

Ecosystems make it easy to organize your system into resources that are shared orneed a common layer of security access. Each ecosystem is defined with one ormore environments, giving you the option to share resources across workspaceboundaries.

Environments are subentities of an ecosystem and every ecosystem has at least oneenvironment. An environment defines a real or virtual machine instance whereIBM Cognos Command Center agents are installed and processes are run. Thetypical use of multiple environments is to create separate production, QA, anddevelopment environments within an ecosystem. Combined with the use ofenvironment variables, IBM Cognos Command Center offers a powerful way todefine a single file resource or process that is shared across multiple environments.

To manage ecosystems, you use the IBM Cognos Command Center Windows userinterface. Select the Ecosystems folder in Setup and Design. You can either add anew ecosystem with the toolbar icon or view/edit an existing one bydouble-clicking an ecosystem name.

The ecosystem UI has three tabs:

Properties Name, description, environments editor, and environment variables table.

Computing resourcesEditor to manage and define the computing resources and their properties.

Audit logRevision list for the ecosystem.

Environments and variablesEnvironments and environment variables are the fundamental components of anecosystem.

You can use an environment to subgroup and share automation objects within anecosystem. For example, an ecosystem might contain environments fordevelopment, test, and production. You can use environment variables todynamically substitute values into processes and tasks. Typically, an environmentvariable is propagated to reduce the number of scripts and processes that wouldotherwise contain hardcoded values.

When you create or edit an ecosystem, you can define environments and variables.

Use the Add icon

and Delete icon

to manage the list of environments.

Attention: When you add an environment, you must define its computingresource properties in the computing resources tab.


Variables are expanded just before the IBM Cognos Command Center serverstreams task definitions and file resources to agents. The syntax for using avariable is $(VarName). Variables can be nested recursively. As an example if youhave two variables.

FIRST = A

SECOND = x$(FIRST)x

Then $(SECOND) is expanded to xAx.

The following properties can be set for environment variables:

EncryptSetting the Encrypt property causes the values in the IBM CognosCommand Center repository to be encrypted. Typically, you would encryptpasswords or other sensitive data. Encrypted text is not visible to usersthat have read-only access to the system.

PromptSetting the Prompt property makes the variable a required input fieldwhen a process in this ecosystem is manually run. For example, a promptfor Password and Host opens when the user manually starts the ListDirectory process.

Variable Value by Environment nameThe values that are substituted at run time into various objects that refer tothe variables.

Computing resourcesComputing resources are an operating system or application interface that use IBMCognos Command Center agents to run automation tasks.

Scripts, plug-in tasks, executable files, or specific applications are associated toeach computing resource type.

Click the Computing Resources tab in an ecosystem editor.

You can add a computing resource with the add icon

or view and edit anexisting one by selecting a computing resource name in the list.

For new computing resources, enter a name and select a resource type. Theresource type defines the category of computing resource that is available for yourprocess tasks. The default type for IBM Cognos Command Center is Host; thisdefines a basic agent that runs scripts and executable files on the host operatingsystem. Other available resource types depend on your particular IBM CognosCommand Center installation and installed task plug-ins.

Agent Defines the agent to be used for each environment that is defined for theecosystem.

Misc PropertiesEach computing resource type has a predefined list of required or optionalproperties. These properties may vary for each environment so must befilled in accordingly.


Ecosystem audit logThe audit log is a read only list of all activity about the ecosystem.

The audit record table lists:

Date modifiedThe record time stamp.

VersionThe revision number.

ActionThe revision action, typically Create or Save.

User The IBM Cognos Command Center user that started the action.

DescriptionThe ecosystem description.

ProcessesA process is group of automation tasks that can be run in serial or in parallel.

Tasks can be defined to branch or perform actions, such as send an email that isbased on task return codes. Select the Processes item from under an ecosystem inthe navigation pane.

You can either add a process with the toolbar New icon

or view and edit anexisting one by double-clicking the Process name.

Attention: You can cut a process from one ecosystem and paste it into anotherone. If the paste operation fails, the process is still in the paste buffer, so you canrepaste the process or trigger back into the original ecosystem.

The process user interface has two tabs:

PropertiesTask tree on the left and item-specific property editor panel on the right.

Audit LogRevision list and audit activities for the process.

You can use the task tree panel to view and manage tasks with the toolbar anddrag-drop:

Table 5. Task actions for a process

Item Description

Add Task Menu Adds a task to the process. This menu is dynamically created from thebase system and from installed task plug-ins.

Delete Task Removes the selected task from the process.

Move Task toTop

Moves the task to the first position.

Move Task Up Moves the task up one position.

Move TaskDown

Moves the task down one position.

Move Task toBottom

Moves the task to the last position.


Table 5. Task actions for a process (continued)

Item Description

Start theProcess or Task

You can do this:

v Start Process

v Start Process Here

v Start Task

Attention: These actions open the Start Process window and then jumpto the Process Run Details view.

Task Tree Contains a tree of tasks that are defined for a process. You can right-clickthe mouse on a task to show its pop-up menu. You can also reorder tasksby selecting a task and dragging it above or below another task.

EmailNotificationNode

Sets properties for email notification.

Process properties and variablesWhen you create or edit a process, you can define its name, description, andprocess variables.

You can use the process properties panel to enter a name and description for theprocess and to enter process variables. Process variables that you define applywithin the process, whereas environment variables apply across all processeswithin an ecosystem.

You can use process variables to dynamically substitute values into the process andits tasks. Variables are expanded just before the IBM Cognos Command CenterServer streams task definitions and file resources to agents. The syntax for using avariable is $(VarName). Variables can be nested recursively. As an example if youhave two variables:

FIRST = A

SECOND = x$(FIRST)x

Then, $(SECOND) is expanded to xAx.

The following properties can be set for process variables:

EncryptEncrypts the values in the IBM Cognos Command Center repository.Typically, you encrypt passwords or other sensitive data. Encrypted text isnot visible to users that have read-only access to the system.

PromptMakes the variable a required input field when the process is manuallyrun.

Adding, deleting, and reordering tasksTasks can be defined to perform actions or to branch, and can be run in serial orparallel. The run order is determined by order in which they appear in the tasktree.


Procedure1. To add a task, click the Add menu item or, with the right-mouse pop-up menu

on the process or any task name. This causes the Task Type menu to appear.2. You can delete a task by selecting it in the tree and clicking the Delete menu

item or with the right-mouse pop-up menu on the task name.3. You can reorder the tasks by selecting a task name in the tree and dragging to a

new location or by using the up and down toolbar arrows.

Task propertiesTask properties are dependent on the type of task. These commonly includeproperties for task parameters, error handling conditions, file resources, and preand post-task actions.

Parameters Type-dependent parameters that might be required to run the task.

File ResourcesThe file resources that are used in the task.

Error RulesSettings that define how to react to error conditions and return codes.

Task Actions Define actions to be run before or after you run a task.

Parameters

Tasks have a list of parameters that are dependent on the task type definition.Parameters for the factory-installed task types are described in the task typessection.

Name The name of the task.

DescriptionDescriptive text about the task.

Computing ResourceThe computing resource that is used to run the task.

ParametersOther parameters that are required for the task type.

File resources

All IBM Cognos Command Center file resources that are used in the task must bedefined in the File Resources tab. When a task runs, its file resources are streamedto the computing resource agent computer.

To add a file Resource, select it from left side selection panel and click Add. Toremove a file resource from the task, select it from the right selection panel andclick Remove.

Error rules

Error rules define how the running task or process is to react to defined conditionsand return codes.

Error rule parameters are task type-dependent.


Table 6. Complete set of error rules

Parameter Description

Action on error Use to select the type of action to be taken when a defined erroroccurs.

v Continue with next task in the process

v Exit the process

v Go to task

v Pause the process

v Set warning and continue with next task

Task timeoutsettings

You can use timeout settings to set error timeout and retry properties.

v Maximum allowed time for task to run sets a maximum run timefor the task, so that tasks that go into an inappropriately long orinfinite loop execution are identified as errors.

v Retry attempts sets the maximum number of failure retries beforethe task completes in an error state.

v Pause between attempts sets the number of seconds to wait beforethe task is tried again.

Error conditions Specifies whether the available conditions are treated as a failure ornot. For example, by default, a timeout is treated as a task failure. Byselecting the Ignore check box, a timeout is not treated as a failure.

Exit codeinterpretation

Program or script execution typically provides a return code when itcompletes. By default, IBM Cognos Command Center treats any returncode as a successful operation. If you want IBM Cognos CommandCenter to inspect a return code and treat it as a failure condition,select the criteria that you want to apply and enter an integer value.

Outputinterpretation

Program or script execution might return some output text when theexecution is done. By default,IBM Cognos Command Center does notinterpret the output. If you want IBM Cognos Command Center toinspect output text for a failure condition string, select the criteria thatyou want to apply and enter the text string.

When a process runs, each task typically has a return code that provides a value ifthere was an error. If any error condition is met while a task is running, then thetask workflow is modified accordingly.

Attention: Certain task types also support pre task and post task actions. Thesetasks also include error handling parameters.

Task actions

Most task types can be decorated with pre and post task actions. Task actionsconsist of an optional condition and an action, which is performed only if thecondition is true.

Pre task actions are run before the task is run.

By default, post task actions are run when the task completes successfully.However, you can also specify that a post task action runs if the task fails, or youcan specify that the action is always processed. To specify how a post task action isrun, in the Task Action Properties window, set the Processing Model property toone of the following values:v Process action when task succeeds


v Process action when task failsv Always process action

To create and remove actions, use the add

and delete

icons. Theactions are run in listed order. To change the order of actions, use the up and

down arrows. To edit an action, click the edit

icon.

You can specify a condition that must be met before a task is run.

The following table lists the condition types:

Table 7. Condition types

Condition Type Description

Compare numericvalues

Compares two numerical expressions. This condition can be used, forexample, to check on the value of a process or ecosystem variablevalue:

$(Year) equals 2007

The value fields can also perform simple mathematical equations, forexample:

4 + Abs(6 * $(myvar)) equals “42”

Numeric comparison math functions (case sensitive):

v Abs returns the absolute value of a specified number. Example:Abs(-1) returns 1

v Ceiling returns the smallest integer greater than or equal to thespecified number. Example: Ceiling(1.5) returns 2

v Floor returns the largest integer less than or equal to the specifiednumber. Example: Floor(1.5) returns 1.

v Max returns the larger of two specified numbers. Example: Max(1, 2)returns 2

v Min returns the smaller of two numbers. Example: Min(1, 2) returns1

v Round rounds a value to the nearest integer or specified number ofdecimal places. Example: Round(5.22, 0) returns 5

v Truncate calculates the integral part of a number. Example:Truncate(1.7) returns 1

Compare stringvalues

Compares two strings. For example, this condition can be used to testthe content of a variable.

Evaluateexpression

Evaluates a logical expression and performs the task action if theexpression is true.

The expression can use the following operators:

v Logical operators: and, or, not

v Logical values: true, false

v Equality: = =

v Grouping by using parenthesis

v Mathematical functions as described for the 'compare numericvalues' condition.

v String literals: 'my string'. String literals are enclosed by singlequotation marks.


Table 7. Condition types (continued)

Condition Type Description

None Initiate an action without performing any checks.

The operation can be one of the following types:

Table 8. Operation types

OperationType Description

Pre-taskaction

Post-taskaction

Extract listfrom outputdata

Extracts a list of values from the task output into anexisting variable. This variable can then be used inan iterator task.

x

Extract stringfrom variable

Extracts a string from a source variable and assignsall or parts to a target variable. This action makes iteasier to pass information between tasks of a largerprocess.

x x

Send email Sends an email based on the task conditions. Thisaction gives you more flexibility in sending an emailunder certain conditions.

x

Extract stringfrom outputdata

Extracts a string from the task output into anexisting variable. You can click Test selection toenter a test string to determine whether yoursubstring pattern-match search criteria works aswanted. Type or paste a test string into the windowand click Test to evaluate the expression. Stringsthat match the pattern criteria are highlighted.

x

Fail task Marks a task as failed. Subsequent actions are notprocessed.

x

Set warning Marks the task as completed successfully, but with awarning. The process proceeds as if the taskcompleted successfully.

x

Set variable Assigns a value to a variable. The value canreference other variables by using the well-known$(VARIABLE) syntax.

x x

Set task resulttext

Sets the task result text to a custom string. Thisaction is useful to modify the standard result text fora task.

x

Skip task Skips the task. Subsequent actions and the task arenot processed.

x

Setting a warning for a taskIn IBM Cognos Command Center, the warning status indicates that a taskcompleted successfully, but that the task completed with a minor error. When youdesign a process, you can specify conditions in a post task action that result in awarning status for a task.

About this task

One scenario in which you might set a warning is in a data load process wheredata is extracted from one system and loaded into another, for example, from SAPto TM1. This process includes post task actions to compare the data totals from thesource and target systems. A discrepancy in the totals can occur because the source


system can add records in the time between the data extraction task and thecalculation of data totals. Or a discrepancy can occur because some records cannotbe loaded onto the target system. If the discrepancy is minor, you might want toissue a warning, but continue the process.

You can use email notifications to alert stakeholders that a task completed with awarning. For more information, see “Email notification” on page 37.

When you set the warning conditions, you can create a custom message for theresult text that provides helpful information.

When you set a warning, you specify actions, conditions, result text, and theprocessing model in the Task Action Properties window. For more information, see“Task properties” on page 26.

To set a warning, edit a process.

Procedure1. In the navigation tree, expand Ecosystems > Processes, and double-click the

process that you want to edit.2. On the Process page, on the Properties tab, double-click the task that you want

to edit.3. On the Actions tab, in the Post task action pane, click the add icon.4. In the Task Action Properties window, from the Action drop-down list, select

Set warning.5. In the Task Action Properties window, from the Condition drop-down list,

select the condition that you want.6. If prompted, in the Perform action below field, type values and select from the

drop-down list, or type the condition.7. Optional: To specify a custom result text value for the task, in the Result text

field, type the text message that you want.8. To choose when the post task action runs, from the Processing model

drop-down list, select the value that you want.

Task typesIBM Cognos Command Center provides various task types that you can use tocheck for certain conditions, run programs, or set up labels for goto processing.When you edit a process and add a task, the Task Type menu items appear.

The task types that are listed in these menus are the defaults. When task plug-insare installed, more task types and sub menus appear.

Run process

The Run Process task runs an IBM Cognos Command Center process within theparent ecosystem. The IBM Cognos Command Center process is selected from thelist of existing processes. This task contains the parameter Start Process that startsthe selected process.

You can also prompt for variables. To prompt for variables that are required by theprocess, you specify the Process parameters attribute. Each parameter is specifiedas "param_name"="param_value", and each parameter is separated by one or more


spaces. For example: MyParam="my_value" MyOtherParam=42. The variable namesare stored as a string. If the target process does not have such a variable at runtime, the Run Process task fails.

The Error handling tab defines how the application reacts to certain conditionsand return codes.

Table 9. Run Process task error rules

Error Rule Description

Timeout If the task does not complete within the optional Timeout setting, thistask is treated by default as a failure.

Process not found The target process does not exist during the time of execution.

Process is alreadyrunning

Multiple copies of a process cannot run simultaneously and the targetprocess was already running at the time of execution.

Could not startprocess

The target process could not be started.

The process failed The target process failed.

The process wascanceled

The target process was started but canceled before successfulexecution.

Run program

The Run Program task runs an executable file. The program file might be in theIBM Cognos Command Center repository or it might be on the agent where thecomputing resource is located.

The Run Program task contains the following parameters:

Startup DirectoryThe location on the agent computer from where the program is run. Bydefault, this parameter is set to the value of the Working Directory namethat is defined for a computing resource. Typically a TEMP directory isused. The Startup Directory is used (together with Home Directory) todetermine what the working directory is for the process that is started. Ifset, then it overrides the Home Directory of the computing resource task.

You can also use either an environment or process variable name as part ofthe Startup definition in the form of:

$(VariableName)

For example, if you have a variable that is called Geography and the valueis set to Europe, then you create a startup path in the following format:

C:\Cube\$(Geography)

This resolves to:

C:\Cube\Europe

Run FileThe program name and location path (if the executable file is not from theIBM Cognos Command Center repository). For example, if ESSCMD.EXE isloaded into the IBM Cognos Command Center repository, then the targetwould be ESSCMD.EXE. If you want to run ESSCMD that is on the filesystem of the agent computer location, then you would specify the filepath and file name, such as c:\hyperion\essbase\bin\ESSCMD.EXE.


ArgumentsThe arguments that are associated with the program to run. For example,the name of a script file to run with ESSCMD.EXE. The file can be from theIBM Cognos Command Center repository, or can be on the file system ofthe agent computer.

The Error Rules tab defines how the application reacts to certain conditions andreturn codes. For the Run Program task, the only error rule is Timeout, that is, ifthe task does not complete within the optional Timeout setting, this is treated bydefault as a failure.

Compare files

You can use the Compare Files task to compare various properties between twofiles that exist on the agent computer where the computing resources are.

TheCompare Files task contains the following parameters:

File name A and BThe name of the two files to compare that are in a directory of theoperating system of the agent computer where the computing resourcesare.

Date/Time CheckCompares the dates of the two files:v Date is anyv Modified date (time)v Create date (time)

Size CheckCompares the size of the two files:v Size is anyv Size is equal to a specified size in kbv Size is less than a specified size in kbv Size is greater than a specified size in kb

The Error Rules tab defines how the application reacts to certain conditions andreturn codes.

Table 10. Compare Files task error rules


Condition notsatisfied

By default, a file (A) defined for check criteria that is not found istreated as a failure. By selecting the Ignore check box, the condition isnot treated as a failure.

File A not found By default, a file that is defined for check criteria that is not found istreated as a failure. By selecting the Ignore check box, the condition isnot treated as a failure.

File B not found By default, a file (B) defined for check criteria that is not found istreated as a failure. By selecting the Ignore check box, the condition isnot treated as a failure.


File properties

You can use the File Properties task to test for various file properties on the agentcomputer where the computing resources are.

The File Properties task contains the following parameters:

File nameA file, full file name path, which is on the file system of the agentcomputer where the computing resources are.

Date/Time comparisonDate property options:v Date is any datev Modified date (time) is more than or less than a specified number of

hours and minutesv created date (time) is more than or less than a specified number of hours

and minutes

Size comparisonFile size property options:v Size is any sizev Size is equal to a specified size in kbv Size is less than a specified size in kbv Size is greater than a specified size in kb


Table 11. File Properties task error rules



By default, a condition that does not meet the criteria is treated as afailure. By selecting the Ignore check box, the condition is not treatedas a failure.

File not found By default, a file that is defined for check criteria that is not found istreated as a failure. By selecting the Ignore check box, the condition isnot treated as a failure.

File existence

You can use the File Existence task to check whether a file exists on the sameagent computer as the computing resource.

TheFile Existence task contains the following parameters:

File nameThe file to check the existence of.

ConditionCheck to whether the file exists or does not exist.



Table 12. File Existence task error rules



By default, a file (A) defined for check criteria that is not found istreated as a failure. By selecting the Ignore check box, the condition isnot treated as a failure.

Wait on Process

You can use the Wait on Process task to check whether another process is running.For example, you can control whether you want a task in the current process torun based on another process.

TheWait on Process task contains the following parameters:

Process nameAn IBM Cognos Command Center process name.

ConditionCheck to see whether the process is running or not running.

Sleep

You can use the Sleep task to put the process into a timed state of suspendedactivity.

TheSleep task contains the parameter Seconds, which sets the duration of the sleepperiod. The task completes after this time.

Sequential group

You can use the Sequential Group task to group a set of tasks. The tasks within asequential group are processed sequentially. Each task must complete before thenext task is started.

Parallel group

IBM Cognos Command Center supports the simultaneous starting of multiple taskswhen defined under a Parallel Group task. When a parallel group of tasks is run,all tasks in the group must complete before you can move to the next set of tasks.

The result of a parallel group task is determined from the results of the child tasks.If there is a failed child task, the parallel group is marked as failed. If all childtasks complete successfully, the parallel group is marked as successfully completed.

Iterate over list

You can use the Iterate Over List task to loop through a list of values and for eachvalue perform a sequence of tasks.

TheIterate Over List task contains the following parameters:

Loop variableName of the variable that is holding the value of the current element.


Value listThe values to loop over. Elements in the list are separated by spaces. Usedouble quotation marks to include an element that contains spaces.

Keep historyIf set to false, only the last iteration is kept in the process run history. If setto true, all iterations are kept in the process run history.

Attention: The maximum number of tasks that can be kept in the processrun history is 20.

Goto

The Goto task is designed to support branching conditions across multiple tasks ina process. Used with the task error handling capabilities, you can this task to createcomplex branching operations.

The Goto task is a simple task that causes the process to jump to a later task in aprocess. This task is handy for skipping a block of tasks in a process if an erroroccurs.

Goto label

The Goto Label task does not perform an operation. It is used as a jump-to pointfrom other tasks.

System Management tasksIBM Cognos Command Center provides various system management task typesthat you can use.

To use the system management tasks:1. Double-click the name of the process to open the process editor.2. Click Edit.

3. Click the add task icon .4. Click Automation Task, and browse to the task that you want to specify. For

example, click Automation Task > System Management > Purge Data.

Purge Data task

To delete historic data that is more than n days old, click the Purge Data option,then set the argument parameters.

The following table shows the task arguments for the Purge Data task.

Table 13. Task arguments for the Purge Data task

Argument Description

Maximum age Information older than n days old is purged.

Purge unusedprocessversions

If true, historic process versions with no run history are deleted.

Purge unusedfile resource

If true, historic file resource versions with no run history are deleted.


Table 13. Task arguments for the Purge Data task (continued)


Purge emptylabels

If true, empty labels are deleted.

List User Access task

This task provides information about user access to IBM Cognos Command Centerobjects.

The following table shows the task arguments for the List User Access task.

Table 14. Task arguments for the List User Access task


User Selects a user.

Output file The name of the file where the access rights of the user are written in .csvformat. If empty, the access rights are displayed on the task output.

Output format When the output format is set to Full, the user role information is includedin the output.

Overwrite If true, and the output file exists, the file is overwritten.

List Object Permissions task

This task provides information about object permissions.

The following table shows the task arguments for the List Object Permissionstask.

Table 15. Task arguments for the List Object Permissions task


Ecosystem Selects an ecosystem.

Type Selects an object type.

Object Selects the process or file resource.

Output file The name of the file where the permissions for the objects from theselected ecosystem are written in .csv format. If empty, the access rightsare displayed on the task output.

Output format When the output format is set to Full, the user role information is includedin the output.


List Audit Log task

The List Audit Log lets you include audit information in your automations.

The following table shows the task arguments for the List Audit Log task.

Table 16. Task arguments for the List Audit Log task


User Selects a user.


Table 16. Task arguments for the List Audit Log task (continued)


Design actions Specifies the design actions to audit.

Process run actions Specifies the process run actions types to audit.

Object types Specifies the object types to audit.

Date range Specifies a date range.

Output file The name of the file where the permissions for the objects from theselected ecosystem are written in .csv format. If empty, the accessrights are displayed on the task output.


Email notificationEmail notification provides a means to notify various users on the outcome of arunning process. IBM Cognos Command Center sends out a system-generated mailtemplate for various outcomes.

By selecting the Email Notification item from the task pane, you can send emailalerts when one or more of the following outcomes occur from running a process:

StartedThe process starts either from manual or scheduled action.

PausedThe process is paused manually.

Resumed The process is resumed from a paused state.

Canceled The process is canceled manually.

Failed A task within the process fails from a manual or scheduled action.

CompletedA Task within the process completes with no errors from a manual orscheduled action.

WarningA task within the process completed successfully, but with a warning.

Selecting the appropriate Enable check box enables the event. You can define oneor more email recipients in the Email to field by clicking the appropriate row andentering a list of email addresses that are separated by commas or semi-colons.

Attention: IBM Cognos Command Center checks for a valid email address format,but does validate that an addressee exists.

The body of the email contains a link. If you installed the IBM Cognos CommandCenter web server, clicking the link takes you directly to a browser page thatcontains all the details of the process run.

Attention: Your IBM Cognos Command Center server must be configured foremail alerts to be sent through an SMTP Server. For more information, see the IBMCognos Command Center Installation Guide.


Process audit logThe audit log is a read only list of all activity about the process.

The top-most entry is the current version. There are two possible user actions:

View The View button, or version link, opens up a read-only viewer anddisplays the selected revision.

PromoteThe Promote button, with the interactivity of the confirmation window,promotes that specific process revision to be the current version,incrementing the version number. This action is often used to revert to anearlier version of the process.

File ResourcesFile resources are files such as scripts, batch files, binary files, and other files thatare loaded into the IBM Cognos Command Center repository.

Although you can use IBM Cognos Command Center to remotely run files onvarious computers, there are many benefits to loading the files that are typicallylocated across many servers into Cognos Command Center as a file resource. Youcan use file resources in Cognos Command Center to perform the following tasks:v View and manage files from a single repository.v Define a master file once and deploy it across multiple servers.v Apply environment variables and process variables.v Remove hardcoded user names, passwords, or other elements that must be

secured from view.v Dynamically point to varying file names and file paths across multiple

environments.

Creating foldersTo make it easier to organize your files, you can define folders and subfolders inan ecosystem under the file resource tree in the object browser.

The IBM Cognos Command Center user interface provides facilities to eitherupload files into the repository or manually create text-based files.

Procedure1. Select an ecosystem.2. Select a node in the file resources tree.3. Click Add Folder.

Uploading filesYou create a file resource in IBM Cognos Command Center by uploading a filethrough the Cognos Command Center user interface.

When you upload a file resource, you can define the following properties:

File Resource NameThe name of the file resource to be created.

Attention: For certain file types, you must include a file extension in thename for the agent operating system to properly run. For example,Microsoft Windows executable files file names must include a file extensionsuch as .bat, .cmd, or .exe.


Uploaded FileUse to select a file from the directories that are visible from the computerthat is running Cognos Command Center. To select multiple files toupload, click Upload multiple files.

File TypeDefines the file type from one of the following sources:v Script text - A text file whose content can be edited in Cognos Command

Center. This file is typically a script, command, or .bat file.v Executable binaryv Zip archive

Attention: The client computer that runs the Cognos Command Center userinterface must have network access to the drives where various files are located.

Procedure1. Start Cognos Command Center.2. Select an ecosystem.3. From the navigation pane, select the appropriate file resources folder item.

4. Click the New icon .

File Resource PropertiesYou can use the file resource properties user interface to manage a file resource.

Properties

You can use the file resource properties user interface to define the followingproperties:

Name The name of the file resource.

DescriptionAn optional description of the file resource.

Deployment PathAn optional file path. By default, it is set to the home directory of thecomputing resource that uses the file resource.

Content If the source file is a text file, then you can view and modify the content.

Deployment path

When a file resource is used in a process, it is streamed to an agent computer. Youcan use various path scenarios for the steaming file resource.

The following table shows how deployment path settings can be used with thesetting of a home directory for a computing resource.

Table 17. Deployment path settings

ComputingResource HomeDirectory

File ResourceDeployment Path

File ResourceName

File that is created on theagent

c:\home c:\absolutepath FileName C:\absolutepath\FileName

c:\home path FileName C:\home\path\FileName


Table 17. Deployment path settings (continued)

ComputingResource HomeDirectory

File ResourceDeployment Path

File ResourceName

File that is created on theagent

c:\home <NO VALUE> FileName C:\home\FileName

If the specified path does not exist on the agent computer, then it is created whenthe process that uses the file resource is run assuming that the user that runs theagent process has rights to create the directory.

You can use either an environment or process variable name as part of thedeployment path definition in the following format:

$(VariableName)

For example, if you have a variable that is called Geography and the value is set toEurope, then you create a deployment path in the form of:

Files\$(Geography)

This would resolve to C:\Budget Files\Europe.

Content

The content of a file resource depends on the defined file type. When the file typeis a script or text file, then you can view and edit the text content of the file. Thefile resource user interface provides a basic text editor that you can use to modifythe file content. A typical file resource example is a script file that runs a batch orscript.

After a file resource is created in IBM Cognos Command Center, you can modifyits content as your application needs change. A common modification is the use ofvariables to eliminate hardcoded strings, such as user names and passwords in theform of: $(VariableName). For more information, see “Variables” on page 42.

File Resource Audit LogThe audit log is a read-only list of all activity for the file resource.

On the Audit Log tab, the current version of the log is shown at the top.

View The View button, or version link, opens up a read-only viewer anddisplays the selected revision.

PromoteThe Promote button promotes a specific file resource revision to be thecurrent version, incrementing the version number. This action is often usedto revert to an earlier version of the file resource.

TriggersYou can use triggers to initiate a process that responds to specific criteria.

A trigger is an object that specifies and monitors a triggering condition. When thecondition is satisfied, the specified action is triggered. Triggers are contained in anecosystem. For more information about ecosystems, see “Ecosystems” on page 22.


Creating triggersYou create a trigger that initiates a process that responds to specific criteria.

You can also export or import triggers.

Procedure1. Click Triggers in the navigation pane of the Setup and Design tab.

2. To add a trigger, either click the New icon

or right-click the trigger item inthe navigation pane. To view or edit an existing trigger, double-click the triggername.Attention: You can cut a trigger from one ecosystem and paste it into anotherone. If the paste operation fails, the trigger is still in the paste buffer, so youcan repaste the process or trigger back into the original ecosystem.

3. Click the Condition tab and specify the condition for the trigger.Attention:

v In Directory to monitor, the directory must be fully specified. Wildcards arenot allowed.

v A trigger can be defined without being active. You must check Activatetrigger, on the lower left corner of the window, to turn on the trigger. ClearActivate trigger to turn off the trigger.

4. Click the Action tab and specify the process to activate when the condition issatisfied.

AgentsAn agent is a small-footprint software application that is installed on eachcomputer where automation processes are run.

You can specify the following agent properties:

Name A name for the agent.

Host Name The host name of the computer where the agent software is installed.

Port The port number of the host computer.

Attention: The agent port number is defined during the softwareinstallation process.

PlatformThe operating system that the agent is running on.

Agent password The agent process password.

Agent user name To ensure a secure connection between the IBM Cognos Command Centerserver and agent, a user name and password combination is associated tothe agent process. The user name and password are defined as part of thesoftware installation process.

Creating agentsYou can create agents to run process tasks.


The agent must be added to the IBM Cognos Command Center and its connectionproperties must be configured in order for the Cognos Command Center server tointeract with the agent.

Procedure1. In the navigation pane of the Setup and Design tab, click Agents.

2. To add a new agent, either click the New icon

or right-click the agent itemin the navigation pane.

3. Specify the properties as needed. To view or edit an existing agent, double-clickthe agent name.

4. Click Test the Agent to verify that a connection to the agent is workingproperly.Attention: The agent must be running on the host for a test connection towork.

VariablesYou can use IBM Cognos Command Center variables to dynamically substitutevalues into processes, tasks, and file resources at run time.

Variables are expanded at run time just before the Cognos Command Center serverstreams task definitions and file resources to agents. The syntax for a variable is$(VarName).

Variables can be nested recursively. For example, if you have two variables:

FIRST = A

SECOND = x$(FIRST)x

Then $(SECOND) is expanded to xAx.

There are three types of variables:v Environment variables that are defined on the ecosystem view. They are visible

to all processes and file resources within the ecosystem.v Process variables that are defined on the process view. Process variables are only

visible inside the parent process.v System variables that are visible to all processes and file resources.

Environment variables

Environment variables can have different values within each environment. Thefollowing properties can be set for environment variables and process variables.

EncryptCauses the values in the Cognos Command Center repository to beencrypted. Typically, you encrypt passwords or other sensitive data.Encrypted text is not visible to users that have read-only access to thesystem.

PromptMakes the variable a required input field when a process in this ecosystemis manually run. For example, a prompt for password and host openswhen the user manually starts the list directory process:


Process variables

Process variables have only a single value, regardless of the environment in whichthe process is run. They are defined in the Process Properties window.

EncryptCauses the values in the Cognos Command Center repository to beencrypted. Typically, you encrypt passwords or other sensitive data.Encrypted text is not visible to users that have read-only access to thesystem.

PromptMakes the variable a required input field when a process in this ecosystemis manually run. For example, a prompt for password and host openswhen the user manually starts the list directory process.

System variables

System variables are built-in variables that give access to runtime information forthe process and its tasks.

Attention: Do not use the words Last and LastSuccess as the optional [name]indexer: these words are reserved names and can conflict with the 'Access previousprocess runs' variable, for example $(Process[LastSuccess].Start) .

The following table shows the set of available system variables.

Table 18. System variables

Variable Description Examples

Date{format} Provides the current date andtime.

The output format isspecified by the optional{format} argument.

$(Date) => "11/30/11"

$(Date{yyyy/MM/dd}) =>"2011/11/30"

$(Date{HH:mm:ss}) =>"14:35:44"

Process[name].Environment The name of the environmentthat the process is running in.

To reference a differentprocess, the optional [name]indexer can be used.

In the example, PROD is thename the user gave theenvironment in theecosystem.

$(Process.Environment) =>PROD


Table 18. System variables (continued)


Process[name].Duration{format} The duration of the process.

The output format isspecified by the optional{format} argument. The{format} argument can havethe following values:

seconds - formats theduration as the number ofseconds.

long - formats the durationas hh:mm:ss.

To reference a differentprocess than the current one,the optional [name] indexercan be used.

$(Process.Duration) =>"00:12:48"

$(Process.Duration{seconds})=> 768

$(Process.Duration{long})=> "00:12:48"

Process[name].JobId A unique identifier of theprocess.


$(Process.JobId) => 18654

Process[name].Name The name of the process thatis running.


$(Process.Name) => "StopHyperion Services"

Process.NextRun{format} The next scheduled run ofthe process.

Expands to an empty string ifthe process is not scheduled.

$(Process.NextRun) =>"11/30/11 14:35:00

Process[name].Start{format} The start time of the process.



$(Process.Start) =>"11/30/11 14:35:44"

Process[name].State The state of the last run ofthe process.

To reference a differentprocess, the optional [name]indexer can be used.

$(Process.State) ==>"Running"

$(Process[My name]).State)==> "Failed"




Process[name].User The name of the user thatstarted the process. Use the$(User) variables for access tothe user's email, phone, orother fields.


$(Process.User) => "JohnDoe"

Process[name].Url A URL to the process detailspage of Cognos CommandCenter web.


$(Process.Url)=>"https://localhost:8180/Process/ Details/42"

Task[Name].Duration{format} The duration of the task.

To reference a different taskthan the current one, theoptional [name] indexer canbe used.

See theProcess.Duration{format}variable for the usage of theformat argument.

$(Task.Duration) =>"00:12:48"

$(Task.Duration{seconds})=> 768

Task[name].ExitCode The exit code of a task.


$(Task[My Name].ExitCode)=> "1"

Task[name].End {format} The end time of a task. $(Task.End) => "11/30/1114:35:44"

Task.Name The name of the current task. $(Task.Name) = "StartEssbase"

Task[name].Start {format} The start time of the task.



$(Task[MyName].Start{hh:mm}) =>"07:22 PM"




Task[name].State The state of a task.


The variable expands to oneof the following strings:NotStarted, Running,Pausing, Paused, Canceling,Canceled, Failed, Completed

$(Task.State) =>"Completed"

$(Task[My Name]).State =>"Completed"

Task[name].Url A URL to the task detailspage of IBM CognosCommand Center Web.

$(Task.Url) =>"https://localhost:8180/

User Shorthand for User.Email. $(User) =>"[email protected]"

User.Email The email field for the userthat started the process

$(User.Email) =>"[email protected]"

User.Name The name field for the userthat started the process.

$(User.Name) => "John Doe"

User.Phone The phone field for the userthat started the process.

$(User.Phone) =>"866.756.7827"

Access previous process runs

You can access information on previous process runs by indexing the processvariable. The syntax is $(Process[indexer].Variable{format}), where indexer canbe one of the following:v Last - the last run of the process. For example, $(Process[Last].Duration)

returns the duration of the last run of the process.v LastSuccess - the last successful run of the process. For example,

$(Process[LastSuccess].Start) returns the start time of the last successful runof the process.

Date and time value variables format

For date and time value variables, the optional {format} argument is a formatspecifier that determines the output format.

The following table shows the most common format specifiers

Table 19. Common format specifiers

FormatSpecifier Description

d Day, 1 digits: 1-31

dd Day, 2 digits: 01-31

h Hours, 12 hour clock, 1 digit: 1-12 a.m./p.m.

hh Hours, 12 hour clock, 2 digits: 01-12 a.m./p.m.

H Hours, 24 hour clock, 1 digit: 0-23


Table 19. Common format specifiers (continued)

FormatSpecifier Description

HH Hours, 24 hour clock, 2 digits: 00-23

m Minutes, 1 digit: 0-59

mm Minutes, 2 digits: 00-59

M Month, 1 digit: 1-12

MM Month, 2 digits: 01-12

s Seconds, 1 digit: 0-59

ss Seconds, 2 digits: 00-59

utc Universal time coordinates in the format yyyy-MM-dd'T'HH:mm:ss'Z'. Forexample, 2015-10-23T21:33:42Z

yy Year 2 digits: 00-99

yyyy Year 4 digits: 0000-9999

Separator characters, such as . , : /, are copied to the output. For example,$(Date{yyyy/MM/dd}) => 2011/12/31 or $(Date{HH:mm})=> 21:08.

Migrating to Cognos Command CenterYou can migrate an existing automation environment to IBM Cognos CommandCenter.

There are three basic strategies:v Point and Runv Upload Existingv Rewrite to Simplify

Depending on your environment, implementation times, and functional needs, oneor more of these strategies might be appropriate for your needs.

Migrating to Cognos Command Center by using Point andRun

Of the three existing migration strategies, the Point and Run strategy requires theleast amount of work.

It leaves all scripts unchanged in their existing locations on various applicationserver computers, and uses IBM Cognos Command Center to centrally run andmonitor the automation environment.

Procedure1. Leave all scripts unchanged.2. Define the ecosystem and agents that are necessary to run and monitor the

scripts.3. Create the process tasks in the Cognos Command Center that runs the scripts.4. Manually run the processes to ensure that they work properly.5. Test run a scheduled process.


Migrating to Cognos Command Center by using UploadExisting

The Upload Existing strategy uses IBM Cognos Command Center capabilities tocentralize your existing scripts into the IBM Cognos Command Center repository.

After you upload scripts to the repository, you might need to make minor changesto your scripts to use Cognos Command Center features, such as environmentvariables, to reduce or eliminate hardcoded strings.

Procedure1. Define the ecosystem and agents that are needed to run and monitor the

scripts.2. Upload scripts into the Cognos Command Center repository as file resources.3. Define environment variables to use in the scripts.4. Modify the uploaded script content with environment variables.5. Create the processes in Cognos Command Center that will run the file

resources.6. Manually run the processes to ensure that they work properly.7. Test run a scheduled process.

Migrating to Cognos Command Center by using Rewrite toSimplify

IBM Cognos Command Center is designed with standard intelligent Hyperioninterfaces, and error handling features that can reduce or simplify the currentscripting code.

After your scripts are in the repository, you might have to make minor changes toyour scripts so that you can use Cognos Command Center features such asenvironment variables to reduce or eliminate hardcoded strings.

Procedure1. Review your existing scripts and look for places where code can be eliminated

or simplified.2. Define the ecosystem and agents that are needed to run and monitor the

scripts.3. Upload scripts to the Cognos Command Center repository as file resources.4. Define the environment variables that are used in the scripts.5. Modify the uploaded script content with environment variables.6. Create the processes in the Cognos Command Center that runs the file

resources.7. Manually run the processes to ensure that they work properly.8. Test run a scheduled process.


Chapter 4. Security

Access to the IBM Cognos Command Center environment is controlled by userlevel security. Each user can be assigned one or more roles that define access toenvironments, file resources, and processes.

Creating usersA user account is required to gain access to IBM Cognos Command Center.

User authentication can be handled by the internal Cognos Command Centerauthentication system, or by using an external authentication, such as LDAP. Useraccounts are always defined in Cognos Command Center, but password handlingdepends on the user configuration to use local or external authentication.

Attention: The user ID is case-sensitive. For example, if you copy the repositoryfrom a previous environment in which the user ID is admin, then configure theagents in the copy by using the user ID Admin, the agent does not run.

When Cognos Command Center is installed, a default user account that is calledDEFAULT is created, with an Administrator role. Only users assigned theAdministrator role can create and edit user accounts.

The Authentication property defines whether the user's login credentials areauthenticated locally by Cognos Command Center or an external source. For moreinformation, see the IBM Cognos Command Center Installation Guide.

The Assigned Roles property lists the roles that are assigned to the user. A user canhave more than one defined role. For users assigned more than one role, theremight be access control overlaps for an environment, process, or file resource.When this overlap occurs, the user inherits the highest level of access. For example,if by using multiple Role assignments, the user has Read access to Process1 andalso Write access to Process1, then the effective access is Write access to Process

Procedure1. In the navigation pane, select the Security item. You can add a user with the

Users folder pop-up menu or with the New icon . You can view and editan existing label by double-clicking the user name.

2. Specify the properties that you want.

Creating rolesAccess to objects, ecosystems, processes, and file resources is controlled by roles.

When IBM Cognos Command Center is installed, a default role that is calledAdministrator is created. A user that is assigned the Administrator role has rightsto manage and run all objects on a Cognos Command Center Server. Only usersthat are assigned the Administrator role can manage Agent, Label, Role, and Userdefinitions.

Cognos Command Center supports the following levels of access control:


Read The user can view an object.

Execute The user can view and run a process. The execute access level can be set torestrict running a process in a specified environment.

Write The user can read and modify an existing object. Processes can be run.

Create Provides complete access to create, view, modify, and run objects.

Procedure1. In the navigation pane, select the Security item.2. Select the Roles folder. You can add a user with the Roles folder pop-up menu

or with the New icon . You can view and edit an existing label bydouble-clicking the role name.

3. Specify the properties that you want.

Name The role name.

Available accessTree view of all ecosystems and their associated processes and fileresources.

Assigned accessList of all assigned objects and the allowed access rights for each item.


Chapter 5. Labels

Labels are a key component in the IBM Cognos Command Center audit andlifecycle functionality.

Labels are groups of Cognos Command Center automation objects that are eitheruser-selected or defined during an import. Similar to a system that assigns aversion number to software or documents, labels take snapshots of objects thatmight later be used for an export or roll-back procedure. The version of each objectis maintained in the label.

Creating labelsLabels are managed through the IBM Cognos Command Center user interface.

The Content property for a label contains the Cognos Command Centerautomation objects tree. When you create a new label, the nodes in this tree havecheck boxes for selecting items to be included. After you save the label, or whenyou view a saved label, there are no check boxes, but there is object versioninformation.

The properties for labels cannot be changed after a label is saved. This is done tomaintain the audit integrity of the label.

After it is saved, you can use a label in two ways:

Roll-backReturns the automation objects back to the specified version on this IBMCognos Command Center server. The Promote button performs this action.

Export Defines a set of automation objects for an export operation. You can usethe Export window to select a label as the set of automation objects.

Procedure1. In the navigation pane, select the Labels item.

2. To add a label, either click the New icon

or right-click the label item in thenavigation pane. You can view and edit an existing label by double-clicking thelabel name.

3. Specify the properties that you want.4. Save the label.



Chapter 6. Export and import

You can use IBM Cognos Command Center to export and import objects.

The export and import feature can take the contents of a Cognos Command Centerserver and load it into another Cognos Command Center server to migrate yourCognos Command Center implementation from development to test to productionserver instances. You can import and export the following objects:v Agentsv Ecosystemsv File resourcesv Processesv Rolesv Triggersv Users

Both development and production instances are managed on a single CognosCommand Center server. Separate ecosystems are created to sandbox changes thatare made between development and production.

In this example, FinPlan is defined as two ecosystems: Fin Plan Development andFin Plan Production. You can use this separation to edit, test, and verify processand file resource changes in the development ecosystem before you upgrade yourproduction ecosystem.


After the process and file resource object changes are verified on the developmentecosystem, migrate the changes to the production system.v Export FinPlanDev to FinPlanDev.sfe, a file that is stored on any accessible

computer.v Import FinPlanDev.sfe into the FinPlanProd ecosystem.

Figure 11. Example of a single-server design option with separate ecosystems


Exporting Cognos Command Center objectsYou can export a snapshot of IBM Cognos Command Center server automationobjects, agents, ecosystems, processes, file resources, and triggers.

Exporting creates a secured XML file that can be imported back into the sameserver or a different IBM Cognos Command Center server.

Procedure1. Click File > Export.2. You have two options to define a list of objects to export:v Select Export Label and select a label.v Select any set of objects in the object tree.

Attention: When you select a process, all referenced file resources areautomatically included in the export.

3. Click Export.4. Specify a file name and folder.5. Enter a valid password.6. Click Export.

Importing Cognos Command Center objectsYou can use the import feature to import an IBM Cognos Command Center exportfile.

Attention: Make sure that the import system has the agents that are required torun the imported processes.

Procedure1. Click File > Import.2. Browse to the file name.3. Enter the valid password that was defined during the export.4. Click Import.5. Select or clear the items that you want to import.6. Click Next.7. Click Finish Import.

All selected automation objects are imported into the Cognos Command Centerserver and a new label is automatically created to identify the imported objects.

Chapter 6. Export and import 55


Chapter 7. Run and monitor automations

Running processes is the primary function of IBM Cognos Command Center.

You can run processes in the following ways:v Manual start with the Windows or browser user interfacev Schedule to run at specific dates and times, or according to occurrence settingsv Trigger by a request from the Event Listenerv Trigger by a request from the Web Service interfacev Trigger by another process

You can use the Process Overview tab to run and monitor all accessible CognosCommand Center processes.

Running a process manuallyYou can run an IBM Cognos Command Center process manually

Procedure1. From the navigation tree, click Processes Overview.2. Select a process.

3. Click the Run icon .4. Click Start.

You can run only a single instance of a specific process within eachenvironment.If you make a start request when the process is already running in theenvironment, the request fails.You can pause or stop the process. The process pauses or stops when the activetask completes.

Scheduling a processYou can use IBM Cognos Command Center to schedule each process in variousway and with multiple schedules.

Each process can have one or more schedules. You can use the Add icon

and Delete icon

to manage multiple schedules.

Attention: You must select the Activate check box to turn on the schedule. ClearActivate to turn the schedule off.

Procedure1. On the Process Overview tab, select a process.2. Click Schedule.3. To view a schedule's properties, select its descriptive row.


4. Specify the schedule times and frequencies by setting the Daily occurrence,Recurrence pattern, and Range of recurrence properties.


Chapter 8. Cognos Command Center plug-ins

You can extend the functionality of IBM Cognos Command Center by using theplug-ins that are available to you.

For example, if you have the FTP or SFTP plug-in installed, you can do thefollowing tasks:v Fetch a file from a remote server and make a local copy.v Move or delete a file on a remote server.v Return a directory listing of a specific path on a remote server.

Other plug-ins provide functionality that is specific to the product for which theplug-in is designed.

Installing the Cognos Command Center plug-insAn IBM Cognos Command Center plug-in is a set of task types and computingresources types that targets a specific technology or target system.

About this task

During the first installation of Cognos Command Center, a default set of plug-insis installed in INSTALLDIR\Plugins and loaded into the repository.

When you upgrade a Cognos Command Center installation, no plug-ins areloaded. You can update plug-ins after the upgrade, or when existing plug-ins areupdated, or when new plug-ins become available. Plug-ins are distributed ascompressed files and are installed by using the Cognos Command Center client.

For information on configuring computing resources for each plug-in and on theuse of plug-in tasks in processes, see the IBM Cognos Command CenterAdministration Guide.

Procedure1. Click Tools > Manage Plugin Tasks.2. In the Manage Plugin Tasks window, from the INSTALLDIR\Plugins directory,

select the plug-in name.x.x.zip file that you want.3. Click Load file. After the plug-in is installed, the plug-in tasks for the selected

plug-in are available on the Add Task menu in the process editor.4. To specify the plug-in tasks:

a. Double-click the name of the process to open the process editor.b. Click Edit.

c. Click the add task icon , click Automation Task, and browse to theplug-in task that you want to specify. For example, click Automation Task >File Utilities > Delete Directory.


Setting up a computing resource in the Cognos Command Centerserver

To use some plug-ins, a computing resource must be configured. This resourcerepresents a server instance.

Procedure1. In the Cognos Command Center navigation tree, click Setup and Design.2. Click Ecosystems.3. Open an ecosystem. For example, double-click the name of an existing

ecosystem in the navigation pane.4. In the ecosystem editor window, click the Computing resources tab.

5. Click the Add computing resource icon

to add a new computingresource. The new computing resource editor opens.

6. Select the computing resource that you want to add from the Type list.7. Configure the attributes that you need.

Cognos Command Center plug-in for Cognos Business IntelligenceThe IBM Cognos Business Intelligence plug-in provides a task type for runningCognos BI tasks from within IBM Cognos Command Center.

Compatibility

The IBM Cognos BI plug-in is compatible with the following IBM CognosCommand Center components:

IBM Cognos Command Center Client10.2.1 or higher.

IBM Cognos Command Center Server10.2.1 or higher.

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

IBM Cognos Business Intelligence plug-in configurationThis resource represents an IBM Cognos BI instance.

The following table shows the arguments for the configuration of the IBM CognosBI computing resource.

Table 20. Configuration of the IBM Cognos BI computing resource


HomeDirectory

The directory to use when processing tasks on this resource.

Dispatcher The dispatcher URI for external applications. See the IBM CognosConfiguration information for the IBM Cognos Business Intelligence server.

Namespace ID The namespace ID. Leave blank if anonymous authentication is enabled forthe IBM Cognos Business Intelligence server.

User name The user name. Leave blank if anonymous authentication is enabled for theIBM Cognos Business Intelligence server.


Table 20. Configuration of the IBM Cognos BI computing resource (continued)


Password The password of the user.

Gateway URI The gateway URI is only needed for the Check Gateway task

IBM Cognos Business Intelligence plug-in task referenceThe Cognos BI tasks have arguments that you can specify.

List reports

The List Reports task lists available Cognos BI reports.

The following table shows the task argument for the List Reports task.

Table 21. Task arguments for the List Reports task


Root searchpath

The root search path for the folder that contains the reports to list.

Recursive Specifies whether to search recursively for reports. The default value isFalse.

Run report

The Run Report task runs a Cognos BI report.

The following table shows the task argument for the Run Report task.

Table 22. Task arguments for the Run Report task


Search path The search path for the report.

Parameters An optional list of parameter values required by the report. Eachparameter is specified as <param_name>=<param_value>, separated by one ormore spaces.

Output type The report output format.

Outputdirectory

The output directory to which the report is written.

Overwrite Specifies whether to overwrite the existing output files. The default valueis True.

Burst Specifies whether to burst the report. The default value is False.

Run job

The Run Job task runs a Cognos BI job.

The following table shows the task argument for the Run Job task.

Table 23. Task arguments for the Run Job task


Search path The search path for the job.

Chapter 8. Cognos Command Center plug-ins 61

List jobs

The List Jobs task lists available Cognos BI jobs.

The following table shows the task argument for the List Jobs task.

Table 24. Task arguments for the List Jobs task


Root searchpath

The root search path for the top folder containing the jobs to list.

Recursive Specifies whether to recursively search subfolders for jobs.

Check gateway

The Check Gateway task uses the Gateway URI attribute defined in the BIcomputing resource to check that the Cognos BI gateway is up. This task requiresthat the gateway URI is defined.

Cognos Command Center plug-in for Cognos Integration ServerThe IBM Cognos Integration Server plug-in provides task types for runningCognos Integration Server selections from within IBM Cognos Command Center.

Attention:

When upgrading the IBM Cognos Integration Server plug-in, you must edit allexisting Cognos Integration Server computing resources because the set ofattributes has changed. For each such computing resource, make sure that thevalue of the Cognos Integration Server installdir attribute points to the CognosIntegration Server installation directory. This is typically C:\ProgramFiles\IBM\cognos\icis.

Compatibility

The IBM Cognos Integration Server plug-in is compatible with the following IBMCognos Command Center components:




IBM Cognos Integration Server plug-in configurationThis resource represents an IBM Cognos Integration Server instance.

The following table shows the arguments for the configuration of the IBM CognosIntegration Server computing resource.


Table 25. Configuration of the IBM Cognos Integration Server computing resource


CognosIntegrationServerinstalldir

The Cognos Integration Server installation directory. Typically C:\ProgramFiles\IBM\cognos\icis.

IBM Cognos Integration Server plug-in task referenceThe Cognos Integration Server tasks have arguments that you can specify.

Run selection

The task Run Selection runs a Cognos Integration Server selection.

The following table shows the task argument for the task.

Table 26. Task argument for the Run Selection task


Selection The name or ID of the selection to run.

Run selection with command file

The task Run Selection with Command File runs a Cognos Integration Serverselection by using a file that contains more input or modification commands. Formore information, see the IBM Cognos Integration Server Administration Guide.

The following table shows the task argument for the task.

Table 27. Task argument for the Run Selection with Command File task


Selection The name or ID of the selection to run.

Command filename

The name of the file that contains the additional input or modificationcommands.

Cognos Command Center plug-in for emailThe email utilities plug-in provides a task type for sending email from within IBMCognos Command Center processes.

Compatibility

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





The plug-in requires Microsoft .NET Framework 3.5 or higher on Windows agenthosts.

The plug-in requires a Java environment on UNIX agent hosts. For moreinformation, see the IBM Cognos Command Center Installation Guide.

Email plug-in configurationAn email host computing resource must be configured to use the email utilitiesplug-in. The computing resource represents a Simple Mail Transfer Protocol(SMTP) server.

The following table shows the arguments for the configuration of the email hostcomputing resource.

Table 28. Configuration of the email host computing resource


Agent The agent that runs all tasks related to this resource.

Homedirectory


Hostname The host name of the SMTP server.

Port The port number of the SMTP server. The standard SMTP port is 25.

Use TLS Set to true if it is a secure SMTP server that requires encryptedcommunication that uses TLS/SSL.

The default value is False.

HELO domain Certain environments require a specific HELO domain to be set as part ofa successful handshake.

Username The user name that is required to authenticate against the SMTP server.Leave empty if the server requires no authentication.

Password The password that is required to authenticate against the SMTP server.Leave empty if the server requires no authentication.

Email plug-in task referenceThe Send Email task sends email to a list of recipients.

The following table shows the task arguments for the Send Email task.

Table 29. Task arguments for the Send Email task


To The email addresses of the recipients. Separate multiple recipients with asemicolon.

Cc The email addresses of the Cc (carbon copy) recipients. Separate multiplerecipients with a semicolon.

Bcc The email addresses of the Bcc (blind carbon copy) recipients. Separatemultiple recipients with a semicolon.

From The sender's email address.

Subject The subject of the message.

Message Email message. Use this field for a simple, one-line message. To sendlonger messages, put the message into a file and refer to this file by usingthe message file property.


Table 29. Task arguments for the Send Email task (continued)


Message file The name of a file that contains the email message body. Use this propertyto send longer messages. To send simple, one-line messages, use themessage property.

Attachments List of attachments. Separate each file by using a semicolon.

Cognos Command Center plug-in for file utilitiesThe 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:




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 Installation Guide.

File utilities plug-in configurationNo special computing resource is required to use the tasks in the file utilitiesplug-in.

File utilities plug-in task referenceThe File Utilities tasks have arguments that you can specify.

Convert encoding

The Convert 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 30. Task arguments for the Convert Encoding task


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.


Table 30. Task arguments for the Convert Encoding task (continued)


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 31. 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.

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


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.

Filter columnwidth

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


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.

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 32. 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 33. 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 34. 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 35. 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.


Table 35. Task arguments for the Delete Less Days task (continued)


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 36. Task argument for the Detect Unicode task


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

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.

Table 37. 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.


Table 37. Task arguments for the Extract List task (continued)


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.


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 38. 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.



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


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 38. 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 39. 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.


Output format Sets the output format. Brief outputs the number of occurrences. Verboseoutputs the matching lines.

List directory

The List Directory task lists the content of a directory on the server.

Table 40. Task arguments for the List Directory 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.

List file content

The List File Content task lists the contents of a file.

Table 41. Task argument for the List File Content task


Computingresource

The host computing resource.

File name The file to list the contents of.


Make directory

The Make Directory task creates a directory on the server.

Table 42. 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 43. 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.


Move less days

The Move less days task moves files or directories that have not been modified inthe last n days.

Table 44. Task arguments for the Move less days task



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

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


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

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 45. 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 46. 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 47. 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 47. 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 48. 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 49. 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.


Cognos Command Center plug-in for FTPThe FTP plug-in provides a task type for transferring files by using File TransferProtocol (FTP).


Compatibility

The FTP plug-in is compatible with the following IBM Cognos Command Centercomponents:





The plug-in requires a Java environment on the agent hosts. On Windows the IBMCognos Command Center 10.1 agent (or higher) comes with Java, and on UNIX,Java must be installed separately. For more information, see the IBM CognosCommand Center Installation Guide.

FTP plug-in configurationNo special computing resource is required to use the tasks in the FTP plug-in.

All tasks have a common set of connection-related arguments as shown in thefollowing table.

Table 50. Configuration of connection-related arguments


Computingresource

The computing resource that is used to run the task. Computing resourcesof only the Host type are allowed.

Hostname Host name for the FTP server. Use either a DNS name (for example,example.com) or a numeric IP address (for example, 127.0.0.1).

Port Port number for the FTP server.


Username User name for the account on the FTP server.

Password Password that is associated with the account.

FTP plug-in task referenceThe FTP tasks have arguments that you can specify.

Delete

The Delete task deletes files or directories from the remote server.

The following table shows the task arguments for the Delete task.



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


Table 51. Task arguments for the Delete task (continued)


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

The default is cleared.

Delete directory

The Delete Directory task deletes directories from the remote server.

The following table shows the task argument for the Delete Directory task.




Dir

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

The following table shows the task argument for the Dir task.

Table 53. Task argument for the Dir task


Directory The directory to list contents of.

Get

The Get task downloads files from the remote server to the local host where thetask is run.

The following table shows the task arguments for the Get task.

Table 54. Task arguments for the Get task


Remote file The name of the files on the FTP server. Use the wildcard characters * and? to specify multiple files on the server.

Local file The name of the file or directory where the content of the remote files arewritten to. When you get multiple files, this must be the name of adirectory.

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



Make directory

The Make Directory task creates a directory on the remote server.

The following table shows the task arguments for the Make Directory task.

Table 55. Task arguments for the Make Directory task



Move

The Move task moves files or directories on the remote FTP server.

The following table shows the task arguments for the Move task.




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



Put

The Put task uploads files from the local host where the task is being run to theremote FTP server.

The following table shows the task arguments for the Put task.

Table 57. Task arguments for the Put task


Local file The name of the files on the local host. Use the wildcard characters * and ?to specify multiple files.

Remote file The local file where the content of the local file is written. When youupload multiple files, the remote file must be a directory name.



Cognos Command Center plug-in for FTPSThe FTPS plug-in provides a task type for transferring files by using File TransferProtocol over SSL (FTPS).


Compatibility

The FTPS plug-in is compatible with the following IBM Cognos Command Centercomponents:






FTPS plug-in configurationNo special computing resource is required to use the tasks in the FTPS plug-in.




Computingresource


Hostname Host name for the FTPS server. Use either a DNS name (for example,example.com) or a numeric IP address (for example, 127.0.0.1).

Port Port number for the FTPS server.

The default value is port 990 for implicit SSL, and port 21 for explicit SSL.

Username User name for the account on the FTPS server.


FTPS plug-in task referenceThe FTPS tasks have arguments that you can specify.

Delete







Table 59. Task arguments for the Delete task (continued)


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


Delete directory






Dir






Get





Remote file The name of the files on the FTPS server. Use the wildcard characters * and? to specify multiple files on the server.

Local file The name of the file or directory where the content of the remote files arewritten to. When you get multiple files, this must be the name of adirectory.




Make directory






Move

The Move task moves files or directories on the remote FTPS server.





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



Put

The Put task uploads files from the local host where the task is being run to theremote FTPS server.








Cognos Command Center plug-in for Oracle EPM MonitoringThe Oracle EPM Monitoring plug-in provides a set of task types for monitoringand administering Oracle EPM services within IBM Cognos Command Centerprocesses.


Compatibility

The Oracle EPM Monitoring plug-in is compatible with the following IBM CognosCommand Center 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 Windows.


The plug-in requires a Java environment to be present on the agent hosts. On theMicrosoft Windows operating system, the IBM Cognos Command Center 10.1agent (or higher) comes with Java, and on UNIX, Java must be installed separately.For more information, see the IBM Cognos Command Center Installation Guide.

Oracle EPM Monitoring plug-in configurationAn Oracle EPM computing resource must be configured to use the Oracle EPMMonitoring plug-in. This resource type represents an Oracle EPM server instance.

The following table shows the arguments for the configuration of the Oracle EPMcomputing resource.

Table 66. Configuration of the Oracle EPM computing resource


Agent The agent that runs all tasks that are related to this resource.

Server The URI of the runtime MBean instance within the Oracle EPM server.

The default value is service:jmx:iiop://localhost:7001/jndi/weblogic.management.mbeanservers.domainruntime.

User name The user name that is required to authenticate against the Oracle EPMserver.

Password The password for the user name.

WebLogicThin Clientdir

The directory that contains the WebLogic thin client jar files(wlfullclient.jar, wlclient.jar, and wljmxclient.jar). These aretypically in the server\lib subdirectory of the WebLogic home directory.wlfullclient.jar, wlclient.jar, and wljmxclient.jar

Attention: This attribute must end with a path separator.

The default value is WebLogicHome\server\lib\.

Homedirectory


Oracle EPM Monitoring plug-in task referenceThe EPM Monitoring tasks have arguments that you can specify.


Check service

The Check Service task checks the state of the servers that comprise an OracleEPM server.

The following table shows the task arguments for the Check Service task.

Table 67. Task arguments for the Check Service task


Service The name of the service to monitor. The set of available service namesdepends on the Oracle EPM installation and can be listed by using the ListServices task.

List Services

The List Services task lists the available services in an Oracle EPM server. The setof services that are found depends on the set of installed components on thetargeted server.

There are no arguments for this task.

Cognos Command Center plug-in for Oracle Essbase 9The Oracle Essbase plug-in provides a task type for automating commonoperations that target Oracle Hyperion Essbase 9 from within IBM CognosCommand Center processes.

Compatibility

The Oracle Essbase 9 plug-in is compatible with the following IBM CognosCommand Center components:






The plug-in requires a Java environment on UNIX agent hosts. For moreinformation, see the IBM Cognos Command Center Installation Guide.

Oracle Essbase 9 plug-in configurationAn Oracle Essbase 9 computing resource must be configured to use the OracleEssbase plug-in. This resource type represents an Oracle Essbase server.

The following table shows the arguments for the configuration of the OracleEssbase 9 computing resource.


Table 68. Configuration of the Oracle Essbase 9 computing resource



Homedirectory


Essbase ServerName

The Essbase server name.

Essbase UserName

The Essbase user name that runs tasks.

EssbasePassword

The password of the Essbase user.

Essbase ServerPath

The Essbase server path to the BIN directory.

Essbase JavaAPI Folder

The location of the Essbase Java API jar files. The plug-in expects to findess_es_server.jar and ess_japi.jar in this folder.

This argument is only required when you use the Export Data (J) task.

OracleDiagnosticLogging(ODL) Folder

Path of the Oracle Diagnostic Logging (ODL) folder. The plug-in looks forojdl.jar in this folder.

This argument is only required when you use the Export Data (J) task thattargets Essbase 11.

Attention: The plug-in uses the Essbase MaxL and ESSCMD command lineinterfaces. In order for the Task Pack to work properly, the user account that runsthe IBM Cognos Command Server agent on an Essbase server must be able to runMaxL and ESSCMD. To achieve this, you can include the local Windows account inthe Hyperion User group. If the agent does not use a valid Essbase user account,you might see the following error message when you try to run a task:

Error initializing localization module

If you receive this error, verify that the user account that is running the IBMCognos Command Center agent on an Essbase server has access to the Essbaseserver computer, and also can log on through the MaxL command line interface.

If these conditions are not satisfied, then modify your environment to start the IBMCognos Command Center agent with a user account that has access to the Essbasecommand line interfaces.

Oracle Essbase 9 plug-in task referenceThe Essbase 9 tasks have arguments that you can specify.

Copy app

The Copy App task copies a specified Essbase application to a new one.

The following table shows the task arguments for the Copy App task.


Table 69. Task arguments for the Copy App task


SourceApplication

The source application.

DestinationApplication

The destination application.

Copy Db

The Copy Db task copies a specified Essbase database to a new one.

The following table shows the task arguments for the Copy Db task.

Table 70. Task arguments for the Copy Db task


SourceApplication

The source application.

SourceDatabase

The source database from the source application.

DestinationApplication

The destination application.

DestinationDatabase

The destination database under the destination application.

Create variable

The Create Variable task creates a new Essbase substitution variable and sets avalue.

The following table shows the task arguments for the Create Variable task.

Table 71. Task arguments for the Create Variable task


ApplicationName

The application name.

DatabaseName

The database name.

VariableName

The variable name to create.

Value The value to which the variable name is set.

Data load text file

The Data Load Text File task runs a data load of a specified text file to an Essbasedatabase.

The following table shows the task arguments for the Data Load Text File task.


Table 72. Task arguments for the Data Load Text File task


ApplicationName


DatabaseName

The database name.

Data FileName

The name of the text data file that is on the Essbase server. A file path canbe defined, for example c:\Files\Data.txt. If only a file name is specified,then the file path is set as the home directory of the Oracle Essbasecomputing resource.

Data load with rules

The Data Load with Rules task runs a data load of a specified file and data loadrule to an Essbase database. This task does not provide the option of specifying anerror log, so any load errors cause the task to fail in IBM Cognos CommandCenter.

The following table shows the task arguments for the Data Load with Rules task.

Table 73. Task arguments for the Data Load with Rules task


ApplicationName


DatabaseName

The database name.

Data FileName


Rules File The name of the Essbase rules file that is on the Essbase server. A file pathcan be defined, for example c:\Files\Act.Rul. If only a file name isspecified, then the file path is set as the home directory of the OracleEssbase computing resource.

Data load with rules log

The Data Load with Rules Log task runs a data load of a specified file and dataload rule to an Essbase database with error logging. If a data load error occurs,then the task returns a zero return code to IBM Cognos Command Center, with theerrors captured in the task output.

The following table shows the task arguments for the Data Load with Rules Logtask.

Table 74. Task arguments for the Data Load with Rules Log task


ApplicationName


DatabaseName

The database name.


Table 74. Task arguments for the Data Load with Rules Log task (continued)


Data FileName


Rules File The name of the Essbase rules file that is on the Essbase server. A file pathcan be defined, for example c:\Files\Act.Rul. If only a file name isspecified, then the file path is set as the home directory of the OracleEssbase computing resource.

Log FileName

The name of the Essbase output error log. A file path can be defined, forexample c:\Files\Data.Err. If only a file name is specified, then the filepath is set as the home directory of the Oracle Essbase computing resource.

Delete App

The Delete App task deletes an Essbase application.

The following table shows the task argument for the Delete App task.

Table 75. Task argument for the Delete App task


ApplicationName

The name of the application to delete.

Delete Db

The Delete Db task deletes an Essbase database.

The following table shows the task arguments for the Delete Db task.

Table 76. Task arguments for the Delete Db task


ApplicationName

The name of the application.

DatabaseName

The name of the database to delete.

Delete variable

The Delete Variable task deletes a substitution variable.

The following table shows the task arguments for the Delete Variable task.

Table 77. Task arguments for the Delete Variable task


ApplicationName


DatabaseName

The name of the database.


Table 77. Task arguments for the Delete Variable task (continued)


VariableName

The name of the variable to delete.

Display lock

The Display Lock task displays block lock information for the Essbase applicationor database.

The following table shows the task arguments for the Display Lock task.

Table 78. Task arguments for the Display Lock task


ApplicationName


DatabaseName


Display Session

The Display Session task displays active login session information for the Essbaseapplication or database.

The following table shows the task arguments for the Display Session task.

Table 79. Task arguments for the Display Session task


ApplicationName


DatabaseName


Drop lock

The Drop Lock task removes any data block locks from Essbase for the Essbaseapplication or database.

The following table shows the task arguments for the Drop Lock task.

Table 80. Task arguments for the Drop Lock task


ApplicationName


DatabaseName



Export data

The Export Data task exports data from a specified database.

The following table shows the task arguments for the Export Data task.

Table 81. Task arguments for the Export Data task


ApplicationName


DatabaseName


Path OutputFile Name

The name of the export file to be created. A file path can be defined, forexample c:\Files\Dump.txt. If only a file name is specified, then the filepath is set as the home directory of the Oracle Essbase computing resource.

Export Data (J)

The Export Data (J) task exports data from a specified database.

The following table shows the task arguments for the Export Data (J) task.

Table 82. Task arguments for the Export Data (J) task


ApplicationName


DatabaseName


Member ListFile

An optional file that contains a list of members to extract.

The purpose of the member list file is to limit the output of the extractionto a subset of members. The format of the member list file is lines ofmember names, which are separated by theEssbaseMemberFileColumnSeparator (in the Essbase.properties file). Itdefaults to a comma. If a member name has a space or theEssbaseMemberFileColumnSeparator in it, it should be enclosed in doublequotation marks. You can enclose all names in double quotation marks, butit is not necessary. You can have as many lines with member names as youlike. For example, here is a two-line member list file:

100-10, "Sales", "Jan", Florida, "New York"

"West", 200, "Ratios"

Member ListFile Delimiter

The delimiter that is used in the member list file.

ColumnHeader

Set to True to include column headers in the output.

Suppress Specifies whether certain values are suppressed from the output.

Data Level Specifies the level of data to be extracted.

Attention: Essbase aggregate storage (ASO) cubes support only level 0.

Precision Specifies the number of decimal places for the output.

Missing Label The label that is used for missing data values.


Table 82. Task arguments for the Export Data (J) task (continued)


ConvertScientific toDecimal

Set to True to convert scientific numbers to decimal in the output.

SpinDimension

The name of the spin dimension that is used for the export.

SpinDimensionMember ListFile

An optional file that contains a list of spin dimension members to extract.Each member must be separated with the delimiter selected in the MemberList File Delimiter attribute.

OutputFormat

The output format.

Output FileDelimiter

The delimiter that is used in the output file.

Output File The output file name. A file path can be defined, for examplec:\Files\JDump.txt. If only a file name is specified, then the file path is setas the home directory of the Oracle Essbase computing resource.

Delete AppLog After Run

Set to True to delete the Essbase application log after the first task is run.

CommandDelay

An optional delay in milliseconds between each command sent to Essbase.

Buffer Size The size of the output buffer that is used when writing the output.

TempDirectory

The directory that is used for writing temporary files.

Attention: This task must be run on an agent that is installed directly on theEssbase server. For more information, see “Specifying the setting for the ExportData (J) task” on page 95.

Get DB Info

The Get DB Info task displays DB information for the specified Essbase database.

The following table shows the task arguments for the Get DB Info task.

Table 83. Task arguments for the Get DB Info task


ApplicationName


DatabaseName


Grant access

The Grant Access task grants the security access level to the specified Essbasedatabase to a user or group.

The following table shows the task arguments for the Grant Access task.


Table 84. Task arguments for the Grant Access task


Access Defines the access control level: No Access, Read & Write, or Read Only.

ApplicationName


DatabaseName


User/GroupName

The user or group to which the access is assigned.

Grant execute

The Grant Execute task grants the security access level to the specified calc scriptto a user or group.

The following table shows the task arguments for the Grant Execute task.

Table 85. Task arguments for the Grant Execute task


ApplicationName


DatabaseName


Calc Script The Calc Script name.

User/GroupName


List variables

The List Variables task displays the substitution variables for the specified Essbaseapplication or database.

The following table shows the task arguments for the List Variables task.

Table 86. Task arguments for the List Variables task


ApplicationName


DatabaseName


Login switch

The Login Switch task enables or disables connections to a specified Essbaseapplication.

The following table shows the task arguments for the Login Switch task.


Table 87. Task arguments for the Login Switch task


Switch Specified whether to enable or disable connections.

ApplicationName


Metadata load

The Metadata Load task loads dimensions from a specified source to an Essbasedatabase.

The following table shows the task arguments for the Metadata Load task.

Table 88. Task arguments for the Metadata Load task


ApplicationName


DatabaseName


Data FileName

The data file name. A file path can be defined, for examplec:\Files\Product.txt. If only a file name is specified, then the file path isset as the home directory of the Oracle Essbase computing resource.

Rules FileName

The rules file name. A file path can be defined, for examplec:\Files\ProdBuild.rul. If only a file name is specified, then the file pathis set as the home directory of the Oracle Essbase computing resource.

Login FileName

The name of the Essbase output error log. A file path can be defined, forexample c:\Files\Data.Err. If only a file name is specified, then the filepath is set as the home directory of the Oracle Essbase computing resource.

Reset DB

The Reset DB task clears all data and linked reporting objects from a specifiedEssbase database.

The following table shows the task arguments for the Reset DB task.

Table 89. Task arguments for the Reset DB task


ApplicationName


DatabaseName


Run calc file

The Run Calc File task runs a calc script from a specified path on the Essbaseserver.

The following table shows the task arguments for the Run Calc File task.


Table 90. Task arguments for the Run Calc File task


ApplicationName


DatabaseName


Calc Script The calc script name. A file path can be defined, for examplec:\Files\Cal.csc. If only a file name is specified, then the file path is setas the home directory of the Oracle Essbase computing resource.

Run calc script

The Run Calc Script task runs a calc script from the App/Db directory on theEssbase server.

The following table shows the task arguments for the Run Calc Script task.

Table 91. Task arguments for the Run Calc Script task


ApplicationName


DatabaseName


Calc Script The calc script name.

Run calc string

The Run Calc String task runs a calculation string.

The following table shows the task arguments for the Run Calc String task.

Table 92. Task arguments for the Run Calc String task


ApplicationName


DatabaseName


Calc String The Essbase calc string, for example: CALC ALL;

Run default calc

The Run Default Calc task runs the default calc against a specified Essbasedatabase.

The following table shows the task arguments for the Run Default Calc task.

Table 93. Task arguments for the Run Default Calc task


ApplicationName



Table 93. Task arguments for the Run Default Calc task (continued)


DatabaseName


Run report script

The Run Report Script task runs a specified report script from a specified path onthe Essbase Server and outputs the results to a specified text file.

The following table shows the task arguments for the Run Report Script task.

Table 94. Task arguments for the Run Report Script task


ApplicationName


DatabaseName


Report Script The report script name. A file path can be defined, for examplec:\Files\Top.RPT. If only a file name is specified, then the file path is setas the home directory of the Oracle Essbase computing resource.

Output FileName

The name of the output file. A file path can be defined, for examplec:\Files\Top.TXT. If only a file name is specified, then the file path is setas the home directory of the Oracle Essbase computing resource.

Set default calc

The Set Default Calc task sets a calculation string as the default calc for adatabase.

The following table shows the task arguments for the Set Default Calc task.

Table 95. Task arguments for the Set Default Calc task


ApplicationName


DatabaseName


Calc String The Essbase calc string, for example: CALC ALL;

Start/Stop app

The Start/Stop App task starts a specified Essbase application.

The following table shows the task arguments for the Start/Stop App task.

Table 96. Task arguments for the Start/Stop App task


Start/Stop Specifies whether to start or stop the specified


Table 96. Task arguments for the Start/Stop App task (continued)


ApplicationName


Update variable

The Update Variable task updates the value of a specified substitution variable.

The following table shows the task arguments for the Update Variable task.

Table 97. Task arguments for the Update Variable task


ApplicationName


DatabaseName


VariableName

The variable name.

Value The value to which the variable is set.

Specifying the setting for the Export Data (J) taskThe Export Data (J) task must be run on an agent that is installed directly on theEssbase server. When you run an Essbase server on a Windows computer, youmust ensure that the following is set for the task to properly run.

Procedure1. Open regedit.2. Go to HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\

Parameters.3. If MaxUserPort is present, change its value to 65534 (decimal). If it is not, add a

DWORD value with the name MaxUserPort and the value 65534 (decimal).4. If TcpTimedWaitDelay is present, change its value to 30 (decimal). If it is not,

add a DWORD value with the name TcpTimedWaitDelay and the value 30(decimal).

5. Restart the computer.

Cognos Command Center plug-in for Oracle Essbase 11The Oracle Essbase plug-in provides a task type for automating commonoperations that target Oracle Hyperion Essbase 11 from within IBM CognosCommand Center processes.

Compatibility

The Oracle Essbase plug-in is compatible with the following IBM CognosCommand Center components:






Oracle Essbase 11 plug-in configurationAn Oracle Essbase 11 computing resource must be configured to use the OracleEssbase 11 plug-in. This resource type represents an Oracle Essbase 11 server.

The following table shows the arguments for the configuration of the OracleEssbase 11 computing resource.

Table 98. Configuration of the Oracle Essbase 11 computing resource


Essbase ServerName

The Essbase server name.

Essbase UserName

The Essbase user name that runs tasks.

EssbasePassword

The password of the Essbase user.

Essbase JavaAPI Folder

The location of the Essbase Java API jar files.

OracleDiagnosticLogging(ODL) Folder

Path of the Oracle Diagnostic Logging (ODL) folder. The plug-in looks forojdl.jar in this folder.

HomeDirectory


Oracle Essbase 11 plug-in task referenceThe Essbase 11 tasks have arguments that you can specify.

Copy application

The Copy Application task copies an Essbase application.

The following table shows the task arguments for the Copy Application task.

Table 99. Task arguments for the Copy Application task


SourceApplicationName

The name of the source Essbase application to copy.

DestinationApplicationName

The name of the target Essbase application.


Copy database

The Copy Database task copies an Essbase database.

The following table shows the task arguments for the Copy Database task.

Table 100. Task arguments for the Copy Database task


SourceApplicationName

The name of the source Essbase application to copy.

DestinationApplicationName

The name of the target Essbase application.

DestinationDatabaseName

The name of the target Essbase database.

Display Lock

The Display Lock task display lock information for an Essbase database.

The following table shows the task arguments for the Display Lock task.

Table 101. Task arguments for the Display Lock task


ApplicationName

The name of the Essbase application.

DatabaseName

The name of the Essbase database.

Display session

The Display Session task displays active login session information for the Essbaseapplication or database.

The following table shows the task arguments for the Display Session task.

Table 102. Task arguments for the Display Session task


ApplicationName


DatabaseName


Drop lock

The Drop Lock task removes any data block locks from Essbase for the Essbaseapplication or database.

The following table shows the task arguments for the Drop Lock task.


Table 103. Task arguments for the Drop Lock task


Applicationname


Databasename


Export data (native)

The Export Data (native) task exports data from a specified database.

The following table shows the task arguments for the Export data (native) task.

Table 104. Task arguments for the Export data (native) task


ApplicationName


DatabaseName


Path OutputFile Name

The name of the export file to be created. A file path can be defined, forexample c:\Files\Dump.txt. If only a file name is specified, then the filepath is set as the home directory of the Oracle Essbase computing resource.

Data Level Controls the level of data to export.

Columns? Controls the output of data blocks in column format for creating rules files.

Export Data (High Performance)

The Export Data (High Performance) task performs a high performance extractionfrom Essbase.

The following table shows the task arguments for the Export Data (HighPerformance) task.

Table 105. Task arguments for the Export Data (High Performance) task


ApplicationName


DatabaseName



Table 105. Task arguments for the Export Data (High Performance) task (continued)


Member ListFile

An optional file that contains a list of members to extract.

The purpose of the member list file is to limit the output of the extractionto a subset of members. The format of the member list file is lines ofmember names, which are separated by theEssbaseMemberFileColumnSeparator in the Essbase.properties file. Itdefaults to a comma. If a member name has a space or theEssbaseMemberFileColumnSeparator in it, it must be enclosed in doublequotation marks. You can enclose all names in double quotation marks, butit is not necessary. You can have as many lines with member names as youlike. For example, here is a two-line member list file:

100-10, "Sales", "Jan", Florida, "New York"

"West", 200, "Ratios"

Member ListFile Delimiter

The delimiter that is used in the member list file.

ColumnHeader

Set to True to include column headers in the output.

Suppress Specifies whether certain values are suppressed from the output.

Data Level Specifies the level of data to be extracted.

Attention: Essbase aggregate storage (ASO) cubes support only level 0.

Precision Specifies the number of decimal places for the output.

Missing Label The label that is used for missing data values.

ConvertScientific toDecimal

Set to True to convert scientific numbers to decimal in the output.

SpinDimension

The name of the spin dimension that is used for the export.

SpinDimensionMember ListFile

An optional file that contains a list of spin dimension members to extract.Each member must be separated with the delimiter selected in the MemberList File Delimiter attribute.

OutputFormat

The output format.

Output FileDelimiter

The delimiter that is used in the output file.

Output File The output file name. A file path can be defined, for examplec:\Files\JDump.txt. If only a file name is specified, then the file path is setas the home directory of the Oracle Essbase computing resource.

Delete AppLog After Run

Set to True to delete the Essbase application log after the first task is run.

CommandDelay

An optional delay in milliseconds between each command sent to Essbase.

Buffer Size The size of the output buffer that is used when the output is written.

TempDirectory

The directory that is used for writing temporary files.


Execute MaxL script

The Execute MaxL Script task executes a MaxL script file

The following table shows the task argument for the Execute MaxL Script task.

Table 106. Task argument for the Execute MaxL Script task


Script MaxL script.

Get database info

The Get Database Info task displays DB information for the specified Essbasedatabase.

The following table shows the task arguments for the Get Database Info task.

Table 107. Task arguments for the Get Database Info task


ApplicationName


DatabaseName


Grant access

The Grant Access task grants the security access level to the specified Essbasedatabase to a user or group.

The following table shows the task arguments for the Grant Access task.

Table 108. Task arguments for the Grant Access task


Access Defines the access control level: No Access, Read & Write, or Read Only.

ApplicationName


DatabaseName


User/GroupName


Grant execute

The Grant Execute task grants the security access level to the specified calc scriptto a user or group.

The following table shows the task arguments for the Grant Execute task.


Table 109. Task arguments for the Grant Execute task


ApplicationName


DatabaseName


Calc Name The calculation name.

Target UserName

The Essbase application name.

List variables

The List Variables task displays the substitution variables for the specified Essbaseapplication or database.

The following table shows the task arguments for the List Variables task.

Table 110. Task arguments for the List Variables task


ApplicationName


DatabaseName


Manage application

The Manage Application task manages an Oracle Essbase application.

The following table shows the task arguments for the Manage Application task.

Table 111. Task arguments for the Manage Application task


Action The action to perform on the Oracle Essbase database. The availableactions are: Start or Stop, Enable or Disable Connection, and Delete.

ApplicationName

The Oracle Essbase application name.

Manage database

The Manage Database task manages an Oracle Essbase database.

The following table shows the task arguments for the Manage Database task.

Table 112. Task arguments for the Manage Database task


Action The action to perform on the Oracle Essbase database. The availableactions are: Delete, Start, Stop, and Reset.

ApplicationName


CubeName The Oracle Essbase database name.


Manage variable

The Manage Variable task creates, updates, or deletes an Essbase server-sidesubstitution variable.

The following table shows the task arguments for the Manage Variable task.

Table 113. Task arguments for the Manage Variable task


Action The action to perform on the Oracle Essbase database: create, update, ordelete.

Variable Scope Application-level or Global-level Essbase server-side substitution variable.

ApplicationName


CubeName The Oracle Essbase database name.

VariableName

The variable name.

Variable Value The variable value.

Metadata load

The Metadata Load task allows the addition or removal of members from theoutline in the active cube from a data file and rules file.

The following table shows the task arguments for the Metadata Load task.

Table 114. Task arguments for the Metadata Load task


ApplicationName


DatabaseName


Data FileName

The data file name with the complete path.

Rules FileName

The rules file name with the complete path.

Log FileName

The log file name with the complete path.

Run calculation script

The Run Calculation Script task runs a calc script against an Essbase cube.

The following table shows the task arguments for the Run Calculation Script task.

Table 115. Task arguments for the Run Calculation Script task


ApplicationName



Table 115. Task arguments for the Run Calculation Script task (continued)


DatabaseName


Calc Type The calculation type.

String/Filename

The name of the string or file.

Run report script

The Run Report Script task sends a report specification to the active database froma local file in a specific character set (US-ASCII or UTF-8)

The following table shows the task arguments for the Run Report Script task.

Table 116. Task arguments for the Run Report Script task


ApplicationName


DatabaseName


Report ScriptFile Name

The full path of the report script in the local computer.

Output FileName

Full path of the output file in the local computer.

Charset US-ASCII or UTF-8.

Cognos Command Center plug-in for Oracle FDMThe Oracle FDM Plug-in provides a task type for automating common operationstargeting Oracle Hyperion Financial Data Management from within IBM CognosCommand Center processes.

Compatibility

The Oracle Essbase plug-in is compatible with the following IBM CognosCommand Center components:



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


Oracle FDM plug-in configurationAn Oracle FDM computing resource must be configured to use the Oracle FDMplug-in. This resource type represents an Oracle FDM server.


The following table shows the arguments for the configuration of the Oracle FDMcomputing resource.

Table 117. Configuration of the Oracle FDM computing resource



FDM LoadBalancerServer Name

The Server domain.

FDM UserName

The FDM user name that runs tasks.

FDM UserPassword

The password of the FDM user.

DomainName

The domain name.

FDM SystemRoot Path

The FDM system root path.

Homedirectory


Oracle FDM plug-in task referenceThe FDM tasks have arguments that you can specify.

FDM import

The FDM Import task runs the native FDM import process from a file.

The following table shows the task arguments for the FDM Import task.

Table 118. Task arguments for the FDM Import task


FDM AppName

The FDM application name.

FDM Location The FDM location.

FDM Period The FDM period.

FDMCategory

The FDM category.

FDM POV The FDM Point of View.

Append Data Specifies whether data is appended.

Input File andPath

The input file and path.

FDM validate

The FDM Validate task runs the FDM validate process.

The following table shows the task arguments for the FDM Validate task.


Table 119. Task arguments for the FDM Validate task


FDM AppName




FDMCategory

The FDM category.



Input File andPath


FDM export

The FDM Export task runs the FDM export process to a file.

The following table shows the task arguments for the FDM Export task.

Table 120. Task arguments for the FDM Export task


FDM AppName




FDMCategory

The FDM category.


Output Fileand Path

The output file name and path.

FDM load to target

The FDM Load to Target task runs the FDM load block process based uponlocation on the target system.

The following table shows the task arguments for the FDM Load to Target task.

Table 121. Task arguments for the FDM Load to Target task


FDM AppName




FDMCategory

The FDM category.


File to Load The file name to load.


FDM calc on target

The FDM Calc on Target task runs the FDM calculation or consolidation blockprocess based upon location on the target system.

The following table shows the task arguments for the FDM Calc on Target task.

Table 122. Task arguments for the FDM Calc on Target task


FDM AppName




FDMCategory

The FDM category.


FDM check target

The FDM Check Target task runs the FDM data check on the target system.

The following table shows the task arguments for the FDM Check Target task.

Table 123. Task arguments for the FDM Check Target task


FDM AppName




FDMCategory

The FDM category.


Run FDM report

The Run FDM Report task runs an FDM report.

The following table shows the task arguments for the Run FDM Report task.

Table 124. Task arguments for the Run FDM Report task


FDM AppName


FDM Report # The FDM report number.

Output Path The output path.

OutputFormat

The output format.


Table 124. Task arguments for the Run FDM Report task (continued)


ReportParameter 1

The first report parameter.

ReportParameter 1Value

The value of the first report parameter value.

ReportParameter 2

The second report parameter.


The value of the second report parameter value.

ReportParameter 3

The third report parameter.


The value of the third report parameter value.

ReportParameter 4

The fourth report parameter.


The value of the fourth report parameter value.

ReportParameter 5

The fifth report parameter.


The value of the fifth report parameter.

Run FDM script

The Run FDM Script task runs the FDM script.

The following table shows the task arguments for the Run FDM Script task.

Table 125. Task arguments for the Run FDM Script task


FDM AppName


FDM Script The script name.

FDM ScriptPath

The script path.

Success Text Defines a success text string.

Fail Text Defines a failure text string.

Run full process

The Run Full Process task runs the full FDM process: Import, Validate, Export,Load, Calculate, and Check.

The following table shows the task arguments for the Run Full Process task.


Table 126. Task arguments for the Run Full Process task


FDM AppName




FDMCategory

The FDM category.



Input File andPath


File to Load The file to load

Cognos Command Center plug-in for Oracle HFMThe Oracle HFM plug-in provides a set of task types for monitoring andadministering Oracle Hyperion Financial Management services within IBM CognosCommand Center processes.

Compatibility

The Oracle HFM plug-in is compatible with the following IBM Cognos CommandCenter components:




The plug-in requires Microsoft .NET Framework 3.5 or higher on MicrosoftWindows agent hosts.

Oracle HFM plug-in configurationAn Oracle HFM computing resource must be configured to use the Oracle HFMplug-in. This resource type represents an Oracle HFM server instance.

The following table shows the arguments for the configuration of the Oracle HFMcomputing resource.

Table 127. Configuration of the Oracle HFM computing resource



ServerDomain

The server domain.

Server Name The server name.

User ID The user ID that runs tasks.


Table 127. Configuration of the Oracle HFM computing resource (continued)


Password The password for the user.

Homedirectory


Oracle HFM plug-in task referenceThe HFM tasks have arguments that you can specify.

Allocate

The Allocate task allocates the data of an entity across a range of periods.

The following table shows the task arguments for the Allocate task.

Table 128. Task arguments for the Allocate task


ApplicationName


ScenarioMember

The scenario member.

Year Member The year member.

EntityMember

The entity member.

Start PeriodMember

The start period member.

End PeriodMember

The end period member.

Value Member The value member.

Clear data slice

The Clear Data Slice task clears an HFM data slice based on the configuration file.

The following table shows the task arguments for the Clear Data Slice task.

Table 129. Task arguments for the Clear Data Slice task


Application The name of the application.

DisplayMembers

Specifies whether Display Members are included.

MemberExpansionOnly

Specifies whether Member Expansion is used.

Clear NoneValue

Specifies whether None values are cleared.

Clear EntityCurrencyValue

Specifies whether Entity Currency values are cleared.


Table 129. Task arguments for the Clear Data Slice task (continued)


ClearDataConfigurationFile

The name of the ClearData configuration file.

Close period

The Close Period task closes an HFM period.

The following table shows the task arguments for the Close Period task.

Table 130. Task arguments for the Close Period task


ApplicationName


ScenarioMember



PeriodMember

The period member.

Close Journals Specifies whether journals are closed.

CloseIntercompany

Specifies whether intercompany items are closed.

Consolidate

The Consolidate task consolidates an entity across a range of periods.

The following table shows the task arguments for the Consolidate task.

Table 131. Task arguments for the Consolidate task


ApplicationName


ScenarioMember



EntityMember

The entity member.

Start PeriodMember


End PeriodMember


ConsolidationType

Specifies the consolidation type.


Copy data

The Copy Data task copies data for one or more entities from one set of cells toanother set of cells that are based on the configuration file.

The following table shows the task arguments for the Copy Data task.

Table 132. Task arguments for the Copy Data task


ApplicationName


DisplayMembers


MemberExpansionOnly

Specifies whether Member Expansion is used

Enable LogDetail

Specifies whether Log Detail is enabled.

Show DetailedProcess Log

Specifies whether the detailed process log is shown.

Update Mode Specifies the Update mode.

View Option Specifies the View option.

Copy NoneValue

Specifies whether the None Value is copied.

Copy EntityCurrencyValue

Specifies whether the Entity Currency Value is copied.

Copy CellText

Specifies whether cell text is copied.

Copy DerivedData

Specifies whether derived data is copied.

IgnoreWarning

Specifies whether warnings are ignored.

Factor Specifies the scaling factor.

ConfigurationFile

The name of the configuration File.

Create star schema

The Create Star Schema task creates or updates a relational star schema or flat fileby extracting data from an HFM application.

The following table shows the task arguments for the Create Star Schema task.

Table 133. Task arguments for the Create Star Schema task


ApplicationName


DisplayMembers



Table 133. Task arguments for the Create Star Schema task (continued)


Show DetailedProcess Log

Specifies whether the detailed process log is shown.

DestinationDSN

The destination DSN.

Table Prefix An optional table prefix string.

Push Type Specifies whether the table is created or updated.

ExcludeDynamicAccounts

Specifies whether dynamic accounts are excluded.

ExcludeCalculatedAccounts

Specifies whether calculated accounts are excluded.

Exclude ICPAccounts

Specifies whether ICP accounts are excluded.

Exclude ICPEntity

Specifies whether ICP entities are excluded.

Use DefaultParent

Specifies whether default parents are used.

ConfigurationFile

The name of the configuration file.

Delete star schema

The Delete Star Schema task deletes an HFM Extended Analytics-generated starschema.

The following table shows the task arguments for the Delete Star Schema task.

Table 134. Task arguments for the Delete Star Schema task


ApplicationName


Star SchemaData SourceName

The star schema data source name.

Table Prefix The table prefix name.

Extract data

The Extract Data task extracts an HFM data slice based on the configuration file.

The following table shows the task arguments for the Extract Data task.

Table 135. Task arguments for the Extract Data task


ApplicationName



Table 135. Task arguments for the Extract Data task (continued)


DisplayMembers

Specifies whether Display Members are extracted.

MemberExpansionOnly

Specifies whether Member Expansion Only is used.

DataDelimiter

Defines the data delimiter.

ExtractCalculatedData

Specifies whether calculated data is extracted.

View Option Specifies the View option.

File to Extract The name of the file to extract.

ConfigurationFile

The name of the configuration file.

Extract journals

The Extract Journals task extracts HFM journals that are based on a combination ofscenario, year, and period.

The following table shows the task arguments for the Extract Journals task.

Table 136. Task arguments for the Extract Journals task


ApplicationName


Journals File The name of the journals file to write.

Log File The name of the log file.

Delimiter Defines the data delimiter.

The default value is "," (comma)

ExtractTemplate

The extract template.

The default value is False

ExtractRecurringTemplate

Specifies whether the recurring template is extracted.


ScenarioMember



PeriodMember

The period member.

Extract member lists

The Extract Member Lists task extracts HFM member lists.

The following table shows the task arguments for the Extract Member Lists task.


Table 137. Task arguments for the Extract Member Lists task


ApplicationName


Member ListFile

The member list file name.

Log File The log file name.

Extract metadata

The Extract Metadata task extracts HFM metadata.

The following table shows the task arguments for the Extract Metadata task.

Table 138. Task arguments for the Extract Metadata task


ApplicationName


Metadata File The name of the metadata file.

File FormatOptions

Specifies the format of the output file.



ExtractSystemAccounts

Specifies whether system accounts are extracted.

Extract ICPs Specifies whether ICPs are extracted.

Extract Values Specifies whether values are extracted.

ExtractCurrencies

Specifies whether currencies are extracted.

ExtractAccounts

Specifies whether accounts are extracted.

ExtractEntities

Specifies whether entities are extracted.

ExtractScenarios

Specifies whether scenarios are extracted.

Settings Specifies whether application settings are extracted.

ExtractConsolidationMethods

Specifies whether consolidation methods are extracted.

ExtractCustom1

Specifies whether Custom1 is extracted.

ExtractCustom2


ExtractCustom3


ExtractCustom4



Extract rules

The Extract Rules task extracts HFM rules.

The following table shows the task arguments for the Extract Rules task.

Table 139. Task arguments for the Extract Rules task


ApplicationName


Rule File The rule file name.


Extract security

The Extract Security task extracts HFM security.

The following table shows the task arguments for the Extract Security task.

Table 140. Task arguments for the Extract Security task


ApplicationName


Security File The security file name.



Extract Usersand Groups

Specifies whether users and groups are extracted.

ExtractSecurityClasses

Specifies whether security classes are extracted.

Extract RoleAccess

Specifies whether role access is extracted.

ExtractSecurity ClassAccess

Specifies whether security class access is extracted.

Load data

The Load Data task loads HFM data.

The following table shows the task arguments for the Load Data task.

Table 141. Task arguments for the Load Data task


ApplicationName


File and Pathto HFM DataFile

Location of the data file.


Table 141. Task arguments for the Load Data task (continued)


File and Pathto HFM DataFile Log

Location of the log file.


Log Append Specifies whether the log is appended.

Data LoadMode

Sets the data load mode to replace, merge, or accumulate.Tip: This option corresponds to the Load Mode option buttons inHyperion Financial Management's Load Data workspace frame. For detailson the load modes, see the Hyperion Financial Management User's Guide.

AccumulatedWithin File

Specifies whether multiple values for the same cell within the load fileshould be accumulated or allowed to overwrite each other. If the load filedoes not contain multiple values for the same cell, then this option has noeffect. In addition, this load option applies to line items and values, but notto descriptions - multiple descriptions always overwrite.Note: Data for system accounts never gets accumulated. Available options:TRUE to accumulate, FALSE to overwrite.

ContainedShare Data

Specifies whether the load file contains shares data such as "sharesoutstanding" or "voting outstanding" or "owned". Available options: TRUEif the file contains shares data, FALSE otherwise.

Load journals

The Load Journals task loads HFM journals.

The following table shows the task arguments for the Load Journals task.

Table 142. Task arguments for the Load Journals task


ApplicationName


Journals File The name of the Journals file.



Load lists

The Load Lists task loads HFM lists.

The following table shows the task arguments for the Load Lists task.

Table 143. Task arguments for the Load Lists task


ApplicationName


Member ListFile

The name of the Member List file.


Scan Only Specifies whether only a scan is performed.


Load metadata

The Load Metadata task loads HFM metadata.

The following table shows the task arguments for the Load Metadata task.

Table 144. Task arguments for the Load Metadata task


ApplicationName


Metadata File The name of the metadata file.

File Format Specifies the format of the output file.


Prescan Specifies whether the file is prescanned.

CheckIntegrity

Specifies whether integrity is checked.

ClearMetadataBeforeLoading

Specifies whether metadata is cleared before loading.

User ReplaceMode

Specifies whether replace mode is used.

Load SystemAccounts

Specifies whether system accounts are loaded.

Load ICPs Specifies whether ICPs are loaded.

Load Values Specifies whether values are loaded.

LoadCurrencies

Specifies whether currencies are loaded.

LoadAccounts

Specifies whether accounts are loaded.

Load Entities Specifies whether entities are loaded.

LoadScenarios

Specifies whether scenarios are loaded.

LoadApplicationSettings

Specifies whether application settings are loaded.

LoadConsolidationMethods

Specifies whether consolidation methods are loaded.

Load Custom1 Specifies whether Custom1 is loaded.




Load rules

The Load Rules task loads HFM rules.

The following table shows the task arguments for the Load Rules task.


Table 145. Task arguments for the Load Rules task


ApplicationName


Rule File The rule file name.


Scan Only Specifies whether only a scan is performed.

CheckIntercompanyTransactions

Checks the referential integrity of intercompany transactions.

Load security

The Load Security task loads HFM security.

The following table shows the task arguments for the Load Security task.

Table 146. Task arguments for the Load Security task


ApplicationName


Security File The security file name.



Clear SecurityInformationBeforeLoading

Specifies whether security information is cleared before the file is loaded.

Load Usersand Groups

Specifies whether users and groups are loaded.

Load SecurityClasses

Specifies whether security classes are loaded.

Load RoleAccess

Specifies whether role access is loaded.

Load SecurityClass Access

Specifies whether security class access is loaded.

Validate Users Specifies whether users are validated.

Lock POV

The Lock POV task locks the cells in a subcube. After the cells in a subcube arelocked, data cannot be entered. Use the Unlock POV task to unlock the cells in thesubcube.

The following table shows the task arguments for theLock POV task.


Table 147. Task arguments for the Lock POV task


ApplicationName


ScenarioMember



PeriodMember

The period member.

EntityMember

The entity member.

Entity Parent The entity parent member.

Value Member The value dimension member.

Unlock POV

The Unlock POV task unlocks the cells in the subcube.

The following table shows the task arguments for the Unlock POV task.

Table 148. Task arguments for the Unlock POV task


ApplicationName


ScenarioMember



PeriodMember

The period member.

EntityMember

The entity member.

Entity Parent The entity parent member.

Value Member The value dimension member.

Translate

The Translate task allocates the data of an entity across a range of periods.

The following table shows the task arguments for the Translate task.

Table 149. Task arguments for the Translate task


ApplicationName


ScenarioMember




Table 149. Task arguments for the Translate task (continued)


EntityMember

The entity member.

Start PeriodMember


End PeriodMember


ValidationMember

The validation member.

Use Force If True, performs translation even if already translated.


Cognos Command Center plug-in for Oracle HFM 11.1.2.4The Oracle HFM 11.1.2.4 plug-in provides a set of task types for monitoring andadministering Oracle Hyperion Financial Management 11.1.2.4 services within IBMCognos Command Center processes.

Compatibility

The Oracle HFM 11.1.2.4 plug-in is compatible with the following IBM CognosCommand Center components:



IBM Cognos Command Center Agent10.2.3 or higher on the Microsoft Windows operating system.

The plug-in requires Microsoft .NET Framework 3.5 or higher on MicrosoftWindows agent hosts.

Oracle HFM 11.1.2.4 plug-in configurationAn Oracle HFM 11.1.2.4 computing resource must be configured to use the OracleHFM 11.1.2.4 plug-in. This resource type represents an Oracle HFM 11.1.2.4 serverinstance.

The following table shows the arguments for the configuration of the Oracle HFM11.1.2.4 or higher computing resource.

Attention: Make sure to add the EPM_ORACLE_INSTANCE environment variableon the system where Oracle HFM 11.1.2.4 is installed, if it does not already exist.You must restart the agent after this change is made. The default value is:C:\Oracle\Middleware\user_projects\epmsystem1.

Table 150. Configuration of the Oracle HFM 11.1.2.4 computing resource



Server Domain The server domain.


Table 150. Configuration of the Oracle HFM 11.1.2.4 computing resource (continued)


Server Name The server name.

User ID The user ID that runs tasks.

EPM Oracle Home The EPM Oracle Home location. The default value isC:\Oracle\Middleware\EPMSystem11R1.

Password The password for the user.

Home directory The directory to use when processing tasks on this resource.

Important information for upgrading to the Oracle HFM11.1.2.4 plug-in

When you upgrade to the Oracle HFM 11.1.2.4 plug-in, much of the of the old taskinformation is saved into new tasks.

However, the earlier HFM plug-in had many tasks that are not available in HFM11.1.2.4 plug-in (see the list in step 2).

If you have tasks from the earlier HFM plug-in that are not available in the HFM11.1.2.4 plug-in, you cannot upgrade these task, and an error similar to thefollowing appears:

Note: The error refers to the first unsupported task that is found. There may bemore unsupported tasks.

You must delete each one of the unsupported tasks in the new plug-in.1. Backup or export all existing HFM 11.1.2.x processes.2. Delete all tasks not supported in the new plug-in. These are:v Allocatev Clear Data Slicev Close Periodv Consolidatev Copy Datav Create Star Schemav Delete Star Schemav Disable Connectionsv Enable Connectionsv Lock POV

Figure 12. An error message that says Unable to load the plugin


v Open Periodv Translatev Unlock POV

3. Upgrade to the HFM 11.1.2.4 plug-in.

Oracle HFM 11.1.2.4 plug-in task referenceThe HFM 11.1.2.4 tasks have arguments that you can specify.

Create Application

The Create Application task creates an HFM application.

The following table shows the task arguments for the Create Application task.

Table 151. Task arguments for the Create Application task


Application name The name of the application.

HFM application description The HFM application description.

HFM profile file The HFM profile file.

User management project The shared service projects to which to add the HFMapplication.

Application type Console or Tax Provisioning. The default is Console.

Delete Application

The Delete Application task deletes an HFM application.

The following table shows the task arguments for the Delete Application task.

Table 152. Task argument for the Delete Application task


Applicationname

The name of the application to delete.

Extract data

The Extract Data task extracts an HFM data slice based on the configuration file.

The following table shows the task arguments for the Extract Data task.

Table 153. Task arguments for the Extract Data task



Data file The name of the data file. If no path is provided, the file iswritten in the Home Directory of the HFM ComputingResource.

Log file The name of the log file. If no path is provided, the file iswritten in the Home Directory of the HFM ComputingResource.


Table 153. Task arguments for the Extract Data task (continued)


Extract format The format the data should be extracted in a flat file. Thepossible values are With Header or Without Header. Thedefault value is With Header.

Delimiter Defines the data delimiter. The default is a semicolon.

Configuration file The configuration file specifying the point of view.

Extract data Extracts an HFM data slice based on a configuration file.

Extract dynamic accounts Specifies whether to extract dynamic accounts.

Calculated data Specifies whether calculated data is extracted.

Derived data Specifies whether to extract derived data.

Cell text Specifies whether to extract cell text.

Phased submission groupdata

Specifies whether to extract phased submission group data.

Line item details Specifies line item details to extract: none, individual lineitems, or the total summary for the cell.

The following text is a sample configuration file that you can use to extract datafrom HFM 11.1.2.4, using the Extract data argument of the Extract Data task:! Follow the rules below to define the data subsets for each dimension! 1. The three dimensions ACCOUNT, ENTITY and PERIOD can be defined with multiple members in a single row, and each member complies with a! member function that is the last element of each data subset row.! a. Available member functions include! [MEMBER] The specified member only! [IDESCENDANTS] [DESCENDANTS] plus the specified member! [DESCENDANTS] All descendants of the specified member! [ICHILDREN] [CHILDREN] plus the specified member! [CHILDREN] All immediate children of the specified member! [BASE] All the base-level members relative to the specified top member (not a base-level member)! [MEMBERLIST] All members of the specified member list!! b. To select all members of a dimention use! [DATA_SUBSET],DIMENSION,DIMENSION,[DESCENDANTS]! For example! [DATA_SUBSET,Account,Account,[DESCENDANTS]! c. Overlapping areas resulting in duplicate members will be automatically removed! d. There is no requirement to place members in quotes and case does not matter! e. Any invalid members will be flagged[DATA_SUBSET],SCENARIO,Actual,[MEMBER][DATA_SUBSET],YEAR,1999,[MEMBER][DATA_SUBSET],PERIOD,January,[MEMBER][DATA_SUBSET],VIEW,<Scenario View>,[MEMBER][DATA_SUBSET],Entity,Entity,[BASE][DATA_SUBSET],Value,<Entity Currency>,[MEMBER][DATA_SUBSET],ACCOUNT,Account,[BASE][DATA_SUBSET],ICP,ICP,[BASE][DATA_SUBSET],Product,Product,[BASE][DATA_SUBSET],Customers,Customers,[BASE][DATA_SUBSET],Channel,Channel,[BASE][DATA_SUBSET],UnitsFlows,UnitsFlows,[BASE]

Extract journals

The Extract Journals task extracts HFM journals that are based on a combination ofscenario, year, and period.


The following table shows the task arguments for the Extract Journals task.

Table 154. Task arguments for the Extract Journals task



Journals file The name of the journals file. If no path is provided, the file iswritten in the Home Directory of the HFM Computing Resource.

Log file The name of the log file. If no path is provided, the file is writtenin the Home Directory of the HFM Computing Resource.

Delimiter Defines the data delimiter. The default value is a semicolon.

Extract template Specifies whether to extract the template.


Extract recurringtemplate

Specifies whether to extract the recurring template.


Extract journals Specifies whether journals are extracted.

The default value is True

Scenario member The scenario member.

Year member The year member.

Period member The period member.

Entity The entity member.

Value member The value member.

Extract member lists

The Extract Member Lists task extracts HFM member lists.

The following table shows the task arguments for the Extract Member Lists task.

Table 155. Task arguments for the Extract Member Lists task



Member list file The output file that contains the member lists.

Log file The log file name.

Extract metadata

The Extract Metadata task extracts HFM metadata.

The following table shows the task arguments for the Extract Metadata task.

Table 156. Task arguments for the Extract Metadata task



Metadata file The output file that contains the metadata.



Table 156. Task arguments for the Extract Metadata task (continued)


File format Specifies the format of the output file.


Extract application settings Specifies whether application settings are extracted.

Extract consolidationmethods

Specifies whether consolidation methods are extracted.

Extract cell text labels Specifies whether cell text labels are extracted.

Extract system accounts Specifies whether system accounts are extracted.

Extract currencies Specifies whether currencies are extracted.

Extract scenarios Specifies whether scenarios are extracted.

Extract entities Specifies whether entities are extracted.

Extract accounts Specifies whether accounts are extracted.

Extract values Specifies whether values are extracted.

Extract ICPs Specifies whether ICPs are extracted.

Extract custom 1 Specifies whether Custom 1 is extracted.




Extract rules

The Extract Rules task extracts HFM rules.

The following table shows the task arguments for the Extract Rules task.

Table 157. Task arguments for the Extract Rules task



Rule file The output file that contains the rules data.


Extract security

The Extract Security task extracts HFM security.

The following table shows the task arguments for the Extract Security task.

Table 158. Task arguments for the Extract Security task



Security file The output file that contains the security data.



Users Specifies whether users are extracted.


Table 158. Task arguments for the Extract Security task (continued)


Security classes Specifies whether security classes are extracted.

Role access Specifies whether role access is extracted.

Security classaccess

Specifies whether security class access is extracted.

Load data

The Load Data task loads HFM data.

The following table shows the task arguments for the Load Data task.

Table 159. Task arguments for the Load Data task



Data file The name of the file that contains the data to load.

Log file Location of the log file.

Log append Specifies whether log data is appended to or overwrites theexisting log file. Available options: TRUE to append, FALSE tooverwrite.


Prescan Specifies whether the data should only be scanned for errors orloaded. The default is FALSE, which loads the data.

File containsownership data

Specifies whether the load file contains shares data such as "sharesoutstanding' or "voting outstanding" or "owned". Available0ptions: TRUE if the file contains ownership data, FALSEotherwise.

File contains processmanagement data

Specifies whether the load file contains data for assignment ofprocess management submission groups to submission phases.Available options: TRUE if the file contains process managementdata, FALSE otherwise.

Data load mode Sets the data load mode to replace, merge, or accumulate.Tip: This option corresponds to the Load Mode option buttons inHyperion Financial Management's Load Data workspace frame.For details on the load modes, see the Hyperion FinancialManagement User's Guide.

Accumulated WithinFile

Specifies whether multiple values for the same cell within the loadfile should be accumulated or allowed to overwrite each other. Ifthe load file does not contain multiple values for the same cell,then this option has no effect. In addition, this load option appliesto line items and values, but not to descriptions - multipledescriptions always overwrite.Note: Data for system accounts never gets accumulated. Availableoptions: TRUE to accumulate, FALSE to overwrite.

Load journals

The Load Journals task loads HFM journals.

The following table shows the task arguments for the Load Journals task.


Table 160. Task arguments for the Load Journals task



Journals file The name of the file that contains the journals data to load.

Log file The name of the log file.


Load member lists

The Load Member Lists task loads HFM lists.

The following table shows the task arguments for the Load Member Lists task.

Table 161. Task arguments for the Load Lists task



Member list file The name of the file that contains the member list data to load.


Scan only Specifies whether only a scan is performed.

Load metadata

The Load Metadata task loads HFM metadata.

The following table shows the task arguments for the Load Metadata task.

Table 162. Task arguments for the Load Metadata task



Metadata file The name of the file that contains the metadata to load.



Prescan Specifies whether the file is prescanned.

Clear metadata and data Clears all metadata and data before loading

Check integrity Specifies whether integrity is checked.

Mode Available options: Merge or Replace.

Load application settings Specifies whether application settings are loaded.

Load consol methods Specifies whether consolidation methods are loaded.

Load cell text labels Specifies whether cell text labels are loaded.

Load system accounts Specifies whether system accounts are loaded.

Load currencies Specifies whether currencies are loaded.

Load scenarios Specifies whether scenarios are loaded.

Load entities Specifies whether entities are loaded.

Load accounts Specifies whether accounts are loaded.

Load values Specifies whether values are loaded.


Table 162. Task arguments for the Load Metadata task (continued)


Load ICPs Specifies whether ICPs are loaded.

Load custom 1 Specifies whether Custom 1 is loaded.




Load rules

The Load Rules task loads HFM rules.

The following table shows the task arguments for the Load Rules task.

Table 163. Task arguments for the Load Rules task



Rule file The name of the file that contains the rules data to load.


Scan only Specifies whether only a scan is performed.

Checkintercompanytransactions

Checks the referential integrity of intercompany transactions.

Load security

The Load Security task loads HFM security.

The following table shows the task arguments for the Load Security task.

Table 164. Task arguments for the Load Security task



Security file The name of the file that contains the security data to load.



Clear security infobefore loading

Specifies whether security information is cleared before the file isloaded.

Load users andgroups

Specifies whether users and groups are loaded.

Load role access Specifies whether role access is loaded.

Load security classes Specifies whether security classes are loaded.

Load security classaccess

Specifies whether security class access is loaded.


Logoff Users

The Logoff Users task logs off all users connected to an HFM application.

The following table shows the task arguments for the Logoff Users task.

Table 165. Task arguments for the Logoff Users task



Cognos Command Center plug-in for Oracle Hyperion PlanningThe Oracle Hyperion Planning plug-in provides a set of task types for runningvarious administrative functions in Oracle Hyperion Planning.

These administrative functions include the following tasks:v Broadcast Messagev Refresh Planningv Unlock Planningv Import Formsv Export Formsv Import / Export Single Formv Import Securityv Export Securityv Copy Data (including Hyperion Planning supporting detail)v Set Login Level

You can sequence these functions with other tasks for a comprehensive andeasy-to-maintain automation routine.

Compatibility

The Oracle Hyperion Planning plug-in is compatible with the following IBMCognos Command Center components:





Oracle Hyperion Planning9.3.x or higher (use Oracle Planning 9.3.x plug-in)

11.1.2.x or higher (use Oracle Planning 11.1.2.x plug-in)

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 Installation Guide.


Oracle Hyperion Planning plug-in configurationTo use the tasks in the Oracle Hyperion Planning plug-in, a specific hostcomputing resource must be configured.

Attention: Different configurations depend on your version of Oracle HyperionPlanning.

The following table shows the arguments for the configuration of the computingresource with Oracle Planning 9.3.x or greater.

Table 166. Configuration of the computing resource with Oracle Planning 9.3.x or greater



Planninghome

The Oracle Hyperion Planning directory under the root of Hyperion Home.For example, C:\Hyperion\Planning.

Hyperioncommon

The Oracle Hyperion common directory under the root of Hyperion Home.For example, C:\Hyperion\common.

Windowshome

The Windows directory.

The default is C:\WINDOWS.

Java home Optional. The Java version should be 1.6 or higher. The value of the Javahome should be chosen so that $JAVA_HOME/bin/java.exe exists.

Server The Oracle Planning server host name.

The following table shows the arguments for the configuration of the computingresource with Oracle Planning 11.1.x or greater.

Table 167. Configuration of the computing resource with Oracle Planning 11.1.x or greater



Planninghome

The Oracle Hyperion Planning directory under user_projects. Forexample, D:\Oracle\Middleware\user_projects\epmsystem1\Planning\planning1.

Windowshome

The Windows directory.

The default is C:\WINDOWS.

Server The Oracle Planning server host name.

Creating a password fileMany of the functions of the Oracle Hyperion Planning plug-in use the planningutilities that are included with the product.

Starting in version 11.x of Oracle Hyperion Planning, you can create an encryptedpassword file. The password file is then referenced as an argument in the setup ofa task.

Procedure1. Open a command prompt and go to the location where the Hyperion Planning

utilities exist. Typically, this location is in the Oracle Hyperion commondirectory under the root of Hyperion Home. For example, C:\Hyperion\common.


2. Run the command PasswordEncryption.cmd with a single parameter for thename of the password file.

3. When prompted to enter the system password, type in the password of theuser that runs the various Planning functions.The contents of the file have a single encrypted value.

4. The password file can be used without being changed. A good practice is to usethe encrypted string for the value of an IBM Cognos Command Centerecosystem variable and use this variable in a Cognos Command Center fileresource.

5. If the value of the password changes, repeat the steps and replace the value ofthe variable.

Oracle Hyperion Planning plug-in task referenceThe Planning tasks have arguments that you can specify.

Broadcast message

The Broadcast Message task displays a message to all Oracle Hyperion Planningusers who are logged on to Hyperion Planning. This task notifies users thatactivity is about to occur, such as a Planning maintenance update.

Table 168. Task arguments for the Broadcast Message task


User The Oracle Hyperion Planning user.

Password File The path and file name of the password file. For more information, see“Creating a password file” on page 130.

Application The Oracle Hyperion Planning application.

Message The text to display in a message.

Refresh planning

The Refresh Planning task synchronizes Oracle Hyperion Planning applicationupdates to Oracle Essbase.

Table 169. Task arguments for the Refresh Planning task





Processdatabase

Push metadata changes from Oracle Hyperion Planning to Oracle Essbase.

The default value is Yes.

Refresh filters Push security filter changes from Oracle Hyperion Planning to OracleEssbase.

The default value is No.

Refresh filters(shared)

Push shared security filter changes from Oracle Hyperion Planning toOracle Essbase.



Table 169. Task arguments for the Refresh Planning task (continued)


Validate filters Validate filters during synchronization.


Unlock planning

The Unlock Planning task unlocks the Oracle Hyperion Planning application.

Table 170. Task arguments for the Unlock Planning task





Export forms

The Export Forms task exports Oracle Hyperion Planning web forms in XMLformat to the Hyperion Planning home directory.

Table 171. Task arguments for the Export Forms task





Import forms

The Import Forms task imports Oracle Hyperion Planning web forms from XMLfiles in the Hyperion Planning home directory.

Table 172. Task arguments for the Import Forms task





Import/export single form

The Import/Export Single Form task performs a single Oracle Hyperion Planningweb form import or export.

Table 173. Task arguments for the Import/Export Single Form Form task




Table 173. Task arguments for the Import/Export Single Form Form task (continued)




Operation A list of the two available operations: Export or Import.

File / Form Depending on whether the operation is an Export or an Import, either afile name (FormName.xml) or form name is accepted.

Export security

The Export Security task performs an Oracle Hyperion Planning security export.

Table 174. Task arguments for the Export Security task





File Export file name and location.

Delimiter A list of supported delimiters: Comma, Pipe, Colon, and Semi-colon.

The default is comma.

Search criteria Mandatory string to filter security export.

Import security

The Import Security task performs an Oracle Hyperion Planning security import.This function accepts only a file named secfile.txt in the Hyperion homedirectory.

Table 175. Task arguments for the Import Security task





Delimiter A list of supported delimiters: Comma, Pipe, Colon, and Semi-colon.

The default is Comma.

Clear security Drop down with a Yes/No toggle.

The default value is Yes.

Copy data

The Copy Data task replicates the Oracle Hyperion Planning copy datafunctionality, but as a fully automated task.


Table 176. Task arguments for the Copy Data task



Password The Oracle Hyperion Planning user password.


Configurationfile

Path and file name of the configuration file. For more information, see thesection Example setup of the copy data task. A good practice is to make this afile resource of the task.

Verboselogging

Drop down with a Yes/No toggle.


Example setup of the copy data task

The following is an example configuration file for the copy data task:SCC_HP_STATICDIMS=account,Period,Currency,Channels,Entity,Segments,VersionSCC_HP_STATICDIMS_ACCOUNT=503100,502100,504100,504200,504300SCC_HP_STATICDIMS_PERIOD=IChildren(YearTotal)SCC_HP_STATICDIMS_CURRENCY=LocalSCC_HP_STATICDIMS_CHANNELS=No ChannelSCC_HP_STATICDIMS_ENTITY=E01_101_1120,E01_101_1110SCC_HP_STATICDIMS_SEGMENTS=NoSegmentSCC_HP_STATICDIMS_VERSION=Working

SCC_HP_SRC_TRGDIMS=Year,ScenarioSCC_HP_SRC_TRGDIMS_SRC_YEAR=FY08SCC_HP_SRC_TRGDIMS_TRG_YEAR=FY09SCC_HP_SRC_TRGDIMS_SRC_SCENARIO=ActualSCC_HP_SRC_TRGDIMS_TRG_SCENARIO=Actual

SCC_HP_SDT=TRUESCC_HP_ANN=TRUESCC_HP_TXT=TRUESCC_HP_PLN_TYPE=Plan1


Attention: There are three primary sections of the configuration file - Staticdimensions, Source and Target dimensions, and Copy Options.

All dimensions must be referenced either in the SCC_HP_STATICDIMS orSCC_HP_SRC_TRGDIMS parameters (sections 1 and 2).

In the first two sections, the parameters SCC_HP_STATICDIMS_,SCC_HP_SRC_TRGDIMS_SRC_, and SCC_HP_SRC_TRGDIMS_SRC_ are constructed by usingthe dimension for the final string of characters.

If a dimension or member name has a space in the name, then use a backslash (\)in the name. For example, COST\CENTER.

The following expansion functions are available for the Static dimensions:v Descendants(MemberName)

v IDescendants(MemberName)

v Ancestors(MemberName)

v IAncestors(MemberName)

v Siblings(MemberName)

v ISiblings(MemberName)

v Parents(MemberName)

v IParents(MemberName)

v Children(MemberName)

v IChildren(MemberName)

v ILvl0Descendants(MemberName)

Replace MemberName with the appropriate name.

In the third section, the following parameters control which data types are copied.Replace the TRUE or FALSE variable to toggle the wanted operation.

Copy Supporting DetailSCC_HP_SDT=TRUE

Copy AnnotationsSCC_HP_ANN=TRUE

Copy CommentsSCC_HP_TXT=TRUE

In the third section, the following parameter controls which plan type is used.Either the plan type name or number can be used.

Planning "Plan Type"SCC_HP_PLN_TYPE=Plan1

IBM Cognos Command Center variables can be used anywhere in the file.

Set login level

The Set Login Level task replicates the ability to set the Login Level formaintenance mode in the Oracle Hyperion Planning application as a fullyautomated task.


Table 177. Task arguments for the Set Login Level task



Password The Oracle Hyperion Planning user password.


Login level Drop-down list of the three Planning login levels: All users,Administrators, Owner.

The default value is All users.

Verboselogging

Drop-down with a Yes or No toggle.


Cognos Command Center reporting automation for QlikView plug-inThe Reporting Automation for QlikView plug-in provides a task type forautomating common operations that target QlikView from within IBM CognosCommand Center processes.

Compatibility

The reporting automation for QlikView plug-in is compatible with the followingIBM Cognos Command Center components:





Reporting Automation for QlikView plug-in configurationA computing resource must be configured to use the Reporting Automation forQlikView plug-in.

The following table shows the arguments for the configuration of the ReportingAutomation for QlikView computing resource.

Table 178. Configuration of the Reporting Automation for QlikView computing resource



QlikView ServerPath

The QlikView server path.

QlikView Port The QlikView port number.

The default is 8130.

Home directory The directory to use when you process tasks on this resource.


Reporting Automation for QlikView plug-in task referenceThe QlikView tasks automate common operations that target QlikView fromwithin IBM Cognos Command Center processes.

Full load

The Full Load task runs a full load.

The following table shows the task argument for the Full Load task.

Table 179. Task argument for the Full Load task


DocumentPath

Path to a QlikView document.

Full load - data file

The Full Load - Data File task runs a full load with a data file.

The following table shows the task arguments for the Full Load - Data File task.

Table 180. Task arguments for the Full Load - Data File task


DocumentPath


Data File Path Path to a data file.

Metadata converter

The Metadata Converter task runs a metadata conversion.

The following table shows the task arguments for the Metadata Converter task.

Table 181. Task arguments for the Metadata Converter task


Source File The source file name.

Target File The target file name.

ConfigurationFile

The configuration file name.

Partial load

The Partial Load task runs a partial load.

The following table shows the task argument for the Partial Load task.

Table 182. Task argument for the Partial Load task


DocumentPath



Partial Load - Data File

The Partial Load - Data File task runs a partial load with a data file.

The following table shows the task arguments for the Partial Load - Data File task.

Table 183. Task arguments for the Partial Load - Data File task


DocumentPath


Data File Path Path to a data file.

Cognos Command Center for SFTP plug-in overviewThe SFTP plug-in provides a set of task types for using standard Secure FileTransfer Protocol (SFTP) operations.

Compatibility

The SFTP plug-in is compatible with the following IBM Cognos Command Centercomponents:






SFTP plug-in configurationNo special computing resource is required to use the tasks in the SFTP plug-in.




Computingresource


Hostname Host name for the SFTP server. Use either a DNS name (for example,example.com) or a numeric IP address (for example, 127.0.0.1).

Port Port number for the SFTP server.


Username User name for the account on the SFTP server.



SFTP plug-in task referenceThe SFTP tasks have arguments that you can specify.

Delete






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


Delete directory






Dir






Get





Remote file The name of the files on the SFTP server. Use the wildcard characters * and? to specify multiple files on the server.


Table 188. Task arguments for the Get task (continued)


Local file The local file where the content of the remote file is written. When you getmultiple files, the local file must be a directory name.

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


Make directory






Move

The Move task moves files or directories on the remote SFTP server.





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

Overwrite If selected, overwrites existing files. When cleared, the task exits withoutoverwriting existing files.


Put

The Put task uploads files from the local host where the task is being run to theremote SFTP server.







Table 191. Task arguments for the Put task (continued)


Overwrite If selected, overwrites existing files. When cleared, the task exits withoutoverwriting existing files.


Cognos Command Center plug-in for system utilitiesThe system utilities plug-in provides a set of task types that provide varioussystem-related operations.

Compatibility

The system utilities plug-in is compatible with the following IBM CognosCommand Center components:






System utilities plug-in configurationNo special computing resource is required to use the tasks in the system utilitiesplug-in, so no configuration is required.

System utilities plug-in task referenceThe System Utilities tasks have arguments that you can specify.

Check ports

The Check Ports task checks the status of one or more Transmission ControlProtocol (TCP) ports.

The following table shows the task arguments for the Check Ports task.

Table 192. Task arguments for the Check Ports task


Port list A comma-separated list of port numbers to check.


Table 192. Task arguments for the Check Ports task (continued)


Expected state The expected state of the ports is one of the following values:

v Closed - No process is listening on the ports.

v Established - A connection is open on the ports.

v Listening - A process is listening on the ports.

The default is Listening

Time to wait The time in seconds that the task waits for the ports to enter the expectedstate.

The default is 0.

Get process information

The Get Process Information task shows information about a running Windowsprocess. The process is identified either by process ID or by name.

The following table shows the task argument for the Get Process Information task.

Table 193. Task argument for the Get Process Information task


Processname/ID

The name or process ID of the process to get information for.

Get system status

The Get System Status task gets the status of a host computer.

The following table shows the task argument for the Get System Status task.

Table 194. Task argument for the Get System Status task


CPU sampletime

The time in seconds to measure the CPU load.

Check Windows service

The Check Windows Service task checks the state of a Windows service.

The following table shows the task arguments for the Check Windows Servicetask.

Table 195. Task arguments for the Check Windows Service task


Service name The display name of the Windows service to check. The name of thewindows service can be found by running the List Windows Service task,or by inspecting the properties of a service by using the Windows Servicesapplication.

Expected state The expected state of the Windows Service.

The default is Running.


Table 195. Task arguments for the Check Windows Service task (continued)


Ports to check An optional comma-separated list of ports to check. For a running service,all ports in this list must be either established or listening. For a stoppedservice, all ports must be closed.

List Windows services

The List Windows Services task lists all Windows services and their run state.

This task has no arguments.

Manage Windows service

The Manage Windows Service task provides a method for starting or stopping aWindows service.

The following table shows the task arguments for the Manage Windows Servicetask.

Table 196. Task arguments for the Manage Windows Service task


Service name The display name of the Windows service to check. The name of thewindows service can be found by running the List Windows Service task,or by inspecting the properties of a service by using the Windows Servicesapplication.

Action The action to perform on the service. As well as Start or Stop, you canchoose Forced Stop to stop the service in an orderly manner. If the servicecannot be stopped in an orderly manner, Forced Stop finds the process IDfor the underlying process and either forces this process to stop by usingthe Sigar library (if such a method exists in the library) or by running ataskkill command.

The default is Start.

Ports to check An optional comma-separated list of ports to check. For a running service,all ports in this list must be either established or listening. For a stoppedservice, all ports must be closed.

Operationtimeout

The maximum allowed time in seconds to wait for the service operation tocomplete. The default of 0 means wait indefinitely.

Cognos Command Center plug-in for Cognos TM1 9.5.2The IBM Cognos TM1 plug-in provides a task type for running CognosTurboIntegrator processes from within IBM Cognos Command Center.

Compatibility

The IBM Cognos TM1 plug-in is compatible with the following IBM CognosCommand Center components:






The plug-in requires a Java environment on the agent hosts. On Windows, the IBMCognos Command Center 10.1 agent (or higher) comes with Java, and on UNIX,Java must be installed separately. For more information, see the IBM CognosCommand Center Installation Guide.

IBM Cognos TM1 9.5.2 plug-in configurationAn IBM Cognos TM1 server computing resource must be configured to use theplug-in. This resource type represents an IBM Cognos TM1 9.5.2 or higher serverinstance.

The following table shows the arguments for the configuration of the IBM CognosTM1 server computing resource.

Table 197. Configuration of the IBM Cognos TM1 server computing resource



Homedirectory

The directory to use when you process tasks on this resource.

Admin host The TM1 admin host.

User name The TM1 user name.

Password The TM1 password.

Server name The TM1 server name.

Certificatekeystore

The full path of the keystore that contains the trusted certificate that isused by the TM1 server. The default is:

C:\Program Files\IBM\cognos\tm1_64\bin64\ssl\tm1store

Certificatekeystorepassword

The password for the certificate keystore. The default is applix.

IBM Cognos TM1 Plug-in task referenceThe TM1 tasks have arguments that you can specify.

Delete Server Object

The Delete Server Object task deletes TM1 server objects.

The following table shows the task arguments for the Delete Server Object task.

Table 198. Task arguments for the Delete Server Object task


Object type The server object type to delete. The object type can be Chore, Cube, orProcess.

Object name The name of the object to delete.


Delete View

The Delete View task deletes TM1 views.

The following table shows the task arguments for the Delete View task.

Table 199. Task arguments for the Delete View task


Cube name The name of the cube that contains the view.

View name The name of the view to delete

List Server Objects

The List Server Objects task lists TM1 server objects.

The following table shows the task argument for the List Server Objects task.

Table 200. Task arguments for the List Server Objects task


Object type The server object type to list. The object type can be Chore, Cube, orProcess.

Displaycontrol objects

Includes in the output the control objects that are prefixed with '}' symbol.

List Views

The List Views task lists TM1 views.

The following table shows the task arguments for the List Views task.

Table 201. Task arguments for the List Views task



Displaycontrol object


Run TI Chore

The Run TI Chore task runs a TurboIntegrator chore.

The following table shows the task argument for the Run TI Chore task.

Table 202. Task argument for the Run TI Chore task


Chore name The name of the TurboIntegrator chore to run.

Run TI Process

The Run TI Process task runs a TurboIntegrator process.

The following table shows the task arguments for the Run TI Process task.


Table 203. Task argument for the Run TI Process tasks


Process name The name of the TurboIntegrator process to call.

ProcessParameters

An optional list of parameter values that are required by the process. Eachparameter is specified as "param_name"="param_value", and eachparameter is separated by one or more spaces. For example:MyTIParam="my_value" MyOtherTIParam=42.

Cognos Command Center plug-in for Cognos TM1 10.2.2The IBM Cognos TM1 plug-in provides a task type for running CognosTurboIntegrator processes from within IBM Cognos Command Center.

Compatibility

The IBM Cognos TM1 plug-in is compatible with the following IBM CognosCommand Center components:





The plug-in requires a Java environment on the agent hosts. On Windows, the IBMCognos Command Center 10.1 agent (or higher) comes with Java, and on UNIX,Java must be installed separately. For more information, see the IBM CognosCommand Center Installation Guide.

Attention: At the present time, the Cognos Command Center TM1 10.2.2 plug-inStart TM1 server and Stop TM1 server tasks are only supported for the MicrosoftWindows environment.

IBM Cognos TM1 10.2.2 plug-in configurationAn IBM Cognos TM1 server computing resource must be configured to use theplug-in. This resource type represents an IBM Cognos TM1 10.2.2 or higher serverinstance.

Attention:

When using the TM1 plug-in to work with HTTPS for the TM1 REST API, youmust add the TM1 server certificate to the Command Center Agent Java JRE. Thefollowing is an example using the keytool application found inccc_install_dir\common\java.6.0.16\jre\bin\:

keytool.exe -importcert -alias "TM1Server" -file tm1_server_certificate-keystore ccc_install_dir\common\java.6.0.16\jre\lib\security\cacerts-storepass changeit

The following table shows the arguments for the configuration of the IBM CognosTM1 server computing resource.


Table 204. Configuration of the IBM Cognos TM1 server computing resource



Homedirectory

The directory to use when you process tasks on this resource.

Serverendpoint

The TM1 server endpoint.

User name The TM1 user name.

Password The TM1 password.

CAMnamespace

This value is only needed if the TM1 server authenticates using CAM(Cognos Access Manager).

Steps to export the TM1 SSL certificate needed for the Keytool action

1. On the TM1 server machine, go to Start > Run ant type mmc.exe.2. Click File > Add/remove SnapIn.3. Select Certificates and click Add.4. Select the Computer account option.5. Click Finish, then OK.6. Click Other People > Certificates and look for the TM1 server certificate.7. Export the certificate in Base-64 encoded X.509 (CER) format.8. Use the exported certificate for keytool import into ccc java cacerts.

IBM Cognos TM1 10.2.2 Plug-in task referenceThe TM1 tasks have arguments that you can specify.

Check TM1 Server

The Check TM1 Server task checks that the TM1 server is running.

Delete Server Object

The Delete Server Object task deletes TM1 server objects.

The following table shows the task arguments for the Delete Server Object task.

Table 205. Task arguments for the Delete Server Object task


Object type The server object type to delete. The object type can be Chore, Cube, orProcess.

Object name The name of the object to delete.

Delete View

The Delete View task deletes TM1 views.

The following table shows the task arguments for the Delete View task.


Table 206. Task arguments for the Delete View task



View name The name of the view to delete

Filter Server Log

The Filter Server Log task lists the TM1 Server's server log content.

The following table shows the task arguments for the Filter Server Log task.

Table 207. Task arguments for the Filter Server Log task


Log level The values for Log level are All, Info, Warning, and Error. If the Errorvalue is selected, then Error and Fatal logs are displayed.

Start time Only logs with a timestamp after (or equal) to this time are included in theoutput.

The time is in UTC. The format is yyyy-MM-dd’T’HH:mm:ss’Z. For example,2015-12-24T20:21:19Z.

The default value is the last time the process ran:$(Process[last].Start{utc}).

Output file The name of the file where the logs will be written in csv format. If empty,the logs will be displayed on the task output.

Overwrite If checked and the output file already exists, it will be overwritten.

Filter Transaction Log

The Filter Transaction Log task lists the TM1 Server's transaction log content.

The following table shows the task arguments for the Filter Transaction Log task.

Table 208. Task arguments for the Filter Transaction Log task


Start time Only logs with a timestamp after (or equal) to this time are included in theoutput.

The time is in UTC. The format is yyyy-MM-dd’T’HH:mm:ss’Z. For example,2015-12-24T20:21:19Z.

The default value is the last time the process ran:$(Process[last].Start{utc}).

Cube filter If not empty, only logs of this cube will be returned.

User filter If not empty, only logs of this user will be returned.

Output file The name of the file where the logs will be written in csv format. If empty,the logs will be displayed on the task output.

Overwrite If checked and the output file already exists, it will be overwritten.


List Server Objects

The List Server Objects task lists TM1 server objects.

The following table shows the task argument for the List Server Objects task.

Table 209. Task arguments for the List Server Objects task


Object type The server object type to list. The object type can be Chore, Cube, orProcess.

Displaycontrol objects


List Users

The List Users task lists all user connection activity.

List Views

The List Views task lists TM1 views.

The following table shows the task arguments for the List Views task.

Table 210. Task arguments for the List Views task



Displaycontrol object


Manage BLOBs

The Manage BLOBs task manages data files on the TM1 Server.

The following table shows the task arguments for the Manage BLOBs task.

Table 211. Task arguments for the Manage BLOBs task


Operation The operation to perform. Possible values: Upload to server, Delete fromserver.

File The path to the file to be uploaded to the server, or the name of the file tobe deleted from the server.

Read Cell

The Read Cell task reads a cell value from a specific TM1 cube.

The following table shows the task arguments for the Read Cell task.

Table 212. Task arguments for the Read Cell task


Cube name The name of the cube containing the cell.


Table 212. Task arguments for the Read Cell task (continued)


Cell Location The syntax for the cell location is[dimension1].[member],[dimension2].[member], and so on. If a dimensionis missing, then the default member is used.

Run TI Chore

The Run TI Chore task runs a TurboIntegrator chore.

The following table shows the task argument for the Run TI Chore task.

Table 213. Task argument for the Run TI Chore task


Chore name The name of the TurboIntegrator chore to run.

Run TI Process

The Run TI Process task runs a TurboIntegrator process.

The following table shows the task arguments for the Run TI Process task.

Table 214. Task argument for the Run TI Process tasks


Process name The name of the TurboIntegrator process to call.

ProcessParameters

An optional list of parameter values that are required by the process. Eachparameter is specified as "param_name"="param_value", and eachparameter is separated by one or more spaces. For example:MyTIParam="my_value" MyOtherTIParam=42.

Start TM1 Server (Windows)

The Start TM1 Server (Windows) task starts the TM1 server and waits for theserver to become operational.

The following table shows the task arguments for the Start TM1 Server (Windows)task.

Table 215. Task arguments for the Start TM1 Server (Windows) task


Service name The name of the windows service corresponding to the current ComputingResource TM1 Server.

Timeout The time (in seconds) to wait for the server to become operational. Thedefault 0 means wait indefinitely.

Stop TM1 Server (Windows)

The Stop TM1 Server (Windows) task stops the TM1 server.

The following table shows the task arguments for the Stop TM1 Server (Windows)task.


Table 216. Task arguments for the Stop TM1 Server (Windows) task


Service name The name of the windows service corresponding to the current ComputingResource TM1 Server.

Timeout The time (in seconds) to wait for the server to stop. The default 0 meanswait indefinitely.

Force The default value is False.

Write Cell

The Write Cell task updates a cell value from a specific TM1 cube.

The following table shows the task arguments for the Write Cell task. The WriteCell task requires that a cell must be a leaf cell.

Table 217. Task arguments for the Write Cell task


Cube name The name of the cube containing the cell.

Cell Location The syntax for the cell location is[dimension1].[member],[dimension2].[member], and so on. If a dimensionis missing, then the default member is used.

Value The new cell value. If the cell value requires a string, then the new valuemust be in quotation marks ("").



Chapter 9. IBM Cognos Command Center Command LineClient

The command line client is a Microsoft Windows command line application. In thecommand line client, you can query, start, pause, and stop IBM Cognos CommandCenter processes, test agent connectivity, and perform full and partial exports ofthe repository.

IBM Cognos Command Center provides a centralized, fully integrated, secure, andhighly extensible environment for system monitoring and automation.

To use the command line client, you should be knowledgeable about IBM CognosCommand Center concepts and general use of the product.

For information about product installation or configuration information related toRDBMS (relational database management systems), see the IBM Cognos CommandCenter Installation Guide.

What's new in the command line clientKnowing what features are new, changed, deprecated, or removed helps you planyour upgrade and deployment strategies and the training requirements for yourusers.

New features in version 10.2.0In the IBM Cognos Command Center command line client, you can now includetriggers in export content and set timeout or batch size for purge commands.

Export triggers

To include triggers in export content, use the /trig:TRIGGER argument with theexport command.

For more information on triggers, see the IBM Cognos Command CenterAdministration User Guide.

Set timeout or batch size for purge commands

To set the purge command timeout within the range of 60 - 1800 seconds, use the/timeout:SECONDS argument with the command.

To set the transaction batch size within the range of 1000 - 100000 records, use the/batchsize:NUMBER argument with the command.

New features in version 10.2.0.1In the IBM Cognos Command Center command line client, you can now passprocess parameters in the start process command.


Start process parameters

To include process parameters and values in the start process command, use theargument /p:name=value.

New features in version 10.2.2There are no new features in this version of the IBM Cognos Command Centercommand line client.

New features in version 10.2.3There are new features in this version of the IBM Cognos Command Centercommand line client.

Agents can be exported from the command line

The Export command is now capable of exporting agents from a repository.

The following graphic shows an example in which the Export command exports allagents in a repository

Users and roles can be exported from the command line

The export command is now capable of exporting users and roles in a repository.

For example, you can export process Y in ecosystem X, the user John, and all rolesby using the following syntax:

CccCommand export /user:DEFAULT /password: /eco:X /proc:Y /u:John /r

Attention:

v User and role names are case insensitive.v Specifying both /u and (at least one) /u:name argument is not allowed.v Specifying both /r and (at least one) /r:name argument is not allowed.v There is a requirement that something must be exported from an ecosystem, a

user, or a role.v Double arguments, for example /u:JOHN /u:john, cause the command to fail.

The behavior is similar for roles.v Specifying an unknown user or role causes the command to fail.

The following graphic shows an example in which the Export command exports allusers and all roles defined in a repository.

Figure 13. An example in which the Export command exports all agents


The following graphic shows an example in which the Export command exportsspecific users and specific roles, such as user1, user2, and role1.

Schedules can now be enabled or disabled from the commandline

You can now enabled or disable schedules from the command line.

You must have administrator permissions to enable schedules.

The following graphic shows an example in which the Set-schedule command setsthe schedule to active.

The following graphic shows an example in which the Set-schedule command setsthe schedule to active for all processes in the ecosystem.

The following graphic shows an example in which the Set-schedule command triesto enable the schedule for all processes in a specific ecosystem and environment,but not all of the processes have schedules defined. A list of the processes nothaving schedules defined is returned, and none of the schedules are modified.

Figure 14. An example in which the Export command exports all users and all roles defined in a repository

Figure 15. An example in which the Export command exports specific users and specific roles

Figure 16. An example in which the Set-schedule command sets the schedule to active

Figure 17. An example in which the Set-schedule command sets the schedule to active for all processes in theecosystem

Chapter 9. IBM Cognos Command Center Command Line Client 155

OverviewYou can use the IBM Cognos Command Center command line client to performmany actions.v Query, start, pause, and stop processes.v Test agent connectivity.v Fully or partially export the repository.v Bulk import and export file resources.

The Cognos Command Center command line client is installed in theINSTALLDIR\CLI subdirectory. To start the command line client, run theCccCommand.exe command in that directory.

To run commands, use the following syntax: CccCommand COMMAND [CommonArguments] [Command Arguments].

List of CommandsIn the IBM Cognos Command Center command line client, you can run thefollowing commands:

export Exports one or more ecosystems or parts of one or more ecosystems.

export-fileExports a file resource or a folder from the Cognos Command Centerrepository into the local file system.

import-fileImports a file or a directory from the local file system into the CognosCommand Center repository.

list-pluginsLists the set of loaded Cognos Command Center plug-ins.

load-pluginsLoads an IBM Cognos Command Center plug-in into the repository.

pause Pauses a running process.

purge Purges old process runs and optionally purges no longer used processrevisions, file resource revisions, and empty labels.

query Queries the running state of a process.

start Starts a process.

stop Stops a process.

Figure 18. An example in which the Set-schedule command tries to enable the schedule for all processes in a specificecosystem and environment, but not all of the processes have schedules defined.


test Tests the connectivity to an agent.

Common ArgumentsThe common arguments are applicable for all the commands available in the IBMCognos Command Center command line client.

You can use the following arguments:

/user:USERThe user that issues the request.

/password:PASSWORDThe password for the user.

/host:HOSTThe hostname and port location of the server. The format for the argumentis: hostname[:port].

The default value is localhost:9001

/cert:CERTIFICATEThe certificate type that is used by the server. Must be one of: trusted, orselfSigned.

The default value is selfSigned.

/protocol:PROTOCOLThe protocol that is used by the server. Must be one of: tcp, http, or https.

The default value is tcp.

Return valuesThe IBM Cognos Command Center command line client returns a zero exit codewhen a command runs successfully. Non-zero exit codes indicate failures.

The following exit code values can be returned:

0 Indicates that a command ran successfully.

1 Indicates that there was a general error in running a command. The outputcontains detailed error information.

2 Indicates that an invalid username or password was used when thecommand was run.

3 Indicates that there was a communication error.

Command referenceWith the IBM Cognos Command Center command line client you can runcommands by using a command line. In addition to the command name andcommon arguments, there are command-specific arguments that you use to writecommands.

To run commands, use the following syntax: CccCommand COMMAND [CommonArguments] [Command Specific Arguments].


ExportTo export the automation repository into an IBM Cognos Command Center exportfile, use the export command. The export file can then be imported into the targetrepository by using the IBM Cognos Command Center client user interface.

You can use the following command-specific arguments:

/outfile:FILENAMEThe name of the output file that holds the export.

/outpassword:PASSWORDThe password that is used to protect the output file.

/msg:MESSAGEAn optional message that describes the export.

/eco:ECOSYSTEMThe name of an ecosystem to export. Multiple /eco: switches are allowed.

/proc:PROCESSThe name of a process within the ecosystem. Multiple /proc: switches areallowed. If no /proc: switch is given, all processes in the ecosystem areexported.

/file:FILENAMEThe name of a file resource in the ecosystem. Multiple /file: switches areallowed. If no /file: switch is given, all file resources in the ecosystem areexported.

/trig:TRIGGERThe name of a trigger within the ecosystem. Multiple /trigger: switchesare allowed. This argument allows triggers to be included in the exportcontent.

/a Exports all agents.

/a:<agent>Exports the agent with the specified name. Multiple /a:<agent> switchesare allowed.

/u Exports all users.

/u:<user>Exports the user with the specified name. Multiple /u:<user> switches areallowed.

/r Exports all roles.

/r:<role>Exports the role with the specified name. Multiple /r:<role> switches areallowed.

The following is an example of an export command that includes commonarguments, and command-specific arguments: C:\>CccCommand.exe export/user:Default /password: /outfile:demo.sfe /outpassword:password/msg:"Exporting Demo" /eco:Demo

Export fileUse the export-file command in the IBM Cognos Command Center commandline client to export a file resource or a folder from the automation repository todisk.



/eco:ECOSYSTEMThe name of the source ecosystem that contains the tile file resource orfolder.

/folder:FOLDERThe full path of the folder to export. Use a forward slash (/) as pathseparator.

/file:FILE[@REV]The full and optional revision of the file resource to export. Use a forwardslash (/) as path separator. If you do not specify /folder or /filearguments, the root folder is exported.

/path:DESTINATIONThe destination directory or file. Use a backward slash (\) as pathseparator.

The default value is: current working directory.

/recursiveExport folders recursively.

The default value is: Export non-recursively.

/overwriteOverwrite existing files.

The default value is: Keep existing files.

Command output

In the command window, the command output lists the names of the files that arebeing exported. Each file name is preceded with a letter that indicates whether thefile was created or updated. The letter C indicates that a file was created. The letterU indicates that a file was updated.

Import fileUse the import-file command in the IBM Cognos Command Center commandline client, to bulk import files and directories from disk into an ecosystem in theautomation repository.


/eco:ECOSYSTEMThe name of the parent ecosystem that contains the destination folder.

/folder:DESTINATIONThe full path of the destination folder within the ecosystem. Use a forwardslash (/) as path separator.

/path:SOURCEThe source file or directory. Use a backward slash (\) as a path separator.

The default value is: Current working directory.

/recursiveImport directories recursively.

The default value is: Import non-recursively.


/overwriteOverwrite existing file resources.

The default value is: Keep existing file resources.

Command output

In the command window, the command writes on the output, the names of thefiles that are being imported. Each file is preceded with a letter that indicateswhether the file was created or updated. The letter C indicates that a file wascreated. The letter U indicates that a file was updated.

List pluginsIn the IBM Cognos Command Center command line client, use the list-pluginscommand to list the set of IBM Cognos Command Center plugins that are loaded.

There are no command specific arguments for the list-plugins command.

The output for the command lists the name and version of the plug-in and thedate that the plug-in was loaded.

Load pluginsIn the IBM Cognos Command Center command line client, use the load-pluginscommand to load an IBM Cognos Command Center plug-in into the repository.

Use the following command-specific argument:

/file:FILEThe name of the plug-in file to load.

In the command window, the command output lists the name and version of theplug-in that was loaded and the date that the plug-in was loaded.

PauseIn the IBM Cognos Command Center command line client, use the pausecommand to pause a currently running process.

Use the following command-specific arguments:

/eco:ECOSYSTEMThe name of the ecosystem that contains the process.

/env:ENVIRONMENTThe name of the environment where the process is running.

/proc:PROCESSThe name of the process.

/wait[:SECONDS]Optional flag. If set, the client waits for the command to complete.

/wait - waits indefinitely.

/wait:60 - waits 60 seconds.

You can also pause a process that is running by clicking the pause icon on the IBMCognos Command Center client user interface.


PurgeIn the IBM Cognos Command Center command line client, use the purgecommand to delete process runs that are older than a number of days that youspecify from the automation repository.

Once purged, the information on these process runs is no longer retrievable. Youcan also delete process and file resource revisions that are older than a number ofdays that you specify and that have no associated process runs. When a process orfile resource revision is deleted, the item is removed from any associated labels.You can purge labels that are left without any associated items.


/maxage:DAYSDelete data that is older than DAYS old.

/processesIf present, old process revisions that have no associated process runs aredeleted.

/fileresourcesIf present, old file resource revisions that have no associated process runsare purged.

/labelsIf present, empty labels are purged.

/timeout:SECONDSIf present, sets the command timeout within the range of 60 - 1800seconds.

Default value is: 120 seconds.

/batchsize:NUMBERIf present, sets the transaction batch size within the range of 1000 - 100000records.

Default value is: 10000 records.

QueryIn the IBM Cognos Command Center command line client, use the purgecommand to query the current run status for a process.






If you use the argument without specifying a number of seconds to wait,the client waits indefinitely for the command to complete. You can alsospecify a wait time, for example /wait:60.


Set-scheduleIn the IBM Cognos Command Center command line client, use the set-schedulecommand to enable or disable schedules.

You can now enable or disable schedules by using the following syntax:

CccCommand set-schedule /state:[on|off|toggle] [/eco:<ecosystem>[/env:<environment> [/proc:<process>]]], where:v /state:[on|off|toggle] sets the schedule to active/inactive.v /eco:<ecosystem> is the name of an ecosystem. Multiple /eco: switches are

allowed.v /env:<environment> is the name of an environment within the ecosystem.

Multiple /env: switches are allowed.v /proc:<process> is the name of a process within the ecosystem. If no /proc:

arguments are given, then all processes in the environment within the ecosystemare affected. Multiple /proc: switches are allowed.

StartIn the IBM Cognos Command Center command line client, use the startcommand to start a process in an environment. Only processes that have no userprompt variables can be started by using this command.





/p:name=valueThe name and the value of a parameter.

Multiple switches must be used to supply multiple parameters.

/wait:[SECONDS]Optional flag. If set, the client waits for the command to complete.


StopIn the IBM Cognos Command Center command line client, use the stop commandto stop a process that is currently running.








You can also stop a process that is running by clicking the stop icon on the CognosCommand Center client user interface.

TestIn the IBM Cognos Command Center command line client, use the test commandto test the connectivity to an automation agent.

Use the following command-specific argument:

/agent:AGENTThe name of the agent to test.



Chapter 10. IBM Cognos Command Center Web Client

Use the web client to run and monitor IBM Cognos Command Center automationprocesses in a browser.

To define, maintain, and manage Cognos Command Center, access the softwarethrough the Cognos Command Center client. For more information, see Chapter 2,“IBM Cognos Command Center client,” on page 11.

For information on product installation, or configuration information that is relatedto RDBMS (relational database management systems), see the IBM CognosCommand Center Installation Guide.

Web client overviewThe IBM Cognos Command Center web client is a browser-based, user interfacefor running and monitoring automation processes. View the status of processes onthe Process Overview page and click links in the table to drill down to process andtask details. Start, pause, or stop process runs.

For information on new features in current and previous releases, see the IBMCognos Command Center Administration Guide.

The processes that you can see are determined by the security access that yoursystem administrator defines for you.

In the web client, you can perform the following actions:

Process Overview page

v View the status of processes that are monitored in Cognos CommandCenter.

v Filter the information that is displayed.v Open the Process Detail page for a process.

Process Detail page

v View run details for a process that you select from the Process Overviewpage.

v View the table of Task Run Details for the process.v Open the Task Detail page.v Open the Run History page for a process.v Start, pause, or stop a process run.

Task Detail page

v View log information, pre-task actions, and post-task actions, for a taskyou select from the Task Run Details table.

Process History page

v View the process run history.v Filter content by status and start date values.v Open the Process Detail page for a process.



Chapter 11. IBM Cognos Command Center Web Services

The IBM Cognos Command Center Web Services interfaces provide SOAP andREST web services that runs on top of HTTP. You can use these interfaces to writeapplications that perform Cognos Command Center tasks.

IBM Cognos Command Center provides a centralized, fully integrated, secure, andhighly extensible environment for system monitoring and automation.

To use the Web Services interface, you should be knowledgeable about IBMCognos Command Center concepts and general use of the product.

For information about product installation or configuration information related toRDBMS (relational database management systems), see the IBM Cognos CommandCenter Installation Guide.

What's new?This section contains a list of new, changed, and deprecated features for this andprevious releases. You can use it to plan your upgrade and application deploymentstrategies and the training requirements for your users.

New features in version 10.2.3

There are no new features in this version of the IBM Cognos Command CenterWeb Services.

New features in version 10.2.2

The IBM Cognos Command Center REST API was added. Use this API to sendHTTP Secure (HTTPS) requests to the Cognos Command Center server to run thefollowing Cognos Command Center tasks:v Logging on to, and off from, the Cognos Command Center server.v Retrieving all ecosystems, environments, and processes available to the currently

logged on user.v Retrieving all process variables for a process.v Retrieving the last run of a process.v Starting a new run of a process.v Retrieving, restarting, pausing, or stopping a specific process run.v Retrieving the status of an asynchronous run of a process.

For more information, see “Using the Cognos Command Center REST API” onpage 172.

Configuring the Web Services interfaceBefore you can use the IBM Cognos Command Center Web Services interface, thereare configuration tasks that you must complete.


About this task

The Cognos Command Center Web Services component is available in the standardedition.

To configure and enable the Web Services interface, you set the followingproperties:

Enable APISet to true to enable the Web Services interface.

HostnameThe base address for the Web Services. Set the address to the external IPaddress of the host where the Cognos Command Center server is running.

Port The port that hosts the Web Services interface.

UsernameThe name of an existing Cognos Command Center user. All requests thatare received on the Web Services interface are processed under this useridentity. To manage what is exposed on the Web Services interface, you canrestrict the access for this Cognos Command Center user.

Procedure1. Log on to Cognos Command Center.2. Click Tools > System Configuration, and enter or select values for the

properties in the Web Service Listener subsystem.3. Restart the Cognos Command Center server.

Security for the Web Services interfaceThe IBM Cognos Command Center Web Services interface is an open service. Youcan secure it by using a firewall and limiting the access rights of users.

A firewall can restrict the location from which incoming connections can be made.Setting access rights for users that are assigned to the interface, controls what canbe managed through the Web Services interface. For information on setting accessrights for users, see the IBM Cognos Command Center Administration Guide.

Service referenceIn IBM Cognos Command Center, you can use the Web Services interface toperform operations with APIs.

Use the Web Services interface to perform the following operations:v Pause a running processv Query the state of a processv Resume a paused processv Query the state of a processv Start a processv Stop a running process

PauseProcessIn the IBM Cognos Command Center Web Services interface, use the PauseProcessoperation to pause a running process.


To pause a running process, use the following operation:

Table 218. PauseProcess request

Property Type Description

processId int The job id of the process to pause.

Table 219. PauseProcess response


HasException boolean A flag that signals if the operation failed. For a successfuloperation, the value is false.

ExceptionInfo string Holds an error message if HasException is true.

QueryProcessIn the IBM Cognos Command Center Web Services interface, use the QueryProcessoperation to query the state of a process.

To query the state of a process, use the following operation:

Table 220. QueryProcess request


processId int The job id of the process to query.

Table 221. QueryProcess response


State string The state of the process. Only set if HasException is false.The state is one of: running, canceling, canceled, pausing,paused, failed, completed, or waiting to retry.



ResumeProcessIn the IBM Cognos Command Center Web Services interface, use theResumeProcess operation to resume a process that is paused.

To resume a process that is paused, use the following operation:

Table 222. ResumeProcess request


processId int The job id of the process to resume.

Table 223. ResumeProcess response




Chapter 11. IBM Cognos Command Center Web Services 169

StartProcessIn the IBM Cognos Command Center Web Services interface, use the StartProcessoperation to start a process.

To start a process, use the following operation:

Table 224. StartProcess request


ecosystem string Name of the ecosystem that contains the process to start.

environment string Name of the environment to run the process in.

process string Name of the process to start.

args array of{name,value}

List of ecosystem and process variable {name,value} pairs.Use this to provide values for variables that are checked asprompt.

Table 225. StartProcess response


ProcessId int The job id of the process that has started. Only set ifHasException is false.



StopProcessIn the IBM Cognos Command Center Web Services interface, use the StopProcessoperation to stop a process.

To stop a process, use the following operation:

Table 226. StopProcess request


processId int The job id of the process to stop.

Table 227. StopProcess response




Web Services Description LanguageThe Web Services Description Language (WSDL) for the IBM Cognos CommandCenter Web Services is distributed with the Cognos Command Center serverinstallation.

The WSDL is in the INSTALLDIR\Server\config\schemas.staranalytics.com.sfcc.wsdl file.


Additionally, the Cognos Command Center Web Services interface enables clientsto query the service definition at run time. The WSDL is available by queryinghttp://serverhost:9003/Sfcc?wsdl.

Testing the Web Services interfaceYou can test and demonstrate the IBM Cognos Command Center Web Servicesinterface by using a web services browser. The following procedure uses the opensource soapUI tool.

Before you begin

This test example shows how to start a process through the Web Services interface.The test requires a process that can be started in the Cognos Command Centerrepository and assumes the following objects exist in the Command Centerrepository:v An ecosystem named WS Test that contains an environment named WS Test.v A process named WS Test that has a process variable named MSG.

Procedure1. Start soapUI and create a new project.

Tip: The WSDL file is in INSTALLDIR\Server\config\schemas.staranalytics.com.sfcc.wsdl.

2. Double-click on the Projects > StartProcess > Request node in the navigator.3. In the Request window, edit the endpoint of the url to point to Cognos

Command Center. For example, http://127.0.0.1:9003/Sfcc.4. In the Request window, Edit the SOAP header to include the to address. For

example,<soap:Header>

<To soap:mustUnderstand="1" xmlns="http://www.w3.org/2005/08/addressing">http://127.0.0.1:9003/Sfcc</To>

</soap:Header>

5. Edit the SOAP body to include names that match the target Cognos CommandCenter system and optionally, add ecosystem and process variable values. Forexample,<soap:Body>

<sfcc: StartProcess><sfcc:ecosystem>WS Test</sfcc:ecosystem><sfcc:environment>WS Test</sfcc:environment><sfcc:process>WS Test</sfcc:process><sfcc:args>

<sfcc:NameValuePair><sfcc:Name>MSG</sfcc:Name><sfcc:Value>Hello from soapUI</sfcc:Value>

</sfcc:NameValuePair></sfcc:args>

</sfcc: StartProcess></soap:Body>

6. Issue the request from the soapUI tool and inspect the result.


Using the Cognos Command Center REST APIThe IBM Cognos Command Center REST API automates the functions available inthe IBM Cognos Command Center. The API uses the representational state transfer(REST) web services architecture.

Use the Cognos Command Center REST API to send HTTP Secure (HTTPS)requests to the Cognos Command Center server to run the following CognosCommand Center tasks:v Logging on to, and off from, the Cognos Command Center server.v Retrieving all ecosystems, environments, and processes available to the currently

logged on user.v Retrieving all process variables for a process.v Retrieving the last run of a process.v Starting a new run of a process.v Retrieving, restarting, pausing, or stopping a specific process run.v Retrieving the status of an asynchronous run of a process.

The response from the server contains data about any actions that are run. Datasent to and retrieved from the server is in the JavaScript Object Notation (JSON)format.

Configuring Cognos Command Center for the REST APIBefore you use the REST API, you must configure it in IBM Cognos CommandCenter.

Procedure1. Log on to Cognos Command Center.2. Click Tools > System Configuration.3. In the REST API subsystem, set the value of Enable API to true. You can also

modify the default port number and the session timeout value, which is inminutes.

4. In the Event Listener subsystem, set the value of Request Queue Length to themaximum number of running and pending asynchronous runs of a processallowed. If this value is 0, asynchronous runs of processes are not availableusing the REST API.

5. Restart the Cognos Command Center server.

Cognos Command Center HTTP request structureThe IBM Cognos Command Center HTTP request can be generated by the weblibraries available with most programming languages. The parts of the HTTPrequest are described here.

Attention:

The Cognos Command Center REST API uses URIs to refer to ecosystems,processes, and environments. For example, when starting a process, you do a POSTon /ccc/ecosystem/environment/process/X/Y/Z, where X, Y and Z are nameschosen by the user.

If X, Y, or Z contains a forward slash, then you cannot refer to these. The HTTPstandard does not support a forward slash as part of a path element.


HTTP method

The IBM Cognos Command Center API HTTP request uses the 4 common HTTPmethods: GET, POST, PUT, and DELETE.

HTTP Secure path

The HTTP Secure path is based on the URL of the Cognos Command Center serverand has the following form:

https://<server_name>:<port>/ccc/<command>/...

The default port number is 9004.

Request headers

If you are sending data in the entity-body, you must include a Content-Type:application/json header.

Entity-body

Many commands require that you submit data in the entity-body. This data ispackaged as a JSON object. The data that is required is described in thedocumentation for the individual commands. Consider the following issues whenyou create the JSON object:v The names in the name-value pairs are case-sensitive.v The name-value pairs can be entered in any order.

Cognos Command Center HTTP response structureThe parts of the HTTP response are described here.

Response code

The response code from a Cognos Command Center request varies depending onthe command. The possible response codes are described in the documentation foreach command.

Response headers

The response headers contain cookies and other information. There is aContent-Type: application/json;charset=utf-8 header if the response includes aJSON object.

Entity-body

The entity-body consists of a JSON object that contains the response to a request.The data that is returned is described in the documentation for the individualcommands. A request returns an empty JSON object if the command ran and noresponse is needed.

Cognos Command Center REST authenticationWhen using the REST API you must authenticate to the IBM Cognos CommandCenter server.


You can authenticate in either of two ways:v You can authenticate by using the login command.v You can include an Authorization header in your REST command. The contents

of the Authorization header are Basic <base64_encoded_username><base_64_encoded_password>.For example, Authorization:Basic RnJlZA== c2VjcmV0.

The response to the authentication request contains a cookie that authenticates theuser for subsequent commands. This cookie expires after the session timeout valueand is reset with each new authentication request. The session timeout value has adefault value of 30 minutes and can be modified in System Configuration. Formore information, see “Configuring Cognos Command Center for the REST API”on page 172.

Cognos Command Center REST command referenceThe IBM Cognos Command Center REST commands are described in the followingtopics.

loginLogs a user in to the IBM Cognos Command Center server. The response to thelogin command includes a cookie that authenticates the user for subsequentcommands.

Syntaxhttps://<server_name>:<port>/ccc/login

HTTP methodPOST

Input JSON object

usernameThe user to log in.

passwordThe password of the user.

Sample{

"userName":"Fred","password":"secret"

}

Output JSON objectNot applicable.

Response codes

204 The user logged in successfully.

401 The user could not be logged in.

logoffLogs a user off from the IBM Cognos Command Center server.

Syntaxhttps://<server_name>:<port>/ccc/logout

HTTP methodDELETE


Input JSON objectNot applicable.

Output JSON objectNot applicable.

Response codes

204 The logoff was successful.

401 The logoff was unsuccessful because the user was not logged in.

ecosystems/processesRetrieves a list of ecosystems, processes, and environments available for the user inthe IBM Cognos Command Center server.

Syntaxhttps://<server_name>:<port>/ccc/ecosystems/processes

HTTP methodGET


Output JSON object

Array of

ecosystemEcosystem name.

environmentsArray of environment names.

processesArray of

name Process name.

access_levelAccess level of the logged in user to the process.One of Read, Execute, Write, or Create. For moreinformation, see the topic on security in the IBMCognos Command Center Administration Guide.

Sample[

{"ecosystem":"CogBI","environments":[

"Default"],

"processes":[

{"name":"ListReports",

"access_level":"Create"},

{"name":"MakDir","access_level":"Create"

},{

"name":"runrep","access_level":"Create"


}]

}{

"ecosystem":"Misc","environments":["Default],"processes":[]

}]

Response codes

200 The command was successful.

401 The command was unsuccessful because the user was not loggedin.

ecosystem/environment/process/variablesRetrieves a list of all process variables for a specific process.

Syntaxhttps://<server_name>:<port>/ccc/ecosystem/environment/process/variables/<ecosystem_name>/<environment_name>/<process_name>

HTTP methodGET


Output JSON object


environmentEnvironment name.

processProcess name.

variablesArray of

Name Process variable name.

Prompttrue if the variable is a prompt value. false otherwise.

Encrypttrue if the variable is encrypted. false otherwise.

Value Process variable value. Empty if the variable is encrypted.

Sample{

"ecosystem":"CogBI","environment":"Default","process":"MakDir","variables":

[{

"Name":"var1","Prompt":true,"Encrypt":false,"Value":"val1"

},{


"Name":"var2","Prompt":false,"Encrypt":false,"Value":"val2"},{

"Name":"var3","Prompt":false,"Encrypt":true,"Value":""

}]

}

Response codes



404 The command was unsuccessful because the object does not existor the user does not have access to it.

ecosystem/environment/process/runRetrieves the last run of a process or starts a new run of a process.

Syntaxhttps://<server_name>:<port>/ccc/ecosystem/environment/process/run/<ecosystem_name>/<environment_name>/<process_name>

Retrieve the last run of a process

HTTP methodGET


Output JSON object




access_levelAccess level of the logged in user to the process. One of Read,Execute, Write, or Create. For more information, see the topic onsecurity in the IBM Cognos Command Center Administration Guide.

state State of the process. One of NotStarted, StartingUp, Running,Cancelling, Cancelled, Pausing, Paused, Failed, Completed,Warning, WaitingToRetry, or Skipped.

run_idProcess run identifier.

start_timeUTC time stamp of the process run start time in ISO 8601 format.For example, 2015-01-22T12:43:40Z


end_timeUTC time stamp of the process run start time in ISO 8601 format.Empty if the process is still running.

result_textThe result text of the process. Empty if the process is still running.

last_modifiedUTC time stamp of the last process run modification in ISO 8601format.

last_modified_userName of the user who last modified this process run.

run_details_urlURL of the web page that contains the run details of the process.The IBM Cognos Command Center web client must be installedand configured to view this web page.

Sample{

"ecosystem":"CogBI","environment":"Default","process":"runrep","access_level":"Create","state":"Cancelled","run_id":1018,"start_time":"2015-01-26T19:22:25Z","end_time":"2015-01-26T19:24:55Z","result_text":"","last_modified":"2015-01-26T19:24:55Z","last_modified_user":"DEFAULT","run_details_url":"https://localhost:8180/Process/Details/1018"

}

Response codes




Start a new run of a process

HTTP methodPOST

Input JSON object (optional)

request_mode (optional)Specifies whether the server queues the run and respondsimmediately (value of async) or responds only when the run iscomplete (value of sync).

The default value is sync.

variables (optional)Specifies process variable values to be used for this run.

Array of

name Process variable name.

value Process variable value for this run.


Sample{

"request_mode":"async","variables":

[{

"name":"var1","value":"val1a"

},{

"name":"var2","value":"val2a"

}]

}

Output JSON object (async run)




run_idProcess run identifier. Only set if the value of state is Active orProcessed.

run_details_urlURL of the web page that contains the run details of the process.Only set if the value of state is Active or Processed. The CognosCommand Center web client must be installed and configured toview this web page.

request_idIdentifier of the request in the Event Listener Queue.

state State of the process. One of Active, Pending, Failed, or Processed.

messageA description of the result of the request.

Sample{

"ecosystem":"CogBI","environment":"Default","process":"runrep","run_id":"1028","run_details_url":"https://localhost:8180/Process/Details/1028","request_id":1010,"state":"Active","message":"Processing started."

}

Output JSON object (sync run)






state State of the process. One of Cancelled, Failed, Completed, orWarning.




run_details_urlURL of the web page that contains the run details of the process.The Cognos Command Center web client must be installed andconfigured to view this web page.

Sample{

"ecosystem":"CogBI","environment":"Default","process":"runrep","run_id":1021,"state":"Failed","start_time":"2015-02-05T16:51:58Z","end_time":"2015-02-05T16:52:03Z","result_text":"Task Run Report failed.","run_details_url":"https://localhost:8180/Process/Details/1021"

}

Response codes




409 The command was unsuccessful because an instance of the processis running or paused. This response code is only applicable to syncruns.

ecosystem/environment/process/run - particular run IDRetrieves, restarts, pauses, or stops a specific process run.

Syntaxhttps://<server_name>:<port>/ccc/ecosystem/environment/process/run/<ecosystem_name>/<environment_name>/<process_name>/<run_id>

Retrieve a specific run of a process

HTTP methodGET


Output JSON object





access_levelAccess level of the logged in user to the process. One of Read,Execute, Write, or Create. For more information, see the topic onsecurity in the IBM Cognos Command Center Administration Guide.

state State of the process. One of NotStarted, StartingUp, Running,Cancelling, Cancelled, Pausing, Paused, Failed, Completed,Warning, WaitingToRetry, or Skipped.





last_modifiedUTC time stamp of the last process run modification in ISO 8601format.

last_modified_userName of the user who last modified this process run.

run_details_urlURL of the web page that contains the run details of the process.The IBM Cognos Command Center web client must be installedand configured to view this web page.

Sample{

"ecosystem":"CogBI","environment":"Default","process":"runrep","access_level":"Create","state":"Failed","run_id":1021,"start_time":"2015-02-05T16:51:58Z","end_time":"2015-02-05T16:52:03Z","result_text":"Task Run Report failed.","last_modified":"2015-02-05T16:51:58Z","last_modified_user":"Fred","run_details_url":"https://localhost:8180/Process/Details/1021"

}

Response codes





Restart a currently paused run of a process

HTTP methodPOST


request_modeSpecifies whether the server queues the run and respondsimmediately (value of async) or responds only when the run iscomplete (value of sync).


Sample{

"request_mode":"async"}







Sample{

"ecosystem":"CogBI","environment":"Default","process":"runrep","run_id":1020,"run_details_url":"https://localhost:8180/Process/Details/1020"

}










result_textThe result text of the process. Empty if the process is running.


Sample{


}

Response codes




409 The command was unsuccessful because the process run is runningor has completed.

Pause a currently running process

HTTP methodPUT




Sample{









Sample{


}











Sample{

"ecosystem":"CogBI","environment":"Default","process":"runrep","run_id":1021,"state":"Failed","start_time":"2015-02-05T16:51:58Z",


"end_time":"2015-02-05T16:52:03Z","result_text":"Task Run Report failed.","run_details_url":"https://localhost:8180/Process/Details/1021"

}

Response codes




409 The command was unsuccessful because the process run hascompleted or is paused.

Stop a currently running process

HTTP methodDELETE




Sample{








Sample{


}












Sample{


}

Response codes




409 The command was unsuccessful because the process run hasalready completed.

requestRetrieves the status of an asynchronous process run request.

Syntaxhttps://<server_name>:<port>/ccc/request/<request_id>

The value of <request_id> is the value of request_id in the response to anasynchronous process run request.


Retrieve the status an asynchronous process run request

HTTP methodGET


Output JSON object




run_idProcess run identifier. Only set if the value of state is Active orProcessed.

run_details_urlURL of the web page that contains the run details of the process.Only set if the value of state is Active or Processed. The CognosCommand Center web client must be installed and configured toview this web page.

request_idIdentifier of the request in the Event Listener Queue.

state State of the process. One of Active, Pending, Failed, or Processed.

messageA description of the result of the request.

Sample{

"ecosystem":"CogBI","environment":"Default","process":"runrep","run_id":"1028","run_details_url":"https://localhost:8180/Process/Details/1028","request_id":1010,"state":"Processed","message":"Completed successfully."

}

Response codes






Chapter 12. IBM Cognos Command Center samples

IBM Cognos Command Center contains sample processes, files, and scripts thatyou can use to familiarize yourself with the product.

After you have imported the samples, you also can export them to other systems.

Importing the Cognos Command Center samplesYou can install the IBM Cognos Command Center samples from the menu of theIBM Cognos Command Center client.

Procedure1. Click File > Import.2. Browse to the samples in the INSTALLDIR\Samples directory.3. Select a file with the extension .sfe. This indicates a samples file that you can

import.4. Click Open.5. Supply a password, if prompted. The default password is password.6. Click Import.7. Select the files and items that you want to import.8. Follow the steps and click Finish Import.



Chapter 13. Troubleshooting

If you encounter problems in running IBM Cognos Command Center, you shouldfirst try to diagnose the issues by viewing log files.

If you are unable to fix the problem yourself, then contact IBM Cognos CommandCenter technical support.

IBM Cognos Command Center log filesThe IBM Cognos Command Center server, agent, and message queue componentswrite information and errors to individual log files.

Note: Depending on the nature of the issue, you might be asked to send one ormore of the log files to IBM Cognos support.

Server Typically, the server log contains the most critical and helpful information.The log can be viewed by clicking Tools > System Log.

The physical log file can be found in the server directory of yourinstallation. This directory is typically in:c:\Program Files(x86)\IBM\Cognos Command Center\Server.

The log.txt file contains the latest set of messages. IBM Cognos CommandCenter uses a log file rollover scheme to prevent the log file from growingtoo large. The default configuration keeps older log content in fileslog.txt.1 through log.txt.n.

Agent The physical log file can be found in the agent directory of yourinstallation. This directory is typically in: c:\Program Files*x86)\IBM\Cognos Command Center\Agent.

The log.txt file contains the latest set of messages. IBM Cognos CommandCenter uses a log file rollover scheme to prevent the log file from growingtoo large. The default configuration keeps older log content in fileslog.txt.1 through log.txt.n.

Message Queue The physical log files can be found in the common directory for yourinstallation. This directory is typically under: c:\Program Files(x86)\IBM\Cognos Command Center\ Common\apache-activemq-5.8.0\data.v activemq.log

v wrapper.log

Software version informationIf you call technical support, you might be asked to provide software versioninformation for your installation.

You can view the software version by clicking Help > About.

Viewing the version number of an agentYou can obtain the version number of an agent.


Procedure1. Run the IBM Cognos Command Center Client.2. From the Setup and Design folder, click the Agents folder.3. Double-click an agent name to open the agent editor.4. Click Test the Agent.

If the agent is installed and running properly, you see a window that containsall of the version information.


Notices

This information was developed for products and services offered worldwide.

This material may be available from IBM in other languages. However, you may berequired to own a copy of the product or product version in that language in orderto access it.

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 Dr.Ottawa, ONK1V 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.


This Software Offering does not use cookies or other technologies to collectpersonally identifiable information.

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 195

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

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


Index

Aactive message queue viiiagents viii, 41, 192

creating 42application menu bar 12application toolbar 12audit log 38

ecosystem 24authentication 13automations 17, 57

Ccase sensitivity 49client 11command

export 158export file 159import file 159list plugins 160load plugins 160pause 160purge 161query 161set-schedule 162start 162stop 162test 163

command-specific arguments 157common arguments 157components viiicomputing resources 23

configuration 60configuring

computing resources 60plug-ins 60, 62

copying 13creating folders 38cutting 13

Ddeployment paths 39

Eecosystems 22edit menu 13email

plug-in, compatibility 63plug-in, configuration 64plug-in, task reference 64

email notification 37environments 22Event Listener 13exporting 53, 55

Ffile menu 13file resource properties 39file resources 38

audit log 40file utilities


FTPplug-in, compatibility 76plug-in, configuration 76plug-in, task reference 76

FTPSplug-in, compatibility 79plug-in, configuration 79plug-in, task reference 79

Hhelp menu 14

IIBM Cognos Business Intelligence

plug-in, compatibility 60plug-in, task reference 61

IBM Cognos Integration Serverplug-in, compatibility 62plug-in, task reference 63

IBM Cognos TM1plug-in, compatibility 143, 146plug-in, configuration 144, 146plug-in, task reference 144, 147

importing 53, 55

Llabels 51

creating 51list of commands 156log files

troubleshooting 191

Mmigration 47

Point and Run method 47Rewrite to Simplify method 48Upload Existing method 48

monitoring 57

Nnew features 1, 153

in version 10.2.0.1 9, 11in version 10.2.1 8, 9in version 10.2.2 7, 8


new features (continued)in version 10.2.3 2in version 10.2.4 1version 10.2.0 153version 10.2.0.1 154version 10.2.2 154version 10.2.3 154

OOracle EPM Monitoring


Oracle Essbaseplug-in, configuration 96

Oracle Essbase 11plug-in, compatibility 95plug-in, task reference 96

Oracle Essbase 9plug-in, compatibility 83plug-in, configuration 83plug-in, setting the Export Data (J) task 95plug-in, task reference 84

Oracle FDMplug-in, compatibility 103plug-in, configuration 104plug-in, task reference 104

Oracle HFMplug-in, compatibility 108plug-in, configuration 108plug-in, task reference 109

Oracle HFM 11.1.2.4plug-in, compatibility 120plug-in, configuration 120plug-in, task reference 122plug-in, upgrading 121

Oracle Hyperion Planningplug-in, compatibility 129plug-in, configuration 130plug-in, creating a password file 130plug-in, task reference 131

overview 156, 165

Ppasting 13plug-ins 59

configuration 60, 62for email, compatibility 63for email, configuration 64for email, task reference 64for file utilities, compatibility 65for file utilities, configuration 65for file utilities, task reference 65for FTP, compatibility 76for FTP, configuration 76for FTP, task reference 76for FTPS, compatibility 79for FTPS, configuration 79for FTPS, task reference 79for IBM Cognos Business Intelligence, compatibility 60for IBM Cognos Business Intelligence, task reference 61for IBM Cognos Integration Server, compatibility 62for IBM Cognos Integration Server, task reference 63for IBM Cognos TM1, compatibility 143, 146

plug-ins (continued)for IBM Cognos TM1, configuration 144, 146for IBM Cognos TM1, task reference 144, 147for Oracle EPM Monitoring, compatibility 82for Oracle EPM Monitoring, configuration 82for Oracle EPM Monitoring, task reference 83for Oracle Essbase 11, compatibility 95for Oracle Essbase 11, task reference 96for Oracle Essbase 9, compatibility 83for Oracle Essbase 9, configuration 83for Oracle Essbase 9, setting the Export Data (J) task 95for Oracle Essbase 9, task reference 84for Oracle Essbase, configuration 96for Oracle FDM, compatibility 103for Oracle FDM, configuration 104for Oracle FDM, task reference 104for Oracle HFM 11.1.2.4, compatibility 120for Oracle HFM 11.1.2.4, configuration 120for Oracle HFM 11.1.2.4, task reference 122for Oracle HFM 11.1.2.4, upgrading 121for Oracle HFM, compatibility 108for Oracle HFM, configuration 108for Oracle HFM, task reference 109for Oracle Hyperion Planning, compatibility 129for Oracle Hyperion Planning, configuration 130for Oracle Hyperion Planning, creating a password

file 130for Oracle Hyperion Planning, task reference 131for Reporting Automation for QlikView, compatibility 136for Reporting Automation for QlikView, configuration 136for Reporting Automation for QlikView, task

reference 137for SFTP, configuration 138for SFTP, task reference 139for system utilities, compatibility 141for system utilities, configuration 141for system utilities, task reference 141

post task actionswarning status 29

processes 24, 25, 38, 57monitoring 14running 14scheduling 14

RReporting Automation for QlikView


repository viiireturn values 157roles 50running 57, 59

Ssamples 189

importing 189scheduling 57server viiisetting a task warning 29setup and design

automation objects 16SFTP

plug-in, configuration 138


SFTP (continued)plug-in, task reference 139

software version informationtroubleshooting 191

system objects ixsystem utilities


Ttask types

Compare Files 30File Existence 30File Properties 30Goto 30Goto Label 30Iterate Over List 30list object permissions 35list user access 35Parallel Group 30purge data 35Run Process 30Run Program 30Sequential Group 30Sleep 30system management 35Wait on Process 30

task warning 29tasks 24, 26

actions 26

tasks (continued)conditions 26error rules 26operations 26properties 26

tool menu 13triggers 40

creating 41troubleshooting 191

Uuploading files 39user interfaces viii, ixusers

creating 49

Vvariables 22, 25

environment 42process 42system 42

version number 192

Wwarning status 29Web Service Listener 13what you can do in the web client 165window menu 14

Index 199