Eloqua Cog

This is a Crank Cog for Eloqua, providing steps and assertions for you to validate the state and behavior of your Eloqua instance.

• Installation
• Usage
• Development and Contributing

Installation

Ensure you have the crank CLI and docker installed and running locally, then run the following. You'll be prompted to enter your Eloqua credentials once the Cog is successfully installed.

$ crank cog:install stackmoxie/eloqua

Note: You can always re-authenticate later.

Usage

Authentication

You will be asked for the following authentication details on installation. To avoid prompts in a CI/CD context, you can provide the same details as environment variables.

Field	Install-Time Environment Variable	Description
companyName	CRANK_AUTOMATONINC_ELOQUA__COMPANYNAME	Company Name
username	CRANK_AUTOMATONINC_ELOQUA__USERNAME	Username
password	CRANK_AUTOMATONINC_ELOQUA__PASSWORD	Password

# Re-authenticate by running this
$ crank cog:auth stackmoxie/eloqua

This Cog uses Basic Authentication to interact with Eloqua's REST API. You may want to create an API-specific user just for Crank.

Steps

Once installed, the following steps will be available for use in any of your Scenario files.

Name (ID)	Expression	Expected Data
Check a field on an Eloqua contact (ContactFieldEquals)	the (?<field>.+) field on eloqua contact (?<email>.+) should (?<operator>be less than|be greater than|be|contain|not be|not contain) (?<expectedValue>.+)	- email: Contact's email address - field: Field name to check - operator: Check Logic (be, not be, contain, not contain, be greater than, or be less than) - expectedValue: Expected field value
Create an Eloqua contact (CreateContact)	create an eloqua contact	- contact: A map of field names to field values
Delete an Eloqua contact (DeleteContact)	delete the (?<email>.+) eloqua contact	- email: Contact's email address

Development and Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Please make sure to add or update tests as appropriate.

Setup

1. Install node.js (v12.x+ recommended)
2. Clone this repository.
3. Install dependencies via npm install
4. Run npm start to validate the Cog works locally (ctrl+c to kill it)
5. Run crank cog:install --source=local --local-start-command="npm start" to register your local instance of this Cog. You may need to append a --force flag or run crank cog:uninstall stackmoxie/eloqua if you've already installed the distributed version of this Cog.

Adding/Modifying Steps

Modify code in src/steps and validate your changes by running crank cog:step stackmoxie/eloqua and selecting your step.

To add new steps, create new step classes in src/steps. Use existing steps as a starting point for your new step(s). Note that you will need to run crank registry:rebuild in order for your new steps to be recognized.

Always add tests for your steps in the test/steps folder. Use existing tests as a guide.

Modifying the API Client or Authentication Details

Modify the ClientWrapper class at src/client/client-wrapper.ts.

• If you need to add or modify authentication details, see the expectedAuthFields static property.
• If you need to expose additional logic from the wrapped API client, add a new ublic method to the wrapper class, which can then be called in any step.
• It's also possible to swap out the wrapped API client completely. You should only have to modify code within this clase to achieve that.

Note that you will need to run crank registry:rebuild in order for any changes to authentication fields to be reflected. Afterward, you can re-authenticate this Cog by running crank cog:auth stackmoxie/eloqua

Tests and Housekeeping

Tests can be found in the test directory and run like this: npm test. Ensure your code meets standards by running npm run lint.