Concepts
This page explains the words you see on screen, and names the word the API reference uses where it differs.
Resource
A resource is anything ReSync tracks: a job, a machine, a material, a person, your organization itself. Every resource has a name, a type and a wall. The Resources list holds them all.
Resource type
A resource type is the kind of thing a resource is, such as Person or Organization. The type decides which
properties, ports and lifecycles its resources share. In the API a type is named by a short code (for example
person) as well as its name.
Organization
An organization is a company or group that owns resources and has members. On screen it is called "Organization" on its wall and "Org" in Switch workspace. In the API this is always written out as "organization".
Workspace
Your workspace is the place you are working in: Personal, or one of your organizations. It decides which resources and types the lists show. In the API there is no workspace as such — the same narrowing is a filter on the owner of each resource.
Wall
A wall is a resource's own page: its header, its Operate and Model tabs, and everything that has happened to it. In the API this is the resource and its history, read through several requests.
Operate and Model
Operate and Model are the two modes of a wall. Operate is for following and working on a resource; Model is for how it is set up. In the API "operate" means something else: it is the name of the set of types a key may change.
Feed
The Feed tab shows a wall's Activity: messages, and every change to the resource, each line led by who acted. All, Messages and Changes narrow it. In the API this is called the resource's history, or its events.
Inbox
Inbox gathers threads and activity that need your attention, across every resource you can reach. It is your first screen after signing in. The API has no inbox page; a live connection can watch it.
Member
On screen, a member is a person who belongs to an organization, listed under Members on its Access tab. In the API "members" means something different: the resources contained inside another resource — on screen those are Contents and Components. One exception on screen: the Components tab has its own Members section, and there it means the resources placed inside, not people.
Grant
A grant is access given to someone: which actions (such as read, attest, write) on which resources. Admins see grants under Issued, and feed lines such as "🔑 granted read, attest, write on all to {person}" record them. In the API this is described as access; the word "grant" appears only in error codes.
Grant set
A grant set is a named bundle of grants, such as member. Picking one when adding a member gives them everything in it at once. Platform sets are shared and read-only; Copy makes one you can edit. The API does not name grant sets.
Admin
An admin is a member whose grant set lets them administer the organization: add and remove members, issue grants, register apps and add credentials. Admins carry an "Admin" chip under Members. In the API this is called an administrator.
Credential
A credential is a key that lets a device or an app act for your organization without a person signing in. Admins add them under Credentials; a device credential names the resource it acts at, and its Connection key is shown once. In the API this is called a key or API key; a device credential keeps its name.
Connected app
A connected app is software registered to act for your organization and to let people sign in to it with ReSync. Admins register one under Connected apps and manage its keys on the app's own wall. The API uses the same name; its client id is the app's Client ID.
Lifecycle
A lifecycle is the set of statuses a type of resource moves through, and the moves allowed between them. The Map tab shows where a resource has been in its lifecycle.
Status
A status is where a resource is in its lifecycle right now, such as a stage of a job. Rows on Advance name the status a move leads to: "→ {status}".
Transition
A transition is a move from one status to another. On Advance each row is one transition, moved with Advance or Submit — {status}. In the API a transition is also called a move or a status move.
Requirement
A requirement is something that must be true before a transition can happen — for example that a check has been recorded. Requirements lists them per move, and Advance shows them as a checklist.
Attestation
An attestation records that something happened, without changing the resource's own fields. You make one with Attest (or the action's own name) on Advance; it shows as a line in Feed. The API uses the same word.
Connection, port and field
A connection links two resources. A port is the place on a resource where a connection attaches; a field is a port that holds one choice. They appear under Connections on Details. In the API connections are called interactions, and the connection made through a field is called an attachment.
Contents and components
Contents (on Operate) lists what sits inside a resource; Components (on Model) shows how it gets there — its Members, Enrollment rules, and what is Inherited from type. In the API these contained resources are called members, and each placement a membership.
Edge
On screen, an edge is a trust crossing between organizations, listed under Edges ("Federation edges"). In the API an edge is something else: a connection between two ports.