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

Procedure

  1. Go to Link installation folder, create a config folder and copy your edited config.yaml file inside it.
  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.

    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.

Verifying the config.yaml file in Linux Native

Procedure

  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. Export LD_LIBRARY_PATH=<Link Installation Folder>/tomcat-context/install/libs.
  4. Export DTX_DATA_DIR=<Link Installation Folder>/tomcat-context/install.
  5. Go to <Link_installation_dir>/bin and open command line.
  6. Run the following command: 
    ./flowcmdserver -v

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

  7. 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.

  8. 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.

    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.

Verifying the config.yaml file in Linux Docker

Procedure

  1. Go to hip-server container/opt/hcl/hip/bin for hip-server and hip-rest container/opt/runtime/bin folder for hip-rest.
  2. Export DTX_DATA_DIR=/opt/hcl/hip and DTX_DATA_DIR=/opt/runtime/bin.
  3. Open command line, run the following command: 
    flowcmdserver -v
    This command will check the configuration file for any errors and provide feedback on its validity.
  4. 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.

  5. 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.