Column Expansion Procedure (using Docker)

About the Docker version of Pleasanter¶

These are steps to use the official Pleasanter Docker image published on Docker Hub.

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

Overview¶

In the Community Edition, you can use 26 columns each category (Class Column, Numeric Value Column, Date Column, Description Column, Check Column, and Attachment Column) for a total of 156 columns, but you can expand the columns in the Enterprise Edition.

Extended columns are created with consecutive numbers starting from "001" (class 001, class 002, etc.).
Follow this procedure if you want to expand columns or change the number of expanded columns.

Notes¶

When you expand columns, the table structure of the time-limited table (Issues table) and record table (Results table) will change. In particular, when you reduce the number of columns, the columns themselves will be deleted from the table, so the data registered in the columns added by the column expansion will disappear. Be sure to make a backup before expanding columns.

Prerequisites¶

This procedure assumes that you have upgraded Pleasanter to Enterprise Edition.

Operation Procedure¶

1. Stop the container
2. Back up the database
3. Edit and store Issues.json and Results.json
4. Build the container image
5. Run CodeDefiner
6. Check the column expansion

Operation Procedure¶

1. Stop the container¶

1. Run the following command.

docker compose stop

2. Back up the database¶

1. Back up the database according to your environment. Please also refer to our online manual.
   
   ・FAQ: PostgreSQL database backup and restore procedure (using Docker)
   
   ・FAQ: MySQL database backup and restore procedure (using Docker)
   

3. Edit and store Issues.json and Results.json¶

1. Download the same version of the Pleasanter module you want to run from the Download Center.
2. Unzip the zip file.
3. Copy the following folders from the unzipped folder to the destination folder for Docker resources.
   
   ・Folder to copy: Copy the \pleasanter\Implem.Pleasanter\App_Data\Parameters\ExtendedColumns folder
   
   ・Destination: Place in the \app_data_parameters folder and create the \app_data_parameters\ExtendedColumns folder
   
   

4. Edit Issues.json and Results.json in the destination ExtendedColumns folder.
   

5. Issues.json: Time-limited table
   json { "TableName": "Issues", "ReferenceType": "Issues", "Class": 0, "Num": 0, "Date": 0, "Description": 0, "Check": 0, "Attachments": 0 }

6. Results.json: Record table
   

   {
      "TableName": "Results",
      "ReferenceType": "Results",
      "Class": 0,
      "Num": 0,
      "Date": 0,
      "Description": 0,
      "Check": 0,
      "Attachments": 0
   }
   

7. Setting contents

   Column	Content
   Class	Number of columns to add to Class columns
   Num	Number of columns to add to Numeric value columns
   Date	Number of columns to add to Date columns
   Description	Number of columns to add to Description columns
   Check	Number of columns to add to Check columns
   Attachments	Number of columns to add to Attachment columns

4. Build container image¶

1. Run the following command.

docker compose build

5. Run CodeDefiner¶

1. Run the following command.
2. Only when using Docker images, the /l and /z arguments are required for the upgrade command.

docker compose run --rm codedefiner _rds /l "<language>" /z "<timezone>"

(*1) For language and timezone, please refer to the following manual page.
FAQ: I want to know the parameter settings for languages and timezones supported by Pleasanter

If you are using a Japanese environment, use the following command.

docker compose run --rm codedefiner _rds /l "en" /z "UTC"

If the message "Type "y" (yes) if the license is correct, otherwise type "n" (no)" appears during the process, enter y.

Note that in version 1.4.8 and later, a message will appear stating that it is "Enterprise Edition", so please confirm.
*The Licensee in the license information may be garbled depending on the CLI used.

In addition, in version 1.4.8 and later, if the number of columns used for the extension is reduced when CodeDefiner is executed, the error message "Configurator.CheckColumnsShrinkage: The columns will be shrinked." will be displayed and the process will end, and CodeDefiner will not be executed. If an error occurs, the columns to be reduced will be displayed as shown below, so please check again whether the parameter file and license are applied correctly.

If you want to allow reduction of columns in version 1.4.8 or later, specify the argument "/f" and run it.

docker compose run --rm codedefiner _rds /l "en" /z "UTC" /f

6. Check column expansion¶

1. Run the following command to recreate and restart the container with the added columns.

docker compose up -d pleasanter

1. Access with a browser and log in.
   
   ・http://localhost:50001
2. Log in to Pleasanter, open any table, and in the navigation menu, go to "Manage" - "Manage Table" and in the "Editor" tab, confirm that the expanded columns (Class 001, Number 001, etc.) are displayed in the list of options.

Related Information¶

• Manage Table: Items: Class
• Manage Table: Items: Date
• Manage Table: Items: Check
• Download Center