Content
Consistency across products plays a big role in the user experience. This glossary provides a lightweight reference for common UI terms and action labels. See also the capitalization guidance.
AA
add
Takes an existing object and uses it in a new context (for example, adds an item to the cart, adds a user to a group, or adds a document to a folder).
Where appropriate, combine add with the object (for example, Add user or Add role). Compare create, insert, new, and upload. See also the Add pattern.
apply
Saves changes without closing the dialog. These properties often affect subsequent system behavior.
Use instead of Save Changes. Compare save.
approve
Indicates the user agrees. In a business process, typically initiates the next step.
Compare reject.
artificial intelligence (AI)
A system capable of simulating human intelligence and thought processes. Note that AI is a broad field of science that covers many sub-disciplines, including machine learning, visual recognition, and natural language processing.
The acronym AI is widely understood to refer to artificial intelligence, so do not use this same acronym to refer to augmented intelligence.
assistant
An AI-driven agent with domain knowledge that assists a human user with a task. Assistants may take the form of a chatbot or some other interface.
augmented intelligence
A similar term to artificial intelligence but with more of a focus on AI's assistive role, emphasizing the fact that cognitive technology is designed to enhance human intelligence rather than replace it.
Compare artificial intelligence.
BB
back
Returns the user to the previous step in a sequence of steps, such as in a wizard.
browse
Assists the user in selecting a file (for example, on a button or link next to an entry field). Typically opens a secondary window where the user can locate and select the desired directory and file.
CC
cancel
Stops the current action and closes the dialog.
Warn the user of any possible negative consequences of stopping an action from progressing, such as data corruption. Compare reset. See also the Cancel pattern.
clear
This action clears all the fields or selections. Also deletes the contents of a document, such as a log. Typically the default selection or value is re-established for controls that always have a selection or value, such as radio buttons.
Where appropriate, combine clear with the object (for example, Clear fields or Clear all). Compare delete and remove. See also the Clear pattern.
close
Closes the current page or window (for example, closing a secondary window containing online help).
Do not use close alongside OK or cancel actions. Compare Cancel and done. See also the Close pattern.
confidence score
In AI contexts, the predicted probability of an answer being correct. This is often a numerical expression of certainty shown as a percentage.
copy
Creates new instances of the selected objects in a specific destination.
Combine copy with the object being copied (for example, Copy folder) or the destination (for example, Copy to clipboard) if there are multiple possibilities. Compare new. See also the Copy pattern.
create
Makes a new object from scratch (for example, creates a calendar event or creates a new document).
In scenarios where the user needs to supply some details or settings as part of the create process, use new to initiate the action and create to apply the user-supplied details or settings to the new object. Compare add, copy, insert, and new.
customize
Allow a user to make desired changes.
DD
delete
Destroys an existing object so that it no longer exists (for example, deletes a file from a directory or deletes a value from a table cell).
Where appropriate, combine delete with the object (for example, Delete column or Delete row). Compare clear and remove. See also the Delete pattern
docs
Opens a separate window containing the landing page for the IBM Cloud product documentation.
Use as link text only for the specific link that points to the IBM Cloud product documentation from the console menu bar. Compare learn more.
done
Indicates that the user has finished working in an environment (for example, editing templates) and wants to return to where he or she came from.
EE
empty trash
Permanently deletes all files or objects that have been placed into a trash container.
Compare move to trash.
entity
In AI contexts, a representation of a real-world object (such as a person, location, or bank account), used by a machine learning model. For example, in the chatbot utterance: "I’d like to order some tacos and beer", the entities would be tacos (food) and beer (drink). Typically, entities are nouns.
Compare intent.
export
Saves data in a different format external to the system. Typically opens a secondary window for the user to specify the file type and destination (for example, storing table data as a set of comma-separated values).
Compare import.
FF
find
Moves the cursor to the next element matching the specified criteria (for example, view the next occurrence of a specific word within an email message).
GG
get help
Opens a search field from which the user can search for help information.
Use only as link text on the Support widget from the IBM Cloud console menu bar. Compare docs and learn more.
HH
hide
Removes an element that was previously shown (for example, enables the user to hide details or descriptions).
Compare show.
II
import
Transforms data or objects from an external source. Typically opens a secondary window for the user to locate the external source.
Context: Creating a new table based on comma-separated values contained in a separate file. Compare export.
insert
Adds an element at a particular position in an ordered view.
Context: Adding a picture to the body of a document or inserting a record into a table. Compare add and new.
insight
In AI contexts, an observation that a machine learning model makes about patterns or unique outliers in a set of data. This can be used, for example, to provide current snapshots and predictions of customer behaviors and attitudes.
intent
1) Broadly, the goals, wants, needs, and values of users and businesses. Intent provides your solution’s purpose.
2) In AI contexts, when a chatbot interprets a conversation, it identifies the action or purpose behind a user's utterance (usually expressed by the verbs). These are identified as the intents. For example, in the utterance: "Where is the bathroom", the intent is to find a location.
Compare entity.
LL
launch
Do not use launch; use start.
learn more
Opens additional, highly contextual information. Insert at the end of inline text or hover text where more information follows but does not fit in the current context.
If space permits, combine learn more with meaningful text that describes the content you're pointing to. For example, if your user needs some best practices to manage apps in multiple regions, you could use Learn more about regions.
log in
Enters a site or application. This choice typically opens a form for entry of credentials. Also used on the submission button after users enter their credentials.
Use instead of sign in. Compare log out.
MM
machine learning (ML)
A subset of artificial intelligence in the field of computer science that often uses statistical techniques to give computers the ability to "learn" (that is, to progressively improve performance on a specific task) with data, without being explicitly programmed.
model / ML model
In machine learning contexts, a method for performing a function or making a decision by running data through a series of mathematical steps, i.e. algorithms. The model represents the steps an intelligent machine will take to arrive at a decision.
move
Transfers an object from one container (for example, folder, activity, or page) to another.
move to trash
A soft delete. Moves a file or object to an area from where it can later be permanently deleted or recovered.
Use instead of delete if it is possible for the user to recover the objects. Compare empty trash.
NN
new
Starts the creation of a new object. New either creates the object immediately or opens a dialog or set of fields where the user can enter properties.
Combine new with the object to create (for example, New user or New column). Compare add, copy, create, and insert.
next
Advances the user to the next step in a sequence of steps, such as in a wizard.
Compare back and finish. See also the Next pattern.
OO
OK
Confirms an action or completes the current task.
Best practice is to use a label corresponding to the specific action (for example, Save or Close or Delete). Use OK only when such a label is not available. Write as shown: two letters, both uppercase.
PP
play
Starts audio, video, or an animation.
post
Adds a new comment to an online community or adds status to a log or record.
If you are editing an existing comment, use save instead.
preview
Shows how an object or content will appear with formatting applied before the content is published or distributed. Alternatively, provides an incomplete display of an existing object without leaving the current context.
Sends a copy of the currently selected object or the object in view to the printer.
RR
refresh
Reloads the view of an object when the displayed view has become unsynchronized with the source.
Likely used only as a tooltip on an icon button. See also the Refresh pattern.
reject
Indicates the user does not approve. In a business process, typically blocks the process from proceeding to the next step.
Compare approve.
remove
Removes an object from the current context – but note that the object still exists (for example, removes a user from a group or removes an item from the cart).
Where appropriate, combine remove with the object that will be removed (for example, Remove user or Remove role). Compare clear and delete. See also the Remove pattern.
reply
Indicates or completes a response to an email or a comment.
reset
Reverts values back to their last saved state. The last saved state includes the values stored the last time the user clicked Apply. Does not close the dialog or window.
Compare cancel, restore, restore defaults, and undo. See also the Reset pattern.
restore all
Completes a restore operation on all files or objects in a given system or container.
Compare restore.
run
Initiates a procedure.
Use run instead of execute.
SS
save
Saves pending modifications made to a file or document. Does not close the window or panel.
Compare apply.
save as
Creates a new object based on the state of the object currently being viewed. The user names the new object and typically identifies its location.
search
Returns all objects (for example, files, names, or documents) within a defined set (for example, in a folder, directory, database, or the internet) that match some specified criteria.
select
Selects data from a table.
send
Transfers an email or other information to the recipient or destination.
show
Reveals an object that was previously hidden (for example, shows descriptions or shows further details).
Compare hide.
sign up
Creates a user account or registers a user in a system.
Use instead of register.
sort
Sorts a list or table column.
Likely used only as a tooltip on an icon button. Can be used without 'ascending' or 'descending' only if the order can be provided to a screen reader in the code for accessibility.
start
Deploy an app or service to its development or production environment so that it can be used.
Use instead of launch.
submit an idea
Opens a separate window containing the IBM Cloud Ideas portal.
Use only as link text on the Support widget from the console menu bar.
TT
top
Returns to the top of the page.
Use instead of back to top.
training
In AI contexts, the process of building a model through learning from a data set. Humans teach machine learning models to identify entities and intents in data by showing them examples and correcting the computer's responses until they identify things with an acceptable degree of accuracy.
UU
undo
Reverts to the state before the most recent changes made by the user. Repeated use successively reverts to prior states in reverse chronological order. Applies to changes in data and not to changes made to the view.
Not all actions, such as save, can be undone. Compare redo, reset, and restore.
update
Label for a button in a dialog or form for editing an object. The settings in the dialog are applied to the object when it is updated.
Compare edit.
VV
view details
Presents additional information or properties for the object.
WW
Watson Machine Learning
An IBM Cloud service that is available through IBM Watson Studio, which uses trusted data to put machine learning and deep learning models into production. It leverages an automated, collaborative workflow to grow intelligent business applications easily and with more confidence.