Using Java Method Annotations for Custom Objects
If you customize your instance of Salesforce, you may need to insert Java method annotations in order to test those features. (See the page object operations page for additional info.)
To test these custom elements, go to the Navigator pane on the left side of your screen in Provar and find the page objects folder under the project/src folder. Double-click the custom page object that you created. You’ll see two tabs at the bottom of your page object viewer: Page Object Editor and Java Source. Click Java Source.
Within the Java Source screen, you can enter the annotations below to customize the custom page object that is part of your overall test.
Below is a quick glossary of the most frequently used method annotations that you can use to insert and apply the commands you need.
@FindBy
This is a selenium annotation that is used to find an element. You can use parameters such as linkText, xpath, id, Name, CSS, Label, and Component Xpath.
Example:
@FindBy(linkText = "Account Information")
@LinkType()
This controls how the user interacts with links in a variety of ways. This annotation can be customized based on the interaction type: Hover, Click, Double-Click, Download, Drag and Drop.
Example:
@LinkType() @FindBy(xpath = "//input[text()='Email']") public WebElement email;
@TextType()
This controls how the user interacts with text in a variety of ways. This annotation can be customized based on the interaction type: Hover, Double Click, Set, Click, Clear, Drag and Drop.
Example:
@TextType() @FindBy(xpath = "//input[text()='Email']") public WebElement email;
@ButtonType()
This controls how the user interacts with buttons in a variety of ways. This annotation can be customized based on the interaction type, such as Hover, Click, Double Click, Download, Drag and Drop.
Example:
@ButtonType() @FindBy(xpath = "//input[text()='Save']") public WebElement save; @ButtonType(file=true) is used to get “Choose File“ interaction
@BooleanType()
This controls how the user performs actions in a variety of ways. This annotation can be customized based on the action type, such as Hover, Double Click, Check, Uncheck, Toggle, Drag and Drop.
Example:
@BooleanType() @FindBy(xpath = "//input[text()='yes']") public WebElement Yes;
@ChoiceListType
This controls how the user interacts with a picklist (a.k.a. drop-down menu) in various ways. This annotation can be customized based on the interaction type: Hover, Double Click, SetByIndex, Set, Clear, Click, Drag and Drop.
Example:
@ChoiceListType(values = { @ChoiceListValue(value = "prod1", title = "Test 123"), @ChoiceListValue(value = "prod2", title = "testing 321") }) @FindBy(xpath = "//*[@id="sproduct"]/select") public WebElement selectProduct;
@ChoiceListValue
This function is used to verify that a specific item is available in a drop-down menu. For example, you can use this to verify that an opportunity stage drop-down menu includes the option to select “Prospecting”.
@FindByLabel
This can be used for finding an element by label in a custom table.
Example:
@PageTable(row = Con.class) @VisualforceBy(componentXPath = "apex:dataTable[@value = "{!con}"]") public List<Con> Con; @PageRow(byColumn = true) public static class Con { @TextType() @VisualforceBy(componentXPath = "apex:outputField[@value = "{!a.lastname}"]") public WebElement lastName; @LinkType() @VisualforceBy(componentXPath = "apex:outputField[@value = "{!a.email}"]") public WebElement email; } @PageTable(row = Con.class) is used to define Rows in table @PageRow(byColumn = true)is used to get in row by column
@PageFrame
This annotation is used to define a frame/Iframe in page objects. (Most of the time Provar automatically manages iframes, but sometimes you may need to handle iframes manually.)
Example:
@PageFrame() public static class Frame{ @TextType() @FindBy(xpath = "//*[text()=’username’]") public WebElement username; } @Findby(name ="testFrame") public Frame frame;
- Provar Automation
- System Requirements
- Browser and Driver Recommendations
- Installing Provar Automation
- Updating Provar Automation
- Licensing Provar
- Granting Org Permissions to Provar Automation
- Optimizing Org and Connection Metadata Processing in Provar
- Using Provar Automation
- API Testing
- Behavior-Driven Development
- Consolidating Multiple Test Execution Reports
- Creating and Importing Projects
- Creating Test Cases
- Custom Table Mapping
- Functions
- Debugging Tests
- Defining a Namespace Prefix on a Connection
- Defining Proxy Settings
- Environment Management
- Exporting Test Cases into a PDF
- Exporting Test Projects
- Japanese Language Support
- Override Auto-Retry for Test Step
- Mapping and Executing the Lightning Article Editor in Provar
- Managing Test Steps
- Namespace Org Testing
- NitroX
- Provar Automation
- Provar Test Builder
- ProvarDX
- Refresh and Recompile
- Reintroduction of CLI License Check
- Reload Org Cache
- Reporting
- Running Tests
- Searching Provar with Find Usages
- Secrets Management and Encryption
- Setup and Teardown Test Cases
- Tags and Service Level Agreements (SLAs)
- Test Cycles
- Test Plans
- Testing Browser Options
- Tooltip Testing
- Using the Test Palette
- Using Custom APIs
- Callable Tests
- Data-Driven Testing
- Page Objects
- Block Locator Strategies
- Introduction to XPaths
- Creating an XPath
- JavaScript Locator Support
- Label Locator Strategies
- Maintaining Page Objects
- Mapping Non-Salesforce fields
- Page Object Operations
- ProvarX™
- Refresh and Reselect Field Locators in Test Builder
- Using Java Method Annotations for Custom Objects
- Applications Testing
- Provar Manager
- How to Use Provar Manager
- Provar Manager Setup
- Provar Manager Integrations
- Release Management
- Test Management
- Test Operations
- Provar Manager and Provar Automation
- Setting Up a Connection to Provar Manager
- Object Mapping Between Automation and Manager
- How to Upload Test Plans, Test Plan Folders, Test Plan Instances, and Test Cases
- Provar Manager Filters
- Uploading Callable Test Cases in Provar Manager
- Uploading Test Steps in Provar Manager
- How to Know if a File in Automation is Linked in Test Manager
- Test Execution Reporting
- Metadata Coverage with Manager
- Provar Grid
- DevOps
- Introduction to Provar DevOps
- Introduction to Test Scheduling
- Apache Ant
- Configuration for Sending Emails via the Automation Command Line Interface
- Continuous Integration
- AutoRABIT Salesforce DevOps in Provar Test
- Azure DevOps
- Running a Provar CI Task in Azure DevOps Pipelines
- Configuring the Automation secrets password in Microsoft Azure Pipelines
- Parallel Execution in Microsoft Azure Pipelines using Multiple build.xml Files
- Parallel Execution in Microsoft Azure Pipelines using Targets
- Parallel execution in Microsoft Azure Pipelines using Test Plans
- Bitbucket Pipelines
- CircleCI
- Copado
- Docker
- Flosum
- Gearset
- GitHub Actions
- Integrating GitHub Actions CI to Run Automation CI Task
- Remote Trigger in GitHub Actions
- Parameterization using Environment Variables in GitHub Actions
- Parallel Execution in GitHub Actions using Multiple build.xml Files
- Parallel Execution in GitHub Actions using Targets
- Parallel Execution in GitHub Actions using Test Plan
- Parallel Execution in GitHub Actions using Job Matrix
- GitLab Continuous Integration
- Travis CI
- Jenkins
- Execution Environment Security Configuration
- Provar Jenkins Plugin
- Parallel Execution
- Running Provar on Linux
- Reporting
- Salesforce DX
- Git
- Version Control
- Masking Provar Credentials on CI
- Salesforce Testing
- Best Practices
- Salesforce Connection Best Practices
- Improve Your Metadata Performance
- Testing Best Practices
- Automation Planning
- Supported Testing Phases
- Provar Naming Standards
- Test Case Design
- Create records via API
- Avoid using static values
- Abort Unused Test Sessions/Runs
- Avoid Metadata performance issues
- Increase auto-retry waits for steps using a global variable
- Create different page objects for different pages
- The Best Ways to Change Callable Test Case Locations
- Working with the .testProject file and .secrets file
- Best practices for the .provarCaches folder
- Best practices for .pageObject files
- Troubleshooting
- How to Use Keytool Command for Importing Certificates
- Browsers
- Configurations and Permissions
- Connections
- DevOps
- Error Messages
- Provar Manager 3.0 Install Error Resolution
- Provar Manager Test Case Upload Resolution
- Administrator has Blocked Access to Client
- JavascriptException: Javascript Error
- macOS Big Sur Upgrade
- Resolving Failed to Create ChromeDriver Error
- Resolving Jenkins License Missing Error
- Resolving Metadata Timeout Errors
- Test Execution Fails – Firefox Not Installed
- Selenium 4 Upgrade
- Licensing, Installation and Firewalls
- Memory
- Test Builder and Test Cases
- Release Notes