Managing config.yaml properties

This section describes how to encrypt the config.yaml properties after making chnages in it.

Encrypting the config.yaml properties

This section describes how to encrypt the config.yaml properties for Linux A and Microsoft Windows:

Encrypting the config.yaml properties for Linux-A

Use these commands to encrypt config.yaml properties for Linux -A:

  • Link encryptproperty <property> <value>[<MKF key id>]

    If the key [<MKF key id>] is not specified, encrypt the <value> using the default key from the <DTXHOME>/config/configvar.mkf. If the file path for MKF is not changed, where [<MKF key id>] is an optional parameter. See masterKeyFile property for MKF file path in the server section of config.yaml.

    If you want to encrypt the password for mongo which is under auth section, the command:
    ./Link encryptproperty /mongo/auth/password <any password>

    It updates the password property with the encrypted value of the password.

  • Link encryptproperty -inplace <property>[<MKF key id>]

    If the key [<MKF key id>] is not specified, encrypt the <value> using the default key from the <DTXHOME>/config/configvar.mkf. If the file path for MKF is not changed, where [<MKF key id>] is an optional parameter. See masterKeyFile property for MKF file path in the server section of config.yaml.

    If the -inplace command is specified, the value argument is not required, the current value of the <property> will be encrypted.

    ./Link encryptproperty /mongo/auth/password

    The current value of the password property will be encrypted.

Encrypting the config.yaml properties for Windows

If you want to encrypt the password for mongo which is under auth section, run this command from <Link Installation location>\DesignServer.

C:\HCL\Link_1.1.5\DesignServer>enctyptproperty.bat - inplace/mongo/auth/password

Verifying the config.yaml file

This section describes how to verify the validity of your config.yaml file after making changes in it. When editing the config.yaml file, ensure that the modifications you make are valid. To verify the validity of your config.yaml file after making changes, perform one of the following procedures based on your setup:

Verifying the config.yaml file in Microsoft Windows

  1. Go to Link installation folder, create a config folder and copy your edited config.yaml file inside it.

    This command will check the configuration file for any errors and provide feedback on its validity.

  2. Open command line, run the following command:
    flowcmdserver.exe -v

    This command will check the configuration file for any errors and provide feedback on its validity.

  3. If the config.yaml file is valid, you should see an output similar to the following:
    HCL Link
**VERSION**
(c) Copyright IBM Corp. 2006, 2016 All rights reserved. (c) Copyright HCL Technologies Ltd. 2017, 2023 All rights reserved
Configuration loaded from <Program Data Folder>\config\config.yaml file

    This indicates that your configuration file is valid and successfully loaded.

  4. If there are any issues with the config.yaml file, you will receive an error message similar to the following:
    HCL Link
**VERSION**
(c) Copyright IBM Corp. 2006, 2016 All rights reserved. (c) Copyright HCL Technologies Ltd. 2017, 2023 All rights reserved.
Failed to load yaml file. illegal map value line=360 collumn=8 Configuration loaded from <Program Data Folder>\config\config.yaml file

    This error message will provide details about the specific problem in the configuration file.

Verifying the config.yaml file in Linux Native

  1. Go to Link installation folder and create a config folder and copy your edited config.yaml file inside it.
  2. Open command line, run the following command:
    flowcmdserver.exe -v

    If you receive following error message, then perform Step 3 through Step 6.

    ./bin/flowcmdserver: error while loading shared libraries: libdstxpi.so: cannot open shared object file: No such file or directory.
  3. Set the environment by running ../setup from <Link Installation Folder>/tomcat-context/install.
  4. Run the following command to test:
    HCL Link*****(1301)(c) Copyright IBM Corp. 2006, 2016 All rights reserved. (c) Copyright HCL Technologies Ltd. 2017, 2023 All rights reserved.Configuration loaded from <Link installation dir>/config/config.yaml file

    This indicates that your configuration file is valid and successfully loaded.

  5. If the config.yaml file is valid, you should see an output similar to the following:
    HCL Link*****(1301)(c) Copyright IBM Corp. 2006, 2016 All rights reserved. (c) Copyright HCL Technologies Ltd. 2017, 2023 All rights reserved.Configuration loaded from <Link installation dir>/config/config.yaml file

    This indicates that your configuration file is valid and successfully loaded.

  6. If there are any issues with the config.yaml file, you will receive an error message similar to the following:
    HCL Link******(1301)(c) Copyright IBM Corp. 2006, 2016 All rights reserved. (c) Copyright HCL Technologies Ltd. 2017, 2023 All rights reserved.Failed to load yaml file. illegal map value line=360 collumn=8Configuration file is <Link installation dir///config/config.yaml

    This error message will provide details about the specific problem in the configuration file.

Verifying the config.yaml file in Linux Docker

  1. Enter the hip-server container and go to /opt/hcl/hip. For the hip-rest container, go to /opt/runtime.
  2. Run the following command:
    flowcmdserver -v

    This command will check the configuration file for any errors and provide feedback on its validity.

  3. If the config.yaml file is valid, you should see an output similar to the following:
    • For hip-server:
      root@c60fa85561aa:/opt/hcl/hip/bin# ./flowcmdserver -v 
HCL Link 
10.9.9.9(1206) 
(c) Copyright IBM Corp. 2006, 2016 All rights reserved. (c) Copyright HCL Technologies Ltd. 2017, 2023 All rights reserved. 
Configuration loaded from /opt/hcl/hip//config/config.yaml file
    • For hip-rest:
      root@c60fa85561aa:/opt/runtime/bin# ./flowcmdserver -v 
HCL Link 
10.9.9.9(1206) 
(c) Copyright IBM Corp. 2006, 2016 All rights reserved. (c) Copyright HCL Technologies Ltd. 2017, 2023 All rights reserved. 
Configuration loaded from /opt/runtime//config/config.yaml file

      This indicates that your configuration file is valid and successfully loaded.

  4. If there are any issues with the config.yaml file, you will receive an error message similar to the following:
    • For hip-server:
      root@018b758fe98d:/opt/hcl/hip/bin# ./flowcmdserver -v 
HCL Link 
10.9.9.9(1206) 
(c) Copyright IBM Corp. 2006, 2016 All rights reserved. (c) Copyright HCL Technologies Ltd. 2017, 2023 All rights reserved. 
Failed to load yaml file. bad file: /config/config.yaml line=0 collumn=0 
Configuration file is /config/config.yaml
    • For hip-server:
      root@018b758fe98d:/opt/runtime/bin# ./flowcmdserver -v 
HCL Link 
10.9.9.9(1206) 
(c) Copyright IBM Corp. 2006, 2016 All rights reserved. (c) Copyright HCL Technologies Ltd. 2017, 2023 All rights reserved. 
Failed to load yaml file. bad file: /config/config.yaml line=0 collumn=0 
Configuration file is /config/config.yaml

    This error message will provide details about the specific problem in the configuration file.

    Note: Make sure to carefully review any error messages and correct the issues in your config.yaml file accordingly. This step is essential to ensure the proper functioning of your system after making changes.