Create or edit workspaces

2 minute readAutomation

You create a new workspace or edit an existing workspace by using the Edit Workspace page.

  1. Navigate to Administration  Workspaces.

  2. If you are creating a new workspace, select Add workspace to open the Edit Workspace page.

  3. If you are editing an existing workspace, select the workspace name to open the Edit Workspace page.

  4. Complete or update the fields or menus as follows:

    Field Name Description


    Enter a unique name to distinguish this workspace from other workspace names.


    (Optional) Plain text or HTML description for this object. If using HTML, you must surround your text with <html> …​ </html> tags. Allowable HTML tags are <a>, <b>, <br>, <div>, <dl>, <font>, <i>, <li>, <ol>, <p>, <pre>, <span>, <style>, <table>, <tc>, <td>, <th>, <tr>, and <ul>.

    • For example, the following HTML:

      <p> <span style="font-family: Arial;"> <i>Note:</i> For more information about the <b>abc</b> object, see <a href=""></a>. </span> </p>

      renders as follows:

      <i>Note</i>: For more information about the <b>abc</b> object, see

    Enter three paths to use on resources to access the workspace root directory:

    UNC Path

    A path in UNC notation (such as //server/ec/a/b/c ) to use on Windows machines. The path can use either slashes or backslashes for separators.

    Drive Path

    A second path for Windows machines, based on drive notation such as N: or N:/b/c. If the drive path contains more than just a drive letter, additional directory names must match the trailing directories of the UNC path. For example, if the UNC path is //server/ec/a/b/c, then N:/b/c can be used as the drive path (agents automatically map N: to //server/ec/a ), but N:/x/c is not allowed.

    UNIX Path

    The path to use for UNIX machines, typically based on an NFS mount. You must ensure appropriate mounts were created on all machines where the path is used. CloudBees CD/RO does NOT automatically mount filesystems for UNIX.

    If the workspace is used only on UNIX machines, you can omit the UNC and drive paths. Conversely, if the workspace is used only on Windows machines, you can omit the UNIX path. For more information, refer to the Define and use workspaces.


    Use the drop-down arrow to select a zone for this workspace.


    Select this checkbox if the workspace is "local", which means files in the local workspace are accessible only from the resource that originally created the file.


    Select this checkbox to enable this workspace. When selected, the workspace is enabled, which means it can be accessed. In the case where a job or job step cannot access the workspace, the job queues, waiting for the workspace to become available.

    Credential Project and Credential Name

    If you need to enter a username and password to mount the workspace, you must enter the credential project name and then choose the appropriate credential name, which contains the required username and password. Select Browse to select information for these fields.

  5. Select OK to save your changes. For more workspace information, refer to Define and use workspaces.