From e84c9377f05fab563bbf31b7ef21bf7f1fc649b6 Mon Sep 17 00:00:00 2001 From: Haritha v Date: Mon, 19 May 2025 13:42:21 +0530 Subject: [PATCH 1/6] Workday_View_Bonuses --- .../.codeblocks/block_0.sh | 3 + .../.codeblocks/block_1.sh | 6 ++ plugins/workday-view-bonuses/README.md | 63 ++++++++++++++++++- 3 files changed, 71 insertions(+), 1 deletion(-) create mode 100644 plugins/workday-view-bonuses/.codeblocks/block_0.sh create mode 100644 plugins/workday-view-bonuses/.codeblocks/block_1.sh diff --git a/plugins/workday-view-bonuses/.codeblocks/block_0.sh b/plugins/workday-view-bonuses/.codeblocks/block_0.sh new file mode 100644 index 00000000..5c3aa73c --- /dev/null +++ b/plugins/workday-view-bonuses/.codeblocks/block_0.sh @@ -0,0 +1,3 @@ +curl --location 'https:///ccx/api/v1//workers?search=' \ +--header 'Authorization: Bearer ' \ +--header 'Content-Type: application/json' diff --git a/plugins/workday-view-bonuses/.codeblocks/block_1.sh b/plugins/workday-view-bonuses/.codeblocks/block_1.sh new file mode 100644 index 00000000..91b2dd91 --- /dev/null +++ b/plugins/workday-view-bonuses/.codeblocks/block_1.sh @@ -0,0 +1,6 @@ +curl --location --request POST 'https:///ccx/api/wql/v1//data' \ +--header 'Authorization: Bearer ' \ +--header 'Content-Type: application/json' \ +--data '{ + "query": "SELECT one_TimePaymentEventReason as Reason, positionForOneTimePayment, scheduledPaymentDate, completedOn, actualBonus_Amount as Amount, plan, compensationElement, employee{employee, employeeID, supervisoryOrganization} as employee FROM bonusAndOne_TimePayments WHERE one_TimePaymentEventReason IN (\"3e2f3c97dcb941e7afd0806555954818\") AND employee = \"\" ORDER BY scheduledPaymentDate DESC LIMIT 10" +}' diff --git a/plugins/workday-view-bonuses/README.md b/plugins/workday-view-bonuses/README.md index 640071ad..c58d8fae 100644 --- a/plugins/workday-view-bonuses/README.md +++ b/plugins/workday-view-bonuses/README.md @@ -1,6 +1,8 @@ --- -fidelity: IDEA +fidelity: GUIDE name: View Bonuses +difficulty_level: INTERMEDIATE +time_in_minutes: 20 purple_chat_link: https://developer.moveworks.com/creator-studio/developer-tools/purple-chat-builder/?workspace=%7B%22title%22%3A%22My+Workspace%22%2C%22botSettings%22%3A%7B%7D%2C%22mocks%22%3A%5B%7B%22id%22%3A157%2C%22title%22%3A%22Mock+1%22%2C%22transcript%22%3A%7B%22settings%22%3A%7B%22colorStyle%22%3A%22LIGHT%22%2C%22startTime%22%3A%2211%3A43+AM%22%2C%22defaultPerson%22%3A%22PAUL%22%2C%22editable%22%3Atrue%7D%2C%22messages%22%3A%5B%7B%22from%22%3A%22USER%22%2C%22text%22%3A%22Can+I+see+my+bonus+history%3F%22%7D%2C%7B%22from%22%3A%22BOT%22%2C%22text%22%3A%22%E2%9C%85+Authenticate+the+user%5Cn%E2%9C%85+Retrieve+bonus+payment+records%5Cn%F0%9F%94%81+Presenting+your+bonus+history%22%7D%2C%7B%22from%22%3A%22BOT%22%2C%22text%22%3A%22Sure%2C+here%27s+a+summary+of+your+bonus+payments+over+the+years+%F0%9F%91%87%22%2C%22cards%22%3A%5B%7B%22title%22%3A%22Bonus+History%22%2C%22text%22%3A%22Your+bonus+payments+are+as+follows%3A%3Cbr%3E%3Cb%3E2023%3A%3C%2Fb%3E+%245%2C000%3Cbr%3E%3Cb%3E2022%3A%3C%2Fb%3E+%244%2C500%3Cbr%3E%3Cb%3E2021%3A%3C%2Fb%3E+%244%2C000%3Cbr%3EFor+detailed+information+and+bonus+criteria%2C+you+can+click+below.%22%2C%22buttons%22%3A%5B%7B%22style%22%3A%22PRIMARY%22%2C%22text%22%3A%22View+Detailed+Bonus+History%22%7D%2C%7B%22text%22%3A%22Learn+About+Bonus+Criteria%22%7D%5D%7D%5D%7D%5D%7D%7D%5D%7D solution_tags: - Finance @@ -10,3 +12,62 @@ systems: - workday --- +## Introduction + +The **“View Bonuses”** plugin allows employees to access their bonus details for a specific period using **Workday**, all through the Moveworks AI Assistant. This ensures users have quick and easy visibility into their compensation without needing to navigate Workday manually. + +This guide will walk you through installing and configuring the plugin in **Agent Studio** in just a few minutes. Let’s get started! + +## **Prerequisites** + +- Access to Agent Studio +- [Workday Connector](https://developer.moveworks.com/marketplace/package/?id=workday&hist=home%2Cbrws#how-to-implement) built in Creator Studio (follow the Workday Authentication guide to create your connector) + +## **What are we building?** + +### Agent Design + +This [purple chat](https://developer.moveworks.com/creator-studio/developer-tools/purple-chat?conversation=%7B%22startTimestamp%22%3A%2211%3A43+AM%22%2C%22messages%22%3A%5B%7B%22role%22%3A%22user%22%2C%22parts%22%3A%5B%7B%22richText%22%3A%22Can+I+see+my+bonus+history%3F%22%7D%5D%7D%2C%7B%22role%22%3A%22assistant%22%2C%22parts%22%3A%5B%7B%22richText%22%3A%22%E2%9C%85+Authenticate+the+user%5Cn%E2%9C%85+Retrieve+bonus+payment+records%5Cn%F0%9F%94%81+Presenting+your+bonus+history%22%7D%5D%7D%2C%7B%22role%22%3A%22assistant%22%2C%22parts%22%3A%5B%7B%22richText%22%3A%22Sure%2C+here%27s+a+summary+of+your+bonus+payments+over+the+years+%F0%9F%91%87%22%7D%2C%7B%22richText%22%3A%22%3Cb%3EBonus+History%3C%2Fb%3E%3Cbr%3EYour+bonus+payments+are+as+follows%3A%3Cbr%3E%3Cb%3E2023%3A%3C%2Fb%3E+%245%2C000%3Cbr%3E%3Cb%3E2022%3A%3C%2Fb%3E+%244%2C500%3Cbr%3E%3Cb%3E2021%3A%3C%2Fb%3E+%244%2C000%3Cbr%3EFor+detailed+information+and+bonus+criteria%2C+you+can+click+below.%22%7D%2C%7B%22buttons%22%3A%5B%7B%22style%22%3A%22filled%22%2C%22buttonText%22%3A%22View+Detailed+Bonus+History%22%7D%2C%7B%22style%22%3A%22outlined%22%2C%22buttonText%22%3A%22Learn+About+Bonus+Criteria%22%7D%5D%7D%5D%7D%5D%7D) shows the experience we are going to build. + +## **Installation Steps** + +We recommend creating the connector for **Workday** first, prior to installing this plugin. Please follow the [Workday Connector](https://developer.moveworks.com/marketplace/package/?id=workday&hist=home%2Cbrws#how-to-implement) guide to set up the connector. + +> Note: For the View Bonuses functionality, make sure your Workday integration system user has the necessary domain permissions. +> + +Specifically, ensure the following domain permissions are assigned with both **View** and **Get** access: + +- **Compensation** +- **Bonus** + +Once the connector is configured, refer to our [plugin installation documentation](https://help.moveworks.com/docs/ai-agent-marketplace-installation) for more details on how to install a plugin in Agent Studio. + +## **Appendix** + +### **API #1: Get Worker Details by Name** + +```bash +curl --location 'https:///ccx/api/v1//workers?search=' \ +--header 'Authorization: Bearer ' \ +--header 'Content-Type: application/json' +``` + +**Query Parameters:** + +- `search` (string) – Search for workers by name + +### **API #2: Retrieve Worker Bonus History** + +```bash +curl --location --request POST 'https:///ccx/api/wql/v1//data' \ +--header 'Authorization: Bearer ' \ +--header 'Content-Type: application/json' \ +--data '{ + "query": "SELECT one_TimePaymentEventReason as Reason, positionForOneTimePayment, scheduledPaymentDate, completedOn, actualBonus_Amount as Amount, plan, compensationElement, employee{employee, employeeID, supervisoryOrganization} as employee FROM bonusAndOne_TimePayments WHERE one_TimePaymentEventReason IN (\"3e2f3c97dcb941e7afd0806555954818\") AND employee = \"\" ORDER BY scheduledPaymentDate DESC LIMIT 10" +}' +``` + +**Query Parameters:** + +- `WORKER_ID` (string) – Filter bonuses for a specific worker ID \ No newline at end of file From 22830899ebe5f5bbb896a045d72a2628d900e8a8 Mon Sep 17 00:00:00 2001 From: Haritha v Date: Thu, 22 May 2025 16:11:37 +0530 Subject: [PATCH 2/6] Workday_view_bonuses_updated --- .../.codeblocks/block_1.sh | 2 +- plugins/workday-view-bonuses/README.md | 20 +++++++++---------- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/plugins/workday-view-bonuses/.codeblocks/block_1.sh b/plugins/workday-view-bonuses/.codeblocks/block_1.sh index 91b2dd91..acdbb613 100644 --- a/plugins/workday-view-bonuses/.codeblocks/block_1.sh +++ b/plugins/workday-view-bonuses/.codeblocks/block_1.sh @@ -2,5 +2,5 @@ curl --location --request POST 'https:///ccx/api/wql/v1/' \ --header 'Content-Type: application/json' \ --data '{ - "query": "SELECT one_TimePaymentEventReason as Reason, positionForOneTimePayment, scheduledPaymentDate, completedOn, actualBonus_Amount as Amount, plan, compensationElement, employee{employee, employeeID, supervisoryOrganization} as employee FROM bonusAndOne_TimePayments WHERE one_TimePaymentEventReason IN (\"3e2f3c97dcb941e7afd0806555954818\") AND employee = \"\" ORDER BY scheduledPaymentDate DESC LIMIT 10" + "query": "SELECT one_TimePaymentEventReason as Reason, positionForOneTimePayment, scheduledPaymentDate, completedOn, actualBonus_Amount as Amount, plan, compensationElement, employee{employee, employeeID, supervisoryOrganization} as employee FROM bonusAndOne_TimePayments WHERE employee = \"{{worker_id}}\" ORDER BY scheduledPaymentDate DESC LIMIT 10" }' diff --git a/plugins/workday-view-bonuses/README.md b/plugins/workday-view-bonuses/README.md index c58d8fae..ec12119d 100644 --- a/plugins/workday-view-bonuses/README.md +++ b/plugins/workday-view-bonuses/README.md @@ -12,6 +12,8 @@ systems: - workday --- +# Workday - View Bonuses + ## Introduction The **“View Bonuses”** plugin allows employees to access their bonus details for a specific period using **Workday**, all through the Moveworks AI Assistant. This ensures users have quick and easy visibility into their compensation without needing to navigate Workday manually. @@ -21,7 +23,6 @@ This guide will walk you through installing and configuring the plugin in **Agen ## **Prerequisites** - Access to Agent Studio -- [Workday Connector](https://developer.moveworks.com/marketplace/package/?id=workday&hist=home%2Cbrws#how-to-implement) built in Creator Studio (follow the Workday Authentication guide to create your connector) ## **What are we building?** @@ -29,19 +30,18 @@ This guide will walk you through installing and configuring the plugin in **Agen This [purple chat](https://developer.moveworks.com/creator-studio/developer-tools/purple-chat?conversation=%7B%22startTimestamp%22%3A%2211%3A43+AM%22%2C%22messages%22%3A%5B%7B%22role%22%3A%22user%22%2C%22parts%22%3A%5B%7B%22richText%22%3A%22Can+I+see+my+bonus+history%3F%22%7D%5D%7D%2C%7B%22role%22%3A%22assistant%22%2C%22parts%22%3A%5B%7B%22richText%22%3A%22%E2%9C%85+Authenticate+the+user%5Cn%E2%9C%85+Retrieve+bonus+payment+records%5Cn%F0%9F%94%81+Presenting+your+bonus+history%22%7D%5D%7D%2C%7B%22role%22%3A%22assistant%22%2C%22parts%22%3A%5B%7B%22richText%22%3A%22Sure%2C+here%27s+a+summary+of+your+bonus+payments+over+the+years+%F0%9F%91%87%22%7D%2C%7B%22richText%22%3A%22%3Cb%3EBonus+History%3C%2Fb%3E%3Cbr%3EYour+bonus+payments+are+as+follows%3A%3Cbr%3E%3Cb%3E2023%3A%3C%2Fb%3E+%245%2C000%3Cbr%3E%3Cb%3E2022%3A%3C%2Fb%3E+%244%2C500%3Cbr%3E%3Cb%3E2021%3A%3C%2Fb%3E+%244%2C000%3Cbr%3EFor+detailed+information+and+bonus+criteria%2C+you+can+click+below.%22%7D%2C%7B%22buttons%22%3A%5B%7B%22style%22%3A%22filled%22%2C%22buttonText%22%3A%22View+Detailed+Bonus+History%22%7D%2C%7B%22style%22%3A%22outlined%22%2C%22buttonText%22%3A%22Learn+About+Bonus+Criteria%22%7D%5D%7D%5D%7D%5D%7D) shows the experience we are going to build. -## **Installation Steps** +## Installation Steps -We recommend creating the connector for **Workday** first, prior to installing this plugin. Please follow the [Workday Connector](https://developer.moveworks.com/marketplace/package/?id=workday&hist=home%2Cbrws#how-to-implement) guide to set up the connector. +While you can create a connector during plugin installation, we recommend setting up the connector in **Agent Studio** beforehand to simplify the process. Please follow our [**Workday Connector Guide**](https://developer.moveworks.com/marketplace/package/?id=workday&hist=home%2Cbrws#how-to-implement) for detailed instructions. Once completed, proceed to install the plugin and complete the setup efficiently. -> Note: For the View Bonuses functionality, make sure your Workday integration system user has the necessary domain permissions. -> +For this plugin, ensure the Workday integration system user has the following permissions: -Specifically, ensure the following domain permissions are assigned with both **View** and **Get** access: +**Required Permissions:** -- **Compensation** -- **Bonus** +- `View access` to Employee Compensation data +- `View access` to Bonus Details -Once the connector is configured, refer to our [plugin installation documentation](https://help.moveworks.com/docs/ai-agent-marketplace-installation) for more details on how to install a plugin in Agent Studio. +After configuring the connector, refer to our [plugin installation documentation](https://help.moveworks.com/docs/ai-agent-marketplace-installation) for more details on completing the setup ## **Appendix** @@ -64,7 +64,7 @@ curl --location --request POST 'https:///ccx/api/wql/v1/' \ --header 'Content-Type: application/json' \ --data '{ - "query": "SELECT one_TimePaymentEventReason as Reason, positionForOneTimePayment, scheduledPaymentDate, completedOn, actualBonus_Amount as Amount, plan, compensationElement, employee{employee, employeeID, supervisoryOrganization} as employee FROM bonusAndOne_TimePayments WHERE one_TimePaymentEventReason IN (\"3e2f3c97dcb941e7afd0806555954818\") AND employee = \"\" ORDER BY scheduledPaymentDate DESC LIMIT 10" + "query": "SELECT one_TimePaymentEventReason as Reason, positionForOneTimePayment, scheduledPaymentDate, completedOn, actualBonus_Amount as Amount, plan, compensationElement, employee{employee, employeeID, supervisoryOrganization} as employee FROM bonusAndOne_TimePayments WHERE employee = \"{{worker_id}}\" ORDER BY scheduledPaymentDate DESC LIMIT 10" }' ``` From 0ef51d008f78801512a71929f99b896891cb6c4c Mon Sep 17 00:00:00 2001 From: Haritha v Date: Thu, 22 May 2025 16:21:44 +0530 Subject: [PATCH 3/6] Workday_View_Bonuses_Updated_one --- plugins/workday-view-bonuses/README.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/plugins/workday-view-bonuses/README.md b/plugins/workday-view-bonuses/README.md index ec12119d..7896be11 100644 --- a/plugins/workday-view-bonuses/README.md +++ b/plugins/workday-view-bonuses/README.md @@ -12,8 +12,6 @@ systems: - workday --- -# Workday - View Bonuses - ## Introduction The **“View Bonuses”** plugin allows employees to access their bonus details for a specific period using **Workday**, all through the Moveworks AI Assistant. This ensures users have quick and easy visibility into their compensation without needing to navigate Workday manually. @@ -38,7 +36,6 @@ For this plugin, ensure the Workday integration system user has the following pe **Required Permissions:** -- `View access` to Employee Compensation data - `View access` to Bonus Details After configuring the connector, refer to our [plugin installation documentation](https://help.moveworks.com/docs/ai-agent-marketplace-installation) for more details on completing the setup From d4b1fba14dc6d21a514697f1f9646e3eec72b922 Mon Sep 17 00:00:00 2001 From: Haritha v Date: Wed, 28 May 2025 14:51:05 +0530 Subject: [PATCH 4/6] Workday_View_Bonuses_updated --- plugins/workday-view-bonuses/.codeblocks/block_0.sh | 7 +++++-- plugins/workday-view-bonuses/README.md | 13 ++++++++----- 2 files changed, 13 insertions(+), 7 deletions(-) diff --git a/plugins/workday-view-bonuses/.codeblocks/block_0.sh b/plugins/workday-view-bonuses/.codeblocks/block_0.sh index 5c3aa73c..839c87fa 100644 --- a/plugins/workday-view-bonuses/.codeblocks/block_0.sh +++ b/plugins/workday-view-bonuses/.codeblocks/block_0.sh @@ -1,3 +1,6 @@ -curl --location 'https:///ccx/api/v1//workers?search=' \ +cucurl --location 'https:///ccx/api/wql/v1/moveworks_dpt1/data' \ --header 'Authorization: Bearer ' \ ---header 'Content-Type: application/json' +--header 'Content-Type: application/json' \ +--data '{ + "query": "SELECT workdayID, fullName, businessTitle, email_PrimaryWorkOrPrimaryHome as email, employeeID FROM allWorkers WHERE email_PrimaryWorkOrPrimaryHome = %27{{email}}%27" +}' diff --git a/plugins/workday-view-bonuses/README.md b/plugins/workday-view-bonuses/README.md index 7896be11..55c56b73 100644 --- a/plugins/workday-view-bonuses/README.md +++ b/plugins/workday-view-bonuses/README.md @@ -42,17 +42,20 @@ After configuring the connector, refer to our [plugin installation documentation ## **Appendix** -### **API #1: Get Worker Details by Name** +### **API#1: Get Worker Details by Email** ```bash -curl --location 'https:///ccx/api/v1//workers?search=' \ +cucurl --location 'https:///ccx/api/wql/v1/moveworks_dpt1/data' \ --header 'Authorization: Bearer ' \ ---header 'Content-Type: application/json' +--header 'Content-Type: application/json' \ +--data '{ + "query": "SELECT workdayID, fullName, businessTitle, email_PrimaryWorkOrPrimaryHome as email, employeeID FROM allWorkers WHERE email_PrimaryWorkOrPrimaryHome = %27{{email}}%27" +}' ``` -**Query Parameters:** +**Request Body Parameters:** -- `search` (string) – Search for workers by name +- `email` (string) – The primary home email address of the worker used to look up their Workday ID ### **API #2: Retrieve Worker Bonus History** From 9054f1837e23cdb90badcfdecd4a3547efe65305 Mon Sep 17 00:00:00 2001 From: Haritha v Date: Wed, 28 May 2025 15:09:20 +0530 Subject: [PATCH 5/6] workday_view_bonuses_updated1 --- plugins/workday-view-bonuses/.codeblocks/block_0.sh | 2 +- plugins/workday-view-bonuses/README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/plugins/workday-view-bonuses/.codeblocks/block_0.sh b/plugins/workday-view-bonuses/.codeblocks/block_0.sh index 839c87fa..e64a5774 100644 --- a/plugins/workday-view-bonuses/.codeblocks/block_0.sh +++ b/plugins/workday-view-bonuses/.codeblocks/block_0.sh @@ -1,4 +1,4 @@ -cucurl --location 'https:///ccx/api/wql/v1/moveworks_dpt1/data' \ +curl --location 'https:///ccx/api/wql/v1/moveworks_dpt1/data' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data '{ diff --git a/plugins/workday-view-bonuses/README.md b/plugins/workday-view-bonuses/README.md index 55c56b73..0a61d757 100644 --- a/plugins/workday-view-bonuses/README.md +++ b/plugins/workday-view-bonuses/README.md @@ -45,7 +45,7 @@ After configuring the connector, refer to our [plugin installation documentation ### **API#1: Get Worker Details by Email** ```bash -cucurl --location 'https:///ccx/api/wql/v1/moveworks_dpt1/data' \ +curl --location 'https:///ccx/api/wql/v1/moveworks_dpt1/data' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data '{ From 52ac5f21935a8a3772fbce8fcd086fd07d96c992 Mon Sep 17 00:00:00 2001 From: Haritha v Date: Thu, 29 May 2025 03:57:44 +0530 Subject: [PATCH 6/6] Workday_view_bonuses_updated --- plugins/workday-view-bonuses/.codeblocks/block_0.sh | 2 +- plugins/workday-view-bonuses/README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/plugins/workday-view-bonuses/.codeblocks/block_0.sh b/plugins/workday-view-bonuses/.codeblocks/block_0.sh index e64a5774..42a3090f 100644 --- a/plugins/workday-view-bonuses/.codeblocks/block_0.sh +++ b/plugins/workday-view-bonuses/.codeblocks/block_0.sh @@ -1,4 +1,4 @@ -curl --location 'https:///ccx/api/wql/v1/moveworks_dpt1/data' \ +curl --location 'https:///ccx/api/wql/v1//data' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data '{ diff --git a/plugins/workday-view-bonuses/README.md b/plugins/workday-view-bonuses/README.md index 0a61d757..f2795f38 100644 --- a/plugins/workday-view-bonuses/README.md +++ b/plugins/workday-view-bonuses/README.md @@ -45,7 +45,7 @@ After configuring the connector, refer to our [plugin installation documentation ### **API#1: Get Worker Details by Email** ```bash -curl --location 'https:///ccx/api/wql/v1/moveworks_dpt1/data' \ +curl --location 'https:///ccx/api/wql/v1//data' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data '{