DataConnect - Admin Setup (Clients, Users, and Quotas)

A few steps must be performed before DataConnect can be used to generate your test data. These steps should be performed by a user with the Organization Admin role in GenRocket. Log into https://app.genrocket.com.

IMPORTANT: Before performing these steps, make certain you have reached out to GenRocket to select a DataConnect package with quota amount, enable the feature, and obtain your Organization's External ID. 

Step 1 - Open DataConnect Management

From the Organization User menu (top-right), select DataConnect Management. This link appears only when DataConnect is enabled for your organization. 

You will be taken to the DataConnect Management page, which has three panels. Not all of the sections shown below will appear at first.

• Organization API Key Panel - Contains your organization's name, external ID, API Key, and Quota information. 
• DataConnect Clients Panel with Table - Lists each DataConnect Client information and provides additional options. 
• DataConnect Users Panel - Contains tabs for Users and Server Users and lists users for the selected DataConnect Client along with additional options. 

Step 2 - Generate the Organization API Key

The Organization API Key panel will appear slightly different depending on if an API Key has been generated or not for your organization. This information will be displayed at the top of the management dashboard. 

No API Key has been generated: 

• If no key exists yet, the button reads Generate Key (green, 🔑 icon), with the hint: "No API key has been generated yet. Generate one to enable DataConnect API access for this organization."
• Click Generate Key. Confirm in the dialog:
  • Title: Generate Org API Key
  • Body: "This will generate a new Org API Key for DataConnect API access. Are you sure you want to generate the key?"
• On success you'll see the toast "Org API Key generated successfully", and the key value is displayed in the panel (a 64-character string). 
• The button changes to Rotate Key (🔄 icon).

Rotating the key (when one already exists):

• The button reads Rotate Key, with the hint:
  "Rotating invalidates the current key immediately. Any existing integrations using the old key will need to be updated."
   
• Confirm dialog Title: Rotate Org API Key; Body: “Rotating the Org API Key will invalidate the current key immediately. Any integrations using the old key will stop working until updated. Are you sure you want to rotate the key?”
   
• Success toast: "Org API Key rotated successfully".

Step 3 - Create a DataConnect Client

In the DataConnect Clients table, select New DataConnect Client.

In the Create DataConnect Client modal enter a Name for the DataConnect Client and click Save.

The client's External ID (a UUID) is generated automatically and shown in the Client Id column of the clients table — copy it for your API calls ( clientExternalId ).

Step 4 - Create DataConnect Users (or Server Users)

Note: Creating both a user and server user is not required. Please see the next section to learn more: 

4a: User vs. Server User — which to use?

Both authenticate the same way — whichever External ID you put in userExternalId determines the identity for that session.

4b: Create DataConnect Users

Select a client name in the table to open its detail view. The DataConnect Users tab is active by default. To add a new user, select New DataConnect User.In the Add DataConnect User modal enter the required information and click Save.

The user's External ID appears in the User Id column — copy it for userExternalId.

4c: Create DataConnect Server Users

On the client detail view, open the DataConnect Server Users tab and select New DataConnect Server User.

In the Add DataConnect Server User modal, enter the required information and click Save.

The External ID appears in the Server Id column — copy it for userExternalId.

Step 5 - Quota Configuration (End-to-End)

DataConnect bills and limits by Gigabyte (GB) of generated data. Quota is allocated in a hierarchy and
consumed top-down on every request.

5a: The quota hierarchy & the golden rule

Org quota (e.g., 25 GB) ← provisioned by GenRocket with your plan
└── Client quota (e.g., 10 GB) ← you allocate per client
├── User quota (e.g., 5 GB) ← you allocate per user
└── Server User quota (e.g., 5 GB) ← you allocate per server user```

Golden rule: at each level, the sum of all non-cancelled child quotas must not exceed the parent quota. Both Users and Server Users count against their parent Client's quota. 

If you violate it, the form rejects the save with a message such as:

• Client vs Org: “Total allocated client quota (30 GB) exceeds the organization quota (25 GB)”
• User vs Client: “Total allocated user quota (12 GB) exceeds the client quota (10 GB)”
• Server User vs Client: "Total allocated server-user quota (12 GB) exceeds the client quota
  (10 GB)"

5b: The Quota Lifecycle

Every quota config has one of four statuses:

Rollover (automatic, FIFO): when the ACTIVE config is fully consumed, DataConnect automatically marks it QUOTA_REACHED, then promotes the oldest AVAILABLE config (by creation order) to ACTIVE. A single large request can even split across configs — filling the active one exactly to its limit and continuing into the next. This lets you stack multiple quota blocks that activate in sequence.

If no AVAILABLE config remains and the ACTIVE one is exhausted, requests are rejected with a
  *_QUOTA_EXCEEDED error. If every config at a level is CANCELED (or none exists), you get a
  *_NO_ACTIVE_QUOTA error instead.

5c: Organization Quota (reference)

Your Org quota is provisioned by GenRocket. For reference, an Org quota config carries: Name, DataConnect Organization (fixed), Package, Price, Number Of GB, and Requested By. You generally won't create these yourself — you divide the Org quota among clients.

5d: Create a Client Quota

From the DataConnect Clients table, click the ⚙️ gear icon on a client row to open Manage DataConnect Client Quota Config. 

Click New DataConnect Client Quota Config.

Enter the required information and click Save (see table below). 

A confirmation model will appear. Click Yes to continue.

The first client quota you create becomes ACTIVE; additional ones are AVAILABLE and roll over later. Remember the golden rule — the sum across all non-cancelled client quotas can't exceed the chosen Org quota's GB. To cancel a quote, use the X in the Action column. 

5e: Create a User / Server User Quota

On the client detail view, click the ⚙️ gear icon on a user (or server user) row to open its quota config screen.

Next, select New … Quota Config.

Enter the required information and click Save (see table below).

A confirmation model will appear. Click Yes to continue.

IMPORTANT: Both User and Server User allocations draw from the same parent Client quota and are summed together against it.

NOTE: Use the X in the Action column to cancel a User or Server User Quota. 

5f: Stacking quotas for automatic rollover

To provide uninterrupted service across renewals, create several quota blocks at the same level:

1. Create "Block A" — becomes ACTIVE.
2. Create "Block B" — stays AVAILABLE.
3. Create "Block C" — stays AVAILABLE.

As Block A is exhausted it flips to QUOTA_REACHED and Block B is promoted to ACTIVE automatically; then C. No code change or manual switch is required.

5g: Cancelling a quota

In any quota table, use the Cancel action (the ✖ / "Cancel Quota Config" control on the row; shown only while the config isn't already cancelled). A cancelled config:

• moves to CANCELLED, recording who cancelled it and when (shown via the row's info
  popover),
• is excluded from parent/child totals (its GB is freed for re-allocation), and
• is skipped by rollover.

A CANCELED quota is not "exhausted." If a request can't proceed because all configs at a level are cancelled, the API returns *_NO_ACTIVE_QUOTA ("No active … quota configured"), not *_QUOTA_EXCEEDED .

5h: Reading quota usage

Every quota table shows consumption as:

<consumed> / <total> GB · <percent>%

For example 2.50 / 5 GB · 50.00% means 2.5 GB of a 5 GB allocation is used (1 GB =
1,073,741,824 bytes).

5i: Threshold email alerts

When consumption crosses any of these thresholds, GenRocket emails your Organization
Admins automatically:

75%, 80%, 85%, 90%, 95%, 100%

Subjects look like "GenRocket DataConnect - Client 'MyClient' quota at 90%" and, at full
consumption, "… quota exhausted (100%)".

The body advises contacting GenRocket to expand quota before service is interrupted

Step 6 - Collect Your Integration Values

Before calling the API, gather these four values from the setup above: