Studio

 Table of contents

Subpages

This chapter describes how to configure Blueriq Studio before getting started.

License

Before you can start Blueriq you have to copy a valid license file into the license directory. The license file is called “license.aql”. You can find the directory here: [Blueriq installation directory]\Studio\Configuration\License.

Security and User Management

During the installation of Blueriq Studio you have chosen a security mode.

See Studio Security Modes for a detailed description of each security mode.

Logging

If any problem occurs with authorization or authentication you can use the  audit.log to trace and find the cause.

Data storage

Model data within Blueriq Studio is stored in one of two locations: work that is being done in a branch is stored in a relational database (PostgreSQL) until it is committed, at which point it is archived for long-term storage in a version control system separate from Blueriq Studio.

Both storage components are included and managed by the Blueriq Installer, no configuration is required.

Creating backups

To create a backup of all Studio data, two options exist: the Blueriq Repository Backup tool, which can be scheduled, or a manual download from the administration page.

Option 1: Blueriq 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 can be downloaded from the customer-area of my.blueriq. The tool can be run using the following parameters:

java -jar blueriq-studio-backup-tool.jar backup --studioUrl=http://studio.server:140/Studio/Server/Services/ManagementService --username=user --password=password --path=backup/path/repository.zip

java -jar blueriq-studio-backup-tool.jar backup --studioUrl=http://studio.server:140/Studio/Server/Services/ManagementService --auth-type=ntlm --username=DOMAIN\user --password=password --path=backup/path/repository.zip

java -jar blueriq-studio-backup-tool.jar backup --studioUrl=http://studio.server:140/Studio/Server/Services/ManagementService --auth-type=kerberos --username=DOMAIN\user --password=password --path=backup/path/repository.zip

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.

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.

java -jar blueriq-studio-backup-tool.jar backup --timeout=0

<managementservice>
<connection url="http://localhost:8095/Services/ManagementService" user="administrationpage" password="administrationpage" requestTimeout="00:02:00"/>
</managementservice>

Restoring backups

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 Backup Tool

The backup tool as mentioned above can also be used to restore a backup using the following parameters:

java -jar blueriq-studio-backup-tool.jar restore --studioUrl=http://studio.server:90/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”.

When the upload has completed all users are logged out and the system automatically refreshes. There is no need to restart the server.

Please note that repositories that exist before restoring a backup but are not present in the backup itself will remain intact!

Commit hook

The commit hook is a feature that sends an HTTP request to a configured endpoint whenever a commit is performed from within studio. This allows you to create buildpipelines that get triggered from Blueriq.

To enable this feature, add the configuration below to the studio section of the config file for Blueriq Studio (StudioService.exe.config).

<configuration>
  <studio>
    ...
	<commithook url="http://localhost:3210" />
    ...
  </studio>
</configuration>

Once you've configured the endpoint, each commit in Blueriq Studio will cause an HTTP POST request to be sent to the endpoint containing the information below.

{
  "repository": "MyRepository",
  "branch": "MyBranch",
  "tags": ["All", "Tags", "On", "The", "Commit"],
  "commitId": "d99ff38c-ac9f-4394-af79-7e1f235018c8",
  "user": "MyUserName",
  "message": "The message that was added to the commit"
}