Partner mode
For consultancies, Amazon Connect integrators and resellers who run Arena for more than one client. Partner mode gives you three things: a launch link with your details filled in, your name and support contact inside each client's supervisor console, and one page that shows the health of every client install.
Arena still runs entirely inside each client's own AWS account. Partner mode adds no access to it. You never see agents, contacts, teams or scores through it.
What you get
- A partner code, such as
acme. It is public: it sits in your launch link and in each client's stack settings.
- A partner key, which opens your fleet page. It is shown to you once. Arena keeps only a hash of it, so a lost key is replaced, not recovered.
- A launch link that opens CloudFormation with your code, name and support contact already filled in.
- A fleet page at arenaforconnect.com/fleet.html. There is a sample fleet you can look at now.
To get a code and key, email [email protected] with your company name, the code you would like, and the help page or support address your clients should be sent to. We reply within one business day.
Your name in the client's console
When a client stack has PartnerName set, the supervisor console shows Supported by and your name in its header, next to Help. With PartnerSupport set, the name is a link to your help page or opens an email to your support address. Supervisors then reach you first, in the place they already work.
The client's own brand is separate and unchanged: company name, colours and logo are set under Brand in the console. See look and feel.
The fleet page
Open fleet.html, enter your code and key, and you see one row per client install:
| Column |
What it tells you |
| Client |
The label set in the client's PartnerClientLabel, or "Unnamed install" with the anonymous install id when there is none. |
| Version |
The Arena version the stack runs, flagged when a newer one exists. |
| Region |
The AWS region of the stack. |
| First and last check-in |
When the install was first and most recently seen. Flagged quiet after 7 days without one. |
| Health |
The most recent alarm the stack shared: in alarm, recovered, or none shared. |
Four counters at the top total the installs, those behind the latest version, those gone quiet and those in alarm now.
The key travels in a request header, never in the address bar, and stays in that browser tab until you close it or choose Sign out.
Joining a client to your fleet
A client joins when four stack settings are filled in. Your launch link fills in the first three; for a client already running Arena, update the stack and set them by hand.
| Setting |
Value |
| PartnerCode |
Your code. This is what puts the install on your fleet page. |
| PartnerName |
Your name as the console should show it. |
| PartnerSupport |
Your help page (an https address) or your support email. |
| PartnerClientLabel |
How you want this client named on your fleet page. Optional. |
A client who subscribes through AWS Marketplace can also type your code on the registration page, which adds your code, name and support contact to their launch link.
The install appears on your fleet page after the next time a supervisor opens the console. Allow up to a day.
What the client shares, and how they stop
Partner mode rides on the daily version check Arena already makes. Nothing new is collected from inside the stack.
| Shared with the partner |
Only if |
| Anonymous install id, Arena version, AWS region, first and last check-in |
The client set PartnerCode and kept Telemetry enabled |
| The client label |
The client also set PartnerClientLabel |
| Alarm name, state, reason and time of the latest alarm |
The client also set Diagnostics to enabled |
Never shared: agent names or ids, contacts, teams, scores, rewards, the AWS account id, or anything typed into Arena.
A client leaves your fleet by clearing PartnerCode on the stack, or by setting Telemetry to disabled. The row drops off your fleet page at the next check-in, or goes quiet if the check-in itself was turned off. The full list of what leaves a client's account is in security and your data.
Things to know
- A check-in is not a heartbeat. It happens when a supervisor opens the console, at most once a day. A quiet install can be a healthy stack that nobody opened over a holiday week. Treat quiet as a reason to ask, not as an outage.
- Alarms need the client's opt-in. Without
Diagnostics=enabled the Health column says none shared, whatever the stack's real state. Agree this setting with the client at handover.
- The code is not a secret. Anyone who knows it can set it on a stack of their own, and that stack would then appear on your fleet page. It gains them nothing and shows them nothing. If an install appears that you do not recognise, tell us.
- Lost or exposed key. Email support and we issue a new one; the old key stops working at once.
- Billing is unchanged. Partner mode has no charge and no effect on the client's AWS Marketplace subscription. Resale margins and referral fees are described on the partners page.
Current as of version 0.29.0. See the release notes for what changed since.