Skip to content

Commit 9236a83

Browse files
committed
Update the readme file
Add the project description, install steps, usage, etc.
1 parent acf8dac commit 9236a83

File tree

2 files changed

+23
-111
lines changed

2 files changed

+23
-111
lines changed

README.md

Lines changed: 23 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,9 @@
11
# Automatic Workflow Branching
22

3-
The Automatic Workflow Branching project demonstrates automatic workflow branching based on a property of the controlled item.
3+
The Automatic Workflow Branching project demonstrates automatic workflow email notifications.
44

55
#### How it works
6-
A method is attached to an automatic activity as an OnActivate server event. When the workflow
7-
is started, the automatic activity is activated and the method finds the controlled item. It
8-
then reads the Plant property, finds the corresponding path and sets that path to be the default.
9-
The activity then closes and the default path is followed.
6+
Two email items are attached as OnActivate notifications to All Assignments. The simple email uses the string "${Item/item_number}" to show the controlled item's number property in the body of the email. The other email uses a query string to get properties of both the activity and the controlled item.
107

118
## Project Details
129

@@ -24,7 +21,19 @@ The activity then closes and the default path is followed.
2421

2522
1. Aras Innovator installed (version 11.0 SPx preferred)
2623
2. Aras Package Import tool
27-
3. AutoWorkflowBranching import package
24+
3. AutoWorkflowEmail import package
25+
4. The Innovator Admin user's email is set to your email address.
26+
5. Aras is configured to send emails, meaning one of the following scenarios:
27+
* The mail server is configured in `InnovatorServerConfig.xml`:
28+
```xml
29+
<Mail SMTPServer="[SMTP Server IP]"/>
30+
```
31+
* Email debugging is enabled in `InnovatorServerConfig.xml`:
32+
```xml
33+
<operating_parameter key="email_debug_option" value="file"/>
34+
```
35+
36+
> Note: If email debugging is enabled in InnovatorServerConfig.xml, all emails will be saved as files in the temp folder (Innovator\Server\temp by default). No emails will be sent to the user's actual email address.
2837
2938
### Install Steps
3039

@@ -34,25 +43,24 @@ The activity then closes and the default path is followed.
3443
* _Note: You must login as root for the package import to succeed!_
3544
4. Enter the package name in the TargetRelease field.
3645
* Optional: Enter a description in the Description field.
37-
5. Enter the path to your local `..\AutoWorkflowBranching\Import\imports.mf` file in the Manifest File field.
38-
6. Select **aras.labs.WorkflowAutomationExamples** and **aras.labs.AutoWorkflowBranching** in the Available for Import field.
46+
5. Enter the path to your local `..\AutoWorkflowEmail\Import\imports.mf` file in the Manifest File field.
47+
6. Select **aras.labs.WorkflowAutomationExamples** and **aras.labs.AutoWorkflowEmail** in the Available for Import field.
3948
7. Select Type = **Merge** and Mode = **Thorough Mode**.
4049
8. Click **Import** in the top left corner.
4150
9. Close the Aras Package Import tool.
4251

43-
You are now ready to login to Aras and try out Automatic Workflow Branching.
52+
You are now ready to login to Aras and try out Automatic Workflow Email notifications.
4453

4554
## Usage
4655

4756
1. Log in to Aras as admin.
4857
2. Navigate to **Workflow Examples** in the table of contents (TOC).
49-
3. Create a new Workflow Assignment Example item.
50-
4. Set the Plant property to any of the listed values.
51-
5. Click **Save/Unlock/Close**.
52-
6. Navigate to **My Innovator > My Inbasket** in the TOC.
53-
7. Search for the newly created assignment. The assignment activity should correspond to the chosen Plant on the Workflow Branching Example form.
58+
3. Create a new Workflow Email Example item.
59+
4. Click **Save/Unlock/Close**.
60+
5. Navigate to **My Innovator > My Inbasket** in the TOC.
61+
6. Search for the newly created assignment.
5462

55-
To review the dynamically created assignment and the paths of the workflow process item, open the Work Item from the assignment. On the item form, select **Views > Workflow** from the main menu to view the workflow process.
63+
If you configured the SMTP server for your Aras instance, you can check your inbox to confirm whether the notification email was sent. If you enabled email debugging instead, check the temp folder. Any email notifications created by Aras will be saved as in the temp folder as text files.
5664

5765
## Contributing
5866

readme.txt

Lines changed: 0 additions & 96 deletions
This file was deleted.

0 commit comments

Comments
 (0)