ℹ️Definition MetaData and Documentation

One of Orkestra Online's most powerful features is its convenience for documenting and referencing a definition. You can associate Metadata with definitions and various documentation files and centralize that information on the platform.

Definitions Metadata

When a definition is on the Orkestra Online platform, it is associated with a lot of information. Some metadata is generated and updated automatically, making it fully reliable. However, the definition creator or any workspace admin can enter additional information to better communicate and inform users.

Version

The Orkestra Online platform automatically tracks file versions. The current version of a file is shown in the Properties Panel. Learn more about versioning definitions here!

Last update

The date and time of each definition update are automatically saved. This information lets you and your users know exactly when the last modification occurred. It is also displayed in the Properties Panel.

Last updated by

Knowing who last updated a definition is crucial, as it helps improve reliability and accountability. Knowing who last updated a definition decreases the time spent looking for information about that update, as it points you to the most appropriate person to refer to. This information is automatically associated with the definitions at each update and displayed on the Properties Panel.

Key Words

Key Words can be associated with a definition by their creator/ administrator to allow definition sorting and searching. To edit the Key Words, you must be an administrator of the Workspace that contains the definition. Click here to see how to add keywords.

Description

A definition name is not always enough to understand exactly what a definition does. That is why Orkestra Online lets you also associate a description with a definition. That description will appear on the Properties Panel to help users understand the definition's effect/ requirements. The description also appears on the tooltip of Online QuickAccesses. To see how to modify descriptions, click here.

Associated Documentation of a Definitions

Key Words and Descriptions are valuable. However, as the saying goes, a picture (or video) is worth a thousand words. That’s why you can associate documentation files of various formats with the definitions. They are stored as clickable hyperlinks in the Properties Panel. Clicking on a file in the list will download and open it:

Automated Graph and Background SnapShots

When uploaded through the Orkestra Online Dynamo View Extension, definitions can have automatically generated snapshots of the graph and the background geometry associated to them. When those snapshots are available, they can be visualized (if you're an admin of the Workspace containing the definition) from the Properties Panel :