Generated using TypeDoc
225 |Generated using TypeDoc
177 |There is support for opening UCI apps, update forms and create forms. 76 | All of these calls use parametrized URLs and wait for the page to fully load and all network requests to be finished. This guarantees for a robust and fast usage experience.
77 | 78 |UCI apps are currently opened by their appId. You can find it out by opening the app in your D365 organization and taking a look into the URL bar in your browser.
81 |There will be a parameter called appId, which will print the id of the currently opened app. 82 | You can use it like that afterwards:
83 |await xrmTest.Navigation.openAppById("3a5ff736-45a5-4318-a05e-c8a98761e64a");
84 | Opening create forms just requires the entity logical name of the entity form that you want to open:
89 |await xrmTest.Navigation.openCreateForm("account");
90 | This allows to open forms with existing records. It works just like the openCreateForm function, but takes another parameter for the record id:
await xrmTest.Navigation.openUpdateForm("account", "83702a07-d3eb-4774-bdab-1d768a2f94d6");
96 | You can open the global quick create very much like openCreateForm by calling its function with the entity logical name as parameter. Afterwards you :
await xrmTest.Navigation.openQuickCreate("account");
102 |
103 | // This will already execute inside the quick create and set the account name
104 | await xrmTest.Attribute.setValue("name", "Test name");
105 |
106 | // This will return the id of the record that was created
107 | const id = await xrmTest.Entity.save();
108 | There is a navigateTo function which allows for flexible navigation inside the system. Client SDK is used for issuing navigation calls.
await xrmTest.Navigation.navigateTo({
117 | pageType: "entitylist",
118 | entityName: "account"
119 | });
120 | Generated using TypeDoc
215 |Controls can currently be checked for their disabled state, their hidden state and their option set values (to check if filtering works).
76 | 79 |Hidden and disabled state can be retrieved as a combined object:
80 |const { isVisible, isDisabled } = await xrmTest.Control.get("name");
81 | The array of currently available options for a control can be retrieved like this:
86 |const options = await xrmTest.Control.getOptions("industrycode");
87 | Generated using TypeDoc
182 |Buttons can be clicked either by name or by data-id. 79 | The data-ids can be found in the HTML DOM, the labels are just the ones you see in the D365 UI. 80 | This should also work for clicking subgrid buttons.
81 | 82 |Clicks the first button with the specified label:
85 |await xrmTest.Button.click({ byLabel: "Create Document" });
86 | Clicks the first button with the specified data-id:
91 |await xrmTest.Button.click({ byDataId: "account|NoRelationship|Form|mscrmaddons.am.form.createworkingitem.account" });
92 | Generated using TypeDoc
187 |There are various functions for interacting with subgrids, which are listed below.
76 | 77 |Gets the number of records that are currently displayed.
80 |const count = await xrmUiTest.Subgrid.getRecordCount("subgrid1");
81 | Opens the update form for the record at position n.
86 |await xrmUiTest.Subgrid.openNthRecord("subgrid1", 1);
87 | Refreshes the subgrid
92 |await xrmUiTest.Subgrid.refresh("subgrid1");
93 | Takes care of opening the tab where the subgrid resides and clicking its "Add New Record" default button. 98 | If the button is hidden inside the overflow menu, the overflow menu is searched as well.
99 |Note:
100 |101 |103 |If the button fails to get clicked, check user permissions, button hide rules and whether you use custom create buttons, as we search for the default create button
102 |
await xrmUiTest.Subgrid.createNewRecord("subgrid1");
104 | Generated using TypeDoc
199 |Tabs don't need to be used for getting or setting values. 76 | However you might want to open them for your IFrames to load correctly (hidden ones will not load on start in D365).
77 | 78 |You can expand / select the active tab like this:
81 |await xrmTest.Tab.open("tab_1");
82 | Hidden state can be retrieved like this:
87 |const { isVisible } = await xrmTest.Tab.get("SUMMARY_TAB");
88 | Generated using TypeDoc
183 |These are functions for dealing with the entity data on a form.
76 | 77 |When just opening a create form and entering data, you might not even want to save your data. 80 | If you just try to navigate away without saving, then a confirm message will appear, reminding you that you have unsaved data.
81 |await xrmTest.Entity.noSubmit();
82 | If you really want to navigate to a different page without saving, call the xrmTest.Entity.noSubmit function for setting all attributes to submitMode never, so that none would be saved and thus CRM does not show the prompt.
Saves the data on your current form.
88 |await xrmTest.Entity.save();
89 | 91 |93 | 94 |This does not use the save button, but the SDK function for saving
92 |
Gets the ID of the current record.
97 |const id = await xrmTest.Entity.getId();
98 | Gets the logical name of the current record (entity)
103 |await xrmTest.Entity.getEntityName();
104 | Gets an entity reference pointing to the current record.
109 |const { id, entityName, name } = await xrmTest.Entity.getEntityReference();
110 | 112 |114 | 115 |The return object has the schema { id: string, entityName: string, name: string }
113 |
Deletes the current record.
118 |await xrmTest.Entity.delete();
119 | 121 |123 | 124 |This function uses the delete button of the form.
122 |
Activates the current record
127 |await xrmTest.Entity.activate();
128 | 130 |132 | 133 |This function uses the activate button of the form
131 |
Deactivates the current record
136 |await xrmTest.Entity.deactivate();
137 | 139 |141 |This function uses the deactivate button of the form
140 |
Generated using TypeDoc
235 |This namespace is used for handlers that interact with D365 default dialogs.
76 | Previously the duplicate dialog was controlled from here, but it was integrated in the xrmTest.Entity.save function.
For now there is no functionality in here, but as soon as new default dialogs have to be handled, this will be done in here again.
78 |For custom dialogs, you can always just use the page object that you retrieve from xrmTest.open.
79 | This allows to interact with the browser using playwright.
Generated using TypeDoc
174 |Yes, you can. You just need to set the acceptDownloads property on the browserContext settings:
await xrmTest.launch("chromium",
80 | {
81 | headless: false,
82 | args: [
83 | '--disable-setuid-sandbox',
84 | '--disable-infobars',
85 | '--start-fullscreen',
86 | '--window-position=0,0',
87 | '--window-size=1920,1080',
88 | '--user-agent="Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36"'
89 | ]
90 | },
91 | {
92 | allowDownloads: true
93 | })
94 | This will accept all following downloads and save them with a generic file name. 96 | If you wish to save it with the name that the browser intended to, you can do so as follows:
97 |const [ download ] = await Promise.all([
98 | page.waitForEvent('download'), // wait for download to start
99 | page.click('a') // Or any other event that triggers your download
100 | ]);
101 |
102 | const suggestedFileName = download.suggestedFilename();
103 | await download.saveAs(`./yourDownloadFolder/suggestedFileName`);
104 | You can check whether the file was successfully downloaded using the checkForFile function of TestUtils:
await TestUtils.checkForFile(page, path.resolve("./reports"), [".pdf", ".pdf'"]);
107 | Yes, you can. You can use page.evaluate for doing this. You should be careful, as page.evaluate can not access variables from its outer context.
You have to pass all variables that you want to use as second argument in page.evaluate like this:
const logicalName = "account";
114 | const id = "someid";
115 |
116 | await page.evaluate((l, i) => {
117 | window.Xrm.WebApi.deleteRecord(l, i);
118 | }, [ logicalName, id ]);
119 | Generated using TypeDoc
214 |These are various utils that are supposed to help you achieve commonly needed tasks when doing UI tests.
76 | 77 |This can be used for clearing downloads or reports files from previous runs.
80 | 81 |This can be used for checking whether a specific file (most often by file ending) has been downloaded to a specific folder.
84 | 85 |This is useful for being able to see what happened when tests failed in DevOps. It will take a screenshot of the whole page and save it with the specified file name if a test fails. The error will be rethrown so that no information on the error is lost.
88 | 89 |This is useful when navigation timeout errors occur.
92 | When loading pages, we wait for all requests to finish (currently 60 seconds wait time by default, but you can increase it using xrmTest.settings = { timeout: 120 * 1000 } for example, for setting the default timeout to 120 seconds).
If you get errors nonetheless, please use this function for reporting the URLs that took longer to load. 94 | We already abort some URLs which have shown timeout issues without being necessary for D365 to work.
95 |Generated using TypeDoc
189 |On most of the navigation functions we wait for the page to settle by checking that it stays idle for 2 seconds without interruption.
79 |If it gets busy during those two seconds, we reset the 2 seconds wait time.
80 |If you nonetheless get time out errors, you can track which requests timed out using the TestUtils.trackTimedOutRequest function:
TestUtils.trackTimedOutRequest(() => page, () => xrmTest.Navigation.openAppById("3a5ff736-45a5-4318-a05e-c8a98761e64a"));
82 | If timeouts occur, D365-UI-Test will log the timed out request URLs to console.
84 |Generated using TypeDoc
178 |Sections are only used for being able to get their visibility state.
76 | 79 |Hidden state can be retrieved like this:
80 |const { isVisible } = await xrmTest.Section.get("SUMMARY_TAB", "ACCOUNT_INFORMATION");
81 | Generated using TypeDoc
176 |