# {{BOT_NAME}}: ops guide Version {{VERSION}} · Written {{DATE}} · Questions or problems: {{ESCALATION_CHANNEL}} (see section 9) ## 1. What this bot does {{AT_MOST_2_LINES: what it does, in which app, from which input}} ## 2. Where is what | Where | What you see there | Open it when | |---|---|---| | {{TAB / SCREEN / FILE / FOLDER}} | {{WHAT IT SHOWS}} | {{WHEN}} | ## 3. How to run **Before you start** - [ ] {{PREREQUISITE: e.g. the target app is installed and you can sign in}} - [ ] {{INPUT RULE: e.g. one clinic per row. Wrong: "North, South". Right: "North" and "South" on two rows.}} - [ ] The app shows version {{VERSION}}. **Steps** 1. {{e.g. Open "" from the Desktop.}} 2. {{e.g. On the Run tab, drop the input Excel on the upload box.}} 3. {{e.g. Check the preview: every sheet has rows.}} 4. {{e.g. Click "Trigger automation".}} **What a normal run looks like:** {{e.g. the 7 checkpoint boxes turn green one by one; the live log shows each item}} ## 4. How long to wait | Step | Normal time | The bot waits at most | After that the bot | What you do | |---|---|---|---|---| | {{STEP}} | {{e.g. 1 min, or "not measured"}} | {{e.g. 5 min}} | {{e.g. restarts the app, up to 3 times}} | {{e.g. nothing, wait}} | **When do you step in?** {{e.g. only when the run ends red, or a box stays red after 3 restarts}} ## 5. After the run | Ending | Meaning | What you do | |---|---|---| | {{e.g. green "Completed"}} | {{MEANING}} | {{ACTION}} | **The report:** {{e.g. Report tab → choose the batch → File Status column. Export with the Excel button.}} | Status | Colour | Meaning | What you do | |---|---|---|---| | {{STATUS}} | {{COLOUR}} | {{MEANING}} | {{ACTION or "nothing"}} | ## 6. How to see an exception 1. {{e.g. Report tab → filter File Status = Error.}} 2. {{e.g. Read the Comments column.}} 3. Find that message in section 7. ## 7. Exception list | ID | Message you see | Where | What it means | What you do | Bot retries / call us when | |---|---|---|---|---|---| | E01 | {{EXACT MESSAGE}} | {{TAB → COLUMN, or FILE}} | {{ONE SENTENCE}} | {{STEPS}} | {{e.g. "Bot retries 3 times, wait. Call us if it fails again."}} | ## 8. How you will know {{e.g. "There is no email or alert. Check the Dashboard after every run, and every morning for the night run."}} ## 9. How to tell us - **Where:** {{ESCALATION_CHANNEL}}. Expect an answer within {{RESPONSE_TIME}}. - **Send:** {{e.g. batch ID, time of the problem, E-number from section 7, a screenshot of the screen, the report row}} - **Never send:** passwords, the settings file, or patient or customer data in chat. Copy this message: ``` Bot: {{BOT_NAME}} v{{VERSION}} Batch / run ID: Time: E-number and message: What I already did: Screenshot: attached ``` ## 10. Don'ts - {{DON'T: e.g. "Don't use the mouse or keyboard while it runs. The bot's clicks land in the wrong window."}} - **To stop the bot:** {{THE ONE RIGHT WAY}} ## 11. Issues seen before | When / version | What you saw | What to do now | |---|---|---| | {{DATE / VERSION}} | {{SYMPTOM}} | {{ACTION, or "fixed in vX, nothing to do"}} |