Professional Documents
Culture Documents
PDD - Generate Yearly Report
PDD - Generate Yearly Report
1
Generate Yearly Report – ACME Systems Inc. – Process Definition Document
Document History
2
Generate Yearly Report – ACME Systems Inc. – Process Definition Document
Contents
1. Introduction 4
1.1 Purpose of the document 4
1.2 Objectives 4
1.3 Process key contacts – Team Charter 4
1.4 Pre-requisites for automation 5
2. As IS process description 6
2.1 Process Overview 6
2.2 Applications used in the process 7
2.3 Process Walk-Through recordings 7
2.4 High Level AS IS 8
2.5 Low Level As IS 8
2.6 Detailed AS IS Process Steps 8
3. Solution 8
3.1 Detailed Process Map 8
3.2 Design Details 8
3.2.1 System Interface 8
3.2.2 RPA Module Level Design 8
3.3 Detailed Solution Design 9
3.4 Reporting 9
4. Scope 10
4.1 In Scope for RPA 10
4.2 Out of Scope for RPA 10
4.3 Business Exceptions Handling 10
4.3.1. Known Exceptions 11
4.3.2. Unknown Exceptions 12
4.4 Application Error and Exception Handling 12
4.4.1. Known Errors or Exceptions 13
4.4.2. Unknown Errors and Exceptions 15
5. User Acceptance Test Scenarios 15
6. Other Requirements and Observations 15
6.1 Additional sources of process documentation 15
6.2 Change/Improvement details 16
7. Document Approval 16
3
Generate Yearly Report – ACME Systems Inc. – Process Definition Document
1. Introduction
The document describes the sequence of steps performed as part of the Generate Yearly Report
process, the conditions, and rules of the process prior to automation and how they are envisioned to
work after automating it, partly or entirely. This specifications document serves as a base for
developers, providing them the details required for applying robotic automation to the selected
business process.
1.2 Objectives
The business objectives and benefits expected by the Business Process Owner after automation of
the selected business process are:
The process that has been selected for RPA is part of the larger Reporting process conducted within
the Finance and Accounting department.
The Process Owner is expected to review it and provide signoff for accuracy and completion of the
steps, context, impact and complete set of process exceptions.
4
Generate Yearly Report – ACME Systems Inc. – Process Definition Document
Process SME / Point of contact for questions
Process related to process details &
exceptions
reviewer
Process Point of contact for questions
Reviewer related to process details &
exceptions
1.4 Assumptions
<Here mostly we specify which are the assumptions that we start from>
For example, if the automation relies on a construction of an API, by the customer’s team we can
suppose the following
5
Generate Yearly Report – ACME Systems Inc. – Process Definition Document
- The API is created by the <TeamName> and available to the UiPath team during the
development period, with at least 7 working days overlapping period between the API
availability and development period
- The information of the API requests is provided by the <TeamName> to the UiPath team,
including but not only: endpoint, body, request format or authentication, status code
2. As IS process description
# Item Description
4 Process short description Download all the monthly reports for a specific vendor and
generate a yearly report.
(operation, activity,
outcome)
6
Generate Yearly Report – ACME Systems Inc. – Process Definition Document
8 Average handling time 15 min/vendor
per item
10 Transaction Volume -
During Peak period
12 Expected increase of -
volume in the next
reference period
13 Level of exception rate Between 1 and 3 monthly reports for each vendor could be
missing. Those months are to be ignored.
7
Generate Yearly Report – ACME Systems Inc. – Process Definition Document
The link(s) for the video recording(s) of the performed walk-through of the process should be added
in here.
Recording Description Path Date Last Updated
Step Description
1.1 Open the ACME System 1 Web Application.
1.2 Log in to System 1. Required input data: email and password.
1.3 Access the Dashboard - the central location, where the user can pick a specific menu item.
1.4 Access the Work Items listing to view all the available tasks to be performed (Output data: list
of tasks).
1.5 For each activity of type WI4, perform the following steps:
1.5.a Open the Details page of the selected activity to retrieve the Vendor Tax ID (Output data: Tax
ID).
1.5.b Go back to the Dashboard and access the Download Monthly Report section in the Reports
8
Generate Yearly Report – ACME Systems Inc. – Process Definition Document
menu.
1.5.c Fill in the Vendor Tax ID and download all the monthly reports for previous year
1.5.d Group the downloaded monthly reports into a single Excel file with the naming convention
“Yearly-Report-[Year]-[Tax ID].xlsx”.
1.5.e Upload the resulting yearly report file in the “Upload Yearly Report” section in the Reports
menu.
1.5.f Fill in the Vendor Tax ID, set the year, and select the file on your hard drive. This will return a
unique upload ID. Output: Upload ID.
1.5.g Go back to the Work Item Details page and select Update Work Item.
1.5.h Set the status to “Completed”. Add the following comment: “Uploaded with ID [Upload ID]”.
1.6 Continue with the next WI4 Activity.
ACME System 1 -
Step by Step.docx
3. Solution
Due to the fact that the applications used in this process could be Shared by multiple processes, a
library with reusable components will be created for the UI Interactions with each one of the
applications. The best practices, naming conventions, etc. for creating such a library can be found
here:
We should create one library for each one of the applications. See the Solution Design Table for
more details.
9
Generate Yearly Report – ACME Systems Inc. – Process Definition Document
A high-level overview of the code structure of the process meant to help the developers.
GetSetTransactionData:
Get from the queue a transaction item with
all the required information for WI4
Process:
Retrieve Vendor Tax ID
Download monthly reports
Merge monthly reports into a yearly report
Upload yearly report
Update item
End State:
Close ACME
A detailed explanation of the main workflows that need to be developed for this automation.
Information mostly destined to the RPA Developer:
Acme4 Solution
Design.xlsx
10
Generate Yearly Report – ACME Systems Inc. – Process Definition Document
3.4 Reporting
The robot will rely for reporting onto the Orchestrator logs.
4. Scope
4.1 In Scope for RPA
All steps (1-5.12) are in scope of RPA
4.2 Out of Scope for RPA
There are no steps which are not in scope for RPA.
The Business Process Owner and Business Analysts are expected to document below all the business
exceptions identified in the automation process. These can be classified as:
Known Unknown
11
Generate Yearly Report – ACME Systems Inc. – Process Definition Document
No Exception name Step Action to be taken
For known and unknown application exceptions, an email will be sent to the predefined distribution
list. This email will be having the following template (also do see an example):
Technology/ Experienced previously, action plan New situation never encountered before
or workaround available for it. or may happened independent of the
Applications
applications used in the process.
12
Generate Yearly Report – ACME Systems Inc. – Process Definition Document
4.4.1. Known Errors or Exceptions
The table below reflects all the errors identifiable in the process evaluation and documentation.
For each of these errors or exceptions, the robot will retry the transaction for a maximum of 3
times before performing the corresponding action.
If there is additional material created to support the process automation please mention it here,
along with the supported documentation provided.
13
Generate Yearly Report – ACME Systems Inc. – Process Definition Document
Additional Process Documentation
Video Recording of the process Insert any relevant comments
[Optional]
Process Steps Details Insert any relevant comments
Process Detail Map Insert any relevant comments
Other documentation Insert any relevant comments
(Optional)
Email templates
Site mapping IDs
Use this section to detail the list the change or improvement opportunity in the To-Be Process.
Important aspects to be mentioned: what is the initiative, expected outcome, expected completion
date, contact person for details, and if will impact the current automation request.
# Initiative name and Expected Process Step(s) Does it impact the current Expected Contact
Outcome/Benefits where it is automation request? How? completion date person for
identified more
details
7. Document Approval
This document requires serial approval (sign off) from the roles defined in the table below.
Changes to the requirements must be documented in an updated version (i.e. v 2.0) and requires a
new signature flow.
14
Generate Yearly Report – ACME Systems Inc. – Process Definition Document
Version Flow Role Name Organization Approval
Date:
(Dept.)
15
Generate Yearly Report – ACME Systems Inc. – Process Definition Document