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 Local Triggers
- Run Parallel Process
- Set Asset
- Set Credential
- Set Environment Variable
- Set Transaction Progress
- Set Transaction Status
- Should Stop
- Split Text
- Sort Data Table
- 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
- TestingOptions.CompareDocuments Class
- VerifyExpression
- VerifyExpressionWithOperator
- VerifyIsGreater
- VerifyIsGreaterOrEqual
- VerifyIsLess
- VerifyIsLessOrEqual
- VerifyIsRegexMatch
- VerifyRange
- Workflow Events
- Workflow Foundation
Workflow Activities
Last updated Nov 18, 2024
TestingOptions.CompareDocuments Class
Use this class to configure options for comparing documents with the VerifyDocumentsEquivalence API.
Namespace: UiPath.Testing.API.Models
Assembly: UiPath.Testing.Activities.Api (in UiPath.Testing.Activities.Api.dll)
public TestingOptions.CompareDocuments()public TestingOptions.CompareDocuments()TestingOptions.CompareDocuments- Initializes a new instance of the
TestingOptions.CompareDocumentsclass.
AdditionalOutputFilePathString- Path to the additional output file. Needs to be set if
OutputDiffTypeis PDF. ContinueOnErrorBoolean- Specifies if the automation should continue even when the method throws an
error. This parameter only supports Boolean values (
true,false). The default value isalse. As a result, if the parameter is blank and an error is thrown, the execution of the project stops. If the value is set totrue, the execution of the project continues regardless of any error. IgnoreIdenticalItemsBoolean- If set to
True, identical items are ignored during comparison. This is useful when comparing static objects, such as watermarks or headers. By default, this is set totrue. IgnoreImagesLocationBoolean- If set to
true, ignores the location of an image in the compared documents. By default, this is set tofalse. IncludeImagesBoolean- If set to true, the comparison process includes images, as well. By default,
this is set to
true. OutputDiffTypeDocumentOutputDiffType- The type you want to use for returning the differences between the documents.
OutputFilePathString- The output path of the base document.
RulesList<ComparisonRule>- List of rules to be applied. They can be of type
RegexRuleorWildcardRule. WordSeparatorsString- The objects, as Strings, that you want to consider as word separators in the comparison process. For example, if the documents you are comparing commonly use a period (.) or backslashes (/) for separating words, then you can define these as word separators.
These are the methods you can use to configure the document comparison options.
Configure if the automation should continue even when the method throws an error.
Definition
Namespace: UiPath.Testing.API.Models
Assembly: UiPath.Testing.Activities.Api (in UiPath.Testing.Activities.Api.dll)
WithContinueOnError(bool)
WithIgnoreRegexRule(
bool continueOnError
)WithIgnoreRegexRule(
bool continueOnError
)continueOnErrorBoolean- Specifies if the automation should continue even when the method throws an
error. This parameter only supports Boolean values (
true,false). The default value isfalse. As a result, if the parameter is blank and an error is thrown, the execution of the project stops. If the value is set totrue, the execution of the project continues regardless of any error.
Generates an HTML file with the highlighted differences identified between the two documents or texts.
Definition
Namespace: UiPath.Testing.API.Models
Assembly: UiPath.Testing.Activities.Api (in UiPath.Testing.Activities.Api.dll)
WithGenerateHtml(string)
WithGenerateHtml(
string filePath
)WithGenerateHtml(
string filePath
)filePathString- The path of the HTML file that stores the differences identified when comparing the documents or texts.
Generates new PDF files with the highlighted differences for both the baseline document and the target document, used to compare against the baseline document.
Definition
Namespace: UiPath.Testing.API.Models
Assembly: UiPath.Testing.Activities.Api (in UiPath.Testing.Activities.Api.dll)
WithGeneratePDF(string, string)
WithGeneratePDF(
string baselinePath,
string targetPath
)WithGeneratePDF(
string baselinePath,
string targetPath
)If set to
True, identical lines are ignored during comparison. This is
useful, in particular, when comparing static objects, such as watermarks or headers.
Definition
Namespace: UiPath.Testing.API.Models
Assembly: UiPath.Testing.Activities.Api (in UiPath.Testing.Activities.Api.dll)
WithIgnoreIdenticalItems(bool)
CompareDocumentsOptions WithIgnoreIdenticalItems<CompareDocumentsOptions>(
bool ignoreIdenticalItems = true
)CompareDocumentsOptions WithIgnoreIdenticalItems<CompareDocumentsOptions>(
bool ignoreIdenticalItems = true
)ignoreIdenticalItemsBoolean- Specifies if identical items should be ignored during comparison. By
default, this parameter is set to
true.
If set to true, ignores the position and page of an image.
Definition
Namespace: UiPath.Testing.API.Models
Assembly: UiPath.Testing.Activities.Api (in UiPath.Testing.Activities.Api.dll)
WithIgnoreImagesPageAndPosition(this, bool)
WithIgnoreImagesPageAndPosition(
bool ignoreImagesPageAndPosition = false
)WithIgnoreImagesPageAndPosition(
bool ignoreImagesPageAndPosition = false
)ignoreImagesPageAndPositionBoolean- If set to
true, ignores the position and page of an image. By default, the value of the parameter isfalse.
If set to
True, ignores any Regex rule that you configured for the
Rules parameter. This allows you to exclude certain parts of the
texts or documents that you are comparing.
Definition
Namespace: UiPath.Testing.API.Models
Assembly: UiPath.Testing.Activities.Api (in UiPath.Testing.Activities.Api.dll)
WithIgnoreRegexRule(string, string, [bool])
WithIgnoreRegexRule(
string ruleName,
string regexPattern,
[bool usePlaceholders = true]
)WithIgnoreRegexRule(
string ruleName,
string regexPattern,
[bool usePlaceholders = true]
)ruleNameString- The name of the rule, as you configured it in the list of
Rules, that you want to ignore in the comparison process. regexPatternString- The actual regex that represents the
ruleNamepreviously entered. usePlaceholderBoolean (Optional)- If set to
Trueit replaces the ignored part of a document or text with a placeholder value. The placeholder value is theruleName. By default, this parameter is set totrue.
If set to
True, ignores any wild card rule that you configured for the
Rules parameter. This allows you to exclude certain parts of the
texts or documents that you are comparing.
Definition
Namespace: UiPath.Testing.API.Models
Assembly: UiPath.Testing.Activities.Api (in UiPath.Testing.Activities.Api.dll)
WithIgnoreWildcardRule(string, string, bool)
WithIgnoreWildcardRule(
string ruleName,
string wildcardPattern,
[bool usePlaceholder = true]
)WithIgnoreWildcardRule(
string ruleName,
string wildcardPattern,
[bool usePlaceholder = true]
)ruleNameString- The name of the rule, as you configured it in the list of
Rules, that you want to ignore in the comparison process. wildcardPatternString- The actual wildcard that represents the
ruleNamepreviously entered. usePlaceholderBoolean (Optional)- If set to
Trueit replaces the ignored part of a document or text with a placeholder value. The placeholder value is theruleName. By default, this parameter is set totrue.
Includes images in the comparison process. If you set this method to
True, it also compares images, when verifying the equivalence
between documents or texts.
Definition
Namespace: UiPath.Testing.API.Models
Assembly: UiPath.Testing.Activities.Api (in UiPath.Testing.Activities.Api.dll)
WithIncludeImages(bool)
WithIncludeImages(
bool includeImages
)WithIncludeImages(
bool includeImages
)includeImagesBoolean- If set to
True, the API also compares images when verifying the equivalence between documents and texts.
Specify the characters that you want to define as word separators. The characters must be stored in a string.
Definition
Namespace: UiPath.Testing.API.Models
Assembly: UiPath.Testing.Activities.Api (in UiPath.Testing.Activities.Api.dll)
WithWordSeparators(string)
WithWordSeparators(
string wordSeparators
)WithWordSeparators(
string wordSeparators
)wordSeparatorsString- The string containing the characters that you want to consider as word separators.
