Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

IMPORTANT NOTES

Note

No components of MettleCI or S2PX are officially supported on macOS, however there is no reason why the Java-based MettleCI Command Line Interface should not be able to execute on a suitably-specified macOS environment. Both of the S2PX plugins have been used with success on macOS platforms, but have not been formally tested or released on that platform.

Warning

NOTE THAT NOT ALL PLUGINS WILL WORK! Some of the MettleCI non-S2PX CLI plugins rely on access to co-resident DataStage Client Tier components , which are themselves only available on a Windows platform. Using one of these plugins on a macOS platform may produce unpredictable and undocumented results. See ‘Windows-Only Commands’ on this page for more details.

Installing S2PX on macOS

Much of this is the same as the regular MettleCI CLI installation process, except with macOS we start with the

Status
colourBlue
titleWindows
distributable.

  1. Download the

    Status
    colourBlue
    titleWindows
    S2PX Command Shell distributable (e.g. dm-mettleci-command-shell-1.1-205-dist.zip)

  2. Unzip it to a convenient location and rename the folder to something memorable like mettleci.

  3. You should now have a directory like this…

    Code Block
    $> tree /Users/johnmckeever/mettleci
    /Users/johnmckeever/mettleci
    ├── bin
    │   ├── bcpg-jdk15on-1.67.jar
    │   ├── bcprov-jdk15on-1.67.jar
    │   └── command-shell-1.1-133.jar
    ├── config.properties
    ├── docs
    │   <SNIP>
    ├── lib
    │   ├── commons-io-2.5.jar
    │   ├── commons-lang-2.6.jar
    │   ├── commons-lang3-3.10.jar
    │   ├── org.eclipse.emf.common-2.18.0.jar
    │   ├── org.eclipse.emf.ecore-2.21.0.jar
    │   └── org.eclipse.emf.ecore.xmi-2.16.0.jar
    ├── log
    │   └── stdout.log
    ├── mettleci
    ├── mettleci-debug
    ├── mettleci-debug.cmd
    ├── mettleci.cmd
    └── plugins
        ├── dm-bamboo-sftp-plugin-1.0-47.jar
        ├── dm-ccmigrate-plugin-1.0-335.jar
        ├── dm-compliance-plugin-2.1-364.jar
        ├── dm-dsadmin-plugin-1.0-448.jar
        ├── dm-dscompile-plugin-1.0-522.jar
        ├── dm-dsdeploy-plugin-1.0-634.jar
        ├── dm-dsexecute-plugin-1.0-385.jar
        ├── dm-dsmsgh-plugin-1.0-45.jar
        ├── dm-dstest-plugin-1.0-374.jar
        ├── dm-isxexport-plugin-1.0-575.jar
        ├── dm-isximport-plugin-1.0-538.jar
        └── dm-properties-config-plugin-1.0-178.jar
    
    12 directories, 77 files
  4. Add executable permissions to the file mettleci

    Code Block
    $> chmod u+x mettleci
    $> ls -l
    total 40
    -rw-r-----@  1 johnmckeever  staff   1.4K 18 May 11:09 mettleci.cmd
    -rw-r-----@  1 johnmckeever  staff   1.5K 18 May 11:09 mettleci-debug.cmd
    -rw-r-----@  1 johnmckeever  staff   1.6K 18 May 11:09 mettleci-debug
    -rwxr-----@  1 johnmckeever  staff   1.5K 18 May 11:09 mettleci
    -rw-r-----@  1 johnmckeever  staff   1.2K 18 May 11:09 config.properties
    drwxrwxrwx@  8 johnmckeever  staff   256B 18 May 11:09 lib
    drwxrwxrwx@  5 johnmckeever  staff   160B 18 May 11:09 bin
    drwxr-x---@ 14 johnmckeever  staff   448B 18 May 11:13 plugins
    drwxr-x---@  3 johnmckeever  staff    96B 18 May 11:13 log
    drwxrwxr-x@  9 johnmckeever  staff   288B 18 May 11:13 docs
    $>
  5. Copy your MettleCI license file (mettleci.lic) into your directory

  6. Edit the config.properties file to point to your MettleCI license file.

    1. Be careful if you’re using a relative path in your config.properties file to point to your license file. This is a common source of error.

    2. Ensure the MettleCI license file has both read and write permissions.

  7. Download the two S2PX plugins and place them in your plugins directory.

  8. Test it. The Command failed messages in the examples below means you didn't provide all the required options for each command.

    Code Block
    $> ./mettleci s2px analysis
    MettleCI Command Line (build 133)
    (C) 2018-2022 Data Migrators Pty Ltd
    The following options are required: -isx -report
    Usage: s2px analysis [options]
      Options:
      * -isx
           the ISX extract or directory of extracts to be analysed
      * -report
           output report (XLSX)
    
    Command failed.
    
    $> ./mettleci s2px convert
    MettleCI Command Line (build 133)
    (C) 2018-2022 Data Migrators Pty Ltd
    The following options are required: -target-dsx -source-dsx -config
    Usage: s2px convert [options]
      Options:
      * -config
           Path to server to parallel configuration file
      * -source-dsx
           Source DSX export to be converted from server to parallel
      * -target-dsx
           Target DSX that will contain all converted jobs
    
    Command failed.
    
    $>
  9. Done 🙂