Context Documents Administration

The Context Documents administration page lets administrators decide where the Build Agent may keep Context Documents. One switch controls the whole environment, and a second switch controls each workspace.

Only Designer Administrators can open this page. For other Creators, the Context Documents item in the Settings sidebar is unavailable. A Creator who opens the page address directly sees a message that explains that the Creator does not have permission. The page is available only when UnqorkAI is on for the environment.

To open the Context Documents administration page, navigate to Administration > Environment Settings > Build Agent > Context Documents.

Environment

The Context Documents for this Environment card at the top of the page has one switch. It controls Context Documents for every workspace in the environment.

Workspaces

The Workspaces section lists every workspace in the environment, each with its own switch. The section is hidden while the Context Documents for this Environment switch is off.

The table displays 10 workspaces per page. When the environment has more workspaces, use Rows per page and the page controls below the table to move through the list. When the page opens, workspaces that are off appear first, followed by the workspaces that are on. Each group is in alphabetical order. A row stays in place when its switch changes, so the list does not move under the pointer.

Saving Changes

Select Save Changes to save the environment switch and every workspace switch together. Nothing changes until the page is saved. After a successful save, the page displays Context document settings have been saved.

If the page cannot save the changes, it displays an error message. The switches stay as they are, so the administrator can try again.

An administrator who leaves the page with unsaved changes sees the Unsaved Changes dialog. The dialog has the Save & Continue, Discard Changes, and Cancel options. If the page cannot load the settings, it displays Unable to load context document settings and asks the administrator to refresh the page.

How the Settings Combine

The environment switch takes priority over the workspace switches. Context Documents are on for a workspace only when both the environment switch and the workspace switch are on.

When Context Documents are off for a workspace:

• The Build Agent does not read or write entries in that workspace. This applies to tasks that are already running.
• The Context tab is hidden in the Build Agent panel.
• An entry that is already open displays a message that Build Agent Context is turned off for the workspace.
• Existing entries are not deleted. They are available again when the switch is turned back on.