Attio for Jira settings and defaults
Most questions about a project's Attio setup are really one question: what is this project configured to do, and what will I break if I touch it. This page is the flat answer. Every setting, its default, where it lives, and what changing it throws away.
All of it lives in one place: the Jira project, then Project settings, Apps, Attio. There is no site-wide configuration and no site-wide key. Each project connects its own Attio workspace and answers these questions for itself.
#Where the settings live, and who sees them
The Attio entry appears in a project's own settings, listed as "Attio" with the line "Connect this project to an Attio workspace". It is offered only on Jira Service Management projects and only to administrators of that project. The app checks that again on every single action, so reaching the address another way gets you the message "Attio settings for this project are available to project administrators only." rather than the settings.
A project that has not finished setup opens a six-step wizard. A project that has finished opens the same six sections as a tab strip. Finished means all five of these are true: an API key is stored, an Attio object is chosen, an attribute to match on is chosen, at least one attribute is on the card, and at least one placement is on.
Nothing at all on other project types. On a business or software project the app adds nothing, including no settings entry. Jira does not list it, for anybody, so there is nothing to set up and nothing to switch off there.
#The six sections
Step | The wizard asks | The tab says |
|---|---|---|
Connection | Connect your Attio workspace | The Attio API key this project uses, and the workspace it reaches. |
Record type | Choose the object your customers live in | Which Attio object your customers live in. |
Matching | Match the reporter to a record | How a reporter is found in Attio, and how linked records are titled. |
Fields | Choose what the card shows | What the card shows, in the order it shows it. |
Permissions | Choose who can see the card | Who sees the card, on top of being able to see the issue. |
Placement | Choose where the card appears | Where on the issue the card appears. Changes here take effect immediately. |
In the wizard there is no Save button: pressing Next stores that step's answer, and "Finish setup" on the last step is what switches the card on. Steps stay locked until the step before them is answered, and hovering a locked step says what to do first, for example "Connect an Attio API key first." The footer counts "Step 1 of 6" through "Step 6 of 6", and carries Back and Next, with no Cancel.
#Every setting and its default
Setting | Section | Default |
|---|---|---|
Attio API key | Connection | None. The project is not connected until a key is stored, and the field always opens empty. |
Attio object | Record type | None. Nothing downstream can be chosen until it is set. |
What the reporter is matched on | Matching | "Match the person", which looks the reporter's own address up. |
Attribute matched on | Matching | None stored. The first time the list loads the app picks the likeliest candidate for you, and never overwrites a choice you made by hand. |
Domains this project ignores | Matching, company matching only | The shipped list of 165 free-mail and consumer domains. An empty list means "use the shipped list". |
Domains to match anyway | Matching, company matching only | Empty. Nothing is forced past the rules. |
Titles for linked records | Matching | "Use the default title", per linked object. |
Attributes on the card | Fields | None. At least one is needed before the card can be switched on. |
Attributes under a linked record | Fields | None. A linked record with none stays an ordinary link. |
How a linked record is shown | Fields | "Show inline". The alternative is "Show on hover". |
Attribute holding the picture | Fields, Image column | None: "Nothing holds the picture." |
Show it beside | Fields, Picture panel | None. Unavailable until an attribute has been nominated in the Image column and at least one attribute is on the card, and it says which of the two is missing. |
Required project permission | Permissions | "Agents in this project". |
Restrict to groups (optional) | Permissions | Empty, which means no group restriction. |
Placement | Placement | None. A project with no placement shows the card nowhere. |
#When a change takes effect
What you changed | How it is saved | When the card changes |
|---|---|---|
The API key | Its own "Test and save this key" button. It is tested against Attio first and stored only if Attio accepts it, so a bad paste cannot replace a working connection. | The next lookup uses the new key. |
A placement | Immediately, the moment it is toggled. The tab says so. | Immediately. |
Anything else | Held until "Save changes" is pressed. Only the settings that actually changed are sent. | Next view of a request. |
No settings change waits out the fifteen minutes an answer is otherwise kept for. Changing the object, the matching attribute, what is matched, either domain list, the attributes on the card, a linked-record title, the attributes nested under a link, inline against hover, the picture attribute or the row it sits beside all take effect on the next view.
A placement toggle discards unsaved work elsewhere. Toggling a placement writes at once and then re-reads the whole configuration, which replaces anything still sitting unsaved on the other tabs. Press Save changes before you touch Placement.
#What a change clears
Change | What goes with it |
|---|---|
A different Attio object | The attribute matched on, every attribute on the card, the attributes nested under linked records, the linked-record titles, the picture nomination and the row it sat beside. All of them belonged to the old object. |
Person matching to company matching, or back | The Attio object as well, plus everything in the row above. The two domain lists survive, so a project that switches away and back still has them. |
Reset to defaults | All of the above, plus the API key, the audience and the placements, and everything the app had kept about that project's Attio records. |
The settings page warns first, naming the object and the number of attributes that will be lost, and offers "Change to {object}" against "Keep {current object}". It skips the warning when there is nothing to lose. The wizard clears without asking, because at that point there is rarely anything worth keeping.
#Who can see the card
The audience is one required Jira project permission, optionally narrowed further by group. It sits on top of being able to open the request, which is the floor and cannot be configured away.
Option | The screen says | Default |
|---|---|---|
Agents in this project | "Anyone with agent access. This is the audience the customer card is for." | Yes |
Anyone who can see the issue | "The widest option. Every licensed user who can browse this project sees the card." | No |
Project administrators only | Only people who administer this project. | No |
Users who can manage sprints | "A team-lead shaped audience on projects that use it as one." | No |
Restrict to groups (optional) | "Jira group names, separated by commas. Leave this empty for no group restriction, which is the default: a group check costs a Jira call on the first render for each viewer." | Empty |
When groups are named the rule is AND, not OR, and the screen says so: "A viewer now needs the permission above AND membership of one of these groups. Both, not either." Group names are compared without regard to capitalisation, and the box accepts commas or new lines.
The audience can be narrowed, never widened. All three card placements are offered only to signed-in viewers with Jira Service Management agent features on a service desk project. "Anyone who can see the issue" narrows from there like the rest, so it does not reach a licensed user without agent access, and it never reaches a portal customer.
There is no per-person hiding of individual attributes. Everyone who passes the gate sees every attribute chosen, and the step counts them out: "The {n} attributes you chose are visible to everyone who passes this gate".
#Where the card appears
Placement | The screen says | Shape |
|---|---|---|
Issue panel | "A panel on the issue itself, above the activity area." | "Full width of the issue, variable height." |
Activity tab | "A tab at the bottom of the issue, beside Comments and History." | Full width. The tab is plain text, with no app icon. |
Issue sidebar | "A collapsible panel in the right-hand column, under the issue details." | "Narrow, and the reader can resize it." Collapsed, it is a button reading Attio. |
The three are independent switches rather than a choice of one, and all three draw the same card. There is no separate on and off control: choosing at least one placement is what switches the card on, and removing every placement is what takes it away. With none chosen the step warns "Until one of these is on, the card renders nowhere, including for you."
Placements only take effect on a project that can resolve a record. Ticking placements on a half-finished project shows the card nowhere. The app publishes the surfaces only once there is a key, an object, a matching attribute and at least one attribute on the card. That is why setup finishes with placement rather than starting with it.
#Reset to defaults
There is no key-only disconnect. The action at the bottom of the Connection tab is the disconnect, and it describes itself: "Removes the API key, the record type, the matching attribute, every field on the card, the linked record settings, the audience and the placements, and clears everything this app has cached about your Attio records. The card comes off every issue in this project and setup starts again from the beginning. Nothing in Attio itself is changed or deleted."
It takes two presses: "Reset to defaults", then "Yes, erase this project's Attio setup", with "Keep my settings" to back out. Because the key is gone afterwards, the page returns to the six-step wizard. Connecting again does not switch the card back on by itself: the placements went with everything else, so somebody has to choose one again.
Saved, but the card is not switched on yet. If Jira refuses the small project update that makes the card visible, the settings are still stored and the page says: "Your settings are stored. Jira would not let this app update the project, which is what makes the card appear on issues. A Jira site administrator may need to approve this app's new permissions in Admin Hub. Choose a placement again once they have."
#A few things worth knowing
Typing a test address on the Fields tab stores your pending changes before it looks anything up, so edits you were still thinking about get committed while the Save changes bar is still on screen.
While there is any text in the API key box the Save changes bar disappears and the other tabs' edits are held: "Changes on the other tabs are held until this key is tested and saved, or until you clear the field." An empty box is not a problem, a half-typed one is.
A group name that does not exist in Jira matches nobody and nothing warns you, so a typo in "Restrict to groups" quietly hides the card from everyone in the project.
#Related
Every default above is what a project has before anybody touches it.
