> For the complete CircleCI developer hub index, see [llms.txt](https://circleci.com/developer/llms.txt)

# accelq/accelq-connect

Use ACCELQ Orb to trigger scheduled CI jobs registered in ACCELQ application.


## Commands

### accelq-ci

This command runs the ACCELQ CI Job using NodeJS make sure its installed.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `agentName` | string |  | Agent Name (Optional) on which you want to run this job |
| `apiKey` | env_var_name |  | API key available in Profile section of ACCELQ |
| `jobId` | string |  | ACCELQ CI Job Id |
| `proxyHost` | string |  | Proxy Host (Optional) |
| `proxyPort` | string |  | Proxy Port (Optional) |
| `runparams` | string |  | Run Params (Optional) should be JSON string form example: {"username": "John Todd", "password": "bxW&=UVw"} |
| `tenantCode` | string |  | ACCELQ Tenant Code |
| `url` | string |  | Your ACCELQ Application URL in the exact following format: https://<hostname>:<port_num> |
| `userId` | string |  | ACCELQ User ID |

## Jobs

### ci-cd

Execute ACCELQ registered CI Jobs


| Parameter | Type | Default | Description |
|---|---|---|---|
| `agentName` | string |  | Agent Name (Optional) on which you want to run this job |
| `apiKey` | env_var_name |  | API key available in Profile section of ACCELQ |
| `jobId` | string |  | ACCELQ CI Job Id |
| `proxyHost` | string |  | Proxy Host (Optional) |
| `proxyPort` | string |  | Proxy Port (Optional) |
| `runparams` | string |  | Run Params (Optional) should be JSON string form example: {"username": "John Todd", "password": "bxW&=UVw"} |
| `tenantCode` | string |  | ACCELQ Tenant Code |
| `url` | string |  | Your ACCELQ Application URL in the exact following format: https://<hostname>:<port_num> |
| `userId` | string |  | ACCELQ User ID |

## Examples

### execute_accelq_tests

Use ACCELQ Orb to trigger scheduled CI jobs registered in ACCELQ application.


```yaml
version: '2.1'
orbs:
  accelq-connect: accelq/accelq-connect@1.0.0
workflows:
  use-my-orb:
    jobs:
      - accelq-connect/accelq-ci:
          agentName: POC
          apiKey: XyzAvsdfwe2322sdf
          jobId: '1'
          proxyHost: localhost
          proxyPort: '9090'
          runparams: '{"username": "john todd", "userID": 2}'
          tenantCode: demotenant
          url: https://poc.accelq.io
          userId: vivekop@yopmail.com
```