This document includes the next methods of PC deploying:

in Docker containerisation environmrnt;
with installation script.

Optional modules is object of licensing. Before installation, please check, which modules included in shipment for install only licensed modules for the purpose of rational computer resources consumption.

Before installation

DB preparing

PC supports the next DBMS: Postgres, Oracle, MS SQL.

Before installation is must to create PCS database and PCSS database (in case if Server Signer component will be installed).

Create database user with CRUD + Alter access privileges, whoose credentials will be used by PC to connect to created databases.

You should not to create any database structure. PC will create it automatically.

Docker

Images

Images includes JRE and PC module jar-file.

PCS: registry.paycontrol.org/pc/pc-server:6
PCE: registry.paycontrol.org/pc/pc-external:6
PCP: registry.paycontrol.org/pc/pc-pusher:6
PCCRT: registry.paycontrol.org/pc/pc-crt:6
PCSS: registry.paycontrol.org/pc/pc-server-signer:6

Environments

SPRING_CONFIG_ADDITIONAL_LOCATION Module configuration file path. Example: file:/opt/app/etc/application.yml.

PCS

SPRING_DATASOURCE_URL — PCS DB connection string. Example for PostgreSQL: jdbc:postgresql://dbserver.loc:5432/db_pcs;
SPRING_DATASOURCE_USERNAME — PCS DB username;
SPRING_DATASOURCE_PASSWORD — PCS DB password.

PCE

PC_EXTERNAL_SERVER_URL — PCS module API endpoint address. Usually ends with pc-api/.

PCCRT

PC_CRT_PCSURL — PCS module API endpoint address. Usually ends with pc-api/, which must be accessible from Conflict Resolving Tool operator's workstation.

PCSS

SPRING_DATASOURCE_URL — PCSS DB connection string. Example for PostgreSQL: jdbc:postgresql://dbserver.loc:5432/db_pcss;
SPRING_DATASOURCE_USERNAME — PCSS DB username;
SPRING_DATASOURCE_PASSWORD — PCSS DB password.
PC_SIGNER_PCSURL — PCS module API endpoint address. Usually ends with pc-api/.
PC_SIGNER_URL — PCSS module API endpoint address, which will be used for call Server Signer to confirm transaction. Usually ends with pc-server-signer-api/confirm_async/.

Пример docker-compose.yml

services:
  pcs:
    restart: unless-stopped
    image: registry.paycontrol.org/pc/pc-server:6
    ports:
      - "8080:8080"
    environment:
      - SPRING_DATASOURCE_USERNAME=${PCS_DB_USER}
      - SPRING_DATASOURCE_PASSWORD=${PCS_DB_PASSWORD}
      - SPRING_DATASOURCE_URL=${PCS_DB_CONNECTION_URL}
    healthcheck:
      test:
        [
          "CMD-SHELL",
          "wget -q -O - --no-verbose --tries=1 http://localhost:8080/pc-api/health_check | grep -q 'PC Server' || exit 1",
        ]
      interval: 5s
      timeout: 5s
      retries: 20

  pce:
    restart: unless-stopped
    image: registry.paycontrol.org/pc/pc-external:6
    ports:
      - "8081:8081"
    depends_on:
      pcs:
        condition: service_healthy
    environment:
      - PC_EXTERNAL_SERVER_URL=http://pcs:8080/pc-api/
    healthcheck:
      test:
        [
          "CMD-SHELL",
          "wget -q -O - --no-verbose --tries=1 http://localhost:8081/pc-client-api/health_check | grep -q 'PC External' || exit 1",
        ]
      interval: 5s
      timeout: 5s
      retries: 20

  pcp:
    restart: unless-stopped
    image: registry.paycontrol.org/pc/pc-pusher:6
    healthcheck:
      test:
        [
          "CMD-SHELL",
          "wget -q -O - --no-verbose --tries=1 http://localhost:8082/pc-pusher-api/health_check | grep -q 'PC Pusher' || exit 1",
        ]
      interval: 5s
      timeout: 5s
      retries: 20

  pccrt:
    restart: unless-stopped
    image: registry.paycontrol.org/pc/pc-crt:6
    ports:
      - "8084:8084"
    depends_on:
      pcs:
        condition: service_healthy
    environment:
      - PC_CRT_PCSURL=http://pcs_address_accessible_from_admin_workspace/pc-api
    healthcheck:
      test:
        [
          "CMD-SHELL",
          "wget -q -O - --no-verbose --tries=1 http://localhost:8084/pc-crt/health_check | grep -q 'PC Conflicts Resolving Tool' || exit 1",
        ]
      interval: 5s
      timeout: 5s
      retries: 20

  pcss:
    restart: unless-stopped
    image: registry.paycontrol.org/pc/pc-server-signer:6
    environment:
      - PC_SIGNER_PCSURL=http://pcs:8080/pc-api/
      - PC_SIGNER_URL=http://pcss:8083/pc-server-signer-api/confirm_async/
      - SPRING_DATASOURCE_USERNAME=${PCSS_DB_USER}
      - SPRING_DATASOURCE_PASSWORD=${PCSS_DB_PASSWORD}
      - SPRING_DATASOURCE_URL=${PCSS_DB_CONNECTION_URL}
    healthcheck:
      test:
        [
          "CMD-SHELL",
          "wget -q -O - --no-verbose --tries=1 http://localhost:8083/pc-server-signer-api/health_check | grep -q 'PC Server Signer' || exit 1",
        ]
      interval: 5s
      timeout: 5s
      retries: 20

Linux

Installation script could deploy PC on Linux-based servers automatically.

For functioning PC requires JRE 17 or JRE 21. Please provide it before start of installation process.

PCv6 ships as separate package for each PC module — here. Default installation directory is '/opt/pc/', and for each module will be created it's own subdirectory.

User, who starts installation process must have root-privileges, or operate as root-user.

For PC module installation you need:

unarchive module package;
modify application.yml with actual values for you infrastructure;
if required, you may change installation path in install.conf file with set value to PC_INSTALL_DIR variable;
start installation with `./install.sh.

As a result of installation process will:

cerated installation directory;
copied PC modules files to install directory;
copied configuration file to install directory;
created and started service;
switched on autostart for service.

After installation

Check services availability

Each PC module has health check endpoint, which returns module name, it's version and API version:

PC Server — http://<IP or DNS-name of PC Server>:8080/pc-api/health_check
PC External — http://<IP or DNS-name of PC External>:8081/pc-client-api/health_check
PC Pusher — http://<IP or DNS-name of PC Pusher>:8082/pc-pusher-api/health_check
PC CRT — http://<IP or DNS-name of PC CRT>:8084/pc-crt/health_check
PC Server Signer — http://<IP or DNS-name of PC Server Signer>:8083/pc-server-signer-api/health_check

PC API

As default PCS API endpoint located at http://<host>:8080/pc-api/.

Application system registration

After installation PCS as first step of interaction with it, you must to register your Application system with Application system register request obtained from PC Vendor or Distributor.

For registration you need to send HTTP POST request to PCS API Endpoint with content of Application system register request in body with cURL, Postman and etc.

Example of registration with cURL

curl --location --request POST 'http://<IP or DNS-name of PC Server>:<port>/pc-api/' --header 'Content-Type: application/json' --data '{"request":"eyJyZXF1ZXN0Ijp7InFyVVJMU2NoZW1lIjEE9NoZ+W1lIjEE9NoZW1lIjEE9... ...IjEE9NoZW1lIjEE9PSJ9"}'

Registration result

At response of registration request information of registered Application system will be returned, and, especially application system ID.

In the next example application system id is e64a67c9-73e9-462c-9c27-2d0195a2bd23. Store it, because it needed to make most part of API calls. If you lost this value, you may ask it the Product Vendor or Distributor.

Example

    {
        "answer_type": "system_info",
        "answer": {
        "result": {
            "error_message": "Success",
            "error_code": 0
        },
        "system_info": {
            "billing_period": 365,
            "system_id": "e64a67c9-73e9-462c-9c27-2d0195a2bd23",
            "description": "Bank1 Payments",
            "report_template_path": "/opt/app/report.docx",
            "created_at": "2020-03-23 12:34:1.895",
            "pc_is_external_url": "https://bank1.example.com/pc-client-api/",
            "register_request": "eyJyZXF1ZXN0I...Xc9PSJFSSZEhTQUFKRXc9PSJEhTQUFKRXc9PSZXN0Ijp7InFyVJ9",
            "pc_is_internal_url": "http://localhost:8080/pc-pusher-api/",
            "is_deleted": false,
            "license_info": {
                "users_count": 20,
                "used": 0,
                "message": "LICENSE NOT FOUND! You are using unlicensed demo-only version of the service"
            },
            "billing_type": 3,
            "user_keys_expiration_period": 365,
            "name": "Bank1"
        }
    },
    "answer_version": 3
}

PC components addresses changing (in case of necessary)

PCS module address correction

In case if you move PCS to another host, you must set new address of PCS in configuration params of Application system and of the next PC components:

PCE, parameter pc.external.server.url;
PCCRT, parameter pc.crt.pcs-url;
PCSS, parameter pc.signer.pcs-url.

PCP module address correction

PC Pusher address can be changed by HTTP PATCH-request request sent to PCS API to {{pc-server-api}}/{{system_id}} endpoint, with desired address as value for pc_is_internal_url parameter. More details by link. Example of request body:

{
    "pc_is_internal_url":"http[s]://<HOSTNAME or IP>[:PORT]/pc-pusher-api/",
}

Also PCP address may be seted via Conflict Resolving Tool (at presence).

PCE module address correction (Mobile App requests address)

PC Pusher address can be changed by HTTP PATCH-request request sent to PCS API to {{pc-server-api}}/{{system_id}} endpoint, with desired address as value for pc_is_external_url parameter. More details by link. Example of request body:

{
    "pc_is_external_url":"http[s]://<External IP or DNS-name PC>[:PORT]/pc-client-api/",
}