Documentation

1. Open the connector.
2. Go to the Configuration tab.
3. Edit the connection details, authentication fields, sync settings, or stream definitions.
4. Select Save configuration.

• Required fields are missing.
• Credentials are invalid or expired.
• The source system cannot be reached.
• The selected database, bucket, folder, file, table, sheet, or collection does not exist.
• The connector does not have permission to read the selected source.
• A stream definition is incomplete or invalid.
• A file matching pattern does not match any available files.

A connector is in Draft status when it has been created but has not yet been fully configured.

• Configuration can be edited.
• Required source details may still be missing.
• Sync jobs cannot be run.
• The connector cannot be activated until valid configuration is saved.

A connector is in Pending status after its source configuration has been saved but before the connector has been activated.

• The source has been configured.
• The connector is not yet fully active.
• Sync jobs are not available until activation is complete.
• You can review configuration before activating the connector.

A connector is Active when it has been configured and activated successfully.

• Manual syncs can be run.
• Sync schedules can be configured.
• Sync history is available.
• Connector outputs can be viewed.
• Logs can be reviewed for sync jobs.

A connector may show an error if configuration, activation, source discovery, or sync execution fails.

• Authentication failures.
• Source connection failures.
• Missing permissions.
• Invalid stream configuration.
• Failed sync attempts.
• Source-specific errors returned by the connected system.

1. Open the connector.
2. Look for the error indicator or logs action.
3. Open the relevant log view.
4. Review the failure message and attempt details.
5. Update the configuration or rerun the sync as needed.

File-based connectors require one or more stream definitions. A file-based stream identifies the files or file-like objects to sync.

• Google Drive
• Microsoft OneDrive
• Microsoft SharePoint
• Amazon S3
• Azure Blob Storage
• Google Sheets

1. Open the connector.
2. Go to Configuration.
3. Find the Streams section.
4. Add a new stream.
5. Enter a stream name.
6. Configure the file, folder, sheet, or path settings.
7. Save the configuration.

Some file-based connectors support glob inputs. A glob is a file matching pattern that tells the connector which files to include in a stream.

Database connectors use streams to identify the tables or database objects to ingest. A database stream typically represents a table, collection, or equivalent source object.

• PostgreSQL
• MySQL
• Microsoft SQL Server
• MongoDB
• Azure Table Storage
• BigQuery
• Redshift
• Snowflake

1. Open the connector.
2. Go to Configuration.
3. Find the Streams section.
4. Add a table, collection, or source object.
5. Save the configuration.

1. Open an active connector.
2. Select Sync Now.
3. Wait for the sync job to start.
4. Review the sync status in the connector detail page.
5. Open logs if the sync fails.

1. Open an active connector.
2. Go to the Schedule tab.
3. Select the schedule type.
4. For cron schedules, enter a cron expression.
5. Save the schedule.

0 */6 * * *

1. Open the connector.
2. Select View syncs.
3. Review the recent sync table.
4. Open logs for any sync job that needs investigation.

Connector-ingested tables are created from connector streams. When a connector sync runs, each configured stream can produce a table.

1. A connector is configured with one or more streams.
2. The connector syncs data from the source system.
3. Vortexify creates or updates tables for the synced streams.
4. Each table becomes available in the workspace.
5. The table can be opened, previewed, filtered, sorted, and inspected.

• A PostgreSQL table synced from a database connector.
• A CSV file stream synced from cloud storage.
• A Google Sheet synced from a file app connector.
• A Snowflake table synced from a warehouse connector.

Uploaded tables are created from files added directly to the workspace. Upload-based tables are useful when you have a local CSV file or exported dataset that you want to inspect, transform, or use in Vortexify.

1. Open the workspace location where the table should be created.
2. Upload the file.
3. Enter or confirm the table name.
4. Wait for the table to initialize.
5. Open the table after processing completes.

The main table view shows a preview of the table’s records. The preview is designed for browsing and validating table contents. Very large tables may show a limited preview rather than every row.

• View rows and columns.
• Sort by supported columns.
• Apply filters.
• Clear active filters.
• Inspect record values.
• Confirm that the data loaded as expected.

Tables support filtering and sorting from the table view. Filters and sorting affect the preview experience. They do not modify the underlying table data.

• Records with a specific status.
• Rows from a particular date range.
• Customers from a selected region.
• Empty or non-empty values.
• Numeric values above or below a threshold.

The schema describes the structure of a table. Each column has a name and a type. Column types help Vortexify understand how values should be displayed, filtered, sorted, and used in downstream workflows.

The metadata tab shows table-level information, including details such as description, table type, created date, last updated date, last synced date, row count, column count, and ingest type.

The history tab shows table-related jobs. Use history to understand when a table was created, updated, synced, or reprocessed.

• Discovery jobs.
• Connector sync jobs.
• Processing jobs.
• Failed jobs.
• Successful jobs.

• The file is empty.
• The file format is unsupported.
• The CSV is malformed.
• Column headers are missing or duplicated.
• Rows have inconsistent numbers of columns.
• Values cannot be parsed consistently.
• The source stream produced no readable data.
• The table data is unavailable or incomplete.

1. Open the table.
2. Go to the History tab.
3. Select the failed job.
4. Open the logs.
5. Review the failure message.
6. Fix the source file or connector configuration.
7. Re-upload the file or rerun the connector sync.

Use Plan mode when you want AI to think through what should be built before making implementation changes. In Plan mode, AI focuses on updating the application and function specifications.

• Designing a new app.
• Deciding which tables to use.
• Deciding which custom functions are needed.
• Writing or revising app requirements.
• Breaking a complex request into frontend and backend work.
• Choosing required packages or libraries.
• Defining expected function outputs.
• Creating a build plan before making code changes.

Use Build mode when you want AI to make implementation changes. Build mode works best when the plan is already clear.

• Creating frontend sections.
• Editing charts, tables, filters, or layouts.
• Writing or updating backend function logic.
• Running tests.
• Debugging app errors.
• Fixing function failures.
• Installing packages.
• Updating function settings.
• Connecting app UI to function outputs.

Apps maintain planning context for the frontend and for each custom function. These specs help AI make consistent changes over time. If the intended behavior changes, update the relevant spec before building.

The AI Context tab stores additional guidance for the AI builder. Good AI context helps the builder make better decisions and reduces repeated instructions.

• The purpose of the app.
• Intended users.
• Design preferences.
• Business rules.
• Definitions of important terms.
• Data assumptions.
• Requirements that should persist across edits.
• Constraints the AI should follow.

This app is for sales managers. Prioritize clarity over density. Use plain-language labels. Revenue should always be shown in USD. Customer risk should be grouped into Low, Medium, and High.

Apps can use two main input types: tables and functions. Tables provide data to the frontend interface and backend functions. Functions provide reusable backend logic that can be triggered from the app, tested in the builder, or scheduled to run automatically.

The Preview tab lets you run the app in an embedded browser view. Preview can be opened in different device modes to validate how the app behaves across screen sizes.

• Test the app layout.
• Confirm that charts and tables render correctly.
• Interact with filters and forms.
• Run buttons or workflows.
• Check responsive layouts.
• Refresh the app.
• View preview logs when something fails.

Preview logs help troubleshoot problems that prevent the app from rendering or behaving correctly. Logs are most useful when paired with a specific failing action.

• The app does not load.
• A section is blank.
• Data does not appear.
• A button does not work.
• A chart fails to render.
• A package or dependency issue prevents the app from starting.

The Code tab lets you edit the frontend app files. Most users should use AI to make code changes, but the code editor is available when manual edits are needed.

• App layout.
• Components.
• Hooks.
• Data loading.
• User interactions.
• Styling.
• Charts and visualizations.
• Function calls.
• Output rendering.

The frontend can query tables that are attached to the app. Use table inputs when the app needs to display rows, render charts, filter records, sort records, run lightweight calculations, or let users explore a dataset.

• Load the first page of records.
• Filter records by status, date, region, or category.
• Sort by a selected column.
• Fetch data for a chart.
• Query aggregate values for summary cards.

The frontend can run custom backend functions that are attached to the app. A function can be run from the app, and the frontend can retrieve the function output and display it.

• Button-triggered analysis.
• Form-based calculation.
• Report generation.
• Data enrichment.
• Forecasting.
• External API lookup.
• Batch processing.
• Scheduled output retrieval.

Apps can include forms for collecting user input. Form inputs may be passed into custom functions at runtime.

• Date range.
• Region.
• Customer ID.
• Threshold.
• Category.
• Number of results.
• Scenario name.
• Free-text instruction.

The Variables view shows the tables and functions available to the app. Each variable represents a resource that the app can use.

Secrets are secure values used by a function at runtime. Use secrets when a function needs to connect to an external system securely.

1. Open the app builder.
2. Confirm the correct version is selected.
3. Open Publish.
4. Deploy the selected version.
5. Review deployment status.
6. Open logs if deployment fails.

The General section shows organization identity and high-level account information.

• Organization name.
• Organization color.
• Organization ID.
• Created date.
• Current plan.
• Subscription status.
• Subscription interval.
• Renewal date.
• Member capacity.
• Credit balance.

The Members section is used to manage who belongs to the organization.

• View current members.
• Invite members by email.
• Assign organization roles.
• Remove members.
• See inactive members when seat limits are reached.

The Billing & Usage section shows the organization’s current plan, usage, seats, credits, and available plan options.

• Review the current plan.
• Compare available plans.
• Change plans.
• Add seats.
• Buy credits.
• Open the billing portal.
• Review renewal information.
• Check member capacity.

• Recent activity.
• Workspace members.
• Workspace resources.
• Usage indicators.
• High-level workspace status.

The General section controls basic workspace identity.

• Workspace name.
• Workspace description.
• Workspace icon and color.
• Workspace handle.
• Default member limit.

The People section controls who has access to a workspace. Workspace access is separate from organization membership.

• View workspace members.
• Add organization members to the workspace.
• Change workspace roles.
• Remove workspace members.

The Security section manages workspace security role status. This section includes Guardian, the workspace security integration used to validate and initialize workspace security roles.

Starter is the entry-level plan. It is best for individual users getting started with the platform.

• Limited member capacity.
• Standard compute.
• Basic app creation.
• Limited collaboration.
• Limited scheduling.
• Limited connector availability.
• Limited support.

Pro is designed for individual power users who need to build and run more complete workflows with connectors, apps, and schedules.

• More app capacity.
• Connectors.
• Scheduled jobs.
• Email support.
• Higher memory options than Starter.
• More frequent schedule intervals than Starter.

Team is designed for small-team collaboration in a shared workspace.

• Multiple members.
• Collaboration features.
• Shared workspace access.
• Scalable member capacity.
• Higher app limits than Pro.

Business is designed for larger teams and more advanced workspace management.

• Multiple workspaces.
• Roles and permissions.
• More included users.
• Additional seats.
• Live support.
• Broader workspace member management.
• Higher app and compute limits.
• More frequent schedules.
• Higher memory settings.

Enterprise is designed for advanced organizational, deployment, compliance, and support requirements.

• Enterprise connectors.
• Private cloud deployments.
• Advanced compliance support.
• On-site support.
• Implementation services.
• Custom limits.
• Advanced security requirements.
• Custom deployment and support arrangements.

Connector availability depends on plan. Starter organizations may not be able to create connectors. Scheduled connector syncs may also depend on plan.

Custom backend function compute options can depend on plan. Use the smallest compute and memory setting that supports the function reliably.

Workspace creation depends on plan. Lower-tier plans may be limited to the default workspace. Business and Enterprise plans are intended for organizations that need multiple workspaces.

• Adding members.
• Adding members to non-default workspaces.
• Assigning certain workspace roles.
• Managing detailed workspace role changes.

• Starter and Pro are usually single-user plans.
• Team includes a small number of members.
• Business includes more members.
• Enterprise may have custom seat terms.

Some plans allow additional seats to be purchased. When additional seats are added, more organization members can become active.

1. Open Organization Settings.
2. Go to Billing & Usage.
3. Select the option to buy credits.
4. Choose the number of bundles.
5. Proceed to checkout.

• Edit organization display settings.
• Invite organization members.
• Change organization roles.
• Remove organization members.
• Manage billing.
• Add seats.
• Buy credits.