IBM Cognos Command Center

https://www.ibm.com/docs/en/ccc
Admin
IBM Cognos Command Center is an enterprise business intelligence and reporting platform that...
Tokens:67,132
Snippets:492
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### Install IBM Cognos Command Center

Source: https://www.ibm.com/docs/en/ccc/10.2_topic=troubleshooting-installation

This command installs IBM Cognos Command Center using msiexec with voice warmup and logging enabled. It requires the installer executable (ICCC.edition.version.exe) and the MSI file (ICCCST~1.MSI) to be present in the current directory. The output log file will be named 'log.ccc.txt' and saved in the user's temporary directory.

```batch
ICCC.edition.version.exe /C:"msiexec /voicewarmupx %TEMP%\log.ccc.txt /i ICCCST~1.MSI"
```

--------------------------------

### Starting Processes with an External Application

Source: https://www.ibm.com/docs/en/ccc/10.2_topic=module-starting-processes-external-application

External applications can trigger the start of IBM Cognos Command Center processes by issuing an HTML GET request to the configured port after the event listener module is enabled.

```APIDOC
## GET /run/{EcosystemName}/{EnvironmentName}/{ProcessName}

### Description
This endpoint allows external applications to start IBM Cognos Command Center processes by issuing an HTML GET request.

### Method
GET

### Endpoint
`http://hostname:9002/run/{EcosystemName}/{EnvironmentName}/{ProcessName}`

### Parameters
#### Path Parameters
- **EcosystemName** (string) - Required - The name of the ecosystem.
- **EnvironmentName** (string) - Required - The name of the environment.
- **ProcessName** (string) - Required - The name of the process to start.

#### Query Parameters
- **User** (string) - Optional - The username to assign to the request.
- **Variable1** (string) - Optional - A parameter value for the process.
- **Variable2** (string) - Optional - Another parameter value for the process.

### Request Example
```
http://hostname:9002/run/EcosystemName/EnvironmentName/ProcessName?User=Name&Variable1=Value&Variable2=Value
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the request (e.g., "success").
- **message** (string) - A message providing details about the process initiation.

#### Response Example
```json
{
  "status": "success",
  "message": "Process 'ProcessName' in environment 'EnvironmentName' for ecosystem 'EcosystemName' initiated successfully."
}
```
```

--------------------------------

### Getting Process Start Time with Formatting

Source: https://www.ibm.com/docs/en/ccc/10.2_topic=ecosystems-variables

Retrieves the start time of the process, supporting an optional format argument for customization. The indexer can be used to refer to other processes.

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

--------------------------------

### Synchronous Process Run Response Example (JSON)

Source: https://www.ibm.com/docs/en/ccc/10.2_topic=reference-ecosystemenvironmentprocessrun

This JSON object shows the response for a synchronous process run. It contains information about the process, its state, start and end times, result text, and a URL for run details. This is returned only when the run is complete.

```json
{
  "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"
}
```

--------------------------------

### Verify Java Runtime Environment (UNIX)

Source: https://www.ibm.com/docs/en/ccc/10.2_topic=systems-agent-unix-os-installation-prerequisites

Commands to verify the Java runtime environment version and locate its path on a UNIX system. This is crucial for the agent installation as it requires the full path to the JRE. The output shows an example of the commands and their results.

```shell
$ java -version
java version "1.6.0_24"
Java(TM) SE Runtime Environment (build 1.6.0_24-b07)
Java HotSpot(TM) 64-Bit Server VM (build 19.1-b02, mixed mode)
$ which java
/opt/java/jdk1.6.0_24/bin/java
$
```

--------------------------------

### StartProcess Operation

Source: https://www.ibm.com/docs/en/ccc/10.2_topic=reference-startprocess

The StartProcess operation allows you to start a process in a specified ecosystem and environment. You can also provide process variables as arguments.

```APIDOC
## POST /startProcess

### Description
Initiates a process within the IBM Cognos Command Center. This operation requires specifying the ecosystem, environment, and process name, along with any necessary arguments.

### Method
POST

### Endpoint
/startProcess

### Parameters
#### Request Body
- **ecosystem** (string) - Required - Name of the ecosystem that contains the process to start.
- **environment** (string) - Required - Name of the environment to run the process in.
- **process** (string) - Required - Name of the process to start.
- **args** (array of objects) - Optional - List of ecosystem and process variable {name,value} pairs. Use this to provide values for variables that are checked as prompt.
  - **name** (string) - Required - The name of the variable.
  - **value** (string) - Required - The value of the variable.

### Request Example
```json
{
  "ecosystem": "my_ecosystem",
  "environment": "production",
  "process": "daily_report",
  "args": [
    {
      "name": "report_date",
      "value": "2023-11-22"
    }
  ]
}
```

### Response
#### Success Response (200)
- **ProcessId** (int) - The job id of the process that has started. Only set if HasException is false.
- **HasException** (boolean) - A flag that signals if the operation failed. For a successful operation, the value is false.

#### Exception Response
- **HasException** (boolean) - Set to true if an error occurred.
- **ExceptionInfo** (string) - Holds an error message if HasException is true.

#### Response Example (Success)
```json
{
  "ProcessId": 12345,
  "HasException": false
}
```

#### Response Example (Error)
```json
{
  "ProcessId": null,
  "HasException": true,
  "ExceptionInfo": "Error starting process: invalid environment name"
}
```
```

--------------------------------

### Run Process API

Source: https://www.ibm.com/docs/en/ccc/10.2_topic=api-cognos-command-center-rest-command-reference

Starts a new run of a process.

```APIDOC
## POST /ecosystem/{ecosystemId}/environment/{environmentId}/process/{processId}/run

### Description
Starts a new run of a process.

### Method
POST

### Endpoint
/ecosystem/{ecosystemId}/environment/{environmentId}/process/{processId}/run

### Parameters
#### Path Parameters
- **ecosystemId** (string) - Required - The ID of the ecosystem.
- **environmentId** (string) - Required - The ID of the environment.
- **processId** (string) - Required - The ID of the process.

#### Query Parameters
- **parameters** (object) - Optional - A JSON object containing parameters for the process run.

### Request Example
```json
{
  "parameters": {
    "InputFileName": "data_20231122.csv"
  }
}
```

### Response
#### Success Response (200)
- **runId** (string) - The unique identifier for the initiated process run.
- **status** (string) - The initial status of the process run (e.g., "RUNNING", "PENDING").

#### Response Example
```json
{
  "runId": "run_abc123",
  "status": "RUNNING"
}
```
```

--------------------------------

### Asynchronous Process Run Request Example (JSON)

Source: https://www.ibm.com/docs/en/ccc/10.2_topic=reference-ecosystemenvironmentprocessrun

This JSON object demonstrates how to initiate an asynchronous run of a process. It includes the 'request_mode' set to 'async' and an array of 'variables' with their names and values.

```json
{
  "request_mode":"async",
  "variables":
    [
      {
        "name":"var1",
        "value":"val1a"
      },
      {
        "name":"var2",
        "value":"val2a"
      }
    ]
}
```

--------------------------------

### Copy Data Task Configuration File Example

Source: https://www.ibm.com/docs/en/ccc/10.2_topic=11124-oracle-hfm-plug-in-task-reference

An example configuration file for the Copy Data task, defining source and target data subsets for dimensions like SCENARIO, YEAR, PERIOD, ENTITY, and ACCOUNT. It specifies member functions such as [MEMBER], [IDESCENDANTS], and [DESCENDANTS] for data selection.

```text
! 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. Overlapping areas resulting in duplicate members will be automatically removed
!    c. There is no requirement to place members in quotes and case does not matter
!    d. Any invalid members will be flagged

[SOURCE], SCENARIO, "Actual", [MEMBER]
[SOURCE], YEAR, "2007", [MEMBER]
[SOURCE], PERIOD, "February", [MEMBER]

[TARGET], SCENARIO, "Actual", [MEMBER]
[TARGET], YEAR, "2007", [MEMBER]
[TARGET], PERIOD, "April", [MEMBER]

[DATA_SUBSET], ENTITY, "EastSales", [MEMBER]
[DATA_SUBSET], ACCOUNT, "Legal", [MEMBER]
```

--------------------------------

### POST /websites/ibm_en_ccc/startRun

Source: https://www.ibm.com/docs/en/ccc/10.2_topic=reference-ecosystemenvironmentprocessrun

Starts a new run of a specified process. Supports both asynchronous and synchronous modes, allowing for immediate response or waiting for the process to complete.

```APIDOC
## POST /websites/ibm_en_ccc/startRun

### Description
Starts a new run of a specified process. You can provide optional request parameters to control the execution mode and set process variables.

### Method
POST

### Endpoint
/websites/ibm_en_ccc/startRun

### Parameters
#### Query Parameters
- **request_mode** (string) - Optional - Specifies whether the server queues the run and responds immediately (`async`) or responds only when the run is complete (`sync`). Defaults to `sync`.

#### Request Body
- **variables** (array) - Optional - Specifies process variable values to be used for this run.
  - **name** (string) - Required - Process variable name.
  - **value** (string) - Required - Process variable value for this run.

### Request Example (Async)
```json
{
  "request_mode":"async",
  "variables":
    [
      {
        "name":"var1",
        "value":"val1a"
      },
      {
        "name":"var2",
        "value":"val2a"
      }
    ]
}
```

### Response
#### Success Response (200)
**Async Run Response:**
- **ecosystem** (string) - Ecosystem name.
- **environment** (string) - Environment name.
- **process** (string) - Process name.
- **run_id** (string) - Process run identifier. Only set if the value of `state` is `Active` or `Processed`.
- **run_details_url** (string) - URL of the web page that contains the run details of the process. Only set if the value of `state` is `Active` or `Processed`.
- **request_id** (integer) - Identifier of the request in the Event Listener Queue.
- **state** (string) - State of the process. One of `Active`, `Pending`, `Failed`, or `Processed`.
- **message** (string) - A description of the result of the request.

**Sync Run Response:**
- **ecosystem** (string) - Ecosystem name.
- **environment** (string) - Environment name.
- **process** (string) - Process name.
- **run_id** (integer) - Process run identifier.
- **state** (string) - State of the process. One of `Cancelled`, `Failed`, `Completed`, or `Warning`.
- **start_time** (string) - UTC time stamp of the process run start time in ISO 8601 format. For example, `2015-01-22T12:43:40Z`.
- **end_time** (string) - UTC time stamp of the process run start time in ISO 8601 format. Empty if the process is still running.
- **result_text** (string) - The result text of the process. Empty if the process is still running.
- **run_details_url** (string) - URL of the web page that contains the run details of the process.

#### Response Example (Async)
```json
{
  "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."
}
```

#### Response Example (Sync)
```json
{
  "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"
}
```

#### Error Responses
- **401** - Unauthorized: The command was unsuccessful because the user was not logged in.
- **404** - Not Found: The command was unsuccessful because the object does not exist or the user does not have access to it.
- **409** - Conflict: The command was unsuccessful because an instance of the process is running or paused. This response code is only applicable to `sync` runs.
```

--------------------------------

### Check msiexec Parameters and Properties for IBM Cognos Command Center Install

Source: https://www.ibm.com/docs/en/ccc/10.2_topic=installing-silent-install

Command to initiate an interactive MSI installation to check parameters and properties for IBM Cognos Command Center. This command generates a log file that can be used to review the properties used by the installer after completion, regardless of success or failure.

```cmd
msiexec /i "<full_path_to_msi>" /log "<full_path_to_log>"
```

--------------------------------

### GET /ccc/ecosystems/processes

Source: https://www.ibm.com/docs/en/ccc/10.2_topic=reference-ecosystemsprocesses

Retrieves a list of ecosystems, processes, and environments available for the user in the IBM Cognos Command Center server.

```APIDOC
## GET /ccc/ecosystems/processes

### Description
Retrieves a list of ecosystems, processes, and environments available for the user in the IBM Cognos Command Center server.

### Method
GET

### Endpoint
https://<server_name>:<port>/ccc/ecosystems/processes

### Parameters
#### Query Parameters
None

#### Request Body
Not applicable.

### Request Example
None

### Response
#### Success Response (200)
An array of ecosystem objects, each containing a list of environments and processes.
- **ecosystem** (string) - Ecosystem name.
- **environments** (array of strings) - Array of environment names.
- **processes** (array of objects) - Array of process objects.
  - **name** (string) - Process name.
  - **access_level** (string) - Access level of the logged in user to the process. One of `Read`, `Execute`, `Write`, or `Create`.

#### Response Example
```json
[
  {
    "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":[]
  }
]
```

#### Error Response (401)
The command was unsuccessful because the user was not logged in.
```

--------------------------------

### LDAP Host URL Configuration Examples

Source: https://www.ibm.com/docs/en/ccc/10.2_topic=configuration-configuring-external-authentication-server

These examples demonstrate the correct syntax for configuring the External LDAP Host property in IBM Cognos Command Center. It covers both non-SSL and SSL connections, specifying the host, port, and distinguished name.

```text
ldap://example.com:389
```

```text
ldap://example.com:636
```

--------------------------------

### Task Start Time with Formatting

Source: https://www.ibm.com/docs/en/ccc/10.2_topic=ecosystems-variables

Retrieves the start time of a task, with optional formatting. The indexer can be used to reference other tasks.

```N/A
$(Task[My Name].Start{hh:mm}) => "07:22 PM"
```

--------------------------------

### ecosystem/environment/process/run

Source: https://www.ibm.com/docs/en/ccc/10.2_topic=reference-ecosystemenvironmentprocessrun

Retrieves the last run of a process or starts a new run of a process. This endpoint requires specifying the ecosystem, environment, and process names.

```APIDOC
## GET ecosystem/environment/process/run

### Description
Retrieves the last run of a process or starts a new run of a process.

### Method
GET

### Endpoint
`https://<server_name>:<port>/ccc/ecosystem/environment/process/run/<ecosystem_name>/<environment_name>/<process_name>`

### Parameters
#### Path Parameters
- **ecosystem_name** (string) - Required - The name of the ecosystem.
- **environment_name** (string) - Required - The name of the environment.
- **process_name** (string) - Required - The name of the process.

### Request Example
```
GET https://your_server:port/ccc/ecosystem/environment/process/run/MyEcosystem/DevEnv/MyProcess
```

### Response
#### Success Response (200)
- **run_id** (string) - The ID of the last run or the newly started run.
- **status** (string) - The status of the process run.

#### Response Example
```json
{
  "run_id": "12345",
  "status": "Running"
}
```
```

--------------------------------

### Generate and Export SSL Keystore and Certificate (keytool)

Source: https://www.ibm.com/docs/en/ccc/10.2_topic=certificates-changing-ccc-queue-certificate

This snippet demonstrates how to generate a keystore with an SSL certificate, create a truststore, and export the certificate for sharing. It requires the 'keytool' utility and uses command-line arguments to specify keystore and certificate details. The output includes keystore and certificate files.

```bash
keytool -genkey -keyalg RSA -alias cccqueue -keystore keystore-queue.jks -keysize 2048
copy keystore-queue.jks truststore-queue.jks
keytool -delete -alias cccqueue -keystore truststore-queue.jks
keytool -export -alias cccqueue -keystore keystore-queue.jks -file cccqueue.cer
```

--------------------------------

### Silent Install IBM Cognos Command Center MSI

Source: https://www.ibm.com/docs/en/ccc/10.2_topic=installing-silent-install

Command to perform a silent installation of IBM Cognos Command Center using the MSI installer. This example installs client and server with an Oracle database repository, creating a new user and configuring services. It assumes the MSI file is extracted and specifies features, database connection details, and service configurations.

```cmd
msiexec /i "C:\ccc\ICCCST~1.MSI" /qn /norestart /log "C:\ccc\installer.log" ADDLOCAL=FCC_FEATURE,FCS_FEATURE 
FCC_SERVER_HOSTNAME=localhost FCC_SERVER_PORT=9001 FCC_SERVER_PROTOCOL=TCP FCC_SERVER_USE_SELFSIGN=1 
DB_TYPE=Oracle DB_OPERATION=Create DB_TRUSTED_SECURITY=0 DB_NAME=localhost:1521/orcl DB_USER=ccc_ora 
DB_PASSWORD=password FCS_PORT=9001 FCS_PROTOCOL=TCP FCS_USE_SELFSIGN=1 MQ_PORT=61617 MQ_USER=admin 
MQ_PASSWORD=password FCS_SERVICE=1 FCS_SERVICE_START=1 FCS_USE_SYSTEM_ACCOUNT=1 

```

--------------------------------

### SOAP Body Configuration for Starting a Process in Cognos Command Center

Source: https://www.ibm.com/docs/en/ccc/10.2_topic=services-testing-web-interface

This snippet demonstrates how to structure the SOAP body to initiate a process within Cognos Command Center. It includes specifying the ecosystem, environment, process name, and optional arguments like message content.

```xml
<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>
```

--------------------------------

### Getting User Name

Source: https://www.ibm.com/docs/en/ccc/10.2_topic=ecosystems-variables

Returns the name of the user who started the process.

```N/A
$(User.Name) => "John Doe"
```

--------------------------------

### GET /websites/ibm_en_ccc/processes/{process_name}/lastrun

Source: https://www.ibm.com/docs/en/ccc/10.2_topic=reference-ecosystemenvironmentprocessrun

Retrieves the details of the last run for a given process. This endpoint returns information such as the process state, run ID, start and end times, and more.

```APIDOC
## GET /websites/ibm_en_ccc/processes/{process_name}/lastrun

### Description
Retrieves the details of the last run for a given process. This endpoint returns information such as the process state, run ID, start and end times, and more.

### Method
GET

### Endpoint
/websites/ibm_en_ccc/processes/{process_name}/lastrun

### Parameters
#### Path Parameters
- **process_name** (string) - Required - The name of the process to retrieve the last run information for.

#### Query Parameters
None

#### Request Body
Not applicable.

### Request Example
GET /websites/ibm_en_ccc/processes/runrep/lastrun

### Response
#### Success Response (200)
- **ecosystem** (string) - Ecosystem name.
- **environment** (string) - Environment name.
- **process** (string) - Process name.
- **access_level** (string) - Access level of the logged in user to the process. One of `Read`, `Execute`, `Write`, or `Create`.
- **state** (string) - State of the process. One of `NotStarted`, `StartingUp`, `Running`, `Cancelling`, `Cancelled`, `Pausing`, `Paused`, `Failed`, `Completed`, `Warning`, `WaitingToRetry`, or `Skipped`.
- **run_id** (integer) - Process run identifier.
- **start_time** (string) - UTC time stamp of the process run start time in ISO 8601 format. For example, `2015-01-22T12:43:40Z`.
- **end_time** (string) - UTC time stamp of the process run start time in ISO 8601 format. Empty if the process is still running.
- **result_text** (string) - The result text of the process. Empty if the process is still running.
- **last_modified** (string) - UTC time stamp of the last process run modification in ISO 8601 format.
- **last_modified_user** (string) - Name of the user who last modified this process run.
- **run_details_url** (string) - URL of the web page that contains the run details of the process.

#### Response Example
```json
{
  "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"
}
```

### Error Handling
- **401** - The command was unsuccessful because the user was not logged in.
- **404** - The command was unsuccessful because the object does not exist or the user does not have access to it.
```

--------------------------------

### GET /websites/ibm_en_ccc/processes/{ecosystem}/{environment}/{process}/runs/{run_id}

Source: https://www.ibm.com/docs/en/ccc/10.2_topic=reference-ecosystemenvironmentprocessrun-particular-run-id

Retrieves detailed information about a specific run of a process. This includes its state, start and end times, results, and modification details.

```APIDOC
## Retrieve a specific run of a process

### Description
Retrieves detailed information about a specific run of a process. This includes its state, start and end times, results, and modification details.

### Method
GET

### Endpoint
`/websites/ibm_en_ccc/processes/{ecosystem}/{environment}/{process}/runs/{run_id}`

### Parameters
#### Path Parameters
- **ecosystem** (string) - Required - Ecosystem name.
- **environment** (string) - Required - Environment name.
- **process** (string) - Required - Process name.
- **run_id** (integer) - Required - Process run identifier.

#### Query Parameters
- **access_level** (string) - Optional - Access level of the logged in user to the process. One of `Read`, `Execute`, `Write`, or `Create`.
- **state** (string) - Optional - State of the process. One of `NotStarted`, `StartingUp`, `Running`, `Cancelling`, `Cancelled`, `Pausing`, `Paused`, `Failed`, `Completed`, `Warning`, `WaitingToRetry`, or `Skipped`.

### Response
#### Success Response (200)
- **ecosystem** (string) - Ecosystem name.
- **environment** (string) - Environment name.
- **process** (string) - Process name.
- **access_level** (string) - Access level of the logged in user to the process.
- **state** (string) - State of the process.
- **run_id** (integer) - Process run identifier.
- **start_time** (string) - UTC time stamp of the process run start time in ISO 8601 format.
- **end_time** (string) - UTC time stamp of the process run start time in ISO 8601 format. Empty if the process is still running.
- **result_text** (string) - The result text of the process. Empty if the process is still running.
- **last_modified** (string) - UTC time stamp of the last process run modification in ISO 8601 format.
- **last_modified_user** (string) - Name of the user who last modified this process run.
- **run_details_url** (string) - URL of the web page that contains the run details of the process.

#### Response Example
```json
{
  "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"
}
```
```

--------------------------------

### Retrieve Last Process Run - Example JSON Output

Source: https://www.ibm.com/docs/en/ccc/10.2_topic=reference-ecosystemenvironmentprocessrun

This snippet demonstrates the expected JSON output when successfully retrieving the last run of a process. It includes details such as ecosystem, environment, process name, access level, state, run ID, timestamps, and more.

```json
{
  "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"
}
```

--------------------------------

### Asynchronous Process Run Response Example (JSON)

Source: https://www.ibm.com/docs/en/ccc/10.2_topic=reference-ecosystemenvironmentprocessrun

This JSON object represents the response when an asynchronous process run is initiated successfully. It includes details like ecosystem, environment, process name, run ID, state, and URLs for run details.

```json
{
  "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."
}
```

--------------------------------

### LDAP Bind DN Example

Source: https://www.ibm.com/docs/en/ccc/10.2_topic=configuration-configuring-external-authentication-server

Example configuration for the External Bind DN property, used to specify the distinguished name for binding to the LDAP server in Cognos Command Center.

```text
cn=Joe,ou=People,dc=example,dc=com
```

--------------------------------

### Ecosystems, Processes, and Environments API

Source: https://www.ibm.com/docs/en/ccc/10.2_topic=api-cognos-command-center-rest-command-reference

Retrieves a list of ecosystems, processes, and environments available for the user in the IBM Cognos Command Center server.

```APIDOC
## GET /ecosystems/processes

### Description
Retrieves a list of ecosystems, processes, and environments available for the user in the IBM Cognos Command Center server.

### Method
GET

### Endpoint
/ecosystems/processes

### Parameters
No parameters are required for this endpoint.

### Request Example
```
GET /ecosystems/processes
```

### Response
#### Success Response (200)
- **ecosystems** (array) - A list of available ecosystems.
  - **ecosystemId** (string) - The unique identifier for the ecosystem.
  - **ecosystemName** (string) - The name of the ecosystem.
  - **environments** (array) - A list of environments within the ecosystem.
    - **environmentId** (string) - The unique identifier for the environment.
    - **environmentName** (string) - The name of the environment.
    - **processes** (array) - A list of processes within the environment.
      - **processId** (string) - The unique identifier for the process.
      - **processName** (string) - The name of the process.

#### Response Example
```json
{
  "ecosystems": [
    {
      "ecosystemId": "eco1",
      "ecosystemName": "Default Ecosystem",
      "environments": [
        {
          "environmentId": "env1",
          "environmentName": "Production Environment",
          "processes": [
            {
              "processId": "proc1",
              "processName": "Data Load Process"
            }
          ]
        }
      ]
    }
  ]
}
```
```

--------------------------------

### LDAP Base DN Example

Source: https://www.ibm.com/docs/en/ccc/10.2_topic=configuration-configuring-external-authentication-server

Example configuration for the External Base DN property, which specifies the base distinguished name for LDAP searches within Cognos Command Center.

```text
ou=People,dc=example,dc=com
```

--------------------------------

### Import File Command

Source: https://www.ibm.com/docs/en/ccc/10.2_topic=reference-import-file

Bulk import files and directories from disk into an ecosystem in the automation repository using the `import-file` command.

```APIDOC
## POST /command/import-file

### Description
Bulk import files and directories from disk into an ecosystem in the automation repository.

### Method
POST

### Endpoint
`/command/import-file`

### Parameters
#### Command-Specific Arguments
- **/eco:ECOSYSTEM** (string) - Required - The name of the parent ecosystem that contains the destination folder.
- **/folder:DESTINATION** (string) - Required - The full path of the destination folder within the ecosystem. Use a forward slash (/) as path separator.
- **/path:SOURCE** (string) - Optional - The source file or directory. Use a backward slash (\\) as a path separator. The default value is: Current working directory.
- **/recursive** (boolean) - Optional - Import directories recursively. The default value is: Import non-recursively.
- **/overwrite** (boolean) - Optional - Overwrite existing file resources. The default value is: Keep existing file resources.

### Request Example
```bash
import-file /eco:MyEco /folder:/Automations/NewFolder /path:C:\\Users\\Admin\\Documents\\MyFile.txt /recursive /overwrite
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.
- **message** (string) - A message detailing the outcome of the import operation.

#### Response Example
```json
{
  "status": "success",
  "message": "File imported successfully."
}
```
```

--------------------------------

### GET /ccc/request/{request_id}

Source: https://www.ibm.com/docs/en/ccc/10.2_topic=reference-request

Retrieves the status of an asynchronous process run request using its unique request ID.

```APIDOC
## GET /ccc/request/{request_id}

### Description
Retrieves the status of an asynchronous process run request.

### Method
GET

### Endpoint
https://<server_name>:<port>/ccc/request/<request_id>

### Parameters
#### Path Parameters
- **request_id** (string) - Required - The unique identifier for the asynchronous process run request.

### Request Example
```
GET https://your_cognos_ccc_server:port/ccc/request/12345-abcde-67890
```

### Response
#### Success Response (200)
- **status** (string) - The current status of the request (e.g., "in_progress", "completed", "failed").
- **results** (object) - Contains details about the process run if completed or failed.

#### Response Example
```json
{
  "status": "completed",
  "results": {
    "process_name": "YourProcess",
    "start_time": "2023-11-22T10:00:00Z",
    "end_time": "2023-11-22T10:05:00Z",
    "output": "Process executed successfully."
  }
}
```
```
Tokens:
Raw