/
docs.html
333 lines (314 loc) · 21.8 KB
/
docs.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="ie=edge">
<title>LIL HELPER DOCUMENTATION</title>
<link rel="icon" type="image/png" href="images/lilFavicon.png" />
<link rel="stylesheet" type="text/css" href="style.css" />
</head>
<body>
<header id="top">
<h1>LIL HELPER DOCUMENTATION</h1>
</header>
<main>
<div id="backToTop"><a href="#top"><h3>BACK TO TOP</h3></a></div>
<div id="tableOfContents">
<h2>TABLE OF CONTENTS</h2>
<ul>
<li><a href="#disclaimer"><b>DISCLAIMER</b></a></li>
<li><a href="#about"><b>ABOUT THE LIL HELPER: A BETTER WAY TO IMPORT</b></a></li>
<li><a href="#features"><b>FEATURES</b></a></li>
<li><a href="#setup"><b>SETTING UP THE LIL HELPER</b></a>
<ul>
<li><a href="#savingAndLoadingSettings"><b>SAVING AND LOADING YOUR SETTINGS</b></a></li>
</ul>
</li>
<li><a href="#usingLILHelper"><b>USING THE LIL HELPER: A STEP-BY-STEP GUIDE</b></a></li>
<li><a href="#devNotes"><b>DEVELOPMENT NOTES</b></a></li>
</ul>
</div>
<section id="disclaimer">
<h2>DISCLAIMER</h2>
<p>The <strong>LIL Helper</strong> is not associated with Magento or Freestyle Solutions in any way.</p>
<p>The <strong>LIL Helper</strong> is provided as-is, with no warranty.</p>
</section>
<section id="about">
<h2>ABOUT THE LIL HELPER:
<br />
A BETTER WAY TO IMPORT</h2>
<p>The <strong>LIL HELPER</strong> takes the heartache and pain out of importing Magento orders into MOM.
</p>
<p>For anyone who uses Bizsync to import orders from Magento to MOM,
the <strong>LIL Helper</strong> makes things easier by taking out the guess-work.
</p>
<p>Every MOM import has its potential dangers: shipping methods that need correction,
special orders, high-risk orders, it's a lot to look for. The <strong>LIL HELPER</strong>
finds these problems, and brings them to your attention. The means less time looking for potential
problems in an order, and more time fixing actual problems.
</p>
<p>The program takes the Bizsync file used in MOM/Magento import, and parses it into a readable list of
potential problems with orders.</p>
<p>The <strong>LIL HELPER</strong> can also take a CSV order file from Magento's Extended Orders page to
look
for more issues.</p>
<p>Using the <strong>LIL HELPER</strong> is as easy as selecting two files from your computer.</p>
<p></p>
</section>
<section id="features">
<h2>FEATURES</h2>
<p>The <strong>LIL HELPER</strong> can detect the <b>following issues</b> in a MOM import:</p>
<ul>
<li>If a customer has overpaid for expedited shipping.</li>
<ul>
<li><i><b>For example,</b> if they paid for <b>three-day shipping,</b> but live inside your
company's
<b>two-day shipping zone.</b></i></li>
</ul>
<li>A <b>UPS shipment</b> headed for a <b>PO Box.</b></li>
<li>A <b>UPS Residential shipment</b> headed to a <b>commercial address.</b></li>
<li>A <b>domestic UPS shipment</b> headed <b>outside the contiguous US.</b></li>
<ul>
<li><i><b>For example,</b> an order headed to <b>Hawaii, Alaska,</b> or <b>Puerto Rico.</b></i></li>
</ul>
<li><b>International orders.</b></li>
<li>An order that has a <b>labor</b> code or <b>special order</b> code, specific to your company.</li>
<li>Orders where the first digit of a phone number is '1'.</li>
<li>Multiple orders from the same customer, which may be combined.</li>
</ul>
<p>When you combine a <b>Magento order file</b> with your <b>MOM import file</b>, you can look for these
additional issues:</p>
<ul>
<li>High-value orders <b>requiring a signature.</b></li>
<li>High-value orders <b>requiring insurance.</b></li>
<li>Orders with a <b>high-fraud risk.</b></li>
<li><b>False positives</b> on high-fraud risk orders, due to being placed by a <b>CSR.</b></li>
</ul>
<p>The <strong>LIL HELPER</strong> has <b>additional features</b> to make importing easier:</p>
<ul>
<li>Auto-generated MOM Chat notifications for starting and ending imports.</li>
<li><b>Click-to-copy</b> for common phrases, like your company's <b>Alternate search ID</b></li>
<li>An <b>insurance calculator</b>, for quickly finding the insurance amount on an order, without
needing to
leave the program.</li>
</ul>
<p>The <strong>LIL HELPER</strong> is <b>built for security:</b> all information specific to your company,
like IP addresses
and labor codes, <strong> is stored locally, <i>not</i> on a server. <em>Take control of your
information!</em></strong>
</p>
<!-- <p>The following features are <b>IN-DEVELOPMENT</b> for <strong>MOM'S LIL HELPER:</strong></p>
<ul>
<li>Detect orders where items have <b>special packing requirements.</b></li>
</ul> -->
</section>
<section id="setup">
<h2>SETTING UP THE LIL HELPER</h2>
<p>The <strong>LIL Helper</strong> requires information specific to your company in order to work.</p>
<p>This information is securely stored in your browser's local storage, it is not stored on a server.</p>
<p>Once this information is entered by the user, it can be stored indefinitely, and updated if needed.</p>
<p>User info can be added, removed, or modified in the SETTINGS section</p>
<ol>
<li>To access user settings, load the <strong>LIL Helper</strong>,
and click the SHOW SETTINGS button in the <strong>top-right corner</strong> of the screen.
<img style="width:60%;" alt="location of the button to show settings" title="location of the button to show settings" src="images/showSettingsLocation.PNG" />
</li>
<li>When the SHOW SETTINGS button is clicked, it will reveal the setting section in the lower
half of the screen.
<img alt="the LIL Helper settings panel" title="the LIL Helper settings panel" src="images/settingsPanelFull.PNG" />
</li>
<li>The <strong>Company Name </strong> will be displayed when you submit your MOM Chat messages about
starting/ending the import.
<img alt="the company name input field" title="the company name input field" src="images/companyName.PNG" />
</li>
<li>The <strong>MOM Folder Validation String</strong> is a set of characters always found at the
beginning of the Bizsync file.
The LIL Helper checks for this sequence of characters to make reasonably sure that you're using the
correct file.
<img alt="the MOM Folder Validation string input" title="the MOM Folder Validation string input" src="images/momFolderValidationString.PNG" />
</li>
<li>The <strong>Magento Admin Folder Validation String</strong> is the same thing, but for the CSV file
output from Magento.
<img alt="the Magento Admin Folder Validation string input" title="the Magento Admin Folder Validation string input" src="images/magentoAdminFolderValidationString.PNG" />
</li>
<li>The <strong>Alternate ID</strong> is a code your company might use to quickly look up the
most-recent orders brought into MOM.
<img alt="Alternate ID input" title="Alternate ID input" src="images/alternateID.PNG" />
</li>
<li>Your <strong>Company IP Address</strong> is used to check for false-positives from Magento's fraud
detection.
When you process a customer's credit card, Magento's fraud detection will see a payment made with
the customer's card, hundreds or
thousands of miles away from the customer's billing address. Magento will usually assume that the
card has been stolen, and give a
high fraud risk to the order. The LIL Helper will check the IP address of an order against your
company's IP address, and use that
to detect a false positive.
<img alt="Company IP Address input" alt="Company IP Address input" src="images/companyIPAddress.PNG" />
</li>
<li>The <strong>Start and End times</strong> are used to narrow down the number of orders displayed, so
the LIL Helper
will only show orders relevant to your import. This is especially important if you are only using
the CSV order file from Magento.
<img alt="import times input fields" title="import times input fields" src="images/importTimes.PNG" />
</li>
<li>Sometimes, an order placed by customer service will have special instructions associated with it.
The <strong>special order code</strong>
is sometimes used to flag orders with special instructions.
<img alt="special order code input field" title="special order code input field" src="images/specialOrder.PNG" />
<p><strong>NOTE: The following items may require special attention to set up.</strong></p>
</li>
<li>Some orders require special packing. For example, orders that contain one large item, and several
small items, might require
two boxes instead of one. Make a list of all items in your MOM inventory that might require special
packing.
<strong>Separate items with commas and no spaces.</strong>
<img alt="special labor codes input field" title="special labor codes input field" src="images/specialLaborCodes.PNG" />
</li>
<li>The next three fields are used to help detect shipping problems with orders. For each of these
fields, use official state abbreviations,
and separate values by commas with no spaces.
<p>For this example, we have assumed that the shipping warehouse is located in <b>Colorado</b>.</p>
<ol>
<li>The <strong>One-Day Zone</strong> includes all US states where you could deliver <strong>UPS
Ground packages</strong> within one business day.
<img alt="one-day shipping zone input field" title="one-day shipping zone input field" src="images/oneDayZone.PNG" />
</li>
<li>Next, list all states in the <strong>Two-Day Zone</strong> for your company.
<img alt="two-day shipping zone input field" title="two-day shipping zone input field" src="images/twoDayZone.PNG" />
</li>
<li>Lastly, list all remaining states in the Contiguous (Lower-48) states US.
<img alt="rest of lower 48 states input fields" title="rest of lower 48 states input field" src="images/restOfLower48.PNG" />
</li>
</ol>
<p>If an order is shipping within the US, but outside the Lower 48 states (like Alaska or Hawaii),
the LIL Helper will automatically recognize that.</p>
<p>All orders not shipping to a recognized US state or territory will be automatically classified as
an <strong>international order</strong>.</p>
<p>If you notice any strange shipping notifications while using the LIL Helper, it may be due to a
mistake in these fields.</p>
</li>
<li>The <strong>High-Value Order Threshold</strong> is the dollar amount at which your company deems an
order to be high-value. These orders
may require a signature and/or insurance, and will probably need to be considered carefully. Your
company may require these orders have
matching billing/shipping addresses, or other special considerations.
<img alt="high-value order threshold input field" title="high-value order threshold input field" src="images/highValueOrderThreshold.PNG" />
</li>
<li>The <strong>Fraud Risk Threshold</strong> is the minimum Magento fraud risk score that your company
considers suspicious. These orders
may require special care. The LIL Helper will help detect false-positives caused by customer service
placing the order.
<img alt="high fraud risk threshold input field" title="high fraud risk threshold input field" src="images/fraudRiskThreshold.PNG" />
</li>
</ol>
<p><strong>These values are stored in local storage in your browser, they are not stored on a
server.</strong></p>
<h2 id="savingAndLoadingSettings">SAVING/LOADING YOUR SETTINGS</h2>
<p>In some cases, it may be useful for co-workers to share settings, rather than have everyone go through the setup process separately.</p>
<p>The LIL Helper makes it easy to copy your user settings, or load in someone else's</p>
<p><strong>To export your settings,</strong> click the button labeled <strong>Copy Settings to Clipboard</strong>
in the <strong>bottom-right</strong> of the settings panel.</p>
<img alt="button to copy settings to clipboard" title="button to copy settings to clipboard" src="images/copySettingsToClipboard.PNG" />
<p>Then, open a new email or text document, and hit <kbd>Control + v</kbd> to paste the settings. It will look something like this:</p>
<img alt="raw settings in text editor" title="what raw settings will look like in a text editor" src="images/copySettingsResults.PNG" />
<p>Do not be alarmed, it's supposed to look like that. You now have the raw LIL Helper settings that someone else can load into their program.</p>
<br />
<p><strong>To load someone else's user settings into your computer,</strong> click the <strong>LOAD SETTINGS</strong>
button in the <strong>bottom-left</strong> of the settings panel.</p>
<img alt="load settings button" title="load settings button" src="images/loadSettingsButton.PNG" />
<p>After clicking <strong>LOAD SETTINGS</strong>, you will receive a prompt, asking you to paste a 'settings string'.</p>
<img alt="'paste settings' prompt" title="'paste settings' prompt" src="images/pasteSettingsPrompt.PNG" />
<p>Paste the raw settings info from earlier, and click <strong>OK</strong></p>
<p>The settings will be automatically loaded into the LIL Helper, and saved into the browser's local storage.</p>
</section>
<section id="usingLILHelper">
<h2>USING THE LIL HELPER: A STEP-BY-STEP GUIDE</h2>
<ol>
<li><b>Load the Bizsync Orders.xml file</b>
<img src="images/xmlFileButton.PNG" title="The button for selecting the XML file." />
<p>This file will always be in the same folder
in your company's system.</p>
<img src="images/xmlFileInFolder.png" title="What the XML folder typically looks like." />
</li>
<li><b>Load the Magento Orders.csv file</b></li>
<p>To create the Magento order file, go into Magento, and click <b>Sales</b> --> <b>Extended Orders</b>
<img src="images/extendedOrders.png" title="The button for the Extended Orders page in Magento." />
</p>
<p>Select only orders from today, at the top of the <b>Purchased On</b> column for the order table.</p>
<img src="images/selectDates.PNG" title="Make sure you select the correct dates!" />
<p><strong>BY ODIN'S BEARD</strong>, <em>make sure you select a date before exporting!</em>
If you do not have dates selected, Magento will attempt to make a CSV file with <strong>all</strong>
company's orders, which will jam the system.</p>
<p>On the right-hand side of the page, click the <b>Export</b> button.</p>
<img src="images/magentoExportCSVButton.PNG"
title="The button for exporting Magento's CSV orders file" />
<p>This will download a CSV file to your specified download folder.</p>
<img src="images/downloadedCSVFile.png" title="What a dowloaded CSV orders file looks like in Chrome" />
<p>The CSV file is now ready to load.</p>
<li><b>Click the RUN PROGRAM button.</b>
<img src="images/runProgramButton.PNG" title="The button for running the LIL Helper" />
</li>
<li><b>Double-check that the import XML file is ready.</b>
<p>After you click RUN PROGRAM, you will be warned to check that
the import file is ready.
</p>
<img src="images/warningConfirm.PNG" />
<p>Never assume that just because the clock says
it's time for your import, that the import file is ready.
The Bizsync Orders.xml file may arrive early, or late.
Don't make the mistake of importing orders that were
already imported, that means nothing but a lot of needless
cleanup.
</p>
<p>As a safeguard against this, the <strong>LIL HELPER</strong>
will warn you before parsing the files to double-check that
your import file is ready.
</p>
</li>
<li><b>If the import XML file is ready, click 'OK'</b>
<p>The submitted files will be parsed and merged into
a single collection of data.</p>
<p>The program will terminate under the following conditions:</p>
<ul>
<li>If <em>no files</em> have been selected.</li>
<li>If the <strong>LIL HELPER</strong> does not recognize the file.</li>
<li>If either file is in the incorrect place,
for example, the CSV file is loaded in the area meant for the XML file.</li>
</ul>
<p>If only one file is used, and is in the correct place,
the program will still work, but not as much information will be processed.
<ul>
<li>Using only the <strong>import XML file</strong> will provide information about
<strong>shipping, special labor codes, special packaging, and phone numbers.</strong>
</li>
<li>Using only the <strong>Magento CSV file</strong> will provide information about
<strong>the value of an order, signature/insurance requirements, fraud risk, and fraud
risk false-positives.</strong></li>
<li>Using either spreadsheet provides information on <strong>multiple orders by one customer
within the same import.</strong></li>
</ul>
</p>
</li>
</ol>
<p>You will receive an alert, giving the number of orders the <strong>LIL HELPER</strong> found.
After dismissing the alert, the <strong>LIL HELPER</strong> will display a table of parsed information.
</p>
<p>After a moment, the program will <em>automatically</em> scroll to the bottom of the
table. You should start at the bottom, and work your way up through the orders.</p>
<p>There will occasionally be a small discrepancy between the number of orders processed
by the <strong>LIL HELPER</strong> and the number of orders in your MOM import.
</p>
</section>
<section id="devNotes">
<h2>DEVELOPMENT NOTES</h2>
<ul>
<li><b>LIL</b> stands for <b><u>L</u></b>ocal <b><u>I</u></b>ntermediary <b><u>L</u></b>ogic.</li>
<li>The <strong>LIL Helper</strong> was programmed using Vanilla JS. <img
style="display:inline;border:0px;" src="http://vanilla-js.com/assets/button.png" /></li>
</ul>
</section>
</main>
</body>
</html>