User interface - Helix Core Server

Helix Core Server provides a central storage area for all of your shared assets. All of the files on the Helix Core Server are version controlled and accessible by Helix Sync. Helix Sync lets you upload files to and download files from the Helix Core Server. It always shows when new versions of files are available.

Helix Sync menus, buttons, and lists:

Helix Sync menu

  • About application: Click to view details about Helix Sync.
  • Quit: Click to log out and close Helix Sync.

Edit menu

Not used.

Help menu

  • Help: Click to view the Helix Sync help.
  • REST API Help: Click to open Helix Sync REST API help.

  • Logs: Click to open the folder where the Helix Sync logs are stored.

  • Licenses: Click to view the software licenses used by Helix Sync.

  • Release Notes: Click to view the Helix Sync release notes.

  • Clear Stored Data: Click to log out and delete saved information from the Server and Username fields.

Profile menu

  • Current connection: Shows user and connection details.

  • Dark theme: Click to toggle dark theme on and off. New Helix Sync installations default to the dark theme. The current theme is maintained when Helix Sync is upgraded.

  • Show welcome page: Click to display the Welcome page.

  • Log out: Click to log out of Helix Sync and leave it open.

Helix Sync icon

The Helix Sync icon is displayed while Helix Sync is running, including when the window is closed or minimized:

  • macOS: The Helix Sync icons are displayed in the dock, and in the system tray to the left of the status menu.

  • Windows: To view the Helix Sync icon, go to the notification area at the far right of the Windows taskbar and click Show hidden icons Image of the Show hidden icons button.

When Helix Sync is running, you can use the Helix Sync icon to reopen or quit Helix Sync:

  • macOS:

    • Reopen: To reopen Helix Sync, click either of the Helix Sync icons.

    • Quit : To quit Helix Sync, do one of the following:

      • From the dock, right-click the Helix Sync icon and select Quit Helix Sync. The standard macOS Quit option is not used.

      • From the system tray, right-click the Helix Sync icon and select Quit.

  • Windows:

    • Reopen: To reopen Helix Sync, click the Helix Sync icon.

    • Quit : To quit Helix Sync, right-click the Helix Sync icon and select Quit.

My workspaces list

Shows the workspaces available for your login on this computer and other computers. If the workspace is mapped, the workspace location is shown in the This computer list. If the workspace is not mapped, you can clone it from the Other computers list.

Workspace list buttons

  • Image of theRefresh all changes button Refresh: Click to manually refresh the workspace list.

  • + Create workspace: Click to create a workspace from a Helix Core Server stream. See Create a workspace in Helix Sync.

This computer list

Shows workspaces you have synced to this computer and the workspace location.

  • Watch workspace (Only used for Allwrite workspaces): Click the ellipsis (...) next to the workspace, and select Watch workspace to toggle the watch setting. By default, Watch workspace is off.

    Tip

    Allwrite workspace paths are labeled in the Helix Sync My Workspaces list as (writable). By default, workspaces are not writable.

    For example: c:\Workspace_Project_Alpha (writable)

  • Workspace watch status:

      Blue dot: Workspace is being watched.

      Orange dot: Workspace is not being watched.

  • Rename: Click the ellipsis (...) next to the workspace, and select Rename to rename the Helix Sync workspace. This only renames the workspace in Helix Sync, it does not change the workspace folder name on your computer or the workspace name in P4V.

Other computers list

Shows workspaces you have on other computers.

Clone workspace: Click the workspace to clone, select a folder, and sync the workspace to your computer. See Clone a workspace.

Workspace buttons and menus

  • Image of theRefresh all changes button Refresh all: Click to manually refresh the My changes, Changes by others, and My files lists.

  • Image of the Show workspace in file browser button Show the workspace in the file browser: Click to open the current workspace in your file browser.

My changes list

Shows files you have added, deleted, renamed, or changed in your workspace. To share the changes with other users, upload them. See Upload changes.

Changes by others list

Shows files that other users have added, deleted, renamed, or changed. To get these changes in your workspace, download them. See Download changes.

My files list

Shows the first 100 files in your workspace, click Show more to display more files in the list. See Work with files in your workspace