uipath/reframework

Robotic Enterprise Framework Template

Documentation is included in the Documentation folder

ReFrameWork Documentation

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

reframework's Issues

file is missing Test_ProcessTransaction.xaml

File Name : TestLog.txt
Test_Framework\Test_ProcessTransaction.xaml ---> Success

I couldn't see this in the github folder.

Can note create unknown type 'http://schemas.uipath.com/workflow/activities)ReadRange' at source UiPath.Core.Activities

Hi there,

I have just download ReFramework and I am getting following error message?

Am I missing something?

Could not load type 'YesNoAuto' from assembly 'UiPath.Vision.Core

Error is thrown when I try to open any .xaml file.
Not sure this is because of version of studio (2020.6.0) or the framework project packages has problem.

here is screen of error

Binary Config.xlsx - worst file format for merging

As a POC Config.xlsx was a very good concept. But for now, any binary file in development provides problems with merging and I with it is possible to switch from it to any plain text format as a set of files "csv","tsv" or single file "json" with a set of nodes.

Why "Process.xaml" is kept in root folder?

The Process.xaml equally qualifies to be part of "Framework" flows. It has got arguments which are closely associated with other flows. Not sure why it has been kept in the root folder.

Will it not be good to move it to be part of "Framework" folder?

_Test.xaml file Unavailable

Hi,
I am following the steps of one of the Practices and I don't see _Test.xaml file nor is it available in studio REFramework Template.

Is there a new way of testing the Config and InitAllApplications workflow.. or should I create this?

thank you

Project does not work in Uipath 2018.4.1

The project fails to upgrade to version 2018.4.1

Does UiPath actively maintain its repositories?

Is this the official UiPath ReFrameWork repo?

We're new UiPath customers.
We've got a vendor doing some proof-of-concept development using the ReFrameWork template.
While learning more about REF, I found this repo and was surprised to see that it hasn't had any significant development in years.
That makes me somewhat skeptical about the viability of the framework going forward.
Can someone help put my mind at ease?

ACME System 1 downloads lack of information

Cann't find other year information like "2017" in drop down list.
URL: https://acme-test.uipath.com/reports/download

Why are there so many pullrequests not being merged ?

I see a lot of pull requests in the project that have not been accepted. Any specific reason as to why this is the case ?

GetAppCredentials.xaml errors

The following errors show up when opening GetAppCredentials in UiPath Studio2018.4.5:

• Could not find type 'GetSecureCredential' in namespace 'http://schemas.uipath.com/workflow/activities'. Row: 92, Column: 18
• Could not find type 'RequestCredential' in namespace 'http://schemas.uipath.com/workflow/activities'. Row: 96, Column: 24
• Could not find type 'AddCredential' in namespace 'http://schemas.uipath.com/workflow/activities'. Row: 102, Column: 28

README out of date?

I see some lines with "Sample for working with Excel input files" as if this package would include sample files for Excel input as well as QueueItem ones however I can't see those mentioned files in the repo.

ReFrameWork for Non-Orchestrator TransactionItems

I agree Orchestrator is a great source for TransactionItems. However, there are numerous use cases where the transaction items may come other sources as well, such as XL files, databases and so on. My question is: Can you customize this framework to make sure it can take care of other data sources too? I tried to use a framework on the Go platform, but that is causing more issues than it resolves.

Main\Business Process\End Process is missing code.

Is the downloadable code up to date?, as the If JobFailed, throw Exception code (a if statement) is missing at the end of Main\Business Process\End Process. This is referred to in the advance training video.

Not running in latest UiStudio - failing workflow

This is when I try to run the current version of the ReFramework. When I delete the workflow it works. So what is this activity and could you update the ReFramework to fix this?

Put tests execution out of Excel Application Scope

Hello,

I had some issues using the tests features with workflows using Excel applications (for example testing a KillAllProcesses workflow that kills Excel processes)

I edited the workflow to only put "Read Range" and "Write Range" activity into "Excel Application Scope" and it seems to work perfectly.

Does the executions of the tests needs to be in the Excel Application Scope?

Get credential invalid

Hello,

Can somebody help me with this situation?

How can i fix it?

Thank you,
Best Regards

Pedro Oliveira

GetAppCredentials invalid

C# Version of ReFrameWork

Exist a ReFrameWork version writen in C#?

Typo of Activity Header

ReFrameWork/Main.xaml

Line 130 in 9778e76

<ui:InvokeWorkflowFile ContinueOnError="{x:Null}" DisplayName="Invoke InitiAllApplications workflow" sap2010:WorkflowViewState.IdRef="InvokeWorkflowFile_5" UnSafe="False" WorkflowFileName="Framework\InitAllApplications.xaml">

"InitiAllApplications" could be changed to "InitAllApplications" in the Activity Header? Many thanks! (Harmonised across the REF, i.e. in-line with "InitAllSettings")

SaveAs requires new filename

SaveAs saves the first file, using the default filename. But subsequent saves using SaveAs with the default filenames will not save. You must change the filename to some other string, save the file, then change the filename back to the name you originally wanted.

i.e.:
saveAs downloadReportsWorkflow - works [used the default filename]
saveAs processNoReportsFound - fails [using the default filename]
saveAs foo - works [changed the filename from the default name]
saveAs processNoReportsFound - works [re-entered default filename]
saveAs retrieveTaxID - fails [using the default name]
saveAs foo - works [again, changed from the default name]
saveAs retrieveTaxID - works [changing it back now, it works]

[GetAppCredentials] This activity is either missing or could not be loaded properly

GetAppCredentials is broken. Numerous activities are displayed as missing or could not be loaded properly. I am using UIPath Studio 2019.10.0-beta.484 Community Edition.

Why can't I use the REFramework workflow file called "GetAPPCredentials.xaml" file in UiPath Studio

First, I tried to download the file from Github but there is no download button so I had to copy and paste the code into a file using notedpadd++ and saved it as a ".xaml" file in my project directory folder.

Next, when I try to open that file in UiPath studio, I get error messages in the output pane. It says the following:

"Could not find type 'GetSecureCredential' in namespace 'http://schemas.uipath.com/workflow/activities"

For convenience, I have attached an image of the raw code of the .xaml file displaying the line that contains the namespace that is mentioned in the above error. I have also attached an image of the UiPath studio error.

I don't know how to fix this. Can someone help?