SoftExpert Capture service

SoftExpert provides a service to perform recognition and indexing for SoftExpert Capture. When this service is not configured, SoftExpert Capture batches will not go to the next step.

Refer to the following topics to see how to configure this service:

▪SoftExpert Capture service (HTTPS)

▪SoftExpert Capture service (HTTP)

▪ SoftExpert Capture service running together with SoftExpert Suite

SoftExpert Capture service (HTTPS)

This topic will show how to configure the SoftExpert Capture service with HTTPS protocol on port 8586.

In order to take the steps below, you must:

info

Have the .pfx SE certificate file and its password.

info

Run the commands below as root.

1. Create the secaptureservice directory:

mkdir /usr/local/se/secaptureservice

2. Access the secaptureservice directory:

cd /usr/local/se/secaptureservice

3. Create the docker-compose.yml file inside the secaptureservice directory:

vim docker-compose.yml

4. Paste the following text:

secaptureservice:
  container_name: secaptureservice
  image: softexpert/secaptureservice:latest
  extra_hosts:
    - <SEAccessURL>:ServerIP
  environment:
   - ASPNETCORE_URLS=https://+:443;
   - ASPNETCORE_Kestrel__Certificates__Default__Password=${CERTIFICATE_PASSWORD}
   - ASPNETCORE_Kestrel__Certificates__Default__Path=/https/${CERTIFICATE_NAME}
  ports:
   - "${HTTPS_PORT}:443"
  volumes:
   - ./cert:/https:ro
   - ./log:/app/log/
deploy:
   resources:
     limits:
       memory: 4G

5. Locate the extra_hosts parameter.

6. Enter the SoftExpert access URL and the local IP of the application server, as shown in the following image:

7. Create the cert directory:

mkdir /usr/local/se/secaptureservice/cert

8. Paste the .pfx certificate file to the /usr/local/se/secaptureservice/cert directory and save it with the name certificate.pfx.

9. Create the capture.env file inside the secaptureservice directory:

Vim capture.env

10. Insert the text below, indicating the port that will be used for the HTTPS connection, and enter the certificate password in the CERTIFICATE_PASSWORD= parameter:

CERTIFICATE_NAME=certificate.pfx

CERTIFICATE_PASSWORD=enter password here

HTTPS_PORT=8586

By default, the port used for HTTPS connection is 8586, but it is possible to set a different port if the default one is already being used. In this case, use the netstat -lnp | grep "8586" command to check whether the port is being used.

11. Start the SoftExpert Capture service using the command below:

cd /usr/local/se/secaptureservice/ ; docker-compose --env-file capture.env up -d

To stop the service, execute the command below:

cd /usr/local/se/secaptureservice/ ; docker-compose --env-file capture.env down

To check whether the secaptureservice service is up, run the command below:

docker ps

12. Once this is done, access the SoftExpert Document component > Configuration > General parameters (DC035) and point the service in the application by entering https://serverIP:8586 in the Enable SoftExpert Capture service redirection > Server field.

13. Then, run the connection test and save.

SoftExpert Capture service (HTTP)

This topic will show how to configure the SoftExpert Capture service with HTTP protocol on port 8587. To do that, take the following steps:

1. Create the secaptureservice directory:

mkdir /usr/local/se/secaptureservice

2. Access the secaptureservice directory:

cd /usr/local/se/secaptureservice

3. Create the docker-compose.yml file inside the secaptureservice directory:

vim docker-compose.yml

4. Paste the following text:

version: '3.7'

services:
 secaptureservice:
  container_name: secaptureservice
  image: softexpert/secaptureservice:latest
  networks:
   - senetwork
  ports:
   - "${HTTP_PORT}:80"
  extra_hosts:
   - SEAccessURL:ServerIP
 deploy:
   resources:
     limits:
       memory: 4G

5. Locate the extra_hosts parameter.

6. Enter the SoftExpert access URL and the local IP of the application server, as shown in the following image:

7. Save the changes with:

wq!:

8. Create the capture.env file inside the secaptureservice directory:

Vim capture.env

9. Insert the following text, indicating the port that will be used for connection:

HTTP_PORT=8587

By default, the port used for HTTP connection is 8587, but it is possible to set a different port, if the default one is already being used. In this case, run the netstat -lnp | grep "8587" command to check whether the port is being used.

10. Start the SoftExpert Capture service using the command below:

cd /usr/local/se/secaptureservice/ ; docker-compose --env-file capture.env --compatibility up -d

To stop the service, execute the command below:

cd /usr/local/se/secaptureservice/ ; docker-compose --env-file capture.env down

To check whether the secaptureservice service is up, run the command below:

docker ps

11. Once this is done, access the SoftExpert Document component > Configuration > General parameters (DC035) and point the service in the application by entering https://serverIP:8587 in the Enable SoftExpert Capture service redirection > Server field.

12. Then, run the connection test and save.

SoftExpert Capture service running together with SoftExpert Suite

This topic will show how to set up the SoftExpert Capture service to run together with SoftExpert Suite.

1. Edit the docker-compose.yml file and add the content below:

secaptureservice:
    container_name: secaptureservice
    image: softexpert/secaptureservice:latest
networks:
    - senetwork

2. Restart SoftExpert Suite.

3. Once this is done, access the SoftExpert Document component > Configuration > General parameters (DC035) and point the service in the application by entering http://secaptureservice in the Enable SoftExpert Capture service redirection > Server field.