# Create Module

<!-- meta: type=create-module; location=Modules; category=Step (action); platforms=Joomla and WordPress (where applicable) -->

## Overview

Create Module is a **Step (action)** in **Modules**. Creates a new Joomla module and assigns it to a template position.

When the flow reaches this step, JOrchestrator executes **Create Module** against your linked site or an external integration, using the field values you set on **General** and **Design**. Downstream steps can read the output payload fields defined for this node.

## Why use this node

Create Module is a **action step** in the **Modules** group. Action steps run in the middle or end of a flow. They perform work on your CMS, call external services, or transform data for the next step.

Typical reasons teams add **Create Module** to a flow:

- Create Module on your linked Joomla site when the flow reaches this step
- Create module based on webhook, schedule, or CMS event data
- Integrate Modules operations with messaging, AI, or database steps in one canvas

## Example workflows

Common patterns on the canvas:

1. **Trigger or Webhook** → upstream steps → **Create Module** → **Send Email** or CMS update
2. **Scheduled trigger** → **Create Module** → **Debug** (while testing) → production action

## How to set it up

Module type, title, position, and menu assignment on Design.

## Good to know

Unpublished modules are created hidden until you publish-module or set published state.

## Properties panel

The designer shows these tabs for this node:

| Tab | Purpose |
|-----|---------|
| **Info** | Plain-language description and output payload fields for downstream steps |
| **General** | Canvas label and read-only node ID |
| **AI** | Optional assistant to help draft settings from plain language |
| **Design** | Node-specific configuration fields |

### System (automatic — not edited by the user)

These fields are managed by the designer or runtime — you do not type into them directly:

| Property key | Label | Type | Required | Visible when | Notes |
|--------------|-------|------|----------|--------------|-------|
| `_nodeId` | Node ID | `node-id` | No | — | — |
| `_payloadFields` | Available Fields | `payload-panel` | No | — | — |

### User-configured — General tab

| Property key | Label | Type | Required | Visible when | Notes |
|--------------|-------|------|----------|--------------|-------|
| `label` | Label | `text` | No | — | Node label |
| `title` | Module Title | `text` | **Yes** | — | Enter module title |
| `moduleType` | Module Type | `text` | **Yes** | — | mod_custom |
| `position` | Position | `text` | **Yes** | — | position-7 |

### CMS site configuration (not on this node's properties panel)

Credentials, API keys, mailers, SMTP, and integration defaults are configured in the CMS plugin under **Node Configuration**, not per step on this node. Link the flow to a domain before testing CMS-backed fields.

## Output payload fields

After this step runs, later nodes can reference these fields using placeholders such as
`{{create_module.id}}`.

| Field key | Type | Description |
|-----------|------|-------------|
| `id` | string | Primary record identifier. |
| `title` | string | Title text for the created or updated record. |
| `position` | string | Module position name on the template. |
| `module` | string | Module extension name (e.g. mod_custom). |

## Validation rules

- **Module Title** (`title`) must be filled before the flow can be saved.
- **Module Type** (`moduleType`) must be filled before the flow can be saved.
- **Position** (`position`) must be filled before the flow can be saved.

## Related nodes

Other steps in the same area of the palette:

- **Delete Module** (`delete-module`) — Modules
- **Publish Module** (`publish-module`) — Modules
- **Unpublish Module** (`unpublish-module`) — Modules
- **Update Module** (`update-module`) — Modules