Library projects

For a visualization of most concepts described in this chapter, see

A project can be of type ‘library’. A library project can contain everything a non-library project can, but cannot be executed in the runtime. Other projects (including library projects) can refer to a library project. When a project refers to a library project, the latter’s content becomes available for use by the first.

Create a library project

1. Create a new project or edit an existing project that you want to convert to a library project.
2. Check ‘Is library’.
3. Click Save project.

Before exporting a library project you might want to fill out the fields Version and Release notes. For more information on adding documents to your library project, see add a document to your library project.

Note: Converting an existing project to a library project will delete its project configuration.

1. Refer to a library project

2. In a (library) project you can add references to internal and external library projects. Adding a reference makes the referred library project’s content available for use.

   1. Select the (library) project in the workspace screen.
   2. Click Edit project.
   3. Add a library reference by selecting the desired library.
   4. Click Save project.

   

3. Export a library project

4. Exporting a library project will convert it to a read-only external library project that can be distributed to be used in another repository. A library project can also be packaged. Exporting the package will convert the contained library project to a read-only external library project as well.

   To export a library project:

   1. Select the library project.
   2. Click on Export library in the ribbon’s tab Project.
   3. Click on Download and save the library.

   For more information on packaging see exporting and importing packages.

5. Import a library project

6. To import a library project:

   1. Open the branch you want to import the library to.
   2. Go to File > Import > Import library or package.
   3. Click on Browse.
   4. Locate the library project on the server or on your local computer and Open.
   5. Click on Import.

   In case there is a project or library project in the branch with the same name as the library project you want to import, a warning is shown. You can choose whether you want to update the existing library, or rename the library project you want to import in order to place it next to the existing one.

7. Add a document to your library project

8. You can add PDF files to a library project that will also be accessible in the read-only export. You can, for example, add help files or release notes to the library project you are going to distribute.

   To add a PDF file to you library project:

   1. Select the library project in the workspace screen.
   2. Click Edit project.
   3. In the Documents field, click on Browse.
   4. Select the PDF file and click Open.
   5. Click Save project.

   To access a PDF file in a library project:

   1. Select the library project in the workspace screen.
   2. In the Documents field, select the document you want to download.
   3. Click on Download document.
   4. Click on the download link in the pop-up.
   5. Open or save the document.

   Performance Issue

   If you notice a performance issue when opening a branch and you see the Migration Manager in the Studio log, it could be that the branch contains libraries from an older Studio version. A possible fix for this issue is to reïmport the libraries into the project. This will trigger the Migration Manager of the Studio which stores a migrated version of the library in the database. The next time when the project is loaded the migrated version will be read from the database and the Migration Manager doesn't have to be run.

9. Related Articles
10. • Page:
      BlueriqCompleteLibraries Package (Blueriq Latest)

      • blueriqlibrary
      • library
      • aquimalibraries
      • aquimalibrary
      • blueriqlibraries
      • libraries