Client profiles
Lesson 7 of 25 7 min read
The order of type-wide setup, and how to add the named connection that send, receive and connect profiles use.
Before any organisation can use a config-driven integration type, the type needs some setup that every organisation shares. You do it once per type. This lesson gives you the order of that setup, then walks through the first piece: the client profile.
The setup, in order
Step 1 happens on the Integration Types screens and is covered in the course Message routing and modules in Prism. Do it first: adding the type with its routing in one go means there is never a moment when the type supports a message type but has no service.
What a client profile is
A client profile is a named connection to another platform. It holds:
- the base address the calls go to;
- the rate limit, so Supply Lens does not call the partner too often;
- the retry rules, for when a call fails;
- the type of sign-in the platform uses.
Send, receive and connect profiles refer to a client profile by its key. A send or receive profile cannot run without one.
Add a client profile
Open Administration → Maps & Profiles → Client Profiles.
- Select Add. The New client profile page opens.
- In Key, type the key that profiles will use, for example
acme-api. - Optional: type a Description.
- In Body, type the configuration.
- Select Validate. Correct the errors, if there are any.
- Select Save.
Choosing the key
- The key cannot be the name of an HTTP client that a coded integration uses. Coded integrations usually name their client after themselves, so do not use the name of a coded integration (for example, do not call a new client
shopify). - The key can be the same as the id of a config-driven integration type. Using the type id, such as
acme-api, keeps things easy to follow.
No versions, no undo
A client profile has no versions. When you save a change, every profile that uses its key changes immediately, in every organisation. You cannot go back to the previous body, and you cannot change a key once a profile uses it. Copy the current body somewhere safe before you change it.
This is very different from maps and profiles, which have drafts and versions. Treat a client profile change like a production change.
Raising Acme's rate limit
Acme tells you their API now allows twice as many calls a minute. The rate limit is in the acme-api client profile. Before you save, you copy the current body into your ticket. You change the limit, select Validate, then Save. Every organisation's Acme send and receive profiles now use the new limit straight away. If Acme starts returning errors, you paste the old body back, because there is no version to roll back to.
Recap
- Type-wide setup order: type and routing, client profile, connect profile, settings shape if needed, then maps and profiles per organisation.
- A client profile holds the base address, rate limit, retry rules and sign-in type.
- Send, receive and connect profiles use it by key; send and receive profiles cannot run without one.
- Do not use a coded integration's client name as the key; the config-driven type id is fine.
- Client profiles have no versions: a save changes everything that uses the key immediately.
Your progress is saved in this browser. Create a free account to keep it everywhere, take quizzes and earn certificates.