1. Application Properties Summary
This section lists the properties available for a server administrator to configure Publication For Capella.
These properties need to be set in the file config/application.properties of the server.
They have sensible default values whenever it is possible.
1.1. Properties Inherited from Underlying Frameworks
1.1.1. General Application Server Properties
| Property key | Default value | Description |
|---|---|---|
|
443 |
The port the server must listen to. |
|
|
The session timeout (inactivity delay after which a web session is invalidated). |
|
Certificate type, e.g. |
|
|
Path to the SSL keystore file, e.g. |
|
|
Password of the SSL Keystore file. |
|
|
Alias of the SSL key in the keystore file. |
|
|
Password of the key in the file (generally identical to the file’s password). |
|
|
|
The JDBC URL of the Publication For Capella database. |
1.1.2. OpenID Connect Properties
The following properties need to be set only if authentication with OpenID Connect is desired.
In this section and the following, {oidc-provider-name} refers to the name of the OpenID Connect provider as it will be displayed in the Login page, if configured.
|
| Property Key | Description |
|---|---|
|
The issuer URI of the OpenID Connect server, which can be used to discover other URIs (authorization URI, token URI, User Info URI, and JWK Set URI).
For example, when using keycloak, |
|
The authorization URI of the OpenID Connect server.
For example, when using keycloak, |
|
The token URI of the OpenID Connect server.
For example, when using keycloak, |
|
The user information URI of the OpenID Connect server.
For example, when using keycloak, |
|
The JWK set URI of the OpenID Connect server.
For example, when using keycloak, |
|
The attribute to consider as the username within Publication For Capella, for instance |
|
The authorization grant type to use by Publication For Capella, should be |
|
The Publication For Capella Client-ID, as registered in the OpenID Connect server. |
|
The Publication For Capella Client secret, as registered in the OpenID Connect server. |
|
The OpenID Connect server’s redirect URI, for example |
|
The OpenID Connect scope to use, should be |
|
The JWT issuer URI, for example |
|
The id provider introspection URI to verify opaque access tokens, for example |
|
The ID of the client that uses these access tokens.
This must only be used together with |
|
The secret of the client that uses these access tokens.
This must only be used together with |
1.1.3. Sirius-Web Properties
1.1.4. Obeo Enterprise Framework Properties
| Property key | Description |
|---|---|
|
License key obtained from Obeo. |
|
Default password of the |
|
The claim key for user organization. |
|
The default organization where the missing teams will be created. |
|
The claim key for user teams. |
|
Delimiter used to split multiple team names from the claim. |
|
Whether to automatically create a team if it does not exist. |
|
Default team assigned when the claim is empty or mapping is missing. |
|
A regular expression filter indicating whether the team name in the claim should be considered or not. |
1.2. Publication For Capella Properties
The following properties are specific to Publication For Capella.
| Property key | Default value | Description |
|---|---|---|
|
|
The name of the default organization. |
|
|
Enablement of the polling of Jama Connect servers.
|
|
|
Jama server polling delay, in seconds. |
|
|
Enablement of the synchronization of attachments (with Jama Connect servers).
|
|
Path to the metaclass filter global defaults file. |
|
|
|
Timeout for Branch locks, in milliseconds. |
|
|
Timeout for Model locks, in milliseconds. |
|
|
Number of attempts to lock the model for publications. |
|
|
Delay to reload the UI extension HTML files, in ISO-8601 duration format. Negative durations or non-parsable durations are ignored and fall back to the default. |
|
ID of UI extension number 0 (the 1st extension). |
|
|
Location of UI extension number 0 (the 1st extension), must be |
|
|
Label of UI extension number 0 (the 1st extension), which will be displayed in the desired location. It is recommended to finish this label with a separator and a space, for example: `perseus.ui.extensions[0].label=Get Help - ` with an addition space at the end. |
|
|
URI of the HTML file to load, like |
|
|
Path to the Content Security Policy whitelist file. |
|
|
Path to the file that contains the mappings of properties |
|
|
|
Set the visibility of the left-hand panel. |
|
|
Set the |
|
|
Set the default visibility of the |
|
|
Set the visibility of the right-hand panel. |
|
|
Set the |
|
|
Set the default visibility of the |
|
|
Registration ID of the OAuth-2.0 Client that provides JWT to the Perseus contributor client.
The segment |
|
|
Name of the claim to use to obtain the client ID from the JWT provided by the OIDC server for a contributor client authentication.
By default, the client ID is read in the |
|
|
Signing Algorithm to use to verify JSON Web Tokens issued by the authentication provider corresponding to |
|
|
Timeout for OAuth connection requests, in milliseconds. |
|
|
Timeout for OAuth connections, in milliseconds. |
|
|
Protocol to use to obtain an OAuth-1 access token.
Possible values are: |
|
|
Timeout for OAuth sockets, in milliseconds. |
|
The duration for which an OAuth-1.0 token is valid, in ISO-8601 format.
For example: |
|
|
The public URL of the publication server, as it is accessed by third-party servers and end-users.
For example, |
|
|
|
Duration for which an entry in the rootservices cache is considered valid. |
|
|
Size of the rootservices cache. |
|
|
Timeout to fetch OSLC links, in seconds. |
|
|
Default height of OSLC previews, as a CSS String (including unit). |
|
|
Default width of OSLC previews, as a CSS String (including unit). |
|
Path to the OSLC linking default config file. |
|
|
|
The duration for which OSLC credentials are valid, in ISO-8601 format.
For example: |
|
|
This property must be set to make it possible for Publication For Capella to access the Atlassian (Jira or confluence) OSLC API.
This is necessary to be able to connect to recent versions of Jira or Confluence.
Adding this property will cause Publication For Capella to systematically add a header |