Page History
...
Blueriq Studio has an internal repository. When installing Blueriq Studio a default repository is provided with an initial content to start using Blueriq Studio.
An already existing repository-backup can replace the default repository. The repository is found in the [Blueriq Installation directory]\Studio\Repository directory and is called Repository.sdf.
The Repository.sdf file contains the entire repository.
Backup the repository
all Blueriq repositories that are present in Studio.
Creating Backups
To create a backup of all Studio data, two options existA backup of the repository can be made. There are two options: the Blueriq Repository Backup tool, which can be scheduled, and or a manual download from the administration page.
Option 1: Blueriq Repository Backup Tool
To backup all relevant content that is stored by Blueriq Studio, the Management Service has a SOAP operation to duplicate its data storage to a single file on disk. For typical automated backup strategies it is cumbersome to interact with a SOAP service, therefore Blueriq provides a tool that can be run from a batch/bash script to perform this operation.
The backup tool is included in the installation zip,
call itand can be run using the following parameters:
java -jar blueriq-repository-backup.jar backup --studioUrl=http://studio.server:
1008090/Studio/Server/Services/ManagementService --username=user --password=password --path=backup/path/repository.zip
Backup the repository to a backup location. This task can be automated by creating a batch file which you add to the Windows task scheduler
Info |
---|
Please note that the provided path is in terms of the machine where Studio is installed on, not on the machine the tool is run from. |
Info | ||
---|---|---|
| ||
The backup tool requires Java 11. |
It is recommended that the file that is created by running the tool is not considered as primary backup, but replicated on a different machine and that backups from multiple days are retained! As such, we strongly advise to copy the resulting file somewhere safe and to avoid overwriting the backup of the prior day.
Option 2: Download from the administration page
- Open the administration page from the welcome page and open the “Repository” tab.
- Click on “Create Backup” and save the file to a backup location.
Restore
...
backup
Only backups created from the same or older versions of Blueriq Studio can be restored. If a backup of an older version is restored the repository is automatically upgraded by Blueriq Studio.
Option 1: Blueriq Repository Backup Tool
The backup tool as mentioned above can also be used to restore a
repository and is included in the installation zip, call itbackup using the following parameters:
java -jar blueriq-repository-backup.jar restore --studioUrl=http://studio.server:
1008090/Studio/Server/Services/ManagementService --username=user --password=password --path=backup/path/repository.zip
As is the case with creating a backup, the path in the above command is in terms of the machine where Studio is installed on, not on the machine the tool is run from.
Option 2: Upload in administration page
- Open the administration page from the Welcome page and open the “Repository” tab
- Click on the “Browse” button near the “Upload Backup” button, browse to the backup file and click “Upload Backup”. The name for the backup file can be any name. The upload feature automatically renames the file name to Repository.sdf when it is installed on the server.
When the upload has completed all users are logged out and the system automatically refreshes. There is no need to restart the server.
...
Once you've configured the endpoint, each commit in Blueriq Studio will cause an http post HTTP POST request to be sent to the endpoint containing to the information below.
Code Block | ||
---|---|---|
| ||
{ "repository": "MyRepository", "branch": "MyBranch", "tags": ["All", "Tags", "On", "The", "BranchCommit"], "commitId": "d99ff38c-ac9f-4394-af79-7e1f235018c8", "user": "MyUserName", "message": "The message that was added to the commit" } |