Terminology in im-web

What the real Image Portal calls each concept today: in the API, the admin and the public site. Inconsistencies are listed as they are, not fixed.
Term as written in im-webwho sees it
ConceptAPIAdminPublicSeen byWorth knowing
Library

Every image a tenant offers, sellable or not.

archive (a source: sdl, shutterStock)
LIP-1338
Image librarycatalog
SDLShutterstock
  • Customers (some)
  • Tenant admins
  • System admins
  • No single word. "archive" means a source in the API, but the whole collection in docs.
  • Images in no main group show as "Not in a main group" (LIP-1338).
Scope

A saved filter over the library: the images a product can sell.

scope, type "primary"
main
ScopesPrimary scope
LIP-1338
Content (menu)Main group
–
  • Customers
  • Tenant admins
  • System admins
  • im-web glossary: "Main group", status under test.
  • "Content" is also the front page editor on main.
Secondary scope

A narrower filter inside one scope, e.g. Magnum within editorial. Has a priority when groups overlap.

scope, type "secondary"
main
Secondary Scopes
LIP-1338
Content group
–
  • Customers
  • Tenant admins
  • System admins
  • The LIP-1338 product sheet still says "Primary Scope" / "Secondary Scope".
Metadata field

An asset property and its possible values, e.g. distributor: NTB, AP, AFP. Scope parameters are built on these.

metadata fieldkeylabeldataType
LIP-1338
Advanced settings › Metadata fieldsUsed by
–
  • Customers
  • Tenant admins
  • System admins
  • For developers. Admin: "Asset properties and their possible values. Scope parameters are built on these, and scopes select from their values."
  • One field can serve several parameters: owner is used by Credit and Owner.
Scope parameter

A filter scopes can use, built on one or more metadata fields: Credit uses credit and owner. Required ones must be set on every main group. AND across parameters, OR within one.

scope parameter
main
Scope parameters
LIP-1338
Advanced settings › Scope parametersRequired parameters
–
  • Customers
  • Tenant admins (some)
  • System admins
  • LIP-1338: only system admins edit them. Admins set their values when they define a main group.
  • Admin: "Control which scope parameters are shown during product creation." Each is In use or Unused.
  • im-web describes a main group as "a saved filter".
Product

One scope + one license group + a base price per license. What gets priced. Draft or published.

product, type "main"
main
Productsprimary product
LIP-1338
Products & variants
–
  • Customers
  • Tenant admins
  • System admins
  • Not shown to customers in im-public.
  • No screen sets draft or published.
Variant

A product inside a product, priced differently, e.g. Magnum images cost more.

product, type "variant"
main
Product variants
LIP-1338
Variants
–
  • Customers
  • Tenant admins
  • System admins
  • Not shown to customers in im-public.
License group

A set of licenses. Every license belongs to one. Half of a product.

license grouplicense type (summaries)
LicensesLicense group
Purchase a license
  • Customers (some)
  • Tenant admins
  • System admins
  • Spelled "License Group" in one admin form.
Pack

Prepaid downloads. In the API a subscription of type "quota" with a download limit.

subscription type "quota"PACKED
Per quotaPack (sales)Subscriptions and credits
LIP-1338
Download quota
Customer centre
klippekort
  • Customers (a lot)
  • Tenant admins
  • System admins
  • Five names in im-web: Per quota, Download quota, Pack, punch card (README) and credits.
Pack unit

What a pack holds and a download uses up.

downloadLimitquantityLimit
Quotadownloads
–
  • Customers (a lot)
  • Tenant admins
  • System admins
  • im-web counts downloads everywhere.
Credit line

Who to credit when publishing an image (IPTC Credit Line).

credit
LIP-1486
credit mappings
CreditKredittKredit (sv)Foto:
  • Customers
  • Tenant admins
  • System admins
  • "Credit" also appears in the workspace tab "Subscriptions and credits", meaning packs.
  • Suppliers are matched on the credit field.
Subscription

Unlimited downloads within a date range, for a fixed price.

subscription type "time"
SubscriptionsTime-limitedSubscription plan
Included in your subscription
  • Customers (a lot)
  • Tenant admins
  • System admins
  • No umbrella word for subscription and pack.
Customer group

Who prices, discounts and subscriptions apply to. In im-web, a workspace.

customerGroupId (= workspace id)
WorkspaceCustomer group (errors)
Workspacearbeidsområde
  • Customers
  • Tenant admins
  • System admins
  • The UI says Workspace, except in validation errors.
  • Enterprise organization has four Norwegian translations in im-public.
Price list

A discount or premium on a product for one workspace, as a percentage or fixed price.

price listbase price
Discounts & premiumsBase price
% Discount
  • Customers (some)
  • Tenant admins
  • System admins
  • The "Global" price mentioned in user tests appears nowhere in im-web.
Supplier

Someone who delivers images to the service, e.g. Magnum.

supplierdistributorName
SuppliersSupplier
DistributorsDistributørerDistributörer
  • Customers
  • Tenant admins
  • System admins
  • Media records have both supplier and distributor fields. No documented mapping between them.
Supplier settings

Who a supplier is (Visma ID, org number, contact) and which incoming credits map to them.

supplierssupplier-mappingsdistributor-config
LIP-1486
System › Suppliersmappings
–
  • Customers
  • Tenant admins (some)
  • System admins
  • API: "companies whose content we credit and invoice".
Tenant

The organisation selling images in the portal: NTB, TT.

tenant
System › TenantsTenant role
im-web docs
"a customer with its own branding"
  • Customers
  • Tenant admins
  • System admins
  • im-web docs call a tenant "a customer"; in admin "Customers" means users and workspaces.
Tenant admin

Runs one tenant’s portal: content, licenses, products, subscriptions, discounts, customers.

tenant permission "admin"
AdminTenant role
Admin (menu link)
  • Customers
  • Tenant admins
  • System admins
  • im-web’s product config guide calls this role "Admin".
System admin

Above the tenant admin, within one tenant: sets up the scope parameters main groups can use.

tenant permission "systemAdmin" (not created yet)
LIP-1338
Advanced settingsSystem adminsystemAdmin
–
  • Customers
  • Tenant admins (some)
  • System admins
  • No tenant has the permission yet, so every admin gets the role for now.
  • Admin copy says parameters are "configured by your administrator".
  • Shares Advanced settings with the Developer role until Developer exists in Auth0.
Developer

Sets up metadata fields: the asset properties scope parameters are built on.

–
LIP-1338
Advanced settings › Metadata fields
Prototypes
Developer
  • Customers
  • Tenant admins
  • System admins
  • A separate role, planned but not in Auth0 yet. Until then it is grouped with System admin under Advanced settings.
Platform admin

Runs the platform for all tenants: tenants, indexing, suppliers. The Loki team.

superadmin
System › TenantsMetadata Indexer
–
  • Customers
  • Tenant admins
  • System admins
  • API: "Whether the user is a super admin". Not the same as systemAdmin, which is per tenant.
  • Which role sees the System menu (Tenants, Suppliers, Metadata Indexer) is not documented.
Asset

One image, video or (later) audio file with its metadata.

MediaObjectAsset (a rendition)
AssetsAsset ActivityImage ID
Asset IDFil-IDmediafiler
  • Customers
  • Tenant admins
  • System admins
  • In the API, "Asset" is a file rendition, not the media item.

im-web usage taken from: main 868163e (admin and public as deployed); LIP-1338 e021d1f (new product config UI, docs/glossary.md); LIP-1486 8210d7c (Suppliers page). No branch means main and LIP-1338 agree. im-admin is English only; Norwegian and Swedish exist only in im-public. Live API docs, which follow the team's current work: products, sales, user, search, indexer.