Object summaries

All the information trac holds for an object can be viewed on its summary page, found via the Search results.

Layout

Object summary pages differ slightly per object type but follow a similar pattern.

At the top of the page are 3-4 action icons. Below, the object’s metadata is displayed under four headings:

• Definition — the object type, object ID, and when it was created

• Version — details of this specific version, plus a link to the full version history

• Source — system-generated tags describing the object’s lineage, which vary by object type and creation method

• Tags — the user-assigned attributes for the object, such as Key, Name, Description, and business segment

Further down you will see information relating to any files that have been appended. If none have, you just see the option to upload a file or link to an existing one.

Files can be appended for a variety of reasons - e.g. you could attach the model development documentation to a model, or a data quality report to a data object.

The final section describes the object and varies by object type.

• For data and models, this will describe their schemas

• For flows this will include a visual representation of the graph

• Jobs will have all the components found on the flow, job and model summaries

Export

The JSON and PDF action icons allow you to download the object summary information. The PDF downloads are formatted to be used in formal governance processes.

For a data object, the CSV action icon allows you to download a copy of the data.

Note

Downloading of datasets is supported — in enterprise deployments data can also be exported using an ExportData job.

Append

Files can be added to objects. To upload a new file, simply find and select it, then click ‘Import’ and ‘Upload’.

As usual you must define the general attributes, except Name which is fixed.

You can also link to an existing file object, using the standard filter and select process.

Once a link to a file has been added you will see it on the object summary.

Clicking ‘Remove link’ does not remove the file object from trac, it just breaks the association with this object.

Clicking ‘More info’ allows you to explore the lineage of the linked file.

Generate schema

On a model summary page, data inputs and outputs have a ‘Generate schema’ button next to them, which is used to generate a schema object from the model definition.

Model code

For models, the PY icon links through to the underlying code in the repository.

Because the model object corresponds to a specific commit, the code associated with this object will never change. For more information see Upload a model.

Note

Access to the code is constrained by the user’s permissions in the repository - the link will not expose the code to someone who doesn’t already have permission.