Scribd
Upload
78 views3 pages

UiPath-ADPv1 Cheat Sheet - REFramework

Uploaded by

daneelrolivaw
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as TXT, PDF, TXT or read online on Scribd
78 views3 pages

UiPath-ADPv1 Cheat Sheet - REFramework

Uploaded by

daneelrolivaw
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as TXT, PDF, TXT or read online on Scribd
You are on page 1/ 3

UiPath RE-Framework Cheat Sheet for Version 2022.

10
Introduction
The UiPath Robotic Enterprise Framework (REFramework) is a robust template designed
to handle complex automation processes efficiently. It provides built-in best
practices for logging, exception handling, and application initialization, making
it an essential tool for Automation Developers.

Key Concepts
State Machines: The REFramework is based on state machines, which include:

Init: Initializes applications and config settings.


Get Transaction Data: Retrieves new transaction items to process.
Process Transaction: Processes the retrieved transaction items.
End Process: Closes applications and performs cleanup activities.
Dispatcher and Performer Model:

Dispatcher: Adds transaction items to Orchestrator queues.


Performer: Processes the transaction items from the queues.
Exception Handling: Utilizes Try-Catch blocks to handle system and business
exceptions throughout the workflow.

Framework Layers
Framework Layer: Manages settings and application checks.
Business Process Layer: Contains the business logic implemented in reusable
workflows.
Data Layer: Manages the Config file and data input files.
Service Layer: Executes specific tasks such as data retrieval.
Configuration File
The Config file is central to the REFramework, storing settings, constants, and
asset information. It is divided into three sheets:

Settings: Stores key-value pairs for configurations.


Constants: Stores static values used across the process.
Assets: References assets stored in Orchestrator.
Steps to Build an REFramework Project
Setup:

Clone the REFramework template from UiPath Studio.


Configure the Config file with necessary settings, constants, and assets.
Initialization:

Initialize applications and check preconditions.


Handle potential initialization errors and retry if necessary.
Transaction Data Handling:

Retrieve transaction items from Orchestrator queues.


Transition to processing state if data is available.
Processing Transactions:

Implement business logic in the Process Transaction state.


Handle business and system exceptions appropriately.
Cleanup:

Close all applications and clean up resources in the End Process state.
Best Practices
Logging: Implement detailed logging for better monitoring and debugging.
Modularity: Break down processes into reusable workflows.
Error Handling: Use global exception handlers and retry mechanisms.
Scalability: Use the Dispatcher and Performer model for handling large volumes of
transactions.
Resources and Training
UiPath Academy Courses: Several courses are available to help you master
REFramework, including "Introduction to Robotic Enterprise Framework," "Building a
REFramework Project with Orchestrator Queues," and practical exercises to apply
what you've learned.
UiPath Documentation: Detailed guides and reference materials are available on the
UiPath documentation portal.

UiPath REFramework Config.xlsx Cheat Sheet


The Config.xlsx file in the UiPath REFramework is critical for managing
configurations, constants, and assets. It ensures that the automation process can
be easily maintained and updated without altering the core logic of the workflows.

Overview of Sheets
Settings Sheet
Constants Sheet
Assets Sheet
Detailed Breakdown
1. Settings Sheet
The Settings sheet contains key-value pairs that define various configuration
parameters for the automation process. These parameters can include application
URLs, file paths, email addresses, and other configurable settings necessary for
the process.

Common Settings:

Name: The key for the setting.


Value: The value associated with the key.
Description: A brief explanation of what the setting is used for.
Example Entries:

OrchestratorQueueName: Name of the queue in Orchestrator where transaction items


are stored.
RetryNumber: The number of retry attempts for a transaction in case of failure.
LogLevel: The level of logging detail (e.g., Info, Debug, Error).
2. Constants Sheet
The Constants sheet is used to store static values that remain unchanged throughout
the process. These values are typically fixed parameters used in the workflows,
such as timeouts, maximum retry counts, and file paths that do not change.

Common Constants:

Name: The key for the constant.


Value: The value associated with the key.
Description: A brief explanation of what the constant is used for.
Example Entries:

TransactionTimeout: Maximum time allowed for a transaction to complete.


MaxRetryCount: The maximum number of retries for a failed transaction.
ProcessTimeout: The time limit for the entire process to complete.
3. Assets Sheet
The Assets sheet references assets stored in the UiPath Orchestrator, such as
credentials, file paths, and other secure information. This allows for secure
handling of sensitive data and centralized management of assets.

Common Assets:

Name: The key for the asset.


Orchestrator Asset Name: The name of the asset as it appears in Orchestrator.
Description: A brief explanation of what the asset is used for.
Example Entries:

Credential: References to usernames and passwords stored in Orchestrator.


FilePath: Path to a file required for the process.
APIKey: API keys required for accessing web services.
Best Practices for Config.xlsx
Consistent Naming Conventions: Use clear and consistent names for settings,
constants, and assets to avoid confusion.
Documentation: Ensure each entry in the Config file has a descriptive explanation
for easy understanding and maintenance.
Regular Updates: Periodically review and update the Config file to reflect any
changes in the process requirements or environment settings.
Secure Handling: Use Orchestrator assets for sensitive information to ensure secure
handling and centralized control.
Usage Example in Workflows
Initialization: In the Init state, read and load all settings, constants, and
assets into a dictionary for use throughout the process.
Accessing Values: Use the dictionary to access specific settings, constants, and
assets during the execution of the workflows.
Error Handling: Update the Config file to include retry counts and error handling
thresholds to manage exceptions efficiently.
By understanding and effectively managing the Config.xlsx file, you can ensure that
your automation processes are flexible, maintainable, and secure.

You might also like