Manage spaces (for site admins)

This topic discusses how site admins manage spaces in an on-premises deployment.

For details on how to configure a particular space, in a SaaS or on-premises deployment, see Manage spaces (for space admins).

Tip: For strategies for setting up your spaces and workspaces, see Best practices for setting up spaces and workspaces.

View space details

To access: Settings > Site > Spaces

  • You can view a grid of the spaces on your site, select the columns to display, sort and filter the grid.
  • Click a space's ID to open its details page, and view its history.
  • The Progress field contains information on a space's upgrade progress or its migration progress to a shared space.

Create a space

  1. In Settings > Site:

    To create a shared space, click .

    To create an isolated space, click .

  2. Name the space. You can rename the space at any time.

  3. If the database at your site is managed by database administrators, and ALM Octane is not authorized to create its own schemas or databases, check Use existing schema. Enter the name of the existing space schema to use, and its password.

  4. Create workspaces and associate them with the space. For details, see Manage workspaces.

Add or remove space admins

To add new or remove existing space admins:

  1. In Settings > Site open the Spaces tab.
  2. Click in the Administrators column in the space you want to edit to open the user drop down.
  3. From the list, select or remove admins for this space.

Upgrade spaces

After upgrading from a previous ALM Octane version, check if any spaces must be upgraded. Upgrade these spaces using the instructions below.

Note: Until all of the background jobs have completed, some data may be unavailable in trend graphs, and some ALM Octane features might be temporarily unavailable.

To upgrade spaces:

  1. In Settings > Site> Spaces, select all spaces and click Upgrade.

    Upgrade is available only if a space needs to be upgraded.

    Click Refresh to see the updated status for the spaces.

  2. The workspace name is a unique identifier within a space. ALM Octane adds a numeric suffix (_1, _2, and so on) to any upgraded workspaces with the same name. If necessary, ALM Octane truncates the last characters from workspace names longer than 255 characters before adding the suffix.

    After upgrading, review the names of the workspaces. You can rename them if you want.

Monitor a space's background jobs

Background jobs include processes that run after upgrading a space, among other activities. A space is only fully upgraded after all background jobs have completed successfully. Check periodically to see when an upgraded space is ready.

  1. In Settings > Site> Spaces, select the space, and click Background Jobs.
  2. Review the statuses of the spaces.

    Active, Inactive

    The space retained its state from before the upgrade.

    No action necessary.

    Upgrading

    The space is waiting to be sent for upgrade but the upgrade has not yet started. When the upgrade is actually in progress, the current step being processed is displayed. See the status Step # of #.

    The number of spaces that can be upgraded concurrently is limited.

    No action necessary.

    Step # of #

    As the upgrade progresses, the current step and operation are displayed.

    No action necessary.

    Suspended

    A recoverable error occurred.

    Review the error and the logs. Display the Recovery guidelines field, and follow the instructions. Restart the upgrade.

    Corrupted

    An unrecoverable error occurred.

    Restore schemas from the previous version.

    For details, see:

  1. Some jobs can be rerun. If a job failed, try rerunning it.

  2. When all jobs have completed, if you are in the middle of an ALM Octane upgrade, continue by restarting all Jetty servers.

Note: Until all of the background jobs have completed, some data may be unavailable in trend graphs, and some ALM Octane features might be temporarily unavailable.

Back to top

Deactivate a space

If you want to disable a space temporarily, instead of deleting it, you can deactivate the space.

To deactivate a space, select it and click Deactivate Space. As soon as background jobs are complete, the space is deactivated. This means that users and space admins cannot log in to the space or view its data.

To re-activate a space, select it and click Activate Space.

Back to top

Convert an isolated space to a shared space

To convert an isolated space to a shared space, select the isolated space, and click Migrate to Shared Space.

In an isolated space, each of its workspaces contains system-defined forms for the workspace entities.

After the isolated space is converted to a shared space, the workspaces inherit system-defined forms from the shared space. The system-defined forms at the workspace level are converted to user-defined forms that can be modified or removed by the workspace administrator.

For details on forms, see Design forms.

Manage storage

Available workspace storage is set on the space level, and not per workspace. This means the amount of total available workspace storage is shared between the workspaces in the space.

Site admins can set the maximum size for storage per space with the STORAGE_MAX_SIZE configuration parameter. For details, see Configuration parameters.

Delete a space

Deleting a space removes all data from all of the space's workspaces.

Caution: You cannot undo this operation. Make sure you want to delete the space before proceeding.

Before deleting a space, note the following: 

  • You cannot delete the default space.

  • You cannot delete multiple spaces at one time.

  • For security and GDPR compliance, you can view the history of deleted spaces using the REST API. For details, see Viewing the history of deleted spaces.

  • The history of session information is deleted. However, files are created that contain this information for security and GDPR compliance.

    Each file can contain information for up to 500 sessions. Files are located here: 

    C:\qc\views\mqm\site\storage\site\security

    The naming convention for the files is: 

    SessionsOfDeletedSpace_<space_id>_<spaceName> [_<pageNum>]

To delete a space: 

  1. In Settings > Site> Spaces, select the space you want to delete.

  2. In the toolbar, click More and then Delete.

Back to top

Export and import spaces (technical preview)

You can export and import spaces along with their settings and data. All of the information is saved to a self-contained file with an osa extension. The export allows you to back up and share your previously configured spaces.

When you export or import a space, you can indicate whether or not to include the space's data. If you do not include data, then only the site users and their relations are saved/loaded. If you include data, the space's tables and file system are also included. If you are working with an exceedingly large space, you may choose to exclude the data, and migrate the data and file system manually using database utilities such as Oracle DUMP. This method will take less time than exporting and importing via ALM Octane and will not affect its performance.

Note:  

  • Search and run history, trends, and audit information are not included in the import/export, even when you include data.
  • The import will only work on a space that was exported with the same version of ALM Octane.

  • Export and import are only supported for the same database vendor. For example, a space exported from Oracle can only be imported into Oracle.

To import a space: 

  1. Open the Settings > Site. By default, ALM Octane opens the Spaces sub-tab.
  2. Make sure no spaces are selected.
  3. Click Import Space. The Import Space dialog box opens.

    1. Indicate whether to import All data or Site users only.
    2. Locate a .osa file that was exported from the same version of ALM Octane.
    3. Choose the space to import.
  4. Click Import to load the space.

    If during the import, new users were added to the site to which the space was imported, they are assigned a default password: NewSiteUser1.

To export a space: 

  1. Open the Settings > Site. By default, ALM Octane opens the Spaces sub-tab.
  2. Select the check box adjacent to the space you want to export and click Deactivate Space. It is important to deactivate the space before exporting it, in case there are changes during the export process.
  3. With the checkbox still selected, click Export Space. This button will only be enabled if a single space is selected. If you select multiple spaces, it will be disabled.
  4. In the Export Space dialog box, indicate if you want to export All data or Site users only.
  5. Click Export. Wait for the status message to indicate Exported Successfully and for the dialog box to show the Download link and MD5 ID number.
  6. Click Download to save the .osa file to your default Download folder. The file name contains the tenant string and the version of ALM Octane.
  7. To clean up the export files, deselect all spaces and click Delete Export Space.
  8. Re-activate the space by selecting it and clicking Activate Space.

Back to top