{"id":19977785,"url":"https://github.com/uipath/reframework","last_synced_at":"2026-01-26T12:35:48.448Z","repository":{"id":48468844,"uuid":"100281901","full_name":"UiPath/ReFrameWork","owner":"UiPath","description":"Robotic Enterprise Framework Template","archived":false,"fork":false,"pushed_at":"2023-02-06T12:07:04.000Z","size":2445,"stargazers_count":340,"open_issues_count":28,"forks_count":562,"subscribers_count":102,"default_branch":"master","last_synced_at":"2025-01-12T10:10:21.555Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/UiPath.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2017-08-14T15:22:38.000Z","updated_at":"2025-01-08T12:55:32.000Z","dependencies_parsed_at":"2022-08-23T02:10:27.767Z","dependency_job_id":"4016e02e-6bef-45f0-ac03-5b6a55805944","html_url":"https://github.com/UiPath/ReFrameWork","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UiPath%2FReFrameWork","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UiPath%2FReFrameWork/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UiPath%2FReFrameWork/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UiPath%2FReFrameWork/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/UiPath","download_url":"https://codeload.github.com/UiPath/ReFrameWork/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241411542,"owners_count":19958753,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T03:29:15.790Z","updated_at":"2026-01-26T12:35:48.383Z","avatar_url":"https://github.com/UiPath.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"### Documentation is included in the Documentation folder ###\n\n[ReFrameWork Documentation](https://github.com/UiPath/ReFrameWork/blob/master/Documentation/REFramework%20documentation.pdf)\n\n### ReFrameWork Template ###\n**Robotic Enterprise Framework**\n\n* built on top of *Transactional Business Process* template\n* using *State Machine* layout for the phases of automation project\n* offering high level exception handling and application recovery\n* keeps external settings in *Config.xlsx* file and Orchestrator assets\n* pulls credentials from *Credential Manager* and Orchestrator assets\n* gets transaction data from Orchestrator queue and updates back status\n* takes screenshots in case of application exceptions\n* provides extra utility workflows like sending a templated email\n* runs sample Notepad application with dummy Excel input data\n* \n\n\n### How It Works ###\n\n1. **INITIALIZE PROCESS**\n + *InitiAllSettings* - Load config data from file and from assets\n + *InitiAllApplications* - Login to applications as per Config(\"OpenApps\") field\n   + *GetAppCredentials* - From Orchestrator assets or local Credential Manager\n + If failing, retry a few times as per Config(\"ProcessRetries\")\n\n2. **GET TRANSACTION DATA**\n   + ./Framework/*GetTransactionData* - Fetches from Orchestrator queue as per Config(\"TransactionQueue\")\n   + ./*GetTransactionData* - Sample for working with Excel input files\n\n3. **PROCESS TRANSACTION**\n + Try *ProcessTransaction*\n + If application exceptions happen\n   + *SaveErrorScreen* - In Config(\"ErrorsFolder\") with the exception message\n   + Going to re/INITIALIZE\n + *SetTransactionStatus* - As Success, Failed or Rejected with reason\n   + ./Framework/*SetTransactionStatus* - Updates the Orchestrator queue item\n   + ./*SetTransactionStatus* - Sample for updating Excel input file\n\n4. **END PROCESS**\n + *CloseAllApplications* - As listed in Config(\"CloseApps\")\n\n\n### For New Project ###\n\n1. Check out the Config.xlsx file and add/customize any required fields and values\n2. Implement OpenApp and CloseApp workflows, linking them in the Config.xlsx fields\n3. Implement GetTransactionData and SetTransactionStatus or use ./Framework versions for Orchestrator queues\n4. Implement ProcessTransaction workflow and any invoked others\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuipath%2Freframework","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fuipath%2Freframework","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuipath%2Freframework/lists"}