Modifying Configuration Files

For Directory Sync 3.0.0 and later, syntax check for configuration files (config.yml, secret.yml) in YAML format has become stricter.
For this reason, an error may occur when a configuration file is read if there is a grammatical error in its description, even if the configuration file can be used for a version earlier than Directory Sync 3.0.0.

When updating your current version to Directory Sync 3.0.0 or later, check whether configuration files are described with correct syntax, and if there are descriptions with incorrect syntax, correct them in advance.

Example: Describing Arrays

When describing an array using a hyphen (-), you can no longer describe the value on the same line as the key.

iid:
  scim:
    attribute:
      user:
        convert:
          externalUserName: - pattern:     '@example.com' # Description that cannot be used
                              replacement: '@example.jp'

In such a case shown above, insert a new line first, and then describe the value.

iid:
  scim:
    attribute:
      user:
        convert:
          externalUserName:
            - pattern:     '@example.com' # Start a new line and then describe the array element
              replacement: '@example.jp'

How to Check Whether Configuration Files Can Be Used with Directory Sync 3.0.0 or Later

Use the following procedure to check.

1. Install Directory Sync 3.0.0 or a later version.
   Refer to "Update Procedure" for information on the update procedure.
   To check the update procedure before updating, prepare another Windows Server terminal and install Directory Sync 3.0.0 or a later version. Refer to "Installation Procedure" for information on the installation procedure.
   
   
2. Set up configuration files you are using.
   Refer to "File Structure" for the setup location.
   
   
3. Run "normal_mode_dry_run.bat", which is a test script.
   It is a normal test-mode executable file. Even if this script is run, a request will not be sent to the IIJ ID Service for differential data, and the cache will not be updated.
   Refer to "Types of Executable Files"" for types of executable files.
   
   
4. Check the execution results with event logs.
   Refer to "Viewing Logs" for how to view logs.

If no error is recorded in the event logs, the relevant configuration files can be used with Directory Sync 3.0.0 and later versions.
If the following errors are recorded in sets, there is a possibility that a syntax error exists in descriptions of the configuration files. Check the details of the error messages and correct the descriptions on the relevant line.

• [1] Event ID: 14595 ([Overview] Program Exit Error.)
• [2] Event ID: 12289 ([Overview] Config error.)