Ticker aliases¶
A research archive names a company in two ways: by name in the text
("Cordwell Digital Infrastructure") and by ticker in the file name
(260115_Broker_CORD_MH_v2.pdf). Nothing in a ticker-only note says the two
are the same company, so a search for the name misses it.
A ticker alias links them: ticker → company name, with an optional exchange. Aliases are a tenant's own vocabulary. An administrator types or imports them; they are not read from documents. Every user in the tenant can read them, and only tenant administrators can change them.
They work with the ticker field that a source's
metadata rules read from each file:
- A search by name finds ticker-only files. A
search_contentquery that contains an aliased company name, or an aliased ticker typed in capitals, also returns the files filed under that ticker. A ticker-only file, one whose text never names the company, is ranked among the company's other notes rather than after every result, so "all notes on Cordwell Digital Infrastructure" reaches it well within the paging limit. A file that names the company keeps its own place. These hits carryalias_ticker. The search's filters and access rights apply to them. - A company name in a ticker filter.
fields: {"ticker": "Cordwell Digital Infrastructure"}matches the alias's ticker. - Plain-English requests. With plain-English reading
on, "every Cordwell Digital Infrastructure note" or "all CORD notes" becomes
a
tickerfilter. - Entities.
search_entitiesresolves a ticker to its company, andentity_documentsincludes the files filed under the company's tickers.
Use the full company name. A request is matched against the whole alias
name, so an alias named with a single common word (NEXT → Next) would
match "next quarter's guidance". Such a one-word name therefore only adds its
files behind every other result. Name it Next plc instead, and it ranks with
the name. To ask for a company by symbol, type the ticker in capitals: a
lower-case word is never read as a ticker.
Only active aliases take effect. Every alias records where it came from
(typed or imported) and a status. Aliases you type or import are active.
An alias saved as rejected is kept but never used, and aliases list shows
the active ones unless asked for another status.
Managing aliases¶
In the console: Find › Entities, Ticker aliases card (or press ⌘K / Ctrl+K and type entities).
From the CLI:
# One at a time (tenant administrator).
kdbl-control entities aliases set CORD --name "Cordwell Digital Infrastructure" --exchange XLON
kdbl-control entities aliases rm CORD --exchange XLON
# From a CSV: ticker,name[,exchange]. --replace makes the file the whole set.
kdbl-control entities aliases import universe.csv
# Anyone in the tenant.
kdbl-control entities aliases list -q cordwell
Tickers are stored in upper case. The ticker and exchange together identify an alias, so one symbol can name different companies on different exchanges. An import reports each line it skipped and why, and never fails as a whole because of one bad line. It takes at most 20,000 rows.