https://github.com/uipath/reframework

Robotic Enterprise Framework Template
https://github.com/uipath/reframework

Last synced: 3 months ago
JSON representation

Robotic Enterprise Framework Template

• Host: GitHub
• URL: https://github.com/uipath/reframework
• Owner: UiPath
• License: mit
• Created: 2017-08-14T15:22:38.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2023-02-06T12:07:04.000Z (over 2 years ago)
• Last Synced: 2025-01-12T10:10:21.555Z (4 months ago)
• Size: 2.33 MB
• Stars: 340
• Watchers: 102
• Forks: 562
• Open Issues: 28
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
### Documentation is included in the Documentation folder ###

[ReFrameWork Documentation](https://github.com/UiPath/ReFrameWork/blob/master/Documentation/REFramework%20documentation.pdf)

### ReFrameWork Template ###

**Robotic Enterprise Framework**

* built on top of *Transactional Business Process* template

* using *State Machine* layout for the phases of automation project

* offering high level exception handling and application recovery

* keeps external settings in *Config.xlsx* file and Orchestrator assets

* pulls credentials from *Credential Manager* and Orchestrator assets

* gets transaction data from Orchestrator queue and updates back status

* takes screenshots in case of application exceptions

* provides extra utility workflows like sending a templated email

* runs sample Notepad application with dummy Excel input data

* 

### How It Works ###

1. **INITIALIZE PROCESS**

 + *InitiAllSettings* - Load config data from file and from assets

 + *InitiAllApplications* - Login to applications as per Config("OpenApps") field

   + *GetAppCredentials* - From Orchestrator assets or local Credential Manager

 + If failing, retry a few times as per Config("ProcessRetries")

2. **GET TRANSACTION DATA**

   + ./Framework/*GetTransactionData* - Fetches from Orchestrator queue as per Config("TransactionQueue")

   + ./*GetTransactionData* - Sample for working with Excel input files

3. **PROCESS TRANSACTION**

 + Try *ProcessTransaction*

 + If application exceptions happen

   + *SaveErrorScreen* - In Config("ErrorsFolder") with the exception message

   + Going to re/INITIALIZE

 + *SetTransactionStatus* - As Success, Failed or Rejected with reason

   + ./Framework/*SetTransactionStatus* - Updates the Orchestrator queue item

   + ./*SetTransactionStatus* - Sample for updating Excel input file

4. **END PROCESS**

 + *CloseAllApplications* - As listed in Config("CloseApps")

### For New Project ###

1. Check out the Config.xlsx file and add/customize any required fields and values

2. Implement OpenApp and CloseApp workflows, linking them in the Config.xlsx fields

3. Implement GetTransactionData and SetTransactionStatus or use ./Framework versions for Orchestrator queues

4. Implement ProcessTransaction workflow and any invoked others