How to find what you're looking for in app and in the documentation

Finding things in the documentation

Etlworks includes a robust UI and a large documentation portal with over 600 articles. Here’s how to efficiently find what you need.

• Use the Search Bar: The search tool auto-suggests articles based on relevance. Be sure to check the Related Articles section at the bottom of each page.

• Step-by-Step Tutorials: Visit Quick tutorials for guided walkthroughs covering the most common use cases.

• Video Tutorials: Watch short video tutorials that demonstrate key features and tasks. 

• Key concepts:
  • Connections, Listeners, Formats and Flows
  • Transformations and Mapping.
  • Etlworks and Etlworks Explorer : explore the UI and flow monitoring tools.

• Use Case-Based Guidance: Find database, file, API, and cloud platform-specific guidance (e.g., Snowflake, Redshift) in the Use Cases section.

• Real-World Examples: Explore real-life implementations in the Case Studies section.

• Scripting: Learn about writing and using scripts in JavaScript and Python in the Scripting section.

• APIs: Read about built-in and user-defined APIs in the Etlworks APIs and Custom API Workflows section.

• Parameterization:  Learn how to use variables and tokens dynamically in the Working with Parameters and Variables section.

• Helpful Tips: Visit the Tips, Shortcuts, and Edge Cases  section for shortcuts and best practices.

• Debugging and Troubleshooting: Check the Troubleshooting and Exception Handling section to solve common issues.

• Working with Nested Documents: Visit the Working with Nested and Hierarchical Data section to learn how to process complex XML and JSON structures.

• Performance Tuning: Learn how to optimize flow execution and resource usage in the Performance Tuning section.

• Billing and Subscriptions: Find information about plans, payments, and managing your subscription in the Subscriptions and Payments section.

• Security and Deployment:

  • Security
  • Architecture and Deployment

Find things in Etlworks app

Global search

To activate global search anywhere within the Etlworks UI, click on Search text field in the top menu bar.

Find where the specific Connection, Listener, or Format is used

When in the Connections window, select a Connection, Listener, or Format and click Find Usage at the bottom of the screen.

Create and manage Connections and Formats

Create Connections and Formats in the Connections window.

Use the search box in the gallery for finding the Connection type you want to create.

Filter existing Connections by name and tag.

Create and manage Flows

Create Flows in the Flows window.

Use the search box in the gallery to find a Flow type to create:

Patterns: source to target or action

Examples:

• Database to file
• Web service to database
• Well-known API to database
• Queue to database
• File to file
• XSL
• JavaScript
• Python
• SQL
• Merge
• Copy
• CDC
• Snowflake
• Redshift

Filter existing Flows by name and tag.

Find errors, stats, and Flow execution status:

In the Flows window, click status.