Skip to content

Commit 344d61c

Browse files
committed
Add initial README files and project metadata for all OrchardCore.Elsa modules.
1 parent ea44f71 commit 344d61c

18 files changed

Lines changed: 449 additions & 0 deletions

File tree

src/modules/OrchardCore.Elsa.Contents/OrchardCore.Elsa.Contents.csproj

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
<TargetFramework>net9.0</TargetFramework>
55
<AddRazorSupportForMvc>true</AddRazorSupportForMvc>
66
<IsPackable>true</IsPackable>
7+
<PackageId>Elsa.OrchardCore.Contents</PackageId>
8+
<PackageTags>Elsa;Workflows;OrchardCore;Contents</PackageTags>
9+
<Description>Provides Elsa workflow activities for Orchard Core content management. Includes activities for creating, updating, publishing, and deleting content items, as well as content event triggers.</Description>
710
</PropertyGroup>
811

912
<ItemGroup>
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Elsa.OrchardCore.Contents
2+
3+
Provides Elsa workflow activities for Orchard Core content management.
4+
5+
## Features
6+
7+
This module integrates Elsa Workflows with Orchard Core's content management system, enabling workflows to interact with content items.
8+
9+
### Content Activities
10+
11+
**Content Operations:**
12+
- **CreateContent** - Create new content items
13+
- **UpdateContent** - Update existing content items
14+
- **GetContent** - Retrieve content items by ID or alias
15+
- **PublishContent** - Publish draft content items
16+
- **UnpublishContent** - Unpublish published content items
17+
- **DeleteContent** - Delete content items
18+
19+
**Taxonomy Operations:**
20+
- **ResolveTerm** - Resolve taxonomy terms for content categorization
21+
22+
### Content Event Triggers
23+
24+
These activities trigger workflows in response to content lifecycle events:
25+
26+
- **ContentCreated** - Triggers when a content item is created
27+
- **ContentUpdated** - Triggers when a content item is updated
28+
- **ContentPublished** - Triggers when a content item is published
29+
- **ContentUnpublished** - Triggers when a content item is unpublished
30+
- **ContentDeleted** - Triggers when a content item is deleted
31+
- **ContentDraftSaved** - Triggers when a content draft is saved
32+
- **ContentVersioned** - Triggers when a content item is versioned
33+
34+
## Dependencies
35+
36+
- `OrchardCore.Elsa`
37+
- `OrchardCore.Contents`
38+
- `OrchardCore.Title`
39+
- `OrchardCore.Taxonomies`
40+
41+
## Installation
42+
43+
Enable the **Content Activities** feature in the Orchard Core admin dashboard under Features.
44+
45+
## Package Information
46+
47+
- **Package ID**: `Elsa.OrchardCore.Contents`
48+
- **Category**: Elsa

src/modules/OrchardCore.Elsa.Data/OrchardCore.Elsa.Data.csproj

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
<PropertyGroup>
44
<TargetFramework>net9.0</TargetFramework>
55
<IsPackable>true</IsPackable>
6+
<PackageId>Elsa.OrchardCore.Data</PackageId>
7+
<PackageTags>Elsa;Workflows;OrchardCore;Data</PackageTags>
8+
<Description>Provides Elsa workflow activities for data processing operations. Includes CSV file handling and data transformation activities.</Description>
69
</PropertyGroup>
710

811
<ItemGroup>
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Elsa.OrchardCore.Data
2+
3+
Provides Elsa workflow activities for data processing operations.
4+
5+
## Features
6+
7+
This module adds data handling capabilities to Elsa workflows within Orchard Core.
8+
9+
### CSV Activities
10+
11+
The module integrates Elsa's CSV data processing activities, enabling workflows to:
12+
13+
- Read data from CSV files
14+
- Parse and process CSV records
15+
- Transform CSV data within workflow pipelines
16+
- Export data to CSV format
17+
18+
These activities are useful for batch processing, data import/export operations, and integration with external systems that use CSV as a data exchange format.
19+
20+
## Dependencies
21+
22+
- `OrchardCore.Elsa`
23+
24+
## Installation
25+
26+
Enable the **CSV Activities** feature in the Orchard Core admin dashboard under Features.
27+
28+
## Package Information
29+
30+
- **Package ID**: `Elsa.OrchardCore.Data`
31+
- **Category**: Elsa

src/modules/OrchardCore.Elsa.Designer.BlazorServer/OrchardCore.Elsa.Designer.BlazorServer.csproj

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55
<Nullable>enable</Nullable>
66
<ImplicitUsings>enable</ImplicitUsings>
77
<IsPackable>true</IsPackable>
8+
<PackageId>Elsa.OrchardCore.Designer.BlazorServer</PackageId>
9+
<PackageTags>Elsa;Workflows;OrchardCore;Designer;BlazorServer</PackageTags>
10+
<Description>Blazor Server implementation of the Elsa Studio workflow designer for Orchard Core. Provides server-side rendering of the visual workflow designer.</Description>
811
</PropertyGroup>
912

1013
<ItemGroup>
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Elsa.OrchardCore.Designer.BlazorServer
2+
3+
Blazor Server implementation of the Elsa Studio workflow designer for Orchard Core.
4+
5+
## Features
6+
7+
This module provides the Blazor Server-based visual workflow designer interface, allowing users to create, edit, and manage workflows through an interactive graphical interface.
8+
9+
### Visual Workflow Designer
10+
11+
- **Drag-and-Drop Interface** - Intuitive workflow design with drag-and-drop functionality
12+
- **Activity Browser** - Browse and search available workflow activities
13+
- **Visual Workflow Canvas** - Interactive canvas for designing workflow logic
14+
- **Real-time Validation** - Immediate feedback on workflow configuration
15+
16+
### Server-Side Rendering
17+
18+
This implementation uses Blazor Server, which means:
19+
20+
- **Lower Client Requirements** - Works on devices with limited resources
21+
- **Server Processing** - All processing happens on the server
22+
- **Real-time Updates** - SignalR connection for instant UI updates
23+
- **Better Security** - Business logic stays on the server
24+
25+
### Authentication
26+
27+
- Integrated authentication and authorization
28+
- User session management
29+
- Role-based access control for workflow design
30+
31+
## When to Use
32+
33+
Use this module if:
34+
35+
- You want the recommended, production-ready designer experience
36+
- You have reliable network connectivity
37+
- You prefer centralized processing and control
38+
- You want to minimize client-side resource usage
39+
40+
## Dependencies
41+
42+
- `OrchardCore.Elsa.Designer`
43+
44+
## Installation
45+
46+
Enable this feature in the Orchard Core admin dashboard under Features. Note that you should enable either this module OR the BlazorWasm variant, not both.
47+
48+
## Package Information
49+
50+
- **Package ID**: `Elsa.OrchardCore.Designer.BlazorServer`
51+
- **Category**: Elsa

src/modules/OrchardCore.Elsa.Designer.BlazorWasm/OrchardCore.Elsa.Designer.BlazorWasm.csproj

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55
<Nullable>enable</Nullable>
66
<ImplicitUsings>enable</ImplicitUsings>
77
<IsPackable>true</IsPackable>
8+
<PackageId>Elsa.OrchardCore.Designer.BlazorWasm</PackageId>
9+
<PackageTags>Elsa;Workflows;OrchardCore;Designer;BlazorWasm</PackageTags>
10+
<Description>Blazor WebAssembly implementation of the Elsa Studio workflow designer for Orchard Core. Provides client-side rendering of the visual workflow designer.</Description>
811
</PropertyGroup>
912

1013
<ItemGroup>
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Elsa.OrchardCore.Designer.BlazorWasm
2+
3+
Blazor WebAssembly implementation of the Elsa Studio workflow designer for Orchard Core.
4+
5+
## Features
6+
7+
This module provides the Blazor WebAssembly-based visual workflow designer interface, allowing users to create, edit, and manage workflows through an interactive graphical interface that runs entirely in the browser.
8+
9+
### Visual Workflow Designer
10+
11+
- **Drag-and-Drop Interface** - Intuitive workflow design with drag-and-drop functionality
12+
- **Activity Browser** - Browse and search available workflow activities
13+
- **Visual Workflow Canvas** - Interactive canvas for designing workflow logic
14+
- **Real-time Validation** - Immediate feedback on workflow configuration
15+
16+
### Client-Side Rendering
17+
18+
This implementation uses Blazor WebAssembly, which means:
19+
20+
- **Offline Capability** - Can work with cached workflows offline
21+
- **Client Processing** - All UI processing happens in the browser
22+
- **Reduced Server Load** - Less server resource usage for UI operations
23+
- **Lower Latency** - Instant UI interactions without round-trips
24+
25+
### Authentication
26+
27+
- Integrated authentication and authorization
28+
- User session management
29+
- Role-based access control for workflow design
30+
31+
## When to Use
32+
33+
Use this module if:
34+
35+
- You want offline or disconnected workflow design capability
36+
- You want to reduce server load for UI operations
37+
- You have users with high-latency connections
38+
- Your users have modern browsers and sufficient client resources
39+
40+
## Trade-offs
41+
42+
Consider that WebAssembly apps:
43+
44+
- Have larger initial download sizes
45+
- Require modern browser support
46+
- May take longer to load initially
47+
48+
## Dependencies
49+
50+
- `OrchardCore.Elsa.Designer`
51+
52+
## Installation
53+
54+
Enable this feature in the Orchard Core admin dashboard under Features. Note that you should enable either this module OR the BlazorServer variant, not both.
55+
56+
## Package Information
57+
58+
- **Package ID**: `Elsa.OrchardCore.Designer.BlazorWasm`
59+
- **Category**: Elsa

src/modules/OrchardCore.Elsa.Designer/OrchardCore.Elsa.Designer.csproj

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@
66
<ImplicitUsings>enable</ImplicitUsings>
77
<IsPackable>true</IsPackable>
88
<AddRazorSupportForMvc>true</AddRazorSupportForMvc>
9+
<PackageId>Elsa.OrchardCore.Designer</PackageId>
10+
<PackageTags>Elsa;Workflows;OrchardCore;Designer</PackageTags>
11+
<Description>Shared components for the Elsa Studio visual workflow designer. Provides core UI components and workflow design functionality for Orchard Core integration.</Description>
912
</PropertyGroup>
1013

1114
<ItemGroup>
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Elsa.OrchardCore.Designer
2+
3+
Shared components for the Elsa Studio visual workflow designer.
4+
5+
## Features
6+
7+
This module provides the core shared components and configuration for the Elsa Studio workflow designer when integrated with Orchard Core.
8+
9+
### Core Components
10+
11+
- **Elsa Studio Integration** - Integrates Elsa Studio UI components with Orchard Core
12+
- **Workflow Designer Core** - Core workflow design and editing functionality
13+
- **Shell Configuration** - Shell and module configuration for the designer
14+
15+
This module serves as the foundation for both the Blazor Server and Blazor WebAssembly implementations of the workflow designer.
16+
17+
## Implementation Modules
18+
19+
Choose one of the following implementation modules based on your deployment preferences:
20+
21+
- **Elsa.OrchardCore.Designer.BlazorServer** - Server-side rendering (recommended for most scenarios)
22+
- **Elsa.OrchardCore.Designer.BlazorWasm** - Client-side rendering (for offline or low-latency requirements)
23+
24+
## Dependencies
25+
26+
This module requires no Orchard Core-specific dependencies but provides shared functionality for the designer implementations.
27+
28+
## Package Information
29+
30+
- **Package ID**: `Elsa.OrchardCore.Designer`
31+
- **Category**: Elsa

0 commit comments

Comments
 (0)