Skip to content

Commit 74f9b69

Browse files
author
Esther Fan
committed
Update draft
1 parent 2d77577 commit 74f9b69

File tree

1 file changed

+39
-37
lines changed

1 file changed

+39
-37
lines changed

articles/logic-apps/create-publish-workflow-templates.md

Lines changed: 39 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,18 @@ Not only can you kickstart development with workflow templates, you can create w
2525

2626
If you don't have this resource, see [Create an example Standard logic app workflow](create-single-tenant-workflows-azure-portal.md).
2727

28+
- Screenshots that show a read-only preview for the workflow template with **.png** file name extension. These preview images for template appear on the template overview pane in the templates gallery.
29+
30+
To create these images, follow these steps:
31+
32+
1. In the [Azure portal](https://portal.azure.com), open the Standard logic app and source workflow in the designer.
33+
34+
1. Set up the workflow to create two screenshots: one version that works with a web browser's light theme and another version that works with a web browser's dark theme.
35+
36+
1. Create the screenshots using your preferred screen capture tool. Don't include too much whitespace around the workflow.
37+
38+
1. Save each image using the **.png** file name extension and a name that follows the [Names and style conventions](#names-style-conventions), for example, **<*image-name*>-light.png** and **<*image-name*>-dark.png**.
39+
2840
## Limitations
2941

3042
Workflow templates currently support only Standard logic apps.
@@ -89,24 +101,27 @@ Next, choose the source workflow definition to use for your template.
89101

90102
| Parameter | Required | Value | Description |
91103
|-----------|----------|-------|-------------|
104+
| **Workflow name** | Yes | <*JSON-workflow-name*> | The JSON name for the workflow that can use only lowercase letters, numbers, and hyphens and which you can rename only one time. |
105+
| **Workflow display name** | Yes | <*workflow-friendly-name*> | The friendly name that appears in the user interface. |
106+
| **State** | Yes | **Stateful** or **Stateless** | Whether to save and store workflow run history, operation inputs, and operation outputs, by default. |
107+
| **Summary** | Yes | <*short-description*> | A short high-level summary about purpose for the template. |
108+
| **Description** | No | <*detailed-description*> | A description with more detailed information about the template. |
109+
| **Prerequisites** | No | <*prerequisites*> | Any requirements that you need before you can use the template. |
92110

93-
Workflow name (Can rename only once. Lowercase letters, numbers, and hyphens only)
94-
Workflow display name
95-
State (Stateful, Stateless)
96-
Trigger
97-
Summary
98-
Description (optional)
99-
Prerequisites (optional)
100-
Light mode image
101-
Dark mode image
111+
1. In the **Workflow images** section, provide the workflow preview images to use for the template overview pane in the templates gallery. This pane includes other template information.
102112

113+
| Workflow image | Description |
114+
|----------------|-------------|
115+
| **Light mode image** | The light-themed preview image for your template. |
116+
| **Dark mode image** | The dark-themed preview image for your template. |
103117

104-
### [Manual](#tab/manual)
118+
1. When you're done, select **Save**.
105119

120+
### [Manual](#tab/manual)
106121

107-
---
122+
For the manual approach to create a template, you need to create a template package.
108123

109-
## What does a template package include?
124+
#### What is in a template package?
110125

111126
The following table describes the required and optional files in a template package:
112127

@@ -122,7 +137,7 @@ The following table describes the required and optional files in a template pack
122137

123138
You can also include any other files to maintain and support your template, for example, files with test or sample data.
124139

125-
## Create a template package folder
140+
#### Create a template package folder
126141

127142
- Before you create the template package folder, get familiar with [Names and style conventions](#names-and-style-conventions).
128143

@@ -134,7 +149,7 @@ You can also include any other files to maintain and support your template, for
134149

135150
- To correctly register your template package folder, you must add the folder name to the [repository's root-level manifest.json file](https://github.com/Azure/LogicAppsTemplates/blob/main/manifest.json).
136151

137-
## Create a workflow.json file
152+
#### Create a workflow.json file
138153

139154
The **workflow.json** file contains the underlying definition for a workflow in JSON format. To create the **workflow.json** file, you need to copy and save your workflow definition as a file named **workflow.json**.
140155

@@ -184,29 +199,6 @@ For example:
184199

185200
For more information about the connector ID, see [Find the connector ID](#find-connector-id).
186201

187-
## Create a workflow template image
188-
189-
In the Azure portal, each workflow template has an overview pane in the workflow templates gallery. This pane includes a read-only preview image for the workflow that the template creates plus other template information.
190-
191-
To create this preview image, follow these steps:
192-
193-
1. In the designer, set up your workflow for creating two screenshots.
194-
195-
You need to create a version each for the browser light theme and dark theme.
196-
197-
1. Create the workflow screenshots using your preferred screen capture tool. Don't include too much whitespace around the workflow.
198-
199-
1. Save each image using the **.png** file name extension and any name that you want, following the [Names and style conventions](#names-style-conventions).
200-
201-
1. In the **manifest.json** file for your workflow template package, add the same image names to the **`images`** section without the **.png** file name extension, for example:
202-
203-
```json
204-
"images": {
205-
"dark": "workflow-dark",
206-
"light": "workflow-light"
207-
}
208-
```
209-
210202
### Create a manifest.json file
211203

212204
The **manifest.json** file describes the relationship between a workflow and related components. Currently, you need to manually create this file, or you can repurpose the **manifest.json** file from an existing prebuilt template in the [Azure Logic Apps workflow template repository in GitHub](https://github.com/Azure/LogicAppsTemplates). As you create the **manifest.json** file, make sure to review the [names and style conventions](#names-and-style-conventions).
@@ -229,6 +221,14 @@ The following table describes the attributes in the **manifest.json** file:
229221
| **`connections`** | Yes, but can be empty if none exist. | <*connections-array*> | The connections to create using the workflow template. Each connection has the following properties: <br><br>-**`connectorId`**: The connector ID must have the suffix, **`_#workflowname#`**. Use only alphanumeric characters, hyphens or underscores, and follow this format: <br><br>**`<connector-ID>_#workflowname#`** <br><br>To find the connector ID, see [Find the connector ID](#find-connector-id). <br><br>- **`kind`**: The connector's runtime host type, which is either **`inapp`** for built-in operations and service provider connectors or **`shared`** for managed, Azure-hosted connectors. In the connectors gallery, built-in operations and service provider connectors are labeled as **In App**, while managed connectors are labeled as **Shared**. |
230222
| **`featuredConnections`** | No | <*featured-connections-array*> | By default, the template gallery shows icons for the prebuilt operations and connectors in Azure Logic Apps used by each template. To include icons for any other operations, you can use the **`featuredConnections`** attribute. Each operation must have the following attributes: <br><br>- **`kind`**: The operation kind <br><br>- **`type`**: The operation type <br><br>To find these values, see [Find the operation kind and type for featuredConnections section](#find-featured-connections-operation-properties). |
231223

224+
In the **manifest.json** file for your workflow template package, add the same image names to the **`images`** section without the **.png** file name extension, for example:
225+
226+
```json
227+
"images": {
228+
"dark": "workflow-dark",
229+
"light": "workflow-light"
230+
}
231+
```
232232
<a name="find-connector-id"></a>
233233

234234
## Find the connector ID
@@ -343,6 +343,8 @@ To publish your template to the templates gallery in the Azure portal, set up Gi
343343

344344
For more information, see [Creating a pull request from a fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork).
345345

346+
---
347+
346348
<a name="names-style-conventions"></a>
347349

348350
## Names and style conventions

0 commit comments

Comments
 (0)