Setup (using Docker)

About the Docker version of Pleasanter¶

This is a procedure for using the official Pleasanter Docker image published on Docker Hub.

implem/pleasanter - Docker Image | Docker Hub
https://hub.docker.com/r/implem/pleasanter

Overview¶

This explains the setup and startup procedures for "Operations Tools".

Restrictions¶

1. Operations Tools cannot be used with MySQL.

Prerequisites¶

1. This procedure assumes that Pleasanter has been upgraded to Enterprise Edition.

Operation Procedure¶

1. Deploying resources
2. Building and starting a container image

Operation Procedure¶

1. Deploying resources¶

1. Unzip "OperationsTools_x.x.x.zip" downloaded from the Operations Tools Releases page.

2. Change the name of the folder "OperationsTools_x.x.x" to "OperationsTools" and create the following folder structure.

   .
   +-- OperationsTools
       +-- ExtendedLibraries
       +-- wwwroot
   

3. Run the following command to stop the container.

   docker compose stop
   

4. Place the "OperationsTools" folder under the container's base folder (in the same location as the "Pleasanter" and "CodeDefiner" folders).

5. Open "\OperationsTools\ExtendedLibraries\OperationsTools\App_Data\Parameters\General.json" with any editor.

6. Specify the login IDs of users who can use the Operations Tools in the Login.Users array format.

   Example)
   General.json: Before modification
   

   {
      "SetupPassword": "operations-tools",
       "Login": {
           "Users": [ "Administrator" ]
       },
       "PageSize": 50,
       "SQLCommandTimeout": 240,
       "DefaultParametersDir": "DefaultParameters"
   }
   

   General.json: After modification
   

   {
      "SetupPassword": "operations-tools",
       "Login": {
           "Users": [ "Administrator", "AdminUser1", "AdminUser2" ]
       },
       "PageSize": 50,
       "SQLCommandTimeout": 240,
       "DefaultParametersDir": "DefaultParameters"
   }
   

   *For details on the OperationsTools parameter files, please refer to the supplementary notes "Parameter: General.json" and "Parameter: BackgroundService.json".

7. Place the default parameter JSON file (all files) for the version of Pleasanter you are using under the "\OperationsTools\ExtendedLibraries\OperationsTools\App_Data\DefaultParameters" folder.

   Example of placement location:
   \OperationsTools\ExtendedLibraries\OperationsTools\App_Data\
   　└ DefaultParameters\
   　　├ Api.json　★Place
   　　├ Authentication.json　★Place
   　　├ ・・・　★Place all parameter files
   

   Note
   By placing it under the DefaultParameters folder, you can compare the differences in the parameter list screen described below.

   If you do not have the parameter JSON file before the change, download it from the GitHub release page.
   https://github.com/Implem/Implem.Pleasanter/releases

8. Open "\Pleasanter\Dockerfile" with any text editor and modify it as follows.

   ARG VERSION=latest
   FROM implem/pleasanter:${VERSION}
   
   COPY app_data_parameters/ App_Data/Parameters/
   COPY OperationsTools/ExtendedLibraries/ ExtendedLibraries/
   COPY OperationsTools/wwwroot/operations-tools wwwroot/operations-tools/
   COPY Implem.License.dll .
   ENTRYPOINT [ "dotnet", "Implem.Pleasanter.dll" ]
   

   Note
   When upgrading the Operations Tools, stop the container, delete the "\OperationsTools" folder, and then perform steps 1 to 8 above.

Parameter: About General.json¶

These are parameters related to common settings. Each parameter is explained below.

Parameter: About BackgroundService.json¶

This parameter is related to the process of synchronizing the intermediate table for data display in the background. The explanation of each parameter is as follows.

2. Build and start the container image¶

1. Execute the following command to build the container image.

   docker compose build
   

2. Run the following command to recreate and restart the Pleasanter container that contains the OperationsTools resources.

   docker compose up -d pleasanter
   

3. Access the following URL.

   http://localhost:50001/operations-tools/admin
   

   

4. Enter the password and click the set up button.

   Note
   The password is the value of SetupPassword set in General.json (the default is "operations-tools").

5. The message "Setup in progress. Please wait." is displayed.
   

6. When the message "Setup is complete" is displayed, the setup is complete.
   

   Note
   The above operation creates a set of tables for Operations Tools (tables with the prefix "_eot").

   Note
   The display data for some screens is created in an intermediate table when the setup is performed, and is synchronized in the background at the time specified by the IntermediateTableSynchronize.RunTime parameter in the Operations Tools' BackgroundService.json. If you want to see the most recent data, press the "Update Display Data" button to manually synchronize the data.

Troubleshooting¶

Q. When accessing the management page, the following message is displayed: "The license file is not configured correctly or is invalid."

A. Please make sure that a valid license file is placed in the Pleasanter main unit.

Q. Results such as detailed information are not displayed for some screens.

A. Depending on the amount of data in the target environment, the setup process may be interrupted by a timeout, and the results of some screens may not be displayed. In that case, please try the following procedure.

＜Steps＞
1. Stop the container.

```text
docker compose stop
```

1. Adjust the value of "SQLCommandTimeout" in the Operations Tools parameter file: General.json.

   {
      "SetupPassword": "operations-tools",
       "Login": {
           "Users": [ "Administrator", "AdminUser1", "AdminUser2" ]
       },
       "PageSize": 50,
       "SQLCommandTimeout": 240,  <-- Adjust the value
       "DefaultParametersDir": "DefaultParameters"
   }
   

2. Execute the following command.

   docker compose build
   

3. Execute the following command.

   docker compose up -d pleasanter
   

4. Click the "Update displayed data" button on the Operations Tools management page screen.

5. Check the log in the [_eot_JobHistory] table and confirm the contents of Status, ErrMessage, and ErrStackTrace.
   (If Status is 'Success' and ErrMessage and ErrStackTrace are blank, it is a success.)

Related Information¶

• Operations Tools Releases page