diff --git a/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.Activities.BlobStoring/README.EN.md b/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.Activities.BlobStoring/README.EN.md new file mode 100644 index 000000000..b7d8cdb5a --- /dev/null +++ b/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.Activities.BlobStoring/README.EN.md @@ -0,0 +1,34 @@ +# LINGYUN.Abp.Elsa.Activities.BlobStoring + +Blob Storage Activities integration module for Elsa workflow + +## Features + +* Provides the following Blob Storage activities: + * **BlobExists**: Check if a blob exists + * **WriteBlob**: Write blob data + * **ReadBlob**: Read blob data + * **DeleteBlob**: Delete blob data + +## Configuration and Usage + +```csharp +[DependsOn( + typeof(AbpElsaActivitiesBlobStoringModule) + )] +public class YouProjectModule : AbpModule +{ +} +``` + +## appsettings.json + +```json +{ + "Elsa": { + "BlobStoring": true // Enable Blob Storage activities + } +} +``` + +[中文文档](./README.md) diff --git a/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.Activities.BlobStoring/README.md b/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.Activities.BlobStoring/README.md new file mode 100644 index 000000000..0e3a26d2c --- /dev/null +++ b/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.Activities.BlobStoring/README.md @@ -0,0 +1,34 @@ +# LINGYUN.Abp.Elsa.Activities.BlobStoring + +Elsa工作流的Blob存储活动集成模块 + +## 功能 + +* 提供以下Blob存储活动: + * **BlobExists**: 检查Blob是否存在 + * **WriteBlob**: 写入Blob数据 + * **ReadBlob**: 读取Blob数据 + * **DeleteBlob**: 删除Blob数据 + +## 配置使用 + +```csharp +[DependsOn( + typeof(AbpElsaActivitiesBlobStoringModule) + )] +public class YouProjectModule : AbpModule +{ +} +``` + +## appsettings.json + +```json +{ + "Elsa": { + "BlobStoring": true // 启用Blob存储活动 + } +} +``` + +[English](./README.EN.md) diff --git a/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.Activities.Emailing/README.EN.md b/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.Activities.Emailing/README.EN.md new file mode 100644 index 000000000..47b77928d --- /dev/null +++ b/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.Activities.Emailing/README.EN.md @@ -0,0 +1,44 @@ +# LINGYUN.Abp.Elsa.Activities.Emailing + +Email sending activities integration module for Elsa workflow + +## Features + +* Provides **SendEmailing** activity for sending emails + * Support sending to multiple recipients + * Support template rendering for email content + * Support JavaScript and Liquid syntax + * Integration with ABP framework's `IEmailSender` interface + * Integration with ABP framework's `ITemplateRenderer` interface for template rendering + +## Configuration and Usage + +```csharp +[DependsOn( + typeof(AbpElsaActivitiesEmailingModule) + )] +public class YouProjectModule : AbpModule +{ +} +``` + +## appsettings.json + +```json +{ + "Elsa": { + "Emailing": true // Enable email sending activities + } +} +``` + +## Activity Parameters + +* **To**: List of recipient email addresses +* **Subject**: Email subject +* **Body**: Email body content +* **Culture**: Culture information +* **Template**: Template name +* **Model**: Model parameters used to format the template content + +[中文文档](./README.md) diff --git a/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.Activities.Emailing/README.md b/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.Activities.Emailing/README.md new file mode 100644 index 000000000..2586fe4f8 --- /dev/null +++ b/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.Activities.Emailing/README.md @@ -0,0 +1,44 @@ +# LINGYUN.Abp.Elsa.Activities.Emailing + +Elsa工作流的邮件发送活动集成模块 + +## 功能 + +* 提供 **SendEmailing** 活动用于发送电子邮件 + * 支持发送给多个收件人 + * 支持使用模板渲染邮件内容 + * 支持JavaScript和Liquid语法 + * 集成ABP框架的 `IEmailSender` 接口 + * 集成ABP框架的 `ITemplateRenderer` 接口进行模板渲染 + +## 配置使用 + +```csharp +[DependsOn( + typeof(AbpElsaActivitiesEmailingModule) + )] +public class YouProjectModule : AbpModule +{ +} +``` + +## appsettings.json + +```json +{ + "Elsa": { + "Emailing": true // 启用邮件发送活动 + } +} +``` + +## 活动参数 + +* **To**: 收件人邮箱地址列表 +* **Subject**: 邮件主题 +* **Body**: 邮件正文内容 +* **Culture**: 文化信息 +* **Template**: 模板名称 +* **Model**: 用于格式化模板内容的模型参数 + +[English](./README.EN.md) diff --git a/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.Activities.IM/README.EN.md b/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.Activities.IM/README.EN.md new file mode 100644 index 000000000..922bf0546 --- /dev/null +++ b/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.Activities.IM/README.EN.md @@ -0,0 +1,45 @@ +# LINGYUN.Abp.Elsa.Activities.IM + +Instant Messaging activities integration module for Elsa workflow + +## Features + +* Provides **SendMessage** activity for sending instant messages + * Support sending user messages and group messages + * Integration with ABP framework's `IMessageSender` interface + * Support multi-tenancy + +## Configuration and Usage + +```csharp +[DependsOn( + typeof(AbpElsaActivitiesIMModule) + )] +public class YouProjectModule : AbpModule +{ +} +``` + +## appsettings.json + +```json +{ + "Elsa": { + "IM": true // Enable instant messaging activities + } +} +``` + +## Activity Parameters + +* **Content**: Message content +* **FormUser**: Sender user ID +* **FormUserName**: Sender username +* **To**: Recipient user ID (for user messages) +* **GroupId**: Recipient group ID (for group messages) + +## Output Parameters + +* **MessageId**: ID of the sent message + +[中文文档](./README.md) diff --git a/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.Activities.IM/README.md b/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.Activities.IM/README.md new file mode 100644 index 000000000..90aac100c --- /dev/null +++ b/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.Activities.IM/README.md @@ -0,0 +1,45 @@ +# LINGYUN.Abp.Elsa.Activities.IM + +Elsa工作流的即时消息活动集成模块 + +## 功能 + +* 提供 **SendMessage** 活动用于发送即时消息 + * 支持发送用户消息和群组消息 + * 集成ABP框架的 `IMessageSender` 接口 + * 支持多租户 + +## 配置使用 + +```csharp +[DependsOn( + typeof(AbpElsaActivitiesIMModule) + )] +public class YouProjectModule : AbpModule +{ +} +``` + +## appsettings.json + +```json +{ + "Elsa": { + "IM": true // 启用即时消息活动 + } +} +``` + +## 活动参数 + +* **Content**: 消息内容 +* **FormUser**: 发送者用户ID +* **FormUserName**: 发送者用户名 +* **To**: 接收用户ID（用户消息） +* **GroupId**: 接收群组ID（群组消息） + +## 输出参数 + +* **MessageId**: 发送的消息ID + +[English](./README.EN.md) diff --git a/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.Activities.Notifications/README.EN.md b/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.Activities.Notifications/README.EN.md new file mode 100644 index 000000000..9eaa5db56 --- /dev/null +++ b/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.Activities.Notifications/README.EN.md @@ -0,0 +1,47 @@ +# LINGYUN.Abp.Elsa.Activities.Notifications + +Notification activities integration module for Elsa workflow + +## Features + +* Provides **SendNotification** activity for sending notifications + * Support sending to multiple users + * Support notification data and template content + * Support JavaScript and Liquid syntax + * Support setting notification severity + * Integration with ABP framework's `INotificationSender` interface + * Support multi-tenancy + +## Configuration and Usage + +```csharp +[DependsOn( + typeof(AbpElsaActivitiesNotificationsModule) + )] +public class YouProjectModule : AbpModule +{ +} +``` + +## appsettings.json + +```json +{ + "Elsa": { + "Notification": true // Enable notification activities + } +} +``` + +## Activity Parameters + +* **NotificationName**: Name of the registered notification +* **NotificationData**: Notification data or template content +* **To**: List of recipient user IDs +* **Severity**: Notification severity (default is Info) + +## Output Parameters + +* **NotificationId**: ID of the sent notification + +[中文文档](./README.md) diff --git a/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.Activities.Notifications/README.md b/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.Activities.Notifications/README.md new file mode 100644 index 000000000..59d740f52 --- /dev/null +++ b/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.Activities.Notifications/README.md @@ -0,0 +1,47 @@ +# LINGYUN.Abp.Elsa.Activities.Notifications + +Elsa工作流的通知活动集成模块 + +## 功能 + +* 提供 **SendNotification** 活动用于发送通知 + * 支持发送给多个用户 + * 支持通知数据和模板内容 + * 支持JavaScript和Liquid语法 + * 支持设置通知严重程度 + * 集成ABP框架的 `INotificationSender` 接口 + * 支持多租户 + +## 配置使用 + +```csharp +[DependsOn( + typeof(AbpElsaActivitiesNotificationsModule) + )] +public class YouProjectModule : AbpModule +{ +} +``` + +## appsettings.json + +```json +{ + "Elsa": { + "Notification": true // 启用通知活动 + } +} +``` + +## 活动参数 + +* **NotificationName**: 注册的通知名称 +* **NotificationData**: 通知数据或模板内容 +* **To**: 接收用户ID列表 +* **Severity**: 通知严重程度（默认为Info） + +## 输出参数 + +* **NotificationId**: 发送的通知ID + +[English](./README.EN.md) diff --git a/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.Activities.Sms/README.EN.md b/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.Activities.Sms/README.EN.md new file mode 100644 index 000000000..0dc03eefa --- /dev/null +++ b/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.Activities.Sms/README.EN.md @@ -0,0 +1,40 @@ +# LINGYUN.Abp.Elsa.Activities.Sms + +SMS activities integration module for Elsa workflow + +## Features + +* Provides **SendSms** activity for sending SMS messages + * Support sending to multiple phone numbers + * Support custom message properties + * Support JavaScript, JSON, and Liquid syntax + * Integration with ABP framework's `ISmsSender` interface + +## Configuration and Usage + +```csharp +[DependsOn( + typeof(AbpElsaActivitiesSmsModule) + )] +public class YouProjectModule : AbpModule +{ +} +``` + +## appsettings.json + +```json +{ + "Elsa": { + "Sms": true // Enable SMS activities + } +} +``` + +## Activity Parameters + +* **To**: List of recipient phone numbers +* **Message**: SMS content +* **Properties**: Additional properties (advanced option) + +[中文文档](./README.md) diff --git a/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.Activities.Sms/README.md b/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.Activities.Sms/README.md new file mode 100644 index 000000000..552f59285 --- /dev/null +++ b/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.Activities.Sms/README.md @@ -0,0 +1,40 @@ +# LINGYUN.Abp.Elsa.Activities.Sms + +Elsa工作流的短信活动集成模块 + +## 功能 + +* 提供 **SendSms** 活动用于发送短信 + * 支持发送给多个手机号码 + * 支持自定义消息属性 + * 支持JavaScript、JSON和Liquid语法 + * 集成ABP框架的 `ISmsSender` 接口 + +## 配置使用 + +```csharp +[DependsOn( + typeof(AbpElsaActivitiesSmsModule) + )] +public class YouProjectModule : AbpModule +{ +} +``` + +## appsettings.json + +```json +{ + "Elsa": { + "Sms": true // 启用短信活动 + } +} +``` + +## 活动参数 + +* **To**: 接收手机号码列表 +* **Message**: 短信内容 +* **Properties**: 附加属性（高级选项） + +[English](./README.EN.md) diff --git a/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.Activities.Webhooks/README.EN.md b/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.Activities.Webhooks/README.EN.md new file mode 100644 index 000000000..ae06c82c9 --- /dev/null +++ b/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.Activities.Webhooks/README.EN.md @@ -0,0 +1,43 @@ +# LINGYUN.Abp.Elsa.Activities.Webhooks + +Webhook activities integration module for Elsa workflow + +## Features + +* Provides **PublishWebhook** activity for publishing webhooks + * Support sending data to subscribers + * Support custom HTTP headers + * Support JavaScript, JSON, and Liquid syntax + * Integration with ABP framework's `IWebhookPublisher` interface + * Support multi-tenancy + +## Configuration and Usage + +```csharp +[DependsOn( + typeof(AbpElsaActivitiesWebhooksModule) + )] +public class YouProjectModule : AbpModule +{ +} +``` + +## appsettings.json + +```json +{ + "Elsa": { + "PublishWebhook": true // Enable webhook activities + } +} +``` + +## Activity Parameters + +* **WebhooName**: Unique name of the webhook +* **WebhookData**: Data to send +* **SendExactSameData**: If true, it sends the exact same data as the parameter to clients +* **UseOnlyGivenHeaders**: If true, webhook will only contain given headers; if false, given headers will be added to predefined headers in subscription +* **Headers**: HTTP headers to be sent (advanced option) + +[中文文档](./README.md) diff --git a/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.Activities.Webhooks/README.md b/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.Activities.Webhooks/README.md new file mode 100644 index 000000000..8d127f3d9 --- /dev/null +++ b/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.Activities.Webhooks/README.md @@ -0,0 +1,43 @@ +# LINGYUN.Abp.Elsa.Activities.Webhooks + +Elsa工作流的Webhook活动集成模块 + +## 功能 + +* 提供 **PublishWebhook** 活动用于发布Webhook + * 支持发送数据到订阅者 + * 支持自定义HTTP头部 + * 支持JavaScript、JSON和Liquid语法 + * 集成ABP框架的 `IWebhookPublisher` 接口 + * 支持多租户 + +## 配置使用 + +```csharp +[DependsOn( + typeof(AbpElsaActivitiesWebhooksModule) + )] +public class YouProjectModule : AbpModule +{ +} +``` + +## appsettings.json + +```json +{ + "Elsa": { + "PublishWebhook": true // 启用Webhook活动 + } +} +``` + +## 活动参数 + +* **WebhooName**: Webhook的唯一名称 +* **WebhookData**: 要发送的数据 +* **SendExactSameData**: 是否直接发送原始数据（如果为true，将直接发送参数中的数据给客户端） +* **UseOnlyGivenHeaders**: 是否仅使用给定的头部（如果为true，将仅使用给定的头部；如果为false，给定的头部将添加到订阅中预定义的头部） +* **Headers**: 要发送的HTTP头部（高级选项） + +[English](./README.EN.md) diff --git a/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.Activities/README.EN.md b/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.Activities/README.EN.md new file mode 100644 index 000000000..aa248a361 --- /dev/null +++ b/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.Activities/README.EN.md @@ -0,0 +1,41 @@ +# LINGYUN.Abp.Elsa.Activities + +Integration of commonly used Activities for Elsa workflow engine. + +## Configuration and Usage + +```csharp +[DependsOn( + typeof(AbpElsaActivitiesModule) + )] +public class YouProjectModule : AbpModule +{ +} +``` + +## appsettings.json +```json +{ + "Elsa": { + "BlobStoring": true, // Enable blob storage activities + "Emailing": true, // Enable email activities + "Notification": true, // Enable notification activities + "Sms": true, // Enable SMS activities + "IM": true, // Enable instant messaging activities + "PublishWebhook": true // Enable webhook publishing activities + } +} +``` + +## Features + +This module integrates several commonly used activities for the Elsa workflow engine: + +* **Blob Storage Activities**: File storage and management operations +* **Email Activities**: Email sending and processing +* **Notification Activities**: System notification handling +* **SMS Activities**: SMS message sending +* **IM Activities**: Instant messaging operations +* **Webhook Activities**: Webhook publishing and handling + +[中文文档](./README.md) diff --git a/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.EntityFrameworkCore.MySql/README.EN.md b/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.EntityFrameworkCore.MySql/README.EN.md new file mode 100644 index 000000000..3c2211b1b --- /dev/null +++ b/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.EntityFrameworkCore.MySql/README.EN.md @@ -0,0 +1,37 @@ +# LINGYUN.Abp.Elsa.EntityFrameworkCore.MySql + +MySql database provider module for Elsa workflow + +## Features + +* Provides MySql database support for Elsa workflow +* Depends on `AbpElsaEntityFrameworkCoreModule` and `AbpEntityFrameworkCoreMySQLModule` +* Pre-configures the following features: + * Persistence storage + * Webhooks storage + * Workflow settings storage + +## Configuration and Usage + +```csharp +[DependsOn( + typeof(AbpElsaEntityFrameworkCoreMySqlModule) + )] +public class YouProjectModule : AbpModule +{ +} +``` + +## Configuration Options + +```json +{ + "Elsa": { + "Persistence": true, // Enable persistence storage + "Webhooks": true, // Enable webhooks storage + "WorkflowSettings": true // Enable workflow settings storage + } +} +``` + +[中文文档](./README.md) diff --git a/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.EntityFrameworkCore.MySql/README.md b/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.EntityFrameworkCore.MySql/README.md new file mode 100644 index 000000000..f87a96f7a --- /dev/null +++ b/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.EntityFrameworkCore.MySql/README.md @@ -0,0 +1,37 @@ +# LINGYUN.Abp.Elsa.EntityFrameworkCore.MySql + +Elsa工作流的MySql数据库提供程序模块 + +## 功能 + +* 提供Elsa工作流的MySql数据库支持 +* 依赖于 `AbpElsaEntityFrameworkCoreModule` 和 `AbpEntityFrameworkCoreMySQLModule` +* 预配置以下功能: + * 持久化存储 + * Webhooks存储 + * 工作流设置存储 + +## 配置使用 + +```csharp +[DependsOn( + typeof(AbpElsaEntityFrameworkCoreMySqlModule) + )] +public class YouProjectModule : AbpModule +{ +} +``` + +## 配置项 + +```json +{ + "Elsa": { + "Persistence": true, // 启用持久化存储 + "Webhooks": true, // 启用Webhooks存储 + "WorkflowSettings": true // 启用工作流设置存储 + } +} +``` + +[English](./README.EN.md) diff --git a/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.EntityFrameworkCore.PostgreSql/README.EN.md b/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.EntityFrameworkCore.PostgreSql/README.EN.md new file mode 100644 index 000000000..b55ffdb70 --- /dev/null +++ b/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.EntityFrameworkCore.PostgreSql/README.EN.md @@ -0,0 +1,37 @@ +# LINGYUN.Abp.Elsa.EntityFrameworkCore.PostgreSql + +PostgreSql database provider module for Elsa workflow + +## Features + +* Provides PostgreSql database support for Elsa workflow +* Depends on `AbpElsaEntityFrameworkCoreModule` and `AbpEntityFrameworkCorePostgreSqlModule` +* Pre-configures the following features: + * Persistence storage + * Webhooks storage + * Workflow settings storage + +## Configuration and Usage + +```csharp +[DependsOn( + typeof(AbpElsaEntityFrameworkCorePostgreSqlModule) + )] +public class YouProjectModule : AbpModule +{ +} +``` + +## Configuration Options + +```json +{ + "Elsa": { + "Persistence": true, // Enable persistence storage + "Webhooks": true, // Enable webhooks storage + "WorkflowSettings": true // Enable workflow settings storage + } +} +``` + +[中文文档](./README.md) diff --git a/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.EntityFrameworkCore.PostgreSql/README.md b/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.EntityFrameworkCore.PostgreSql/README.md new file mode 100644 index 000000000..d5a797c47 --- /dev/null +++ b/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.EntityFrameworkCore.PostgreSql/README.md @@ -0,0 +1,37 @@ +# LINGYUN.Abp.Elsa.EntityFrameworkCore.PostgreSql + +Elsa工作流的PostgreSql数据库提供程序模块 + +## 功能 + +* 提供Elsa工作流的PostgreSql数据库支持 +* 依赖于 `AbpElsaEntityFrameworkCoreModule` 和 `AbpEntityFrameworkCorePostgreSqlModule` +* 预配置以下功能: + * 持久化存储 + * Webhooks存储 + * 工作流设置存储 + +## 配置使用 + +```csharp +[DependsOn( + typeof(AbpElsaEntityFrameworkCorePostgreSqlModule) + )] +public class YouProjectModule : AbpModule +{ +} +``` + +## 配置项 + +```json +{ + "Elsa": { + "Persistence": true, // 启用持久化存储 + "Webhooks": true, // 启用Webhooks存储 + "WorkflowSettings": true // 启用工作流设置存储 + } +} +``` + +[English](./README.EN.md) diff --git a/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.EntityFrameworkCore.SqlServer/README.EN.md b/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.EntityFrameworkCore.SqlServer/README.EN.md new file mode 100644 index 000000000..25afe1601 --- /dev/null +++ b/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.EntityFrameworkCore.SqlServer/README.EN.md @@ -0,0 +1,37 @@ +# LINGYUN.Abp.Elsa.EntityFrameworkCore.SqlServer + +SqlServer database provider module for Elsa workflow + +## Features + +* Provides SqlServer database support for Elsa workflow +* Depends on `AbpElsaEntityFrameworkCoreModule` and `AbpEntityFrameworkCoreSqlServerModule` +* Pre-configures the following features: + * Persistence storage + * Webhooks storage + * Workflow settings storage + +## Configuration and Usage + +```csharp +[DependsOn( + typeof(AbpElsaEntityFrameworkCoreSqlServerModule) + )] +public class YouProjectModule : AbpModule +{ +} +``` + +## Configuration Options + +```json +{ + "Elsa": { + "Persistence": true, // Enable persistence storage + "Webhooks": true, // Enable webhooks storage + "WorkflowSettings": true // Enable workflow settings storage + } +} +``` + +[中文文档](./README.md) diff --git a/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.EntityFrameworkCore.SqlServer/README.md b/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.EntityFrameworkCore.SqlServer/README.md new file mode 100644 index 000000000..20b0077aa --- /dev/null +++ b/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.EntityFrameworkCore.SqlServer/README.md @@ -0,0 +1,37 @@ +# LINGYUN.Abp.Elsa.EntityFrameworkCore.SqlServer + +Elsa工作流的SqlServer数据库提供程序模块 + +## 功能 + +* 提供Elsa工作流的SqlServer数据库支持 +* 依赖于 `AbpElsaEntityFrameworkCoreModule` 和 `AbpEntityFrameworkCoreSqlServerModule` +* 预配置以下功能: + * 持久化存储 + * Webhooks存储 + * 工作流设置存储 + +## 配置使用 + +```csharp +[DependsOn( + typeof(AbpElsaEntityFrameworkCoreSqlServerModule) + )] +public class YouProjectModule : AbpModule +{ +} +``` + +## 配置项 + +```json +{ + "Elsa": { + "Persistence": true, // 启用持久化存储 + "Webhooks": true, // 启用Webhooks存储 + "WorkflowSettings": true // 启用工作流设置存储 + } +} +``` + +[English](./README.EN.md) diff --git a/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.EntityFrameworkCore/README.EN.md b/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.EntityFrameworkCore/README.EN.md new file mode 100644 index 000000000..f61e021bc --- /dev/null +++ b/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.EntityFrameworkCore/README.EN.md @@ -0,0 +1,29 @@ +# LINGYUN.Abp.Elsa.EntityFrameworkCore + +EntityFrameworkCore integration module for Elsa workflow + +## Features + +* Provides EntityFrameworkCore integration for Elsa workflow +* Depends on `AbpElsaModule` and `AbpEntityFrameworkCoreModule` + +## Configuration and Usage + +```csharp +[DependsOn( + typeof(AbpElsaEntityFrameworkCoreModule) + )] +public class YouProjectModule : AbpModule +{ +} +``` + +## Database Providers + +This module is database provider agnostic. You need to choose one of the following modules based on your actual database: + +* [SqlServer](../LINGYUN.Abp.Elsa.EntityFrameworkCore.SqlServer/README.md) +* [PostgreSql](../LINGYUN.Abp.Elsa.EntityFrameworkCore.PostgreSql/README.md) +* [MySql](../LINGYUN.Abp.Elsa.EntityFrameworkCore.MySql/README.md) + +[中文文档](./README.md) diff --git a/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.EntityFrameworkCore/README.md b/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.EntityFrameworkCore/README.md new file mode 100644 index 000000000..1834a586f --- /dev/null +++ b/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.EntityFrameworkCore/README.md @@ -0,0 +1,29 @@ +# LINGYUN.Abp.Elsa.EntityFrameworkCore + +Elsa工作流的EntityFrameworkCore集成模块 + +## 功能 + +* 提供Elsa工作流的EntityFrameworkCore集成 +* 依赖于 `AbpElsaModule` 和 `AbpEntityFrameworkCoreModule` + +## 配置使用 + +```csharp +[DependsOn( + typeof(AbpElsaEntityFrameworkCoreModule) + )] +public class YouProjectModule : AbpModule +{ +} +``` + +## 数据库提供程序 + +本模块是数据库提供程序无关的基础模块，你需要根据实际使用的数据库选择以下对应的模块： + +* [SqlServer](../LINGYUN.Abp.Elsa.EntityFrameworkCore.SqlServer/README.md) +* [PostgreSql](../LINGYUN.Abp.Elsa.EntityFrameworkCore.PostgreSql/README.md) +* [MySql](../LINGYUN.Abp.Elsa.EntityFrameworkCore.MySql/README.md) + +[English](./README.EN.md) diff --git a/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.Notifications/README.EN.md b/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.Notifications/README.EN.md new file mode 100644 index 000000000..f90d32fb6 --- /dev/null +++ b/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.Notifications/README.EN.md @@ -0,0 +1,68 @@ +# LINGYUN.Abp.Elsa.Notifications + +Workflow notification integration. When a workflow is triggered, it publishes corresponding event notifications. + +## Available States + +* Faulted: Workflow execution encountered an error +* Cancelled: Workflow was cancelled +* Completed: Workflow execution completed +* Suspended: Workflow is suspended + +## Configuration and Usage + +```csharp +[DependsOn( + typeof(AbpElsaNotificationsModule) + )] +public class YouProjectModule : AbpModule +{ +} +``` + +```csharp +// Define notifications +public class DemoNotificationDefinitionProvider : NotificationDefinitionProvider +{ + public override void Define(INotificationDefinitionContext context) + { + var demoGroup = context.AddGroup("Group"); + + // Due to the diversity of notifications, template messages are used to transmit data + demoGroup.AddNotification("Faulted") + .WithTemplate(template => { }); + demoGroup.AddNotification("Cancelled") + .WithTemplate(template => { }); + demoGroup.AddNotification("Suspended") + .WithTemplate(template => { }); + demoGroup.AddNotification("Completed") + .WithTemplate(template => { }); + } +} +``` + +```csharp +// Define workflow +public class DemoWorkflow : IWorkflow +{ + public void Build(IWorkflowBuilder builder) + { + builder + .WithFaultedNotification("Faulted") + .WithCancelledNotification("Cancelled") + .WithSuspendedNotification("Suspended") + .WithCompletedNotification("Completed") + .SetVariable("demo", context => + { + // Can pass custom parameters, which will be written as transient variables into the published notification data + context.WithNotificationData("demo", "demo"); + // Custom tenant ID for publishing notifications + context.WithNotificationTenantId(Guid.NewGuid()); + }) + .WriteLine("Start a workflow.") + .WriteLine("Workflow finished."); + } +} +``` + +[中文文档](./README.md) diff --git a/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.Server/README.EN.md b/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.Server/README.EN.md new file mode 100644 index 000000000..737f67583 --- /dev/null +++ b/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa.Server/README.EN.md @@ -0,0 +1,28 @@ +# LINGYUN.Abp.Elsa.Server + +Integration of Elsa.Server.Api, handling default Elsa endpoints. + +## Features + +* Integrates Elsa server API endpoints with ABP framework +* Provides SignalR support +* Configures API versioning +* Includes automapper profiles for data mapping +* Registers necessary services: + * `ConnectionConverter` + * `ActivityBlueprintConverter` + * `WorkflowBlueprintMapper` + * `EndpointContentSerializerSettingsProvider` + +## Configuration and Usage + +```csharp +[DependsOn( + typeof(AbpElsaServerModule) + )] +public class YouProjectModule : AbpModule +{ +} +``` + +[中文文档](./README.md) diff --git a/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa/README.EN.md b/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa/README.EN.md new file mode 100644 index 000000000..56b902e0e --- /dev/null +++ b/aspnet-core/modules/elsa/LINGYUN.Abp.Elsa/README.EN.md @@ -0,0 +1,30 @@ +# LINGYUN.Abp.Elsa + +ABP Framework integration for [elsa-core](https://github.com/elsa-workflows/elsa-core) workflow engine. + +## Features + +* Provides default **AbpActivity** with multi-tenancy integration +* Defines **AbpTenantAccessor** for multi-tenancy integration +* Defines **AbpElsaIdGenerator** that generates workflow identifiers through the **IGuidGenerator** interface +* Defines **abp** related JavaScript extensions + +## Configuration and Usage + +```csharp +[DependsOn( + typeof(AbpElsaModule) + )] +public class YouProjectModule : AbpModule +{ + public override void PreConfigureServices(ServiceConfigurationContext context) + { + PreConfigure(elsa => + { + // Custom elsa related configuration + }); + } +} +``` + +[中文文档](./README.md)