activities
latest
false
- Overview
- Callout
- Complex Scenarios
- Credentials
- Data Service
- Form
- Release notes
- Project compatibility
- Real Time Forms
- Updating form data
- Running forms using JavaScript
- Customizing Forms Using CSS
- Conditional components
- Adding multiple components on the same row in Columns
- Using the Data Table component
- Get File/Folder path
- Reading cell values from a Data Grid component
- Displaying PDF files
- Displaying images in forms
- Scrolling through Data Grids
- Using Dev Tools with forms
- Calculate form component values
- Managing dates in forms
- Opening hyperlinks inside forms
- Displaying a default tab in forms
- Displaying the full label of a component
- Searching long strings in drop-down lists
- About the pre 23.4 Form experience
- Project Compatibility
- Real Time Forms
- Dynamic Checkboxes
- Conditional Dropdowns
- Displaying a Default Tab
- Displaying Images
- Displaying PDF Files
- Displaying the Full Label
- Dynamic HTML Elements
- Managing Dates
- Searching Long Strings in Drop-downs
- Customizing Forms Using Local CSS Files
- Executing Do Block On Checkbox Change
- Customizing Columns Width
- Updating Form Data
- Resetting Collection Data
- Advanced Logic
- Executing Do Block on Dropdown Option Change
- Reading Cell Values From a Data Grid Component
- Conditional Components
- Scrolling Through Data Grid Components
- Using the Grid Component
- Dev Tools
- Calculated Value
- Dynamic Dropdowns
- Switching Tabs With Button Click
- Opening Hyperlinks Inside Form
- FTP
- IPC
- Persistence
- Release notes
- Project compatibility
- About the Persistence activity package
- Bulk Form Designer
- Start Job And Get Reference
- Wait For Job And Resume
- Add Queue Item And Get Reference
- Wait For Queue Item And Resume
- Wait For Form Task And Resume
- Resume After Delay
- Assign Tasks
- Create External Task
- Wait For External Task And Resume
- Complete Task
- Forward Task
- Get Form Tasks
- Get Task Data
- Get App Tasks
- Add Task Comment
- Update Task Labels
- Create App Task
- Wait For App Task And Resume
- Configure task timer
- Working with App tasks
- Building Your First Form Action
- Advanced Controls for Drop-downs
- Embedding Objects in Form Actions
- Allowing Users to Upload Files to the Storage Bucket
- Adding Advanced Logic Using Java Script
- Setting a Default Tab
- Removing the Delete button from Edit Grid using custom CSS
- Customizing Edit Grid templates
- Using buttons to trigger custom logic
- Using an External Form Layout
- Dynamically expanding form components at runtime
- Aligning the content of a form component from left to right using JSON attributes
- Sample Workflows
- Automation Ops Pipelines
- System
- Release notes
- About the System activity package
- Project compatibility
- Supported character encoding
- RegEx Builder Wizard
- Add Data Column
- Add Data Row
- Add Log Fields
- Add or Subtract from Date
- Add Transaction Item
- Add Queue Item
- Append Item to Collection
- Append Item to List
- Append Line
- Beep
- Break / Exit Loop
- Browse for File
- Browse for Folder
- Build Collection
- Build Data Table
- Bulk Add Queue Items
- Change Case for Text
- Change Type
- Check False
- Check True
- Clear Data Table
- Collection to Data Table
- Comment
- Compress/Zip Files
- Copy File
- Copy Folder
- Combine text
- Comment Out / Disabled Activities
- Continue / Skip Current
- Create File
- Create Folder
- Create List
- Custom Input
- Delete
- Delete File
- Delete Folder
- Delete Storage File
- Delete Queue Items
- Disable Local Trigger
- Do While
- Download file from URL
- Download Storage File
- Enable Local Trigger
- Evaluate Business Rule
- Exists in Collection
- Extract/Unzip Files
- Extract Date and Time from Text
- Extract Text
- File Change Trigger
- File Exists
- Filter Collection
- Filter Data Table
- Folder Exists
- For Each
- For Each File in Folder
- File Change Trigger V3
- Find and Replace
- Find Matching Patterns
- For Each Folder in Folder
- For Each Row in Data Table
- Format Date as Text
- Format Value
- Generate Data Table From Text
- Get Asset
- Get Credential / Get Orchestrator Credential
- Get Current Job Info
- Get Environment Folder
- Get Environment Variable
- Get File Info
- Get Folder Info
- Get Jobs
- Get Processes
- Get Row Item
- Get Transaction Item
- Get Username/Password
- Get Queue Items
- Global Variable Changed Trigger
- Input Dialog
- Invoke Code
- Invoke Com Method
- Invoke Power Shell
- Invoke Process
- Invoke VBScript
- Invoke Workflow File
- Is Text Matching
- Join Data Tables
- Kill Process
- Launch Workflow Interactive
- List Storage Files
- Log Message
- Lookup Data Table
- Manual Trigger
- Merge Collections
- Merge Data Table
- Message Box
- Modify Date
- Modify Text
- Move File
- Move Folder
- Multiple Assign
- New Item Added to Queue
- Notify Global Variable Changed
- Orchestrator HTTP Request
- Output Data Table
- Path Exists
- Postpone Transaction Item
- Process End Trigger
- Process Start Trigger
- Raise Alert
- Read List Item
- Read Text File
- Read Storage Text
- Remove Data Column
- Remove Data Row
- Remove Duplicate Rows
- Remove From Collection
- Remove Log Fields
- Replace Matching Patterns
- Repeat Number of Times
- Repeat Trigger
- Rename File
- Rename Folder
- Report Status
- Reset Timer
- Resume Timer
- Retry Scope
- Return
- Run Parallel Process
- Set Asset
- Set Credential
- Set Environment Variable
- Set Transaction Progress
- Set Transaction Status
- Should Stop
- Split Text
- Sort Data Table
- Run Local Triggers
- Start Timer
- Start Job
- Stop Job
- Stop Local Triggers
- Stop Timer
- Text to Left/Right
- Text to Upper/Lowercase
- Time Trigger
- Trigger Scope
- Timeout Scope
- Update Row Item
- Update List Item
- Upload Storage File
- Wait for Download
- Wait Queue Item
- While
- Workflow Placeholder
- Write Storage Text
- Write Text File
- AddDataRow
- AddQueueItem
- AddTransactionItem
- AppendLine
- BulkAddQueueItems
- ClearDataTable
- CompressZipFiles
- CopyFile
- CreateFile
- CreateFolder
- DeleteFileOrFolder
- DeleteQueueItems
- DeleteStorageFile
- DownloadStorageFile
- ExtractUnzipFiles
- FilterDataTable
- GetAsset
- GetCredential
- GetJobs
- GetQueueItem
- GetQueueItems
- GetResourceForLocalPath
- GetRowItem
- GetTransactionItem
- InvokeProcess
- JoinDataTables
- ListStorageFiles
- LookUpDataTable
- MergeDataTable
- MoveFile
- OrchestratorHTTPRequest
- OutputDataTable
- PathExists
- PostponeTransactionItem
- ReadStorageText
- ReadTextFile
- RemoveDataColumn
- RemoveDuplicateRows
- Replace
- SetAsset
- SetCredential
- SetTransactionProgress
- SetTransactionStatus
- SortDataTable
- StartJob
- StopJob
- UpdateRowItem
- UploadStorageFile
- WaitQueueItem
- WriteStorageText
- WriteTextFile
- Testing
- Release notes
- About the Testing activity package
- Project compatibility
- Project Settings
- Add Test Data Queue Item
- Address
- Attach Document
- Bulk Add Test Data Queue Items
- Create Comparison Rule
- Delete Test Data Queue Items
- Get Test Data Queue Item
- Get Test Data Queue Items
- Given Name
- Last Name
- Random Date
- Random Number
- Random String
- Random Value
- Verify Control Attribute
- Verify Documents Equivalence
- Verify Expression
- Verify Expression With Operator
- Verify Range
- Verify Text Equivalence
- Address
- AddTestDataQueueItem
- AttachDocument
- BulkAddTestDataQueueItems
- DeleteTestDataQueueItems
- GetTestDataQueueItem
- GetTestDataQueueItems
- GivenName
- LastName
- RandomDate
- RandomNumber
- RandomString
- RandomValue
- VerifyAreEqual
- VerifyAreNotEqual
- VerifyContains
- VerifyExpression
- VerifyExpressionWithOperator
- VerifyIsGreater
- VerifyIsGreaterOrEqual
- VerifyIsLess
- VerifyIsLessOrEqual
- VerifyIsRegexMatch
- VerifyRange
- Workflow Events
- Workflow Foundation
VerifyDocumentsEquivalence
Workflow Activities
Last updated Oct 31, 2024
VerifyDocumentsEquivalence
Verifies if two documents are equivalent, using multiple comparison options, including
the following comparison types:
- Comparing words.
- Comparing lines.
- Comparing characters as
char
variables.
Note: The supported document type is
PDF
.
Namespace: UiPath.Testing.API
Assembly: UiPath.Testing.Activities.Api (in UiPath.Testing.Activities.Api.dll)
ComparisonResult VerifyDocumentsEquivalence(
string baselinePath,
string targetPath,
[ComparisonType comparisonType],
[CompareDocumentsOptions opts])
ComparisonResult VerifyDocumentsEquivalence(
string baselinePath,
string targetPath,
[ComparisonType comparisonType],
[CompareDocumentsOptions opts])
baselinePath
String- The path of the base document that is used as a reference for comparison.
targetPath
String- The path of the document that is compared against the base document.
comparisonType
ComparisonType
(Optional)- The type of comparison to use when comparing documents. The following
options are available:
ComparisonType.Char
: Compares every character (char
) in the documents.ComparisonType.Line
: Compares every line in the documents.ComparisonType.Word
: Compares every word in the documents.
opts
CompareDocumentsOptions- The specific comparison options that should be used for this operation. To
create an object of type
CompareDocumentsOptions
, use theTestingOptions.CompareDocuments Class.
ComparisonResult
The result of the comparison action, stored within a
ComparisonResult
variable.
- Comparing PDFs by
characters:
In this example, we are comparing two PDF files, a light bill and a water bill. The comparison is done at the character level. The paths of these PDF files are represented by the
firstBill
andsecondBill
variables. The wildcard rule and regex rule provided along withWithIgnoreWildcardRule
andWithIgnoreRegexRule
methods are used to ignore specific patterns in the comparison. For instance, the wildcard rule2022
and the regex rule\d{1,2}/\d{1,2}/\d{4}
ignore dates (assuming they are in the MM/DD/YYYY format) in the comparison, since they might differ in two separate bills and aren't relevant to the structure of the bills.Once the comparison is done, theWithGenerateHtml
method creates an HTML report of the comparison and any differences found are recorded in the logs using the methodLog
.var firstBill = @"C:\bills\2024.10\pdfs for compare\(electricity_bill.pdf"; var secondBill = @"C:\bills\2024.10\pdfs for compare\(water_bill.pdf"; var identicalCharCompareResult = testing.VerifyDocumentsEquivalence( firstBill, secondBill, ComparisonType.Character, TestingOptions.CompareDocuments() .WithGenerateHtml(@".\HtmlCompareResults\PDFCharCompare.html") .WithIgnoreWildcardRule("WildcardRule", "*2022*", true) .WithIgnoreRegexRule("RegexRule", @"\d{1,2}/\d{1,2}/\d{4}", true) ); Log("pdf compare by char " + identicalCharCompareResult.AreEquivalent.ToString(),LogLevel.Error);
var firstBill = @"C:\bills\2024.10\pdfs for compare\(electricity_bill.pdf"; var secondBill = @"C:\bills\2024.10\pdfs for compare\(water_bill.pdf"; var identicalCharCompareResult = testing.VerifyDocumentsEquivalence( firstBill, secondBill, ComparisonType.Character, TestingOptions.CompareDocuments() .WithGenerateHtml(@".\HtmlCompareResults\PDFCharCompare.html") .WithIgnoreWildcardRule("WildcardRule", "*2022*", true) .WithIgnoreRegexRule("RegexRule", @"\d{1,2}/\d{1,2}/\d{4}", true) ); Log("pdf compare by char " + identicalCharCompareResult.AreEquivalent.ToString(),LogLevel.Error); - Comparing PDFs by
word:
In this example, we are comparing the same PDF files as in the previous example: a light bill and a water bill. The comparison is done at the word level. The paths of these PDF files are represented by the
firstBill
andsecondBill
variables. The wildcard rule and regex rule provided along withWithIgnoreWildcardRule
andWithIgnoreRegexRule
methods are used to ignore specific patterns in the comparison. For instance, the wildcard rule2022
ignore dates (assuming they are in the MM/DD/YYYY format) in the comparison, since they might differ in two separate bills and aren't relevant to the structure of the bills. The regex rule[$]\d+\.\d{2}
ignores currency values, assuming they are in a format similar to$XX.XX
.Once the comparison is done, theWithGenerateHtml
method creates an HTML report of the comparison and any differences found are recorded in the logs using the methodLog
.var firstBill = @"C:\bills\2024.10\pdfs for compare\(electricity_bill.pdf"; var secondBill = @"C:\bills\2024.10\pdfs for compare\(water_bill.pdf"; var differentWordCompareResult = testing.VerifyDocumentsEquivalence( firstBill, secondBill, ComparisonType.Word, TestingOptions.CompareDocuments() .WithGenerateHtml(@".\HtmlCompareResults\PDFWordCompareDiff.html") .WithIgnoreWildcardRule("WildcardRule", "*2022*", true) .WithIgnoreRegexRule("RegexRule", @"[$]\d+\.\d{2}", true) ); Log("pdf compare by Word " + differentWordCompareResult.AreEquivalent.ToString(), LogLevel.Error);
var firstBill = @"C:\bills\2024.10\pdfs for compare\(electricity_bill.pdf"; var secondBill = @"C:\bills\2024.10\pdfs for compare\(water_bill.pdf"; var differentWordCompareResult = testing.VerifyDocumentsEquivalence( firstBill, secondBill, ComparisonType.Word, TestingOptions.CompareDocuments() .WithGenerateHtml(@".\HtmlCompareResults\PDFWordCompareDiff.html") .WithIgnoreWildcardRule("WildcardRule", "*2022*", true) .WithIgnoreRegexRule("RegexRule", @"[$]\d+\.\d{2}", true) ); Log("pdf compare by Word " + differentWordCompareResult.AreEquivalent.ToString(), LogLevel.Error); - Comparing PDFs by
line:
In this example, similar to the previous one, we are comparing two PDF files, a light bill and a water bill. In this scenario, the comparison is done at the line level. The paths of these PDF files are represented by the
firstBill
andsecondBill
variables. The wildcard rule and regex rule provided along withWithIgnoreWildcardRule
andWithIgnoreRegexRule
methods are used to ignore specific patterns in the comparison.For instance, the wildcard rule2022
ignore dates (assuming they are in the MM/DD/YYYY format) in the comparison, since they might differ in two separate bills and aren't relevant to the structure of the bills. The regex rule[$]\d+\.\d{2}
ignores currency values, assuming they are in a format similar to$XX.XX
.Once the comparison is done, theWithGenerateHtml
method creates an HTML report of the comparison and any differences found are recorded in the logs using the methodLog
.var firstBill = @"C:\bills\2024.10\pdfs for compare\(electricity_bill.pdf"; var secondBill = @"C:\bills\2024.10\pdfs for compare\(water_bill.pdf"; var largeLineCompareResult = testing.VerifyDocumentsEquivalence( firstBill, secondBill, ComparisonType.Line, TestingOptions.CompareDocuments() .WithGeneratePdf(@".\PDFCompareResults",@".\PDFCompareResults") .WithIgnoreWildcardRule("WildcardRule", "*2022*", true) .WithIgnoreRegexRule("RegexRule", @"[$]\d+\.\d{2}", true) ); Log("Pdf compare by line " + largeLineCompareResult.AreEquivalent.ToString(), LogLevel.Error);
var firstBill = @"C:\bills\2024.10\pdfs for compare\(electricity_bill.pdf"; var secondBill = @"C:\bills\2024.10\pdfs for compare\(water_bill.pdf"; var largeLineCompareResult = testing.VerifyDocumentsEquivalence( firstBill, secondBill, ComparisonType.Line, TestingOptions.CompareDocuments() .WithGeneratePdf(@".\PDFCompareResults",@".\PDFCompareResults") .WithIgnoreWildcardRule("WildcardRule", "*2022*", true) .WithIgnoreRegexRule("RegexRule", @"[$]\d+\.\d{2}", true) ); Log("Pdf compare by line " + largeLineCompareResult.AreEquivalent.ToString(), LogLevel.Error);
In all examples, the
AreEquivalent
property returns whether the
documents are equal or not.