Skip to content

Commit ca808df

Browse files
authored
Workflow DataGenerator - update docs for 16 (#7209)
* update docs for 16 * lint
1 parent 2c55898 commit ca808df

File tree

3 files changed

+26
-7
lines changed

3 files changed

+26
-7
lines changed

16/umbraco-workflow/data-generator/data-generator.md

Lines changed: 26 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The generator gets you up and running for testing or product evaluation without
77
## Installation
88

99
{% hint style="info" %}
10-
The package must only be installed into an empty Umbraco application.
10+
The package should only be used in testing or product evaluation environments.
1111
{% endhint %}
1212

1313
To install the Umbraco Workflow DataGenerator package (Umbraco.Workflow.DataGenerator), follow these steps:
@@ -41,9 +41,32 @@ When the application restarts, it will automatically install [The Starter Kit](h
4141

4242
## Getting started
4343

44-
The package adds an additional view in the Workflow settings, which provides controls for the data generation task.
44+
The package adds new API endpoints for creating and removing Workflow configuration. There is no Backoffice interface, instead the API should be accessed via Swagger.
4545

46-
<figure><img src="images/data-gen-dashboard.png" alt="Data Generator dashboard"><figcaption></figcaption></figure>
46+
The package makes use of Umbraco's Delivery API configuration, to configure an API key in the request headers. Note in the configuration example below `PublicAccess` is disabled. If an API key is not provided, the API will return a 401 Unauthorized response.
47+
48+
```
49+
{
50+
"Umbraco": {
51+
"Cms": {
52+
"DeliveryApi": {
53+
"Enabled": true,
54+
"PublicAccess": false,
55+
"ApiKey": "workflow"
56+
}
57+
}
58+
}
59+
}
60+
```
61+
62+
## Usage
63+
1. Run the application and navigate to `/umbraco/swagger/`
64+
2. Select the `Umbraco Workflow Data Generator API` definition in the dropdown.
65+
3. Click on the `POST /umbraco/workflow/data-generator/api/v1/generator` endpoint.
66+
4. Click on `Try it out!` and set the parameters for the endpoint before executing.
67+
5. The endpoint will now generate the specified number of groups, users and relate configuration as a background task.
68+
- To see the current generation status, use the `GET /umbraco/workflow/data-generator/api/v1/generator/status` endpoint.
69+
6. Go to the Umbraco backoffice and navigate to the `Workflow` section, and click on `Approval Groups` to verify the new groups have been created.
4770

4871
The available settings are explained below.
4972

@@ -52,12 +75,8 @@ The available settings are explained below.
5275
* **Number of groups per workflow** - determines how the created groups are allocated into the generated workflows. Defaults to 0, which allocates a random number of groups to each workflow.
5376
* **Number of users per group** - determines how the created users are allocated into the generated workflow approval groups. Defaults to 0, which allocates a random number of users to each approval group.
5477

55-
When the generator task completes, you will be prompted to take a Workflow tour. The tours can be resumed at any time from the Data generation view.
56-
5778
Groups and users are created with arbitrary names, feel free to rename these to suit.
5879

5980
### Reset
6081

6182
Once Workflow configuration has been updated, the environment must be reset before regenerating. Resetting cancels all active workflows and deletes all workflow configuration. Umbraco users are not deleted, but will be reused in future data generation actions.
62-
63-
<figure><img src="images/data-gen-reset.png" alt="Data Generator dashboard - reset"><figcaption></figcaption></figure>
Binary file not shown.
Binary file not shown.

0 commit comments

Comments
 (0)