DataMagik Automations Guide

Create browser-based automations that trigger actions from any web page using the DataMagik Automate browser extension.

Table of Contents

1. Overview
2. Getting Started
3. Creating Automations
4. Action Types
5. Questions & User Input
6. Parameter Configuration
7. Permissions & Roles
8. Browser Extension
9. Use Cases
10. Best Practices

1. Overview

DataMagik Automations extends your ERP and business applications with custom actions accessible directly from your browser. When installed, the DataMagik Automate browser extension adds custom buttons and actions to web pages based on the automations you configure.

Key Features:

• Browser Integration — Adds buttons to existing web applications
• Context-Aware — Actions can use URL parameters from the current page
• Six Action Types — Navigation, webhooks, scripts, AI chat, table lookups, and app designer
• Questions System — Prompt users for input before executing actions
• Permission-Based — Control who can access which automations
• Parameter Passing — Pass data from page URLs to automation endpoints

2. Getting Started

Prerequisites

• DataMagik Account — Access to the DataMagik platform
• Browser Extension — DataMagik Automate installed in Chrome/Edge
• Permissions — Appropriate permissions to create automations

Installation Steps

1. Navigate to DataMagik → Automations
2. Install the DataMagik Automate browser extension (see Section 8)
3. Configure the extension with your DataMagik credentials
4. Create your first automation

3. Creating Automations

Step 1: Navigate to Automations

Go to DataMagik → Automations in the main menu.

Step 2: Click "Add Automation"

Click the Add Automation button in the top right.

Step 3: Configure Automation

Step 4: Add Screens

Link the automation to specific screens (URLs) where the button should appear. Screens are matched by URL pattern, so the automation button only shows on relevant pages.

Step 5: Add Actions

After creating the automation, click Edit to add one or more actions.

4. Action Types

Each automation can have one or more actions. There are six action types:

4.1 Navigation Actions

Navigate to a URL in a new window, tab, or the current window.

4.2 Webhook Actions

Call an external API or internal webhook endpoint.

Authentication Types:

4.3 Script Actions

Execute a DataMagik Script Engine script.

The script receives parameters in the context object:

function main(context) {
  const orderId = context.orderId;
  const customerId = context.customerId;
  
  const order = tables.get("orders", orderId);
  documents.generate("Order Summary", order);
  
  return { success: true };
}

4.4 AI Chat Actions

Open an AI chat interface with context from the current page.

This allows users to interact with AI assistants while providing relevant context from their current work.

4.5 Table Lookup Actions

Look up data from User Defined Tables and display results or pass them to subsequent actions.

Table lookup actions are useful for displaying customer settings, product information, or any reference data stored in User Defined Tables directly from the browser extension.

4.6 App Designer Actions

Open a DataMagik Application directly from the browser extension.

This action type links automations directly to applications built in the Application Designer, allowing users to launch custom apps with context from their current page.

5. Questions & User Input

Questions allow you to prompt users for input before executing an automation. This is useful when actions need additional information not available in the URL.

Adding Questions to an Automation

1. Edit the automation
2. Navigate to the Questions tab
3. Click Add Question

Question Types

Question Configuration

Choices (for Select/Multi-Select)

For select-type questions, configure the available choices:

User answers are passed to actions as parameters alongside URL parameters and static values.

6. Parameter Configuration

Parameters allow automations to capture data from the current page URL and pass it to actions.

Required URL Parameters

Specify parameters that must be present in the current URL for the automation button to appear:

Example: If you add order_id as required, the automation button will only show on pages with ?order_id=123 in the URL.

URL Parameters to Pass

Map parameters from the current URL to your action:

Example: Source: user_id → Target: userId

Static Values

Add fixed values to every request:

7. Permissions & Roles

Control who can access automations through roles and permissions.

Managing Roles

Navigate to Manage Roles (visible to users with DataMagik - Security permission).

1. Click Add Role
2. Enter role name and description
3. Assign permissions to the role
4. Save

Assigning Permissions to Automations

1. Edit an automation
2. Go to the Permissions tab
3. Select which roles can access this automation
4. Save

User Role Assignment

Assign roles to users in the User Management section to control their automation access.

8. Browser Extension

The browser extension displays automation buttons on web pages.

Installation

1. Go to the Chrome Web Store or Edge Add-ons
2. Search for "DataMagik Automate"
3. Click Add to Chrome / Add to Edge
4. Pin the extension for easy access

Configuration

1. Click the extension icon in your browser
2. Enter your DataMagik credentials
3. Configure settings

Using the Extension

1. Navigate to a web page with matching URL parameters
2. Automation buttons appear in the extension popup
3. Click a button to execute the automation
4. If questions are configured, answer them before execution
5. View results in notifications or new windows

9. Use Cases

Use Case 1: Print Labels from ERP

Scenario: Add a "Print Label" button to your ERP's order detail page.

Setup:

1. Create automation: "Print Shipping Label"
2. Add required parameter: order_no
3. Add webhook action with printer endpoint
4. Map order_no → orderNumber

Result: When viewing an order in your ERP (?order_no=12345), clicking the button triggers label printing.

Use Case 2: Generate Report in New Tab

Scenario: Open a custom report page with context from current view.

Setup:

1. Create automation: "View Sales Report"
2. Add navigation action opening in a new tab
3. Map customer_id → customerId

Result: Opens sales report for the current customer in a new tab.

Use Case 3: Execute Script with User Input

Scenario: Run a data sync script where the user selects the target warehouse.

Setup:

1. Create automation: "Sync Inventory"
2. Add a select question: "Select Warehouse" with warehouse options
3. Add script action: "Inventory Sync Script"
4. Map the question answer to the script parameter

Result: User selects a warehouse, then the sync script runs with that selection.

Use Case 4: Multi-Step Automation

Scenario: Print label AND open tracking page in one click.

Setup:

1. Create automation: "Ship Order"
2. Add webhook action (print label)
3. Add navigation action (open tracking)

Result: One button click prints the label and opens the tracking page.

10. Best Practices

Naming Conventions

• Be descriptive — "Print Shipping Label" not "Print"
• Use verbs — Start with action words (Print, Generate, View, Sync)
• Include context — "Print Order Label" not just "Print Label"

Security

• Use authentication — Always secure webhook endpoints
• Limit permissions — Only grant access to necessary roles
• Use Bearer tokens — Rotate tokens periodically
• Review regularly — Audit automation access periodically

Parameter Design

• Keep it simple — Only require necessary parameters
• Use consistent naming — Match parameter names across automations
• Document parameters — Add descriptions for clarity

Questions

• Use select types when possible — Reduces user input errors
• Set default values — Pre-fill common answers
• Mark required carefully — Only require what's truly needed

Testing

• Test with valid URLs — Verify buttons appear correctly
• Test authentication — Confirm webhooks authenticate properly
• Test edge cases — Missing parameters, network errors
• Test permissions — Verify role-based access works