diff --git a/connection-guides/hris/workday_wql.mdx b/connection-guides/hris/workday_wql.mdx index 5734c6c..a3cafd4 100644 --- a/connection-guides/hris/workday_wql.mdx +++ b/connection-guides/hris/workday_wql.mdx @@ -349,49 +349,128 @@ If your URL is `https://my-instance.workday.com/my-tenant/d/etc`, your tenant is -### Create a Custom Report + +## Create and View a Custom Report - - Use the global search bar to search for "Create Custom Report". + + Search and navigate to the `Create Custom Report` task + + Accessing Report Designer + + + + + Follow these steps to configure the custom report: + + - **Report Name**: Must be unique within the tenant + - **Report Type**: Select **Advanced** + - **Optimised for Performance**: Tick this box to enhance performance + - **Data Source**: Choose the appropriate data source based on the data you need (e.g. Workers for HCM reporting). + - Global search for Create Custom Report + Create Custom Report + Click `OK` to continue. - Enter the following details: - - **Report Name**: Name for the WQL report. - - **Optimised for Performance**: If ticked, only indexed data sources are shown. Untick this option to display all data sources. - - **Data Source**: Select the data source you want to build a custom report for (e.g. All Workers). - - **Report Type**: Select `Advanced`. + Add and configure report fields: + - Click the `+` icon to add a field. + - Select a Business Object (e.g. Worker) in the **Business Object** column. + - Choose the specific field (e.g. Employee ID) in the **Field** column. + - Set aliases in **Column Heading Override** to ensure stable field names in API responses. + + + The **Column Heading Override XML Alias** column will appear only after you enable **Enable As Web Service** under the Advanced tab and save the report. You can view this column when you return to edit the report. + + + + Add following **field's Alias** in your report. The aliases serve as stable identifiers for the API responses but the underlying fields must be properly configured. + - Workday_ID + - Employee_ID + - Title + - First_Name + - Last_Name + - Display_Full_Name + - Personal_Email + - Work_Email + - Personal_Phone_Number + - Work_Phone_Number + - Gender + - Ethnicity + - Date_Of_Birth + - Marital_Status + - Job_Title + - Company + - Hire_Date + - Original_Hire_Date + - Employment_Status + - Location + - Employment_Type + - Manager + - Cost_Centers + - National_Identifier_Numbers + - Termination_Date + - Home_Address + - Home_Address_Country + - Home_Address_Postal_Code + - Home_Address_State + - Home_Address_City + - Work_Address + - Work_Address_Country + - Citizenships + - Job_Code + - Effective_Date + - Grade + - Benefits + - Skills + - Create Custom Report details + Fields and Aliases Settings - - Click `OK` to create the report. - - - After creating the report you are taken to the editing page. Select the fields you want to include from the data source. + + - Tick **Populate Undefined Prompt Defaults** to make prompt default fields visible in the report table. Once the `Prompt Defaults` grid is visible, the ticked **Populate Undefined Prompt Defaults** field will be unticked again. + - Tick **Display Prompt Values in Subtitle** to enable prompt display. - Edit Custom Report + Prompts Settings - Click `OK` to save the field selection. - - - Test the report by clicking `Test` in the three-dot action menu beside the report name. + + Search for `View Custom Report`, - Edit Custom Report + Search for View Custom Report + + + select the report you just created, and then click `OK` to open it. + + Select Custom report to View + + + + + Navigate to `Test` under the `Custom Report` menu via the 3-dot menu. + + Navigate to Test + + + Click `OK` to test it. + + Click OK on Pop-up + + + You will get some sample data based on the fields you configured in the custom report. + + Sample Data from Custom Report - -### Convert the Report to WQL in Workday + +## Convert the Report to WQL in Workday @@ -400,19 +479,25 @@ If your URL is `https://my-instance.workday.com/my-tenant/d/etc`, your tenant is Global search for Convert Reports to WQL - Select the custom report you created earlier in the [Create a Custom Report](#create-a-custom-report) step. + Select the custom report you created earlier in the [Create and View a Custom Report](#create-and-view-a-custom-report) step. Select created custom report - Click `OK`. + Click `OK`. + + + + + Click to continue without filter + - + You are taken to a page showing the generated WQL query for your custom report. Generated WQL Query - Copy this WQL query and paste it into the `Employee WQL Query` field when connecting through the StackOne Connector Hub. + Copy this WQL query and paste it into the `Employee WQL Query` field when connecting through the StackOne Connector Hub. WQL does not support calculated fields when converting custom reports to WQL. @@ -434,7 +519,7 @@ Enter the following details in the StackOne Connector Hub: ```sql /* Sample WQL query format */ - SELECT employeeID,legalFirstName,legalLastName, ... FROM employees; + SELECT workdayID as Workday_ID, employeeID as Employee_ID, legalName_Title as Title, legalFirstName as First_Name, legalLastName as Last_Name, legalNameInGeneralDisplayFormat as Display_Full_Name, email_PrimaryHome as Personal_Email, email_PrimaryWork as Work_Email, phone_PrimaryHome as Personal_Phone_Number FROM allWorkers ``` Click **Connect**. @@ -444,7 +529,7 @@ Click **Connect**. className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="Linking your Account" - src="/images/workday-wql/image24.png" + src="/images/workday-wql/workday_wql_stackone_connector_hub_10.png" /> diff --git a/images/workday-wql/workday_wql_click_ok_to_move_forward_to_test.png b/images/workday-wql/workday_wql_click_ok_to_move_forward_to_test.png new file mode 100644 index 0000000..42b48ac Binary files /dev/null and b/images/workday-wql/workday_wql_click_ok_to_move_forward_to_test.png differ diff --git a/images/workday-wql/workday_wql_click_to_continue.png b/images/workday-wql/workday_wql_click_to_continue.png new file mode 100644 index 0000000..f6d92ca Binary files /dev/null and b/images/workday-wql/workday_wql_click_to_continue.png differ diff --git a/images/workday-wql/workday_wql_create_custom_report.png b/images/workday-wql/workday_wql_create_custom_report.png new file mode 100644 index 0000000..3e030ff Binary files /dev/null and b/images/workday-wql/workday_wql_create_custom_report.png differ diff --git a/images/workday-wql/workday_wql_crw_generate_7.png b/images/workday-wql/workday_wql_crw_generate_7.png index 2b42612..2cd1956 100644 Binary files a/images/workday-wql/workday_wql_crw_generate_7.png and b/images/workday-wql/workday_wql_crw_generate_7.png differ diff --git a/images/workday-wql/workday_wql_crw_select_report_6.png b/images/workday-wql/workday_wql_crw_select_report_6.png index 3430a80..366158a 100644 Binary files a/images/workday-wql/workday_wql_crw_select_report_6.png and b/images/workday-wql/workday_wql_crw_select_report_6.png differ diff --git a/images/workday-wql/workday_wql_custom_report_prompt.png b/images/workday-wql/workday_wql_custom_report_prompt.png new file mode 100644 index 0000000..86c3c6f Binary files /dev/null and b/images/workday-wql/workday_wql_custom_report_prompt.png differ diff --git a/images/workday-wql/workday_wql_fields_aliases.png b/images/workday-wql/workday_wql_fields_aliases.png new file mode 100644 index 0000000..0a9bb7c Binary files /dev/null and b/images/workday-wql/workday_wql_fields_aliases.png differ diff --git a/images/workday-wql/workday_wql_integration_config_8.png b/images/workday-wql/workday_wql_integration_config_8.png new file mode 100644 index 0000000..58c6c2d Binary files /dev/null and b/images/workday-wql/workday_wql_integration_config_8.png differ diff --git a/images/workday-wql/workday_wql_integration_workday_setup_form_9.png b/images/workday-wql/workday_wql_integration_workday_setup_form_9.png new file mode 100644 index 0000000..91d6e6e Binary files /dev/null and b/images/workday-wql/workday_wql_integration_workday_setup_form_9.png differ diff --git a/images/workday-wql/workday_wql_navigate_to_test.png b/images/workday-wql/workday_wql_navigate_to_test.png new file mode 100644 index 0000000..1e488a7 Binary files /dev/null and b/images/workday-wql/workday_wql_navigate_to_test.png differ diff --git a/images/workday-wql/workday_wql_sample_data_from_custom_report.png b/images/workday-wql/workday_wql_sample_data_from_custom_report.png new file mode 100644 index 0000000..350e6d5 Binary files /dev/null and b/images/workday-wql/workday_wql_sample_data_from_custom_report.png differ diff --git a/images/workday-wql/workday_wql_search_for_view_custom_report.png b/images/workday-wql/workday_wql_search_for_view_custom_report.png new file mode 100644 index 0000000..32b15f0 Binary files /dev/null and b/images/workday-wql/workday_wql_search_for_view_custom_report.png differ diff --git a/images/workday-wql/workday_wql_select_for_view_custom_report.png b/images/workday-wql/workday_wql_select_for_view_custom_report.png new file mode 100644 index 0000000..47e1532 Binary files /dev/null and b/images/workday-wql/workday_wql_select_for_view_custom_report.png differ diff --git a/images/workday-wql/workday_wql_stackone_connector_hub_10.png b/images/workday-wql/workday_wql_stackone_connector_hub_10.png new file mode 100644 index 0000000..5515189 Binary files /dev/null and b/images/workday-wql/workday_wql_stackone_connector_hub_10.png differ