Automating DX Execution via Repository Post-Hook

Overview

This article discusses a potential DX automation use case where customers store ReqIF files in a Git repository and want to trigger Data Exchange (DX) execution when files are updated. It also covers authentication considerations to avoid exposing sensitive credentials.

1. Can DX Be Triggered Automatically from a Git Repository?

✔ DX itself does not have built-in webhook support, but automation is possible using a repo post-hook and a script.
✔ The post-hook can detect changes in the Git repository and trigger a script that executes DX.

2. Steps to Automate DX Execution

A. Set Up a Post-Hook in the Git Repository

1. Monitor ReqIF file changes in the repository (e.g., using a Git post-receive hook).

2. Trigger a script when an update is detected.

B. Configure a Script to Run DX Automatically

1. The script should execute DX via the command line.

2. The jama.properties file is required to run DX but should be secured (see authentication section below).

3. The script can import the updated ReqIF files into Jama Connect automatically.

3. Authentication & Security Considerations

✔ The jama.properties file contains authentication details and must not be exposed in a public repo.
✔ Best practices for securing the credentials:

• Store credentials in a secure location (e.g., environment variables, secret vaults).

• Modify the script to dynamically inject authentication details instead of hardcoding them.

• Use a dedicated service account with limited permissions to run automated imports.

4. Best Practices for DX Automation

✅ Use Git post-hooks to trigger automation scripts on file updates.
✅ Run DX via a command-line script, ensuring authentication details remain secure.
✅ Store authentication credentials securely using environment variables or vaults.
✅ Regularly test the automation workflow to ensure smooth execution.

5. Conclusion

• DX does not support webhook triggers natively, but automation is possible via Git post-hooks and scripting.

• Authentication details in jama.properties must be protected to prevent exposure.

• Automating DX execution can streamline ReqIF imports but requires careful setup.