Skip to main content

Quick Reference

Essential tips and shortcuts for working efficiently in TDMP.

Keyboard Shortcuts​

Navigation:

  • g d - Go to Dashboard
  • g p - Open Projects menu
  • g l - Go to Library
  • g i - Go to Integrations
  • g a - Go to Analytics

Actions:

  • ? - Show keyboard shortcuts help
  • Esc - Close modal/dialog

Best Practices​

Project Organization​

Naming conventions:

  • Use clear, descriptive names: "User Registration Testing"
  • Include version or environment: "Customer API v2"
  • Avoid generic names like "Test Project 1"

Structure:

  • One project per feature or application module
  • Add relevant team members only
  • Use project descriptions to explain purpose

Schema Management​

Do:

  • ✅ Validate schemas before uploading
  • ✅ Use descriptive schema names
  • ✅ Link schemas to appropriate projects
  • ✅ Save commonly-used schemas to Library

Don't:

  • ❌ Upload multiple versions of the same schema
  • ❌ Use ambiguous field names
  • ❌ Create overly complex nested structures

Constraint Sets​

Effective constraints:

  • Start simple, add complexity gradually
  • Test with small record counts (10-100) first
  • Use built-in formats (email, phone, date) when possible
  • Document complex constraint logic

Common patterns:

  • Email: Use value category
  • Phone: Use regex pattern for your locale
  • Date ranges: Set realistic min/max dates
  • Enums: List valid values explicitly

Dataset Generation​

Performance tips:

  • Generate 1,000-10,000 records for most testing needs
  • Use smaller batches for quick iterations
  • Schedule large generations (10,000+) during off-peak hours

Quality checks:

  • Preview data before downloading
  • Verify key fields are populated correctly
  • Check that constraints are applied as expected

Common Tasks​

Generate Dataset Quickly​

  1. Select existing project
  2. Choose schema from project
  3. Select or create constraint set
  4. Set record count
  5. Click Generate

Reuse Previous Configuration​

  1. Go to Library
  2. Find previous dataset
  3. Click "Generate Similar"
  4. Adjust parameters if needed
  5. Generate

Share Schema with Team​

  1. Upload schema with clear name
  2. Link to relevant projects
  3. Create example constraint set
  4. Notify team members

Set Up API Access​

  1. Go to Settings → Tokens
  2. Click "Create Token"
  3. Enter descriptive name
  4. Copy token immediately
  5. Use in API calls with Bearer authentication

Troubleshooting Quick Reference​

IssueSolution
Generation stuckCheck dataset status, verify schema validity
Upload failsEnsure file is under 10MB, UTF-8 encoded
Can't access projectRequest access from project admin
Constraint conflictReview min/max ranges, check for contradictions
Download times outTry smaller dataset or better network

Integration Examples​

Trigger Generation from CI/CD​

# Authenticate
TOKEN=$(curl -X POST $TDMP_URL/users/token \
  -d "username=$USER&password=$PASS" \
  | jq -r '.access_token')

# Create dataset
curl -X POST $TDMP_URL/datasets/create \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "CI Test Data", "project_id": 5, "schema_id": 12, "record_count": 100}'

Poll for Completion​

# Check status
STATUS=$(curl $TDMP_URL/datasets/$DATASET_ID \
  -H "Authorization: Bearer $TOKEN" \
  | jq -r '.status')

# Wait until completed or failed
while [ "$STATUS" != "completed" ] && [ "$STATUS" != "failed" ]; do
  sleep 5
  STATUS=$(curl $TDMP_URL/datasets/$DATASET_ID \
    -H "Authorization: Bearer $TOKEN" \
    | jq -r '.status')
done

Download Generated Data​

# Download dataset
curl $TDMP_URL/data/$DATASET_ID \
  -H "Authorization: Bearer $TOKEN" \
  -o test-data.json

Getting Help​

  • Guides - Step-by-step tutorials
  • FAQ - Common questions
  • API Overview - For automation
  • Contact your administrator for deployment-specific help