Page Comparison

{anchor:start_step}
h1. Start Step

The start step is automatically created when the campaign is first created.  It is displayed at the bottom of the screen (_scroll down to see it_).  It does no action.  It serves as an anchor.  The start step can contain only one child step and cannot be deleted.
\\ !worddav33c49eef9d96a272e10b1aa69d6d0a03.png|height=213,width=284!
*The Start Step anchors all other steps*
\\
\\
The start step contains hyperlinks common to all steps.    While the start step cannot be deleted, all other steps also contain a \[Delete\] link.  The Delete action is discussed separately later in the chapter because it is complex.
\\
| Hyperlink | Action |
| \[View History\] | This link will open a report page showing every customer that has ever passed through the step.   The Step & Recipient History section discusses the history report in detail. |
| In Queue | This link will display all active recipients whose 'Next Step' is the Start step.  These are customers who are newly enrolled. |
| Total Executions | This link will display all recipients -- active or otherwise -- who have ever passes through this step. |
| Successful | This link displays a history of all customers who have successfully completed this step.  The start step does nothing, so all recipients will succeed this step. |
| Failed | This link displays a history of all customers who failed at this step.  The start step cannot fail.  Other steps may fail for numerous reasons. \\
\\
Logic steps may fail for invalid velocity code or an invalid $result velocity variable. \\
\\
Email steps may fail for a myriad of reasons such as connectivity issues, template errors or velocity code errors. \\
\\
Pause steps never fail. |
| \[Add Step\] | The Add Step link displays the Add Step form. |
\\
\\

h1. Adding a Step

{tip}
*Tip*: A brief word about step names.  The name can be anything you wish within the max character limit.  However, the names are used as the output from logic steps to determine which step executes next.  For that reason, keep your names simple.  Do not add leading or trailing spaces, as that's sure to cause trouble down the road.  Underscores instead of spaces may also prevent typing errors when matching logic outputs to child steps.  The velocity error checker does not validate your $result values to child step names.  It is your responsibility to get it correct.
{tip}
\\ \\
Click the \[Add Step\] link at the bottom right of any step to add a step.  The link will not be available for any step restricted to one child and already having a child.  The Edit/Add Step form displays all properties available for all steps.  Once a type is selected, non-applicable properties are grayed out.
\\ !worddav90f204aa597ecb64861275d34d477c2f.png|height=239,width=407!
*Edit/Add Campaign Step Form*
\\ \\
\\ !worddave97f31c9a95de2f3574447fe59bbd587.png|height=240,width=408!
*Add/Edit Step Form showing the different types of Steps*
\\
\\

{anchor:logic_step}
h1. Logic Step

The Logic Step allows for branching.  Why branch?  Branching is desired any time a different email should be sent based upon the customer. Possible reasons for branching:
* Has the customer ordered before?
* Has the customer ordered a specific item before?
* Has the customer ordered with the last XX days?
* How many items has the customer ordered?
* Has the customer spent more than XX dollars?
* Is today a particular month/week/day?
* Is the customer in a particular state or region where one offer may be preferred?

\\
\\ 
{warning}
 *Warning*: The Logic step is a two-part step.  The step is created and saved first, and then the logic is added.  This allows for extra error checking of the velocity code.  Do not forget to add code to your logic step.
\\
Forgetting to add code to your logic step will cause the step to fail, halting all recipients at that step.  That would be bad -- _bad like digging up an alien gate, activating it, and then going through it with only light weapons and a single nuke_.
\\
!worddav2e22598198a9ec9556ef0e4a842abbd3.png|height=113,width=150!
{warning}
\\
\\
To create a logic step, select Logic as the type, provide a name for the step, and click Ok.  No other settings are needed.  Once created, the logic step will appear below its parent, and the overall tree structure will re-position accordingly.  A small warning icon will appear in the bottom left of the step.  This is an alert for empty logic.  Any step with empty logic will fail, so the alert is your cue to add logic.
\\ !worddav717553614a0fa9fb0e60809598982e62.png|height=346,width=267!
*Warning\!  A newly created logic step needs code\!*
\\ \\
Click the \[Edit Logic\] link to add velocity code.  A form will display providing a text area for velocity code.  The Velocity Code section that follows provides detail on creating complex code.
\\ \\
At a bare minimum, the logic step code must set the value of $result to the name of a child step.
\\ !worddav63e44f3f7900f0fda7959cfcd8fe9ff0.png|height=308,width=488!
*Campaign Logic Step - Logic Editor*
\\ \\
The editor will validate the code when the Ok button is clicked.  Any errors will display the output from the velocity compiler.  Admittedly, the error messages can be vague.   However, the most important feedback is the line number.  Use the line number to troubleshoot the problem.  Google, the UltraCart forums, and the Apache Velocity mailing lists will help solve the problem.
\\
\\ !worddav569d390e2a4adaa5f52601717515bee2.png|height=393,width=501!
*Campaign Logic Step - Velocity Syntax Error Message*
\\ \\
A logic step may have as many children as desired.  Click the \[Add Step\] link and add steps as needed.  The screen will re-position the steps as each are added.
| !worddavd073a0fed536ce7e1aedc1392ca40ef8.png|height=161,width=124! | *{rarr}* | !worddav85c2a1f96777a149173dca556e647ab8.png|height=204,width=102! | *{rarr}* | !worddav7a8567a73691be26f8d96258e8aa9119.png|height=203,width=192! |
\\
\\
{tip}
*Ending a campaign*: If you wish to end a campaign at a logic step, simply set the *$result* variable equal to *\_ENDCAMPAIGN\_*
Example, which proceeds to step *NextStepName* unless the customer has ordered in the last 14 days.  If they have, their campaign is over.
{code:linenumbers=true|theme=DJango}
#set($result = 'NextStepName')
#if($customer.hasOrderedInLastDays(14))
   #set($result = '\_ENDCAMPAIGN\_')
#end
{code}
{tip}
\\
\\
{tip}
*Looping*: If you wish to loop a campaign, then set a logic step *$result* variable equal to *\_GOTO:StepName\_*
The [ucdoc:Sunday Night Coupons] tutorial makes heavy use of _GOTO_ directives.
{code}
{tip}



{anchor:email_step}
h1. Email Step

Because email steps use templates, creating an email step is relatively simple.  The major decisions are template selection and parameter overrides.   Create an email step by clicking the \[Add Step\].   Supply a name and select a template.  Click the Ok button to create the step.
\\ \\ !worddav8d924a11cfd281615e5ca01cf46751d0.png|height=246,width=416!
*Email Step Creation Example*
\\ \\
The Email Step (shown below) has some links on it the other steps do not.
!worddav8ccca0a54a700efa840ceffb5b2f8804.png|height=179,width=265!
*Autoresponder Campaign Email Step*
\\ \\
Email Step Links
| Hyperlink | Action |
| Template | Click the template name to visit the template.  From there, you may change the email content or parameters. |
| \[View Performance\] | This link will open a performance report showing email specific results for the step including bounces, opens, link clicking, and purchasing as a result of a campaign. |
| Opt Out | The Opt Out statistic displays the count of recipients who opted out during this step.  Click the link to see a detailed list of every recipient who opted out of the campaign at this step. |
| Sales Response | This link displays the total sales attributed to this email.  Click the link to see a list of all recipients who placed orders for this campaign.  Please see the section near the end of the chapter titled "Attributing Sales to a Campaign" for important details about Sales Response. |
| Suspend | Click to suspend the step.  A suspended step is skipped over, and the next step executes.  This is a way to ice a step and still allow the campaign to continue. |
| \[Parameters\] | Click to edit email parameters.  See the following discussion on editing parameters. |
\\
\\
h2. Editing Parameters

Email Templates containing parameters may have step specific values.  To edit parameters, click the \[Parameters\] link on the Email step.  You'll notice that the pointer doesn't change to a hand icon.  This is a result of the drag-n-drop ability of steps (_discussed later_).
\\ !worddav97ff26977923ae7a4234416067a4b0c9.png|height=65,width=272!
*Email Step's Parameters link*
\\ \\
When clicked, a form appears displaying the email template parameters and the defaults.  Override any defaults by filling in the input field to the right of the default value.  Leave the field blank to use the default.
\\ !worddav7654dc97ebf3ffc6aabfbc296d44ad36.png|height=236,width=514!\\
\\
{anchor:pause_step}
h1. Pause Step

The Pause step does what it's named.  It pauses.  Pauses are useful to allow a customer to react to an email, or to simply avoid sending customers too many emails.
\\
To create a Pause step, click the \[Add Step\] link of any step and set the type to Pause in the Add/Edit Step form.   The only other requirement for a Pause step is the duration.   The Pause Duration is stored in hours, but the entry field allows shorthand for days and weeks as well.  If no unit is provided, the number is assumed to be hours.  The Pause Duration only accepts whole numbers.  If fractional days are needed, enter hours (example: 3.5d = 84h).
\\ \\ !worddav6756f42ce20ffd8cbd748d4725ddbceb.png|height=245,width=415!
*Adding a Pause Step*
\\ \\
Here are some shorthand examples:
\\ \\ !worddav150fbeaea84d2b1995a7f1cacdb2de69.png|height=30,width=350!\\ !worddav56c7d10363de1a80802c463c2629b6d8.png|height=25,width=358!\\ !worddav7d83d3fc00bbd11188999d060a9cc1d5.png|height=27,width=342!\\
\\
h1. Rearranging Steps

Campaign steps may be rearranged by dragging and dropping a step onto another.  When a step is dragged and dropped, all of its children come with it.  The target step will highlight in yellow when another step is dragged onto it.   Be patient with moving steps.  Do not make another move while the Wait message is displaying.
\\
| !worddavbc9eb6a9bef5b5a04fe326bca9d9b764.png|height=176,width=230! | {rarr} | !worddavaab45d57ab59f29658f623fc75770cfe.png|height=173,width=179! |
\\
\\
\\
\\
\\

h2. Rules for Rearranging

# Dragging steps onto a step with no children is a straightforward appending to the target step.  The dragged step becomes a child of the target step.
# If a target already has children, the result depends on the target type.
## If steps are dropped onto a logic step, they become children of the logic step.  Since a logic step can have numerous children, the dropped step becomes a sibling to any other children the logic step already has.
## If steps are dropped onto any other step that already has children, then the dropped step (and its children) is injected between the target and the target's children.

\\ !worddavf381c959f3b52cc488e2d5fde4265de9.png|height=176,width=256!\\
Action: Drag Step B onto Step D
Result:  Step B and C inject between
Step D (target) and its children (Step E)
\\
\\ !worddavc977938fec92c41ee164e7a4bf22f63e.png|height=303,width=110!\\
## If the step being dragged (moved) has more than one branch, the target's original children are appended to the first branch.  For the example below, Step B is dragged onto Step D.   Step E is appended to the first branch.  If this is not desired, simple move Step E to its new parent.

\\ !worddave7ceaac7f8ab352571f45034c16a39da.png|height=176,width=371!\\
Action: Drag Step B onto Step D
Result:  Step B, C and F inject between Step D (target)
and its children (Step E).  Step E is appended to Step C.
\\
\\ !worddavc20cda6131d010c5ec3804f7747b8851.png|height=330,width=243!\\
\\

h1. Deleting Steps

Deleting a step raises two issues.
# What do I do with the children of the step (subsequent steps in the chain)?

Choices:
* Delete the children as well
* Shift the children up, filling the hole caused by deleting the step.

\\
# What do I do with recipients who are currently scheduled for the deleted step?

Choices:
* Move them to another step of your choice.

These options are presented when the \[Delete\] link is clicked for a step.
\\ !worddavfc6d46eee161276b61ccdc81a3102be6.png|height=259,width=315!\\
Please note: if you delete a Logic step containing more than one branch, the branches cannot be shifted up because they would collide.  If you wish to keep the branches, move them to different steps before deleting the Logic, and then move them back in the desired order.
\\ !worddav4ed8144eebe3bd850cf85c14fc3b3b9a.png|height=160,width=575!
*Warning Message when deleting a Logic Step with multiple children*
\\
\\
\\