Skip to main content

Managing repositories

The Manage Repositories page (in Administration → Repositories) is where you create new repositories, register and migrate existing ones, and rename, disable, unregister, or delete them.

Prerequisites​

  • Access to the Administration → Repositories area.
  • For a new or registered repository, the database connection details (host, port, database name, and a database user) — see Database setup.

Steps​

Create a new repository​

  1. Open Administration → Repositories and click Create New Repository.
  2. Fill in the fields (which vary with your choices):
    • Repository Name — the name shown in the UI (for example in a repository picker). It can include spaces and punctuation such as hyphens or underscores.
    • Short Name — used in URLs and other places where the full name isn't valid. Maximum 15 characters, no special characters.
    • Connection Type — JDBC (a Java database connection, required if you want one database to host multiple repositories using a table prefix) or JNDI (a Java directory service that connects using the value in JNDI Name).
    • Database Type — the back-end database (Microsoft SQL Server).
    • Hostname — for JDBC, the computer hosting the database.
    • Port — for JDBC, the port the database instance listens on.
    • Database name — for JDBC to SQL Server, the database you're connecting to.
    • Table Prefix — for JDBC, set this to store more than one repository in a database. All of this repository's tables are created with the prefix, leaving room for other repositories under other prefixes.
    • JNDI Name — for JNDI, the name that identifies the database to JNDI.
    • User and Password — for JDBC. A directory user is formatted DOMAIN\USER. The platform service user connects with passthrough, so its password isn't required.
  3. Click Create New Repository. With correct settings, you return to Manage Repositories and the new repository appears in the list.

Register an existing repository​

Register a repository created in another platform instance to make it available here. To migrate a version-15 repository, see Migrating repositories instead.

  1. Open Administration → Repositories and click Register Existing Repository.
  2. Fill in the same fields as for creating a repository.
  3. Click Register Existing Repository. With correct settings, the repository appears in the list.

Rename a repository​

  1. Open Administration → Repositories and select the repository.

  2. Open the Settings tab and edit Repository Name and Short Name. Editing either shows a warning you can cancel.

    warning

    Changing the Short Name can break external links to the repository and to the objects it contains.

  3. Click Save Changes.

Download the ETL script for Performance Indicator data​

To load Performance Indicator values from an external system — or read them out for reporting — a database administrator needs controlled access to the repository's fact tables.

  1. Open Administration → Repositories, select the repository, and open the ETL Script tab.
  2. Click Download SQL Script. The script creates a database role that, when assigned to database users, allows access to the Performance Indicator value tables (the facts) and loading data via an ETL process.

Disable, unregister, or delete a repository​

Open Administration → Repositories, select the repository, and open the Administrative tab.

  • Disable — makes the repository temporarily unavailable. The button becomes Enable; click it (or use the repository list) to re-enable.

  • Unregister — removes the repository from this instance without deleting it; you can register it again later. Click Unregister, then Confirm Unregister. To cancel, click an empty area of the page.

  • Delete — permanently removes the repository and all its data. Click Delete, then Confirm Delete.

    warning

    Deleting a repository can't be undone — all data is removed. Be certain before you proceed.