DX Best Practices Configuration Checklist

This checklist provides recommended best practices for configuring Data Exchange (DX) to optimize security, performance, and data integrity when exchanging requirements via ReqIF.

1. Security & SSL Verification

✅ Enable "Verify SSL Certificate" (File → Settings)

• Ensures encrypted and authenticated connections to external systems.

• Disable only in testing environments where self-signed certificates may be used.

✅ Ensure DX is using secure endpoints

• Always connect to servers via HTTPS instead of HTTP.

2. ReqIF Export & Import Settings

✅ Enable "Export as ReqIF" (if structured data exchange is required)

• Ensures that exported data adheres to the ReqIF standard, facilitating exchange with DOORS, Jama, and other ALM tools.

✅ Set "Reverse Relationship Direction" if needed

• Some tools (e.g., DOORS) use an opposite dependency model for linked requirements.

• Enabling this ensures relationships are correctly mapped.

✅ Enable "Exchange Test Case Steps"

• Ensures test case steps are properly exported/imported.

• Prevents missing test step data in roundtrip exchanges.

✅ Check "Use Project ID (Docker) as Name When Underlined"

• Helps enforce structured naming conventions when importing/exporting data.

✅ Enable "Remove HTML from Fields & Attributes"

• Prevents formatting issues when exchanging rich text fields between tools.

3. Handling Deleted Objects in DX

✅ Map deleted objects using "ReqIF.ForeignDeleted"

• DX does not delete items in Jama but can map the deletion flag to an attribute for tracking.

✅ Use an "IsDeleted" attribute in Jama

• Deleted items should be imported but filtered out from views using a Boolean field.

✅ Ensure proper handling of "Soft Deleted" vs. "Purged" items in DOORS

• Soft Deleted Items: Marked with ReqIF.ForeignDeleted = True but still traceable.

• Purged Items: Permanently removed and not included in ReqIF exports.

• Best Practice: Purge items in DOORS before exporting if they should not be included in ReqIF.

4. Performance Optimization & Throttling

✅ Set an appropriate "Throttle Requests per Second" value (Default = 10)

• Helps prevent excessive API calls from overloading the server.

• Adjust based on system performance needs (higher values increase speed, lower values reduce server impact).

✅ Enable "Asynchronous Requests"

• Allows DX to process multiple operations simultaneously, reducing execution time.

✅ Monitor DX logs for performance issues

• Look for API rate limits, timeouts, or slow responses, and adjust settings accordingly.

5. General Best Practices

✅ Test DX settings in a sandbox environment before production deployment.
✅ Validate ReqIF file integrity using ReqIF Studio or similar tools.
✅ Regularly update DX to ensure compatibility with the latest ReqIF standards.
✅ Coordinate settings with IT/Security teams to ensure compliance with company policies.

Conclusion

This checklist ensures that DX is configured for optimal security, ReqIF data integrity, and performance. By following these best practices, organizations can minimize errors, improve data exchange reliability, and ensure compliance with the security standard.