Skip to main content

Version: 22.10

Maestro SCM Quick Start

This guide is a quick walkthrough performing Maestro Source Code Management (SCM) using the T-CLI command line tool to sync content between your local file system and a Maestro server.

Prior to undertaking this exercise, you need to obtain the T-CLI jar file from the tools folder of the unzipped SDK distribution. Follow the initial steps in Setup Journey SDK, until the distribution is unzipped.

The instructions below will guide you through the following steps.

  • Create and build a new project and form in Maestro with some deliberate mistakes.
  • Start T-CLI.
  • Connect T-CLI to your Maestro server.
  • Pull the Maestro project into the file system.
  • Edit the form.json code to correct the deliberate mistakes.
  • Push the corrected form back into Maestro.
  • Render the form again to verify the fixes have been deployed correctly.

Start T-CLI and connect to Maestro

Here we start T-CLI and connect to a Maestro server.

  1. Open a command prompt or a terminal session in your SCM folder.

  2. Run the T-CLI executable.

  3. Connect to your Maestro server with scm connect.

    cd \Development\CLI
    java -jar transact-cli-22.10.0.jar
    scm connect localhost
  4. Provide your credentials.

Pull the Maestro project down to the local filesystem

Here we copy the scm command from the Maestro Management Dashboard and paste it into the T-CLI session.

  1. In Maestro, select the form project in the Navigator.

  2. Copy the SCM Clone command to the clipboard.

  3. In the T-CLI session, paste the command and press Enter.

Correct the errors in the form.json file

An error has been identified in the form, and here we fix it locally by editing the form.json file.

  1. Locate the form.json file that has been saved to the local filesystem.

  2. Edit the file in your preferred text editor.

  3. Correct all 'Namee' strings to 'Name', including the id and path property values.

  4. Save the form.json file.

Push the corrections back into Maestro

Here we push the corrected form back into Maestro.

  1. Change into the project directory - it will be three levels below where the scm clone command was issued from.

  2. Issue the following commands:

    • scm project status - This shows there has been a local modification.

    • scm project push - The locally modified file is pushed back into Maestro.

Render the form to verify the corrections have been applied

Here we render the form from Maestro and verify the fix has been accepted.

  1. Open the form in Maestro.

  2. Verify the error has been fixed.

Examine the Save History in Maestro

Here we inspect the save history of the form in Maestro.

  1. Select the form version in the Maestro Navigator.

  2. Click the Save History tab in the form version detail panel.

    You will see the original saved form with Maestro as the Source, and the corrected form with SCM as the Source.