Examples

${cpq_quote_model}=    Read CPQ Quote      ${quote_id}
${cpq_product}=        Read CPQ Product    ${product_id}[records][0][Id]    ${pricebook_id}[records][0][Id]    USD
${quote_with_product}=  Add CPQ Products  ${cpq_quote_model}    ${cpq_product}

Parameters

quote_model : str/dict

Quote Model (json/dict) of quote to which add products.

product_models : str/dict

Product model(s) of products to be added to quote.

group_key : int

An index of the existing quote line group where you’re adding products (0 indexed by default). Required only for grouped quotes.

timeout : str | int (optional)

How long we wait for API call response before failing. Default 10 (seconds)

Returns

dict

Quote model (dictionary) of fields and values of the cpq quote, where products have been added.

Raises

ValueError

Authentication failed, quote/product model was not found, api call was malformatted.

Examples

Authenticate     ${client_id}   ${client_secret}   myusername@test.com    ${password}

# Authenticate to sandbox (can be accessed via https://test.salesforce.com)
Authenticate     ${client_id}   ${client_secret}   myusername@test.com    ${password}   sandbox=True

# Authenticate with custom url
Authenticate     ${client_id}   ${client_secret}   jdoe@test.com    ${password}   custom_url=https://someurl.com

# Authenticate and reuse access token in 3rd party library
Import      QForce
Import      RequestsLibrary
# you can also get the token using GetAccessToken keyword
${token}=                 Authenticate     ${client_id}   ${client_secret}   jdoe@test.com    ${password}
${my_acc}=                Create Record               Account             Name=My Account      NumberOfEmployees=83
${api_version_url}=       Get API Version Url
${instance_url}=          Get Instance Url
# Call SF Rest API using RequestsLibrary keyword and token from QForce Authenticate
&{headers}=               Create Dictionary  Authorization=Bearer ${token}
${resp}=                  GET                url=${instance_url}${api_version_url}/sobjects/Account/${my_acc}
...                       headers=&{headers}  timeout=10
Log                       ${resp.json()}  console=true
Should Be Equal           ${resp.json()}[Name]  My Account
Should Be Equal           ${resp.json()}[Id]    ${my_acc}

Parameters

client_id : str

Consumer key of a connected app

client_secret : str

Consumer secret of a connected app

username : str

Your Salesforce username

password : str

Your Salesforce password

sandbox : bool (optional)

Is the instance a sandbox instance? This flag will set login url accordingly, either login.salesforce.com or test.salesforce.com (sandbox). Default: False (-> login.salesforce.com)

You can find out if your environment is a sandbox by trying to login with your credentials through https://login.salesforce.com and https://test.salesforce.com. If you can login through https://login.salesforce.com then your environment is NOT a sandbox and if you can login through https://test.salesforce.com then your environment is a sandbox.

custom_url : str (optional)

Custom instance url in cases where you can login only using custom url, not the default Salesforce urls mentioned above. If custom_url is given, sandbox will be ignored.

timeout : str | int (optional)

How long we wait for API call response before failing. Default 10 (seconds)

Returns

token

Access token to be used in all subsequent calls. Note this value is automatically used in QForce keywords, but returned in case you want to use the same authentication token with a custom call with other libraries.

Raises

ConnectionError

Authentication call was not successful.

KeyError

Reply did not contain expected data.

Related keywords

Revoke, JWTAuthenticate, GetAccessToken, GetInstanceUrl

Examples

${cpq_quote}=           Read CPQ Quote         a2w7Q000000LBGRQA4
${calculated_quote}=    Calculate CPQ Quote    ${cpq_quote}

Parameters

quote_model : str

Quote Model (json/dict) of quote to be calculated. TIP: Use "CPQ Read Quote" to get the quote model.

timeout : str | int (optional)

How long we wait for API call response before failing. Default 10 (seconds)

Returns

dict

Quote model (dictionary) of fields and values of the calculated cpq quote

Raises

ValueError

Authentication failed, quote was not found, api call was malformatted.

Examples

ClickCheckbox    I am not a robot    on
ClickCheckbox    I am not a robot    off

With table(Pick table with use table keyword first):

ClickCheckbox    r1c1               on
ClickCheckbox    r-1c3              off  #last row, third cell
ClickCheckbox    r?Robot/c-1        on   #row that contains text Robot, last cell

With anchor

ClickCheckbox    I am not a robot    on    anchor text
ClickCheckbox    r?Robot/c-1         on    Test  #row contains texts Robot and Test
ClickCheckbox    r?Robot/c-1         on    3    #third row which contains text Robot

Parameters

locator : str

Text that locates the checkbox. The checkbox that is closest to the text is selected. Also one can use xpath by adding xpath= prefix and then the xpath. Error is raised if the xpath matches to multiple elements. When using XPaths, the equal sign "=" must be escaped with a "\".

value : str

Value of the checkbox. On or off.

anchor : str (default None)

Text near the checkbox's locator element. If the page contains many places where the locator text is then anchor is used to get the one that is closest to it.

timeout : str | int

How long we try to find element before failing. Default 10 (seconds)

index : int

If cell contains more than one checkbox elements index is needed. Default = 1 (first)

kwargs :

Accepted kwargs:

limit_traverse : False. If limit traverse is set to false we are heading up to

fifth parent element if needed when finding relative input element for some label.

partial_match: True. If element is found by it's attribute set partial_match

to True to allow partial match

Raises

QWebElementNotFoundErr

CheckBox element not found

Related keywords

VerifyCheckbox, VerifyCheckboxStatus, VerifyCheckboxValue (documented in QWeb library)

Examples

ClickFieldValue    Phone           # clicks 12345

Parameters

label : str

Label/heading of the record to verify.

index : int

If there are multiple duplicate labels in record layout, index can be used to identify which one should be verified.

tag: str

Tag of the field. Default: a (link).

timeout : str | int

Timeout for waiting element to appear before failing. Default value is what is set in "DefaultTimeout".

Raises

QWebElementNotFoundError

Page did not contain element

Related keywords

VerifyField

Examples

ClickTableCell           Quantity             3
ClickTableCell           List Unit Price      5     double=True  # double clicks field

Parameters

column : str

Column header in table.

row : str

Row number in the column.

double : str

False (default): single-click. True: double-clicks the cell.

Related keywords

GetTableCell, TypeTable, VerifyTableCell

Examples

ClickText        Canis

In the above example the ClickText keyword will click the word Canis. If there are multiple instances of the word Canis on the page, first one will be clicked unless 'anchor' is given. You can specific which one should be clicked by either:

• a number or
• a word that is near to the word Canis

For example

ClickText    Canis    3     # clicks the third "Canis" on the page
ClickText    Canis    Dog   # clicks the "Canis" near to the word "Dog"
# handling numeric anchors as text, not index
ClickText    Canis    3     anchor_type=text   # clicks the "Canis" next text "3"

If text can't be found with normal means, you can use computer vision engine instead:

# clicks the text "Canis" using computer vision engine
ClickText    Canis    recognition_mode=vision

If you want to specify how long ClickText tries, you need to add both anchor and timeout.

ClickText    Canis    1     20s   # Tries to click the first "Canis" for 20s

If clickable element is child or parent of locator element use child/parent attribute + elements tagname to pick right element

ClickText   Canis     parent=span # Clicks Canis element's first parent with span -tag
ClickText   Canis     child=a     # First childnode with a -tag

ClickText   Canis     js=true     #Use Javascript click instead of Selenium

To double-click text, use argument doubleclick=True

ClickText   Canis       doubleclick=True

Or use SetConfig

SetConfig   DoubleClick     On
ClickText   Canis

To extend normal text search to shadow DOM, use SetConfig ShadowDOM. Note that certain arguments like partial_match are ignored when searching from shadow DOM.

SetConfig   ShadowDOM     True
ClickText   Canis

Parameters

text : str

Text to be clicked.

anchor : str

Text near the element to be clicked or index. If the page contains many places where the text argument is then anchor is used to get the one that is closest to it. (default 1)

timeout : str | int

How long we wait element to appear and click to succeed

parent : str

tag name for clickable parent.

child : str

tag name for clickable child.

js : boolean

If set to true, uses javascript instead of selenium to click element.

recognition_mode : str

Use either "web" backend (default) or computer vision ("vision"). Computer vision finds texts from the screen regardless how they appear on DOM. This is useful to verify truncated ui texts and especially when elements are under shadow dom.

Accepted kwargs:

css=False/off: Use this to bypass css search when finding elements by visible text

Examples

ClickTree        Western Sales Director   # expands node, does nothing if already expanded
ClickText        CA Sales Rep  # clicks subtree node
ClickTree        Western Sales Director   False   # collapses parent Tree node "User"

Parameters

label : str

Label of the parent tree element to click

expanded : bool

True (default) expands tree node, False will close it.

index : int

If there are multiple duplicate nodes in Tree layout, index can be used to identify which one should be verified. Note: only affects partial match, see below

timeout : str

How long to wait for page header to appear. Default 0 (use the default timeout setting)

kwargs :

Accepted kwargs:

partial_match: True. If element is found by it's attribute set partial_match

to True to allow partial match

Raises

QWebElementNotFoundError

Page did not contain parent Tree node element with given name. Note: If tree node does not have children, use ClickText instead. You can't expand/collapse nodes without children.

Examples

Combobox        Search Accounts...      Test Account
# using label and selecting 3rd duplicated instance
Combobox        *Account Name           Test Account   index=3

Parameters

locator : str

Placeholder for combobox (preferred) or label of the field having combobox. Note that all comboboxes do not open just by clicking the label. If using label, mandatory fields need the "*" character.

value : str

Value to be searched and selected from a combobox.

timeout : str | int

How long we try to find the combobox before failing. Default: DefaultTimeout configuration value.

index : int

If there are duplicated values in the search results, index of the instance which will be selected.

selection_delay : int

The delay in seconds after typing search term and starting to select item from results list. Default: 1 second

all_results : bool

If true, does not select the value from proposed values, but clicks "Show all results for..." item and selects value from the dialog that will open.

Raises

QWebElementNotFoundError

Page did not contain element

Related keywords

MultiPickList, GetPickList, GetPickListCount, VerifyPickList

Examples

${contact}=      Create Record   Contact    FirstName=Jane    LastName=Doe
${account}=      Create Record   Account    Name=KindCorp     BillingPostalCode=12345

# if duplicate check rule is on, you can give additional headers:

# works with string header
${account2}=     Create Record   Account    Name=KindCorp     BillingPostalCode=12345    additional_headers={"Sforce-Duplicate-Rule-Header": "allowSave=true"}
# works with dict header
&{headers_dict} =               Create Dictionary               Sforce-Duplicate-Rule-Header=allowSave=true
${account3}=     Create Record   Account    Name=KindCorp     BillingPostalCode=12345    additional_headers=${headers_dict}

Parameters

sobject : str

Salesforce object type. You can use keyword "List Objects" to get names of all Salesforce objects.

additional_headers : str/dict

Additional headers which will be appended to auth/content-type header. See examples.

timeout : str | int (optional)

How long we wait for API call response before failing. Default 10 (seconds)

**data: str

Fields and values for the new record. You must specify values for required fields as part of the data. Specifying values for other fields is optional.

Returns

id : str

Id of the newly created record.

Raises

ValueError

Authentication failed, record was not found or api call was malformatted.

Examples

${contact}=      Create Record  Contact            FirstName=Jane         LastName=Doe
${account}=      Create Record  Account            Name=KindCorp
Delete Record    Contact        ${contact}
Delete Record    Account        ${account}
Delete Record    Account        0015E000024YyV0QAK

Parameters

sobject : str

Salesforce object type. You can use keyword "List Objects" to get names of all Salesforce objects.

oid: str

ID of the record to be deleted

timeout : str | int (optional)

How long we wait for API call response before failing. Default 10 (seconds)

Raises

ValueError

Authentication failed, record was not found or api call was malformatted.

Examples

${results}=     Execute Apex      Account newAccount = new Account();\nnewAccount.Name = String.valueOf(Date.today());\ninsert newAccount;
${results}=     Execute Apex      my_script.apex    is_file=True

Parameters

script : str

Apex script as a string or path to a file containing the script.

is_file : bool

False (default): Apex script is given as string True: Apex script is stored in a file. Filepath should be given in first argument.

timeout : str | int (optional)

How long we wait for API call response before failing. Default 10 (seconds)

Returns

dict

dictionary of fields and values of the queried object

Raises

ValueError

Authentication failed, record was not found or api call was malformatted.

Examples

${results}=     Export Records       SELECT id,name from Contact      ${OUTPUTDIR}/contacts.json

Parameters

query : str

SOQL query.

output_file : str

Full path to .json file which will be created for output. Directories must exist, file will be created.

timeout : str | int (optional)

How long we wait for API call response before failing. Default 10 (seconds)

Returns

str

Full path to newly created file which contains query results.

Raises

ValueError

Authentication failed, record was not found or api call was malformatted.

Related keywords

ImportRecords

Examples

${token}=    Get Access Token

Examples

${api_version_url}=    Get API Version URL

Examples

${value}=          GetFieldValue        Phone           # returns 12345
${value}=          GetFieldValue        Notes           # returns text from Notes field

# returns non-formated text from a tag
${value}=          GetFieldValue        Quote Number    tag=a

Parameters

label : str

Label/heading of the record to verify.

index : int

If there are multiple duplicate labels in record layout, index can be used to identify which one should be verified.

tag: str

Tag of the field. Default: span. Some salesforce texts are under non-formatted <a> tag

timeout : str | int

Timeout for waiting element to appear before failing. Default value is what is set in "DefaultTimeout".

Raises

QWebElementNotFoundError

Page did not contain element

Related keywords

VerifyField

Examples

${instance_url}=    Get Instance URL

Examples

${mfa_code}=    GetOTP          my_user@testsf.com    ${MY_SECRET}
TypeText        Code            ${mfa_code}

Parameters

usenname : str

Salesforce username of the user logging in.

secret : str

Secret given by Salesforce when connecting an OTP authentication app to an account.

url : str

Salesforce instance url. Default: "https://login.salesforce.com"

Raises

ValueError

An error occurred while generating OTP. Please make sure correct details (user, secret) are used.

Related keywords

MultiPickList

Setup

1.Enable OTP authentication app in your SF user settings:

2. Get the security code. You can hover on top of the QR code or right-click and open the image in another tab (code will be in url):

3. FInalize the setup with you mobile authentication app and provide first code from the app.

4. Provide the security token in variable ${secret}. This should be given as encrypted variable in Copado Robotic Testing.

Examples

${options}=         GetPicklist        Salutation
# Returns  ['--None--', 'Mr.', 'Ms.', 'Mrs.', 'Dr.', 'Prof.']
${selected}=        GetPicklist        Salutation   selected=True
# Returns  'Mr.' if that one was selected.

Parameters

label : str

Label of the pick list where value should be selected.

index : int

If multiple picklists are present with same label, index can be used to identify which one should be selected. Default: 1

selected : bool

Return all options (False) or just currently selected option (True). Default: False

timeout : str | int

How long we try to find the picklist before failing. Default: DefaultTimeout configuration value.

Raises

QWebElementNotFoundError

Page did not contain element

Related keywords

PickList, MultiPickList, GetPickListCount, VerifyPickList

Examples

${count}=   GetPickListCount        Salutation   # returns 5

Parameters

label : str

Label of the pick list where value should be selected.

timeout : str | int

How long we try to find the picklist before failing. Default: DefaultTimeout configuration value.

Raises

QWebElementNotFoundError

Page did not contain element

Related keywords

PickList, MultiPickList, GetPickList, VerifyPickList

Examples

Authenticate     ${client_id}   ${client_secret}   myusername@test.com    ${password}
${account}=      Get Record     Account            0015E00001TyR6mQAF
Should Be Equal As Strings     ${account}[Name]               Corporation

Parameters

sobject : str

Salesforce object type. You can use keyword "List Objects" to get names of all Salesforce objects.

oid: str

Salesforce object id

timeout : str | int (optional)

How long we wait for API call response before failing. Default 10 (seconds)

Returns

dict

dictionary of fields and values of the queried object

Raises

ValueError

Authentication failed, record was not found or api call was malformatted.

Examples

${id}=  Get Record ID From Url    # returns 5005E00000BMpypQAD or similar

Parameters

None

Raises

QWebValuedError

Id was not found or was not of expected format.

Related keywords

GoToRecord

Examples

${value}=    GetTableCell          Quantity             3
${value}=    GetTableCell          List Unit Price      5

Parameters

column : str

Column header in table.

row : str

Row number in the column.

Related keywords

ClickTableCell, TypeTable, VerifyTableCell

Examples

GlobalSearch       ${login_url}   John Doe             # returns top results for "John Doe"
GlobalSearch       ${login_url}   John Doe     Contact # returns results for a Contact named "John Doe"

Parameters

instance_url: str

Salesforce instance base url.

search_term : str

The search term that will be searched for. Mandatory.

record_type : str

Type of the record(s) that will be searched. Optional, if omitted, TOP_RESULTS will be returned.

timeout : str

How long to wait for the search results page to appear. Default 0 (use the default timeout setting).

Raises

QWebElementNotFoundError

Page did not contain element

Related keywords

LaunchApp

Examples

# Navigates to given Lightning record id
Go To Record     001UD000002XlBuYAK

Parameters

record_id: str

Id of the record to be navigated to. This can be found in url when record is opened.

url: str

Salesforce env base url. If not given, content of variable "login_url" is used. If neither is set, this keyword will fail.

Related keywords

GetRecordIDFromUrl

Example .json file content (new_records.json)

{
    "records" :[{
        "attributes" : {"type" : "Account", "referenceId" : "ref1"},
        "name" : "SampleAccount1",
        "phone" : "1111111111",
        "website" : "www.salesforce.com",
        "numberOfEmployees" : "100",
        "industry" : "Banking"
        },{
        "attributes" : {"type" : "Account", "referenceId" : "ref2"},
        "name" : "SampleAccount2",
        "phone" : "2222222222",
        "website" : "www.salesforce2.com",
        "numberOfEmployees" : "250",
        "industry" : "Banking"
        },{
        "attributes" : {"type" : "Account", "referenceId" : "ref3"},
        "name" : "SampleAccount3",
        "phone" : "3333333333",
        "website" : "www.salesforce3.com",
        "numberOfEmployees" : "52000",
        "industry" : "Banking"
        },{
        "attributes" : {"type" : "Account", "referenceId" : "ref4"},
        "name" : "SampleAccount4",
        "phone" : "4444444444",
        "website" : "www.salesforce4.com",
        "numberOfEmployees" : "2500",
        "industry" : "Banking"
        }]
    }

Example Test Script

# using .json in test script
${json}=      Import Records   Account    ${CURDIR}/resources/new_records.json

# Get id's from response
${id1}=                  Set Variable                ${json}[results][0][id]
${id2}=                  Set Variable                ${json}[results][1][id]
${id3}=                  Set Variable                ${json}[results][2][id]
${id4}=                  Set Variable                ${json}[results][3][id]

# can also get all id's to list at once like this
@{created_ids}=             Evaluate                   [x['id'] for x in $json['results']]

Parameters

sobject : str

Salesforce object type. You can use keyword "List Objects" to get names of all Salesforce objects.

file : str

Full path to .json file describing the objects to be created.

additional_headers : str/dict

Additional headers which will be appended to auth/content-type header. See examples.

timeout : str | int (optional)

How long we wait for API call response before failing. Default 10 (seconds)

Returns

id : str

Id of the newly created record.

Raises

ValueError

Authentication failed, record was not found or api call was malformatted.

Related keywords

ExportRecords, CreateRecord

Examples

JWTAuthenticate     ${client_id}   ${private_key}   myusername@test.com

Parameters

client_id : str

Consumer key of a connected app

username : str

Your Salesforce username

private_key : str

The private_key of the connected app. The private key must be in PEM format.

sandbox : bool (optional)

Is the instance a sandbox instance? This flag will set login url accordingly, either login.salesforce.com or test.salesforce.com (sandbox). Default: False (-> login.salesforce.com)

You can find out if your environment is a sandbox by trying to login with your credentials through https://login.salesforce.com and https://test.salesforce.com.

If you can login through https://login.salesforce.com then your environment is NOT a sandbox and if you can login through https://test.salesforce.com then your environment is a sandbox.

custom_url : str (optional)

Custom instance url in cases where you can login only using custom url, not the default Salesforce urls mentioned above. If custom_url is given, sandbox will be ignored.

timeout : str | int (optional)

How long we wait for API call response before failing. Default 10 (seconds)

Returns

token

Access token to be used in all subsequent calls. Note this value is automatically used in QForce keywords, but returned in case you want to use the same authentication token with a custom call with other libraries.

Raises

ConnectionError

Authentication call was not successful.

KeyError

Reply did not contain expected data.

Revoke, Authenticate, GetAccessToken, JWTLogin

Examples

OpenBrowser         about:blank     chrome
JWTAuthenticate     ${client_id}    ${private_key}   myusername@test.com
JWTLogin            /lightning/setup/SetupOneHome/home

Parameters

ret_url : str (optional)

URL to redirect after login. Default: None (goes to page defined in user's profile)

JWTAuthenticate

Examples

LaunchApp          Sales    # Launch normal app
LaunchApp          Sales    Opportunities   # Launch app + check text after launch
LaunchAPp          Gmail    connected_app=True  # Launch connected app, skips checks
LaunchApp          E-Bikes  index=2   # Launch second instance if there are duplicates

Parameters

app_name : str

Exact name of the application to launch.

tab : str

Tab text which will be verified to exist after succesfully opening an application (optional).

connected_app: bool

Connected apps behave differently than "native" apps. After launching applauncher is left open and app opens in a new tab. If True is given here, we will skip check that applauncher is closed and verification of tab name. (optional) Default: False

index : int

If there are exact duplicate app names, index of item that should be selected (optional) Default: 1

Raises

QWebElementNotFoundError

Page did not contain element

Related keywords

Login

Examples

ListObjects

Parameters

timeout : str | int (optional)

How long we wait for API call response before failing. Default 10 (seconds)

Examples

MultiPicklist    Hide Tabs     Auto Resolved Conflicts
# Move from "selected" back to "available"
MultiPicklist    Hide Tabs     Auto Resolved Conflicts   action=Move to Available

Parameters

label : str

Label of the pick list where value should be selected.

value : str

Value to be selected from a pick list.

action : str

Action of the button to click after selection. It's usually the text next to the button, or the tooltip text (yellow) that appears when mouse pointer is hovered over the button. Default: "Move to Chosen" and "Move selection to Chosen" (select). Change to "Move to Available" to unselect.

Raises

QWebElementNotFoundError

Page did not contain element

Related keywords

PickList, GetPickList, GetPickListCount, VerifyPickList

Examples

PickList        Salutation      Mr.

# Finding with exact label when label includes special characters
# ("*" needs to be escaped with "\")
PickList        \*Status        Open     partial_match=False

Parameters

label : str

Label of the pick list where value should be selected.

value : str

Value to be selected from a pick list.

index : int

If multiple picklists are present with same label, index can be used to identify which one should be selected. Default: 1

timeout : str | int

How long we try to find the picklist before failing. Default: DefaultTimeout configuration value.

kwargs :

Accepted kwargs:

partial_match: False. If partial matches are accepted set

partial_match to True.

Default: as set in config PartialMatch. Check with 'GetConfig PartialMatch'

Raises

QWebElementNotFoundError

Page did not contain element

Related keywords

MultiPickList, GetPickList, GetPickListCount, VerifyPickList

Examples

${results}=     QueryRecords       SELECT id,name from Contact WHERE name LIKE 'John%'
# add id from first result object to a variable
${ID}=          Set Variable       ${results}[records][0][Id]

Parameters

query : str

SOQL query.

timeout : str | int (optional)

How long we wait for API call response before failing. Default 10 (seconds)

Returns

dict

dictionary of fields and values of the queried object

Raises

ValueError

Authentication failed, record was not found or api call was malformatted.

Examples

${product_id}=      Query Records    query=Select Id FROM Product2 WHERE Name='SLA: Gold'
${pricebook_id}=    Query Records    query=Select Id FROM Pricebook2 WHERE IsStandard=True
${cpq_product}=     Read CPQ Product    ${product_id}[records][0][Id]    ${pricebook_id}[records][0][Id]    USD

Parameters

product_id : str

Product Id.

pricebook_id : str

Pricebook Id.

quote_model : str

The ISO code of a Salesforce currency where the product’s price is loaded. Required only for multi-currency orgs. Default: USD.

timeout : str | int (optional)

How long we wait for API call response before failing. Default 10 (seconds)

Returns

dict

Product model (dictionary) of fields and values of the cpq product.

Raises

ValueError

Authentication failed, quote was not found, api call was malformatted.

Examples

${cpq_quote}=      Read CPQ Quote    a2w7Q000000LBGRQA4

Parameters

quote_id : str

Id of the CPQ Quote

timeout : str | int (optional)

How long we wait for API call response before failing. Default 10 (seconds)

Returns

dict

dictionary of fields and values of the queried cpq quote

Raises

ValueError

Authentication failed, quote was not found, api call was malformatted.

Examples

Authenticate     ${client_id}   ${client_secret}   myusername@test.com    ${password}
# do actions with API
Revoke

Parameters

timeout : str | int (optional)

How long we wait for API call response before failing. Default 10 (seconds)

Raises

ConnectionError

Authentication call was not successful.

Examples

${cpq_quote}=           Read CPQ Quote         a2w7Q000000LBGRQA4
${calculated_quote}=    Calculate CPQ Quote    ${cpq_quote}
${saved_quote}=         Save CPQ Quote         ${calculated_quote}

Parameters

quote_model : str

Quote Model (json/dict) of quote to be saved.

timeout : str | int (optional)

How long we wait for API call response before failing. Default 10 (seconds)

Returns

dict

Quote model (dictionary) of fields and values of the saved cpq quote

Raises

ValueError

Authentication failed, quote was not found, api call was malformatted.

Examples

# Default action, page down in a list
ScrollList

# Scrolls list up by one page
ScrollList  direction=page_up

# Scroll list right
ScrollList  uiScroller      right

# Scroll to the bottom of a list using different locator and tag
ScrollList  scrollable2     bottom      tag=custom_tag

# Scroll to the top of a list
ScrollList  direction=top

# Scroll (page) down 3 times in a list
Repeat Keyword     3 times    ScrollList    direction=down

Parameters

scrollable: str

Attribute value or xpath to identify scrollable element. Default: as set in setting SFScrollable

direction : str

Direction to scroll to (down, up, left, right, top, bottom, page_down, page_up).

• Down/up/left/right map to respective ARROW keys.
• Top/Bottom map to HOME & END keys.
• Page_up/Page_down map to PAGE_UP and PAGE_DOWN keys.

Default value: page_down

tag : str

Tag of the scrollable element. Needed if attribute value is used instead of xpath. Default value: div

timeout : str

How long to wait for the search results page to appear. Default 0 (use the default timeout setting).

Raises

QWebValueError

Direction is not given in correct format.

QWebElementNotFoundError

Page did not contain given scrollable element

Examples

TypeTable          Quantity             3     2.00
TypeTable          List Unit Price      5     9322

Parameters

column : str

Column header in table.

row : str

Row number in the column.

text : str

Text to be written into the field

Related keywords

ClickTableCell, GetTableCell, VerifyTableCell

Examples

${contact}=      Create Record      Contact     FirstName=Jane         LastName=Doe
${account}=      Create Record      Account     Name=KindCorp

Update Record    Contact    ${contact}    FirstName=Jamie     Email=jamie.doe@fake.com

Parameters

sobject : str

Salesforce object type. You can use keyword "List Objects" to get names of all Salesforce objects.

oid: str

ID of the record to be deleted

timeout : str | int (optional)

How long we wait for API call response before failing. Default 10 (seconds)

Raises

ValueError

Authentication failed, record was not found or api call was malformatted.

Examples

ClickText          New

UseModal           On   # limits all text based element searches to dialog, if open
... do something in modal dialog
UseModal           Off

# Filter by non-default modal dialog
UseModal           On   //div[@class='slds-modal__container']

Parameters

status : str

Status of limitation (on/off). Default on

modal_xpath : str

Xpath to the root element of the modal dialog. Default: //div[contains(@class, 'modal-container')]

Examples

${cpq_quote}=           Read CPQ Quote         a2w7Q000000LBGRQA4
${validation_errors}=   Validate CPQ Quote     ${cpq_quote}

Parameters

quote_model : str

Quote Model (json/dict) of quote to be calculated. TIP: Use "CPQ Read Quote" to get the quote model.

timeout : str | int (optional)

How long we wait for API call response before failing. Default 10 (seconds)

Returns

list

Returns empty list if validation was successful. If not, returns list of validation errors.

Raises

ValueError

Authentication failed, quote was not found, api call was malformatted.

Examples

VerifyField        Phone             12345
VerifyField        Phone             123                 partial_match=True
VerifyField        Account Name      Customer X
VerifyField        Notes             This is the begi    partial_match=True

# verifies that field "Type" is empty
VerifyField        Type              ${EMPTY}

# Verifies only text under <a> tag
VerifyField        Lead Owner        John Doe            tag=a

Parameters

label : str

Label/heading of the record to verify.

value : str

Value which is expected to be in the field.

index : int

If there are multiple duplicate labels in record layout, index can be used to identify which one should be verified.

partial_match : bool

If full match is expected or if partial match is accepted. Default: False (full match)

tag: str

Tag of the field. Default: span. Some salesforce texts are under non-formatted <a> tag

timeout : str | int

Timeout for waiting element to appear before failing. Default value is what is set in "DefaultTimeout".

Raises

QWebElementNotFoundError

Page did not contain element

Related keywords

GetFieldValue

Examples

VerifyPageHeader    Opportunities

Parameters

tab_name : str

Name of the tab which should be opened.

timeout : str

How long to wait for page header to appear. Default 0 (use the default timeout setting)

Raises

QWebElementNotFoundError

Page did not contain element

Related keywords

LaunchApp, VerifyField

Examples

# Verify specific option value exists
VerifyPicklist        Salutation    Dr.
# Verify multiple option values exist
VerifyPicklist        Salutation    Mr.   Ms.    Dr.
# Verify specific value exists and is selected
VerifyPicklist        Salutation    Dr.   selected=True

Parameters

label : str

Label of the pick list where value should be selected.

args: str

Option values which should exist on a picklist

index : int

If multiple picklists are present with same label, index can be used to identify which one should be selected. Default: 1

selected : bool

Verifies that given option exists only (False) or that it also is the currently selected option (True). Default: False

timeout : str | int

How long we try to find the picklist before failing. Default: DefaultTimeout configuration value.

Raises

QWebElementNotFoundError

Page did not contain element

Related keywords

PickList, MultiPickList, GetPickList, GetPickListCount

Examples

${contact}=      Create Record      Contact     FirstName=Jane         LastName=Doe
Update Record    Contact    ${contact}  FirstName=Jamie    Email=jamie.doe@fake.com
Verify Record    Contact    ${contact}  FirstName=Jamie    LastName=Doe   Email=jamie.doe@fake.com

Parameters

sobject : str

Salesforce object type. You can use keyword "List Objects" to get names of all Salesforce objects.

oid: str

ID of the record to be verified

partial_match: bool

Require full string match (default) or accept partial matches.

timeout : str | int (optional)

How long we wait for API call response before failing. Default 10 (seconds)

**data: str

Set of fieldname/expected value pairs to verify

Raises

KeyError

Given field does not exist.

ValueError

Authentication failed, record was not found, api call was malformatted or at least one of the verified fields has different value than expected.

Examples

VerifyTableCell          Quantity             3     2.00
VerifyTableCell          List Unit Price      5     7 632     partial_match=True

Parameters

column : str

Column header in table.

row : str

Row number in the column.

expected : str

Expected value in column to verify against.

partial_match : str

False (default): expect full match. True: allow partial matches

Related keywords

ClickTableCell, TypeTable, GetTableCell

Examples

VerifyText          Canis
VerifyText          Canis       20  # Waits max 20 seconds for text to appear
VerifyText          Canis       recognition_mode=vision  # Use Computer Vision engine

Parameters

text : str

Text to be verified.

timeout : str | int

How long we try to find text before failing. Default 10 (seconds)

anchor : str | int

Another text close to text we are trying to find or index.

recognition_mode : str

Use either "web" backend (default) or computer vision ("vision"). Computer vision finds texts from the screen regardless how they appear on DOM. This is useful to verify truncated ui texts and especially when elements are under shadow dom.