# OrchardCore.Transformalize

**Repository Path**: OrchardCore/OrchardCore.Transformalize

## Basic Information

- **Project Name**: OrchardCore.Transformalize
- **Description**: 基于Orchard Core 的 数据转换组件，它为批量操作的任务、窗体和报表添加内容类型。
- **Primary Language**: C#
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-06-13
- **Last Updated**: 2022-05-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## Transformalize in Orchard Core

This is an [Orchard Core](https://github.com/OrchardCMS/OrchardCore) module 
that [Transformalize](https://github.com/dalenewman/Transformalize)s everything 
(for better or worse).  It adds content types for 
tasks, forms, and reports with bulk actions.

### Tasks

Tasks are arrangements as demonstrated on the [Transformalize Read Me](https://github.com/dalenewman/Transformalize/blob/master/README.md) 
page. In this module, tasks accept, transform, and validate 
parameters before running.

`TODO: Explain example arrangement and show GIF.`

### Reports
Reports are arrangements that read, filter, 
search, export, and page over data records from a 
data source.  You may transform records using [Razor](https://docs.microsoft.com/en-us/aspnet/core/mvc/views/razor?view=aspnetcore-3.1) 
and/or [Liquid](https://shopify.github.io/liquid).  Optionally, 
you may display records on a map.

`TODO: Explain example arrangement and show GIF.`

### Forms
Building off the ability to validate parameters, 
forms collect valid user supplied input and store it 
in a relational provider (a specified table).

`TODO: Explain example arrangement and show GIF.`

### Bulk Actions
Bulk Actions combine reports and tasks. You may 
select records on a report, and send them to a 
task for processing.

<!--Actions are added to report arrangements like this:

```xml
<cfg name="report">
   <actions>
      <add name="task-alias" description="a description" />
   </actions>
</cfg>
```
-->

Five configurable tasks must be defined in order to run bulk actions:

1. `batch-create`: create and return a batch identifier
1. `batch-write`: write batch values.
1. `batch-summary`: gather review and result summary for a batch.
1. `batch-run`: indicate the task is running (not yet implemented)
1. `batch-success`: indicate the task succeeded
1. `batch-fail`: indicate the task failed

A recipe named "Transformalize Batches SQLite" provides an 
example set of the above tasks.

---

Putting it all together, here is a GIF showing a report (with map) that has a bulk 
action to change color associated with the record.

![bogus report](src/Site/App_Data/samples/sacramento-crime/criminal-bulk-actions.gif)

`TODO: Link to arrangement here.`

---

### Development
- Visual Studio 2019 with ASP.NET Core related workloads:
  - ASP.NET and Web Development
  - .NET Core Cross-Platform Development
- Relies on nuget source https://www.myget.org/F/transformalize/api/v3/index.json
- **Caution**: This project is still under development.