Class XrmUiTest

Main class for testing in D365

Hierarchy

XrmUiTest

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new XrmUiTest(settings?: TestSettings): XrmUiTest

- Defined in src/xrm/XrmUITest.ts:86
Construct a new instance of XrmUiTest

Parameters
- Optional settings: TestSettings
  
  Define certain behaviour settings optionally. If not passed, defaults will be used
Returns XrmUiTest

Accessors

AppId

get AppId(): string
set AppId(value: string): void

- Defined in src/xrm/XrmUITest.ts:284
Gets the currently opened AppId

Returns string
- Defined in src/xrm/XrmUITest.ts:291
Sets the currently opened AppId. Is set automatically by calling Navigation.openAppById

Parameters
- value: string
Returns void

Attribute

get Attribute(): Attribute

- Defined in src/xrm/XrmUITest.ts:196
Gets the subfunctions for interacting with attributes in D365, for example getting or setting values

Returns Attribute

Button

get Button(): Button

- Defined in src/xrm/XrmUITest.ts:174
Gets the subfunctions for using ribbon buttons in D365

Returns Button

Control

get Control(): Control

- Defined in src/xrm/XrmUITest.ts:207
Gets the subfunctions for interacting with controls in D365, for example getting visibility or disable states

Returns Control

Dialog

get Dialog(): Dialog

- Defined in src/xrm/XrmUITest.ts:218
Gets the subfunctions for interacting with dialogs in D365, for example duplicate detection dialogs

Returns Dialog

Entity

get Entity(): Entity

- Defined in src/xrm/XrmUITest.ts:185
Gets the subfunctions for interacting with the record in D365

Returns Entity

Form

get Form(): Form

- Defined in src/xrm/XrmUITest.ts:229
Gets the subfunctions for interacting with forms in D365, for example opening different forms

Returns Form

Grid

get Grid(): Grid

- Defined in src/xrm/XrmUITest.ts:240
Gets the subfunctions for interacting with grids / entity lists in D365, for example opening specific records

Returns Grid

Navigation

get Navigation(): Navigation

- Defined in src/xrm/XrmUITest.ts:163
Gets the subfunctions for navigating in D365

Returns Navigation

Section

get Section(): Section

- Defined in src/xrm/XrmUITest.ts:273
Gets the subfunctions for interacting with sections in D365, for example getting its visibility state

Returns Section

SubGrid

get SubGrid(): SubGrid

- Defined in src/xrm/XrmUITest.ts:251
Gets the subfunctions for interacting with subgrids in D365, for example refreshing or opening specific records

Returns SubGrid

Tab

get Tab(): Tab

- Defined in src/xrm/XrmUITest.ts:262
Gets the subfunctions for interacting with tabs in D365, for example to open one

Returns Tab

WebApi

get WebApi(): WebApi

- Defined in src/xrm/XrmUITest.ts:298
Gets the subfunctions for interacting with the D365 WebApi using Xrm.WebApi

Returns WebApi

browser

get browser(): Browser

- Defined in src/xrm/XrmUITest.ts:135
Gets the browser object that was generated when launching playwright

Returns Browser

context

get context(): BrowserContext

- Defined in src/xrm/XrmUITest.ts:142
Gets the browser context object

Returns BrowserContext

crmUrl

get crmUrl(): string

- Defined in src/xrm/XrmUITest.ts:156
Gets the D365 base URL

Returns string

page

get page(): Page

- Defined in src/xrm/XrmUITest.ts:149
Gets the page object that was generated when connecting to D365

Returns Page

settings

get settings(): TestSettings
set settings(value: TestSettings): void

- Defined in src/xrm/XrmUITest.ts:117
Default settings for various actions such as navigation

Returns TestSettings
- Defined in src/xrm/XrmUITest.ts:124
Update settings

Parameters
- value: TestSettings
Returns void

Methods

buildUrl

buildUrl(url: string, appId?: string): string

- Defined in src/xrm/XrmUITest.ts:358
Parameters
- url: string
- Optional appId: string
Returns string

close

close(): Promise<void>

- Defined in src/xrm/XrmUITest.ts:434
Closes the playwright browser session

Returns Promise<void>

launch

launch(browser?: "chromium" | "firefox" | "webkit", launchOptions?: LaunchOptions, contextOptions?: BrowserContextOptions): Promise<[Browser, BrowserContext, Page]>

- Defined in src/xrm/XrmUITest.ts:314
Function for launching a playwright instance

remarks

viewport in launchOptions is preset to null for using your clients default resolution. Overwrite viewport to change.

Parameters
- Default value browser: "chromium" | "firefox" | "webkit" = "chromium"
- Optional launchOptions: LaunchOptions
- Optional contextOptions: BrowserContextOptions
Returns Promise<[Browser, BrowserContext, Page]>

Started browser instance, browser context and page

open

open(url: string, extendedProperties: OpenProperties): Promise<void>

- Defined in src/xrm/XrmUITest.ts:369
Opens your D365 organization and logs you in

Parameters
- url: string
  
  Url of your D365 organization
- extendedProperties: OpenProperties
  
  Options for logging in. User name and password are required. If you have a custom authentication page, you should pass userNameFieldSelector if user name has to be reentered and passwordFieldSelector for password entry. These are css selectors for the inputs.
Returns Promise<void>

Resolves as soon as D365 is logged in and open

waitForIdleness

waitForIdleness(): Promise<void>

- Defined in src/xrm/XrmUITest.ts:329
Waits for all pending UCI operations to settle

Returns Promise<void>

Generated using TypeDoc