Workflows

📋 Workflows Dashboard

• Navigation: Workflows is accessible from the top navigation bar.
• View: Users see a list of workflows with metadata:
  • Name
  • Components used (M3, Excel, Mail, Filter)
  • Last executed (timestamp)
  • Created by / Modified by (initials of users)
  • Actions: Run, Edit, Execution Logs, Add to Favorites, Copy, Delete

---

▶️ Running and Managing Workflows

• Click the three-dot menu under Actions next to a workflow to:
  • Run the workflow
  • Edit or Copy it
  • View Execution Logs
  • Add to favorites for quick access
  • Delete if obsolete

---

📈 Viewing Execution Logs

Click Execution Logs to access detailed results for each run.

• Metadata shown:
  • Start/End time
  • Duration
  • Run by (user)
  • Status (Success / Failed)
• Tabs available:
  • Results: Summarized visual flow of components
  • Result Details (JSON): Raw structured output including payload, error trace, environment info
  • M3 Logs: Any specific logs returned from the M3 APIs

---

❌ Handling Failures

• Failed executions display red error messages.
• JSON result tab will contain failed: true and an error message.
• Check the field error inside result details (JSON) for root cause (e.g. malformed payload, missing subject in an email node, incorrect tenant/user/environment setup).

---

✅ Successful Executions

• Marked with green "Success" status

• May include downloadable results (e.g., Excel files)

• Example:

  {
    "failed": false,
    "error": null,
    "executionId": "WFEXEC-...",
    "workflowId": "WORKFLOW-..."
  }
  
  

---

➕ Creating a New Workflow

Click New Workflow and follow the wizard steps:

1. Descriptors

• Workflow Name
• Description
• Workflow Type: Express (simplified) or Standard
• Import Workflow: Optionally import structure from JSON
• Enable: Checkbox to activate immediately
• Labels: Add tags for filtering

2. Template Selection

• Choose from templates like:
  • M3 API → Excel
  • M3 API → Filter → Table
  • Start from scratch

Adding Workflow Steps

To add a step to your workflow:

1. Click the green plus button.
2. In the Add workflow step modal, choose a step type:
   • Trigger
   • Excel
   • Transform
   • Email
   • SMS
   • Rest API
   • Code
   • Data lake
   • Table
   • Table updater
   • Filter
   • File Loader
   • Converter

Click Ok to insert the step into the workflow.

---

Triggering Workflows

You can trigger workflows manually, on a schedule, or based on an event.

Manual Trigger

Select the Manual tab in the trigger section to allow manual execution.

Scheduled Trigger

1. Choose the Schedule tab.
2. Define start and end time, recurrence (year, month, day, hour, minute), and optionally set timezone.
3. Click Save.

Event Trigger

1. Select the Event tab.
2. Choose a table and an event action:
   • Create
   • Update
   • Delete
3. Click Save to finalize the trigger source.

Step Configuration Example

Each step can be customized. For instance:

• M3 API: Choose and configure MI transactions such as MMS200MI > LstItmByItm or LstItmWhsByItm, specify required inputs like ITNO, CONO, FSTY, etc.
• Excel: Define output headers and map values from upstream steps.
• Code: Insert custom JavaScript with access to prevStep, allSteps, and trigger data structures.

module.exports = function(prevStep, allSteps, trigger) {
  // Custom transformation logic here
};

---

Example Workflow Structure

Trigger → M3 API → Filter → Excel → Code

This structure allows data fetching from M3, filtering it, exporting to Excel, and post-processing via custom code.

---

Editing Workflow Steps

You can update step configuration at any time by clicking the three-dot menu on the step and selecting Edit. This opens the configuration panel where inputs, filters, and defaults can be adjusted.

---

Useful Tips

• Use Set common cell style for Excel formatting.
• Use Client preview to validate inputs.
• Use Configure lookups to bind M3 fields.

3. Environment

• Select which environments (e.g., DEV, DEL-TEST) will be active for the workflow
• Set one environment as Primary and one (if needed) as API environment

4. Summary

• Review all selections
• Click Create to finalize

---

🔍 Filtering Workflows

Use the dropdowns above the workflow list to filter by:

• Labels
• Status (All / Active / Inactive)
• Search: Type any keyword in name or description

---

📌 Best Practices

• Use descriptive names for workflows for easier identification
• Add labels to categorize by project or module
• Regularly check Execution Logs to monitor failures and resolve quickly
• Clean up unused or failed test workflows to avoid clutter