PoolParty Semantic Suite

https://help.poolparty.biz
Admin
PoolParty Semantic Suite is a comprehensive semantic middleware platform that provides taxonomy and...
Tokens:849,671
Snippets:5,764
Trust Score:9.8
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### Start PoolParty server (poolparty start)

Source: https://help.poolparty.biz/en/administrator-guide/poolparty-configuration/changing-the-port-used-by-the-poolparty-server.html

Starts the PoolParty server. Replace <PPAppDir> with the actual PoolParty installation directory. Run this command after switching to root.

```bash
<PPAppDir>/bin/poolparty start
```

--------------------------------

### Example .env file for on-premise Linux installation

Source: https://help.poolparty.biz/en/administrator-guide/poolparty-installation/preparing-the-poolparty-installation---upgrade/fresh-poolparty-installation.html

Example .env file showing mandatory and optional parameters for an on-premise installation on a Linux server. Adjust non-mandatory parameters as needed for your component.

```bash
poolparty@/opt/poolparty/poolparty_setup$ cat .env 
ENV_PATH_POOLPARTY_INSTALLATION="/opt/poolparty"
ENV_PATH_POOLPARTY_DATA="/opt/poolparty/data"
ENV_USER="poolparty"
ENV_GROUP="poolparty"
ENV_URL_POOLPARTY_BASE_SCHEME="httpscheme.server.com”
ENV_URL_POOLPARTY_BASE_VOCABULARY="vocabulary.server.com"
ENV_URL_POOLPARTY_BASE_CONTEXT="data.server.com"
ENV_URL_POOLPARTY_BASE_USER="resource.server.com/user"
ENV_PORT_POOLPARTY_TOMCAT="8081"
ENV_URL_KEYCLOAK="server.com/auth"

```

--------------------------------

### Start PoolParty

Source: https://help.poolparty.biz/en/administrator-guide/poolparty-administration/controlling-poolparty--linux-.html

Use this command to start the PoolParty instance. It is the example action provided in the usage instructions.

```bash
/opt/poolparty/bin/poolparty start
```

--------------------------------

### Example Upgrade Routine for ADF Search Application

Source: https://help.poolparty.biz/application-development-framework/en/search-application/upgrade-the-search-application.html

Interactive installer session for upgrading an existing ADF installation. The example shows the prompts and expected responses: confirm installation, choose 'Upgrade an existing ADF installation', select standalone or shared Tomcat mode, accept the default installation directory, and review the application properties before proceeding.

```text
This will install ADF 1.1.0 on your computer. 
OK [o, Enter], Cancel [c]
> o

Choose the appropriate option: 
Install ADF [1, Enter],
Upgrade an existing ADF installation [2],
Cancel installation [c]
> 

Choose the appropriate option: 
ADF is run as a standalone application [1, Enter],
ADF is run on a shared Tomcat 9 instance (this will not update Tomcat) [2],
Cancel installation [c]
> 1

Enter installation directory: 
[/opt/ADF]
>

Please review the application properties: 

SETTING                 VALUE
Base Path               /search
PoolParty URL           https://example.poolparty.biz
PoolParty User Group    ADF
Keycloak URL            uhttps://example-keycloak.poolparty.biz:8181rl
Keycloak Realm          poolparty
Keycloak Client ID      ppt
Keycloak Client Secret  JhbGciOiJSUzI1NiIsInR5
Proceed installation?
OK [o, Enter], Cancel [c]
>
```

--------------------------------

### Start UnifiedViews services

Source: https://help.poolparty.biz/en/poolparty-unifiedviews/unifiedviews-installation-guide.html

Used to start UnifiedViews after installation. First switch to root with sudo -i, then start the frontend service followed by the backend service. The frontend must be started before the backend.

```bash
sudo -i
```

```bash
/opt/unifiedviews/bin/unifiedviews-frontend start
/opt/unifiedviews/bin/unifiedviews start
```

--------------------------------

### Installation script output with credentials

Source: https://help.poolparty.biz/en/administrator-guide/poolparty-installation/preparing-the-poolparty-installation---upgrade/fresh-poolparty-installation.html

Example output from running ./setup.sh, showing the installation progress and the credentials printed after successful completion. Note the warning about running PoolParty with root user privileges.

```bash
/opt/poolparty/poolparty_setup$ ./setup.sh
[ Note ] PoolParty installation script for version 9.5.0 has started.
[ Note ] Input validation and system checks have been completed.
[ Note ] Files and folders have been copied to the specified target directories.
[ Note ] Placeholder values in configuration files have been updated with the provided input (.env file).
[ Note ] Keycloak has been successfully set up.
[ Note ] Elasticsearch has been successfully set up.

[ Note ] Authentication service admin credentials: poolparty_auth_admin/password
[ Note ] Superadmin credentials: superadmin/password 
[ Note ] Elasticsearch credentials: elastic/password

[ Note ] Running PoolParty with root user privileges is not recommended.

```

--------------------------------

### Example Request: GET extractedterms

Source: https://help.poolparty.biz/en/poolparty-developer-guide/thesaurus---ontology-manager-api/corpus-services/web-service-method--request-extracted-terms-of-a-corpus.html

Example request to retrieve extracted terms for a corpus. The corpusId must start with "corpus:" and the project path variable is a UUID.

```http
http://<server-url>/PoolParty/api/corpusmanagement/1DCE489D-9695-0001-E272-285217B0181E/results/extractedterms?corpusId=corpus:e62d3b7e-ce07-48c0-b2c3-696a159227e2
```

--------------------------------

### GET /PoolParty/api/corpusmanagement/{project}/uptodate

Source: https://help.poolparty.biz/en/poolparty-developer-guide/thesaurus---ontology-manager-api/corpus-services/web-service-method--request-up-to-date-information-about-a-corpus.html

Example request to check if a corpus is up-to-date. The corpusId parameter must start with "corpus:" and the project path variable is a UUID or URI supplement.

```http
http://<server-url>/PoolParty/api/corpusmanagement/1DCE489D-9695-0001-E272-285217B0181E/uptodate?corpusId=corpus:e62d3b7e-ce07-48c0-b2c3-696a159227e2
```

--------------------------------

### Run setup.sh script

Source: https://help.poolparty.biz/en/administrator-guide/poolparty-installation/preparing-the-poolparty-installation---upgrade/fresh-poolparty-installation.html

Executes the setup.sh script to start the installation. If all mandatory variables in the .env file are correct, the installation completes without interaction.

```bash
./setup.sh

```

--------------------------------

### Example Request URL for Request Concept Matches

Source: https://help.poolparty.biz/en/poolparty-developer-guide/thesaurus---ontology-manager-api/corpus-services/web-service-method--request-concept-matches-of-a-corpus.html

Shows the HTTP GET request to retrieve concept matches for a corpus. The `corpusId` parameter must start with 'corpus:' and the project UUID is used in the path.

```http
http://<server-url>/PoolParty/api/corpusmanagement/1DCE489D-9695-0001-E272-285217B0181E/results/concepts?corpusId=corpus:e62d3b7e-ce07-48c0-b2c3-696a159227e2
```

--------------------------------

### Example request for Get Running Tasks

Source: https://help.poolparty.biz/en/poolparty-developer-guide/thesaurus---ontology-manager-api/system-services/web-service-method--get-running-tasks-of-a-system.html

An example GET request to the runningTasks endpoint using a sample server URL.

```http
http://vocabulary.semantic-web.at/PoolParty/api/runningTasks
```

--------------------------------

### Example Installation Routine

Source: https://help.poolparty.biz/application-development-framework/en/search-application/how-to-install-the-search-application.html

Interactive terminal session showing the ADF installer prompts and user responses. Confirm installation with 'o' or Enter, choose standalone or shared Tomcat, and provide configuration values when prompted.

```text
This will install ADF 1.2.0 on your computer. **1** 
OK [o, Enter], Cancel [c]
> o

Choose the appropriate option: **2**
Install ADF [1, Enter],
Upgrade an existing ADF installation [2],
Cancel installation [c]
> 

Choose the appropriate option: **3**
ADF is run as a standalone application [1, Enter],
ADF is run on a shared Tomcat 9 instance (this will not update Tomcat) [2],
Cancel installation [c]
> 1

Where should ADF be installed **4**
[/opt/ADF]
>

Default ADF user: **5**
[poolparty]
>

Default ADF group: 
[poolparty]
>

Please review: **6**
SETTING                 VALUE
Installation directory  /opt/ADF, Access: OK
ADF user:group          poolparty:poolparty

Proceed installation?
OK [o, Enter], Cancel [c]
>

Which base path (directory in the URL) do you want ADF to be accessible at? (e.g.: /ADF) **7**
> /search

What is the URL to the PoolParty instance to use? (e.g.: https://test.poolparty.biz) **8**
> https://example.poolparty.biz

What is the user group for the PoolParty user? **9**
> ADF

What is the URL to the Keycloak instance to use? (e.g. https://<KEYCLOAK_URL>[:8181]) **10**
> https://example-keycloak.poolparty.biz:8181


What is the Realm in the Keycloak instance to use? (e.g. poolparty) **11**
> poolparty


What is the Client Secret of Keycloak Client "ppt"? **12**
> JhbGciOiJSUzI1NiIsInR5

Please review the application properties: **13**


SETTING                 VALUE
PoolParty URL           https://example.poolparty.biz
PoolParty User          superadmin
PoolParty User Group    ADF
Keycloak URL            uhttps://example-keycloak.poolparty.biz:8181
Keycloak Realm          poolparty
Keycloak Client ID      ppt
Keycloak Client Secret  JhbGciOiJSUzI1NiIsInR5
Proceed installation?
OK [o, Enter], Cancel [c]
>


```

--------------------------------

### Example Response for Pending Pipeline Execution

Source: https://help.poolparty.biz/en/poolparty-unifiedviews/unifiedviews-apis/unifiedviews---pipeline-execution-services/web-service-method--request-the-last-running-or-queued-pipeline-execution.html

Example response for the GET request to /pipelines/{pipeline_id}/executions/pending. Returns a single pipeline execution entry with fields such as id, status, isDebugging, orderNumber, start, end, schedule, stop, and lastChange. Statuses QUEUED, RUNNING, and CANCELLING are considered, with CANCELLING presented as RUNNING.

```json
[{
    id: 3,
    status: "QUEUED",
    isDebugging: false,
    orderNumber: 1,
        start: "2014-08-08T15:15:15.555Z",
    end: "2014-08-08T15:15:15.555Z",
    schedule: 12,
    stop: false,
    lastChange: "2014-08-08T15:15:15.555Z"
}]
```

--------------------------------

### Example Request: Get PoolParty License

Source: https://help.poolparty.biz/en/poolparty-developer-guide/thesaurus---ontology-manager-api/system-services/web-service-method--get-poolparty-license.html

Example request to the Get PoolParty License endpoint using a preview server URL.

```http
https://preview.poolparty.biz/PoolParty/api/license
```

--------------------------------

### Example .env file for on-premise upgrade

Source: https://help.poolparty.biz/en/administrator-guide/poolparty-installation/preparing-the-poolparty-installation---upgrade/upgrading-poolparty-2025-release-1-to-poolparty-2025-release-2.html

Example .env file for an on-premise installation upgrade on a Linux server. Edit the variables as needed.

```bash
ENV_PATH_POOLPARTY_INSTALLATION="/opt/poolparty"
ENV_PATH_POOLPARTY_DATA="/opt/poolparty/data"
ENV_USER="poolparty"
ENV_GROUP="poolparty"
ENV_URL_POOLPARTY_BASE_SCHEME="<scheme.server.com>"
ENV_URL_POOLPARTY_BASE_VOCABULARY="<vocabulary.server.com>"
ENV_URL_POOLPARTY_BASE_CONTEXT="<data.server.com>"
ENV_URL_POOLPARTY_BASE_USER="<resource.server.com>/user"
ENV_PORT_POOLPARTY_TOMCAT="8081"
ENV_URL_KEYCLOAK="<server.com>:8181/auth"
```

--------------------------------

### GET Request Example

Source: https://help.poolparty.biz/en/poolparty-developer-guide/thesaurus---ontology-manager-api/thesaurus-services/concept-and-concept-scheme-management-services/web-service-method--request-a-concept-s-status.html

Example HTTP GET request to retrieve the status of a concept. The URL includes the project UUID and the concept URI as a query parameter.

```http
http://<server-url>/PoolParty/api/thesaurus/1DCE489D-9695-0001-E272-285217B0181E/getConceptStatus?concept=http://testserver.poolparty.biz/NeoGeo/5
```

--------------------------------

### Start PoolParty

Source: https://help.poolparty.biz/en/administrator-guide/poolparty-installation/preparing-the-poolparty-installation---upgrade/fresh-poolparty-installation.html

Starts PoolParty by executing the start command from the bin folder.

```bash
./poolparty start

```

--------------------------------

### Example Request for Get PoolParty Version

Source: https://help.poolparty.biz/en/poolparty-developer-guide/thesaurus---ontology-manager-api/system-services/web-service-method--get-poolparty-version.html

An example request to the Get PoolParty Version endpoint. Replace the server URL with your own PoolParty Thesaurus Server address.

```http
http://vocabulary.semantic-web.at/PoolParty/api/version
```

--------------------------------

### GET Request Example for Request Concept Notes

Source: https://help.poolparty.biz/en/poolparty-developer-guide/thesaurus---ontology-manager-api/thesaurus-services/notes-services/web-service-method--request-concept-notes.html

Example GET request to the Request Concept Notes endpoint using a specific project UUID and concept URI.

```http
http://<server-url>/PoolParty/api/thesaurus/bb2df837-7654-4c89-8994-d23f5468b56b/notes?concept=http://vocabulary.semantic-web.at/doku/Americas
```

--------------------------------

### Installation prompts for RecommenderWorkbench 2.0.1

Source: https://help.poolparty.biz/en/administrator-guide/poolparty-installation/poolparty-workbench-installation-and-upgrade.html

Shows the initial prompts when running the installer, including confirmation and choice between new installation or upgrade. Press 'o' or 'Enter' to confirm, 'c' to cancel.

```text
This will install RecommenderWorkbench 2.0.1 on your computer.
OK [o, Enter], Cancel [c]
>
Choose the appropriate option:
Install RecommenderWorkbench [1, Enter],
Upgrade an existing RecommenderWorkbench installation [2],
Cancel installation [c]
>

```

--------------------------------

### Example Response for Get PoolParty Version

Source: https://help.poolparty.biz/en/poolparty-developer-guide/thesaurus---ontology-manager-api/system-services/web-service-method--get-poolparty-version.html

Example response from the Get PoolParty Version endpoint. The response is a string containing the version number of the PoolParty Thesaurus Server.

```text
 9.0.1
```
Tokens:
Raw