From 54333da4404993351fd6fe1cfc72e718d0683883 Mon Sep 17 00:00:00 2001 From: hariv24 Date: Mon, 19 May 2025 19:41:27 +0530 Subject: [PATCH 1/4] Update Pronouns plugin --- .../.codeblocks/block_0.sh | 4 + .../.codeblocks/block_1.sh | 4 + .../.codeblocks/block_2.sh | 16 +++ .../README.md | 99 +++++++++++++++++-- 4 files changed, 116 insertions(+), 7 deletions(-) create mode 100644 plugins/sap-success-factors-view-payslips/.codeblocks/block_0.sh create mode 100644 plugins/sap-success-factors-view-payslips/.codeblocks/block_1.sh create mode 100644 plugins/sap-success-factors-view-payslips/.codeblocks/block_2.sh diff --git a/plugins/sap-success-factors-view-payslips/.codeblocks/block_0.sh b/plugins/sap-success-factors-view-payslips/.codeblocks/block_0.sh new file mode 100644 index 00000000..dcbf277e --- /dev/null +++ b/plugins/sap-success-factors-view-payslips/.codeblocks/block_0.sh @@ -0,0 +1,4 @@ +curl --location --globoff 'https:///odata/v2/User?%24filter=email%20eq%20%27{{email}}%27&%24select=userId%2CfirstName%2ClastName%2CdisplayName%2Cnickname%2Cemail%2Clocation%2Cdepartment%2Cstatus%2Cgender%2CtimeZone%2CemployeeClass%2ChireDate%2CimpactOfLoss%2CriskOfLoss%2CjobCode%2CbusinessPhone%2Csalary%2CcompensationSalaryRateType%2CempId' \ +--header 'Accept: application/json' \ +--header 'Authorization: \ +--data '' diff --git a/plugins/sap-success-factors-view-payslips/.codeblocks/block_1.sh b/plugins/sap-success-factors-view-payslips/.codeblocks/block_1.sh new file mode 100644 index 00000000..e5121fd0 --- /dev/null +++ b/plugins/sap-success-factors-view-payslips/.codeblocks/block_1.sh @@ -0,0 +1,4 @@ +curl --location 'https:///odata/v2/PicklistOption?%24filter=picklist%20eq%20%27PersonPronouns%27&%24select=id%2CexternalCode' \ +--header 'Authorization: Bearer \ +--header 'Accept: application/json' \ + diff --git a/plugins/sap-success-factors-view-payslips/.codeblocks/block_2.sh b/plugins/sap-success-factors-view-payslips/.codeblocks/block_2.sh new file mode 100644 index 00000000..8565ba88 --- /dev/null +++ b/plugins/sap-success-factors-view-payslips/.codeblocks/block_2.sh @@ -0,0 +1,16 @@ +curl --location 'https:///odata/v2/upsert?%24format=json' \ +--header 'Authorization: Bearer ' \ +--header 'Accept: application/json' \ +--header 'Content-Type: application/json' \ +--data '[ +{ + "__metadata": { + "uri": "/odata/v2/User('\''userId'\'')", + "type": "SFOData.User" + }, + "userId": "{{userId}}", + "pronouns": "{{pronouns}}" + } +] + +' diff --git a/plugins/sap-success-factors-view-payslips/README.md b/plugins/sap-success-factors-view-payslips/README.md index f87f3cdd..4343abfd 100644 --- a/plugins/sap-success-factors-view-payslips/README.md +++ b/plugins/sap-success-factors-view-payslips/README.md @@ -1,14 +1,99 @@ --- -description: A plugin that allows employees to securely access and retrieve their - payslips. -fidelity: IDEA -name: View Payslips -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%22name%22%3A%22%22%2C%22imageUrl%22%3A%22%22%7D%2C%22mocks%22%3A%5B%7B%22id%22%3A7773%2C%22title%22%3A%22New+Mock%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%22GWEN%22%2C%22editable%22%3Atrue%2C%22botName%22%3A%22%22%2C%22botImageUrl%22%3A%22%22%7D%2C%22messages%22%3A%5B%7B%22from%22%3A%22USER%22%2C%22text%22%3A%22Can+you+show+me+my+paychecks+for+the+past+few+months%3F%22%7D%2C%7B%22from%22%3A%22BOT%22%2C%22text%22%3A%22%3Cp%3EHere%27s+a+summary+of+your+recent+paychecks.+%3Cbr%3E%3C%2Fp%3E%22%2C%22cards%22%3A%5B%7B%22title%22%3A%22Paycheck%3A+March+15%2C+2023%22%2C%22text%22%3A%22%3Cb%3EDate+Deposited%3A%3C%2Fb%3E+March+15%2C+2023%3Cbr%3E%3Cb%3EAmount%3A%3C%2Fb%3E+%241537.42%22%7D%2C%7B%22title%22%3A%22Paycheck%3A+March+1%2C+2023%22%2C%22text%22%3A%22%3Cb%3EDate+Deposited%3A%3C%2Fb%3E+March+1%2C+2023%3Cbr%3E%3Cb%3EAmount%3A%3C%2Fb%3E+%241542.75%22%7D%2C%7B%22title%22%3A%22Paycheck%3A+February+15%2C+2023%22%2C%22text%22%3A%22%3Cb%3EDate+Deposited%3A%3C%2Fb%3E+February+15%2C+2023%3Cbr%3E%3Cb%3EAmount%3A%3C%2Fb%3E+%241528.60%22%7D%2C%7B%22title%22%3A%22Paycheck%3A+February+1%2C+2023%22%2C%22text%22%3A%22%3Cb%3EDate+Deposited%3A%3C%2Fb%3E+February+1%2C+2023%3Cbr%3E%3Cb%3EAmount%3A%3C%2Fb%3E+%241530.99%22%7D%2C%7B%22title%22%3A%22Paycheck%3A+January+15%2C+2023%22%2C%22text%22%3A%22%3Cb%3EDate+Deposited%3A%3C%2Fb%3E+January+15%2C+2023%3Cbr%3E%3Cb%3EAmount%3A%3C%2Fb%3E+%241501.33%22%7D%2C%7B%22title%22%3A%22Paycheck%3A+January+1%2C+2023%22%2C%22text%22%3A%22%3Cb%3EDate+Deposited%3A%3C%2Fb%3E+January+1%2C+2023%3Cbr%3E%3Cb%3EAmount%3A%3C%2Fb%3E+%241503.22%22%7D%5D%7D%5D%7D%7D%5D%7D +description: A plugin that enables a user to update their pronouns. +fidelity: GUIDE +name: Update Pronouns +difficulty_level: BEGINNER +time_in_minutes: 15 +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%22name%22%3A%22%22%2C%22imageUrl%22%3A%22%22%7D%2C%22mocks%22%3A%5B%7B%22id%22%3A4081%2C%22title%22%3A%22New+Mock%22%2C%22transcript%22%3A%7B%22messages%22%3A%5B%7B%22from%22%3A%22USER%22%2C%22text%22%3A%22%3Cp%3EI+need+to+update+my+pronouns.%3C%2Fp%3E%22%7D%2C%7B%22from%22%3A%22BOT%22%2C%22text%22%3A%22%3Cp%3ESure%2C+I+can+help+with+that.+Please+share+your+pronouns%3F%3C%2Fp%3E%22%7D%2C%7B%22from%22%3A%22USER%22%2C%22text%22%3A%22%3Cp%3EThey%2FThem%2FTheirs%3Cbr%3E%3C%2Fp%3E%22%7D%2C%7B%22from%22%3A%22BOT%22%2C%22text%22%3A%22%3Cp%3EOkay%2C+I+will+update+your+pronouns+to+They%2FThem%2FTheirs.%3C%2Fp%3E%22%2C%22cards%22%3A%5B%7B%22title%22%3A%22%3Cp%3EPlease+confirm+your+new+pronouns%3Cbr%3E%3C%2Fp%3E%22%2C%22text%22%3A%22%3Cp%3E%3Cb%3EPronouns%3A+%3C%2Fb%3EThey%2FThem%2FTheirs%3Cbr%3E%3C%2Fp%3E%22%2C%22buttons%22%3A%5B%7B%22style%22%3A%22PRIMARY%22%2C%22text%22%3A%22Update+Pronouns+in+Success+Factors%22%7D%2C%7B%22text%22%3A%22Edit+Pronouns%22%7D%2C%7B%22text%22%3A%22Cancel%22%7D%5D%7D%5D%7D%5D%2C%22settings%22%3A%7B%22colorStyle%22%3A%22LIGHT%22%2C%22startTime%22%3A%2211%3A43%2BAM%22%2C%22defaultPerson%22%3A%22GWEN%22%2C%22editable%22%3Atrue%2C%22botName%22%3A%22%22%2C%22botImageUrl%22%3A%22%22%7D%7D%7D%5D%7D solution_tags: -- Finance -- Finance - Payroll - HR +- HR - Employee Records systems: - sap-success-factors --- + +# **Introduction:** + +The **Update Pronouns** plugin allows users to easily update their pronouns in the system directly through the Moveworks AI Assistant. This ensures that their preferred pronouns are accurately reflected across all platforms. + +This guide will help you install and configure the plugin in Agent Studio quickly. Let’s get started! + +# **Prerequisites :** + +- Access to Agent Studio +- [SAP Successfactors Connector](https://developer.moveworks.com/creator-studio/resources/connector/?id=sap-success-factors&commit_id=21f2fb0f5f2b0852c62a72235121cd8d78d6b46b;) built in Creator Studio (follow the SAP Successfactors 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-builder/?workspace=%7B%22title%22%3A%22My+Workspace%22%2C%22botSettings%22%3A%7B%22name%22%3A%22%22%2C%22imageUrl%22%3A%22%22%7D%2C%22mocks%22%3A%5B%7B%22id%22%3A4081%2C%22title%22%3A%22New+Mock%22%2C%22transcript%22%3A%7B%22messages%22%3A%5B%7B%22from%22%3A%22USER%22%2C%22text%22%3A%22%3Cp%3EI+need+to+update+my+pronouns.%3C%2Fp%3E%22%7D%2C%7B%22from%22%3A%22BOT%22%2C%22text%22%3A%22%3Cp%3ESure%2C+I+can+help+with+that.+Please+share+your+pronouns%3F%3C%2Fp%3E%22%7D%2C%7B%22from%22%3A%22USER%22%2C%22text%22%3A%22%3Cp%3EThey%2FThem%2FTheirs%3Cbr%3E%3C%2Fp%3E%22%7D%2C%7B%22from%22%3A%22BOT%22%2C%22text%22%3A%22%3Cp%3EOkay%2C+I+will+update+your+pronouns+to+They%2FThem%2FTheirs.%3C%2Fp%3E%22%2C%22cards%22%3A%5B%7B%22title%22%3A%22%3Cp%3EPlease+confirm+your+new+pronouns%3Cbr%3E%3C%2Fp%3E%22%2C%22text%22%3A%22%3Cp%3E%3Cb%3EPronouns%3A+%3C%2Fb%3EThey%2FThem%2FTheirs%3Cbr%3E%3C%2Fp%3E%22%2C%22buttons%22%3A%5B%7B%22style%22%3A%22PRIMARY%22%2C%22text%22%3A%22Update+Pronouns+in+Success+Factors%22%7D%2C%7B%22text%22%3A%22Edit+Pronouns%22%7D%2C%7B%22text%22%3A%22Cancel%22%7D%5D%7D%5D%7D%5D%2C%22settings%22%3A%7B%22colorStyle%22%3A%22LIGHT%22%2C%22startTime%22%3A%2211%3A43%2BAM%22%2C%22defaultPerson%22%3A%22GWEN%22%2C%22editable%22%3Atrue%2C%22botName%22%3A%22%22%2C%22botImageUrl%22%3A%22%22%7D%7D%7D%5D%7D) shows the experience we are going to build. + +# **Installation Steps** + +While you can create a connector during plugin installation, we recommend creating a connector in **Agent Studio** beforehand to streamline the process. Please follow our [**SAP successfactors Connector Guide**](https://developer.moveworks.com/creator-studio/resources/connector/?id=sap-success-factors&commit_id=21f2fb0f5f2b0852c62a72235121cd8d78d6b46b;) to do so. Once completed, follow our plugin installation documentation to install the **Update Pronouns** plugin in minutes. + +After configuring the connector, refer to our installation documentation for more details on completing the setup. + +# **Appendix** + +### **API #1: Fetch User Information** + +The **Fetch User Information** API retrieves a userId using user email. + +```bash +curl --location --globoff 'https:///odata/v2/User?%24filter=email%20eq%20%27{{email}}%27&%24select=userId%2CfirstName%2ClastName%2CdisplayName%2Cnickname%2Cemail%2Clocation%2Cdepartment%2Cstatus%2Cgender%2CtimeZone%2CemployeeClass%2ChireDate%2CimpactOfLoss%2CriskOfLoss%2CjobCode%2CbusinessPhone%2Csalary%2CcompensationSalaryRateType%2CempId' \ +--header 'Accept: application/json' \ +--header 'Authorization: \ +--data '' +``` + +**Query Parameters :** + +- $filter (string) – Filter items by property values +- $select (array[string]) – Select properties to be returned + +### **API #2: GET Picklist** + +The **GET Picklist** API retrieves a optionId of the Pronouns. + +```bash +curl --location 'https:///odata/v2/PicklistOption?%24filter=picklist%20eq%20%27PersonPronouns%27&%24select=id%2CexternalCode' \ +--header 'Authorization: Bearer \ +--header 'Accept: application/json' \ + +``` + +**Query Parameters :** + +- $filter (string) – Filter items by property values +- $select (array[string]) – Select properties to be returned + +### **API #3: Upserting an Existing User with Pronoun** + +The **Upserting an Existing User with Pronoun** API updates the pronouns of the user whose userId is specified in the URI. + +```bash +curl --location 'https:///odata/v2/upsert?%24format=json' \ +--header 'Authorization: Bearer ' \ +--header 'Accept: application/json' \ +--header 'Content-Type: application/json' \ +--data '[ +{ + "__metadata": { + "uri": "/odata/v2/User('\''userId'\'')", + "type": "SFOData.User" + }, + "userId": "{{userId}}", + "pronouns": "{{pronouns}}" + } +] + +' +``` + +**Slots**: + +1. UserId. +2. Pronoun ID. \ No newline at end of file From e0082d8e9078e69949c7f4c37694f48bfc68820e Mon Sep 17 00:00:00 2001 From: hariv24 Date: Thu, 22 May 2025 18:40:48 +0530 Subject: [PATCH 2/4] Made the requested changes --- .../.codeblocks/block_0.sh | 4 + .../.codeblocks/block_1.sh | 4 + .../.codeblocks/block_2.sh | 16 ++++ .../README.md | 94 ++++++++++++++++++- 4 files changed, 117 insertions(+), 1 deletion(-) create mode 100644 plugins/sap-success-factors-update-pronouns/.codeblocks/block_0.sh create mode 100644 plugins/sap-success-factors-update-pronouns/.codeblocks/block_1.sh create mode 100644 plugins/sap-success-factors-update-pronouns/.codeblocks/block_2.sh diff --git a/plugins/sap-success-factors-update-pronouns/.codeblocks/block_0.sh b/plugins/sap-success-factors-update-pronouns/.codeblocks/block_0.sh new file mode 100644 index 00000000..30369d37 --- /dev/null +++ b/plugins/sap-success-factors-update-pronouns/.codeblocks/block_0.sh @@ -0,0 +1,4 @@ +curl --location --globoff 'https:///odata/v2/User?%24filter=email%20eq%20%27{{email}}%27&%24select=userId%2CfirstName%2ClastName%2CdisplayName%2Cnickname%2Cemail%2Clocation%2Cdepartment%2Cstatus%2Cgender%2CtimeZone%2CemployeeClass%2ChireDate%2CimpactOfLoss%2CriskOfLoss%2CjobCode%2CbusinessPhone%2Csalary%2CcompensationSalaryRateType%2CempId' \ +--header 'Accept: application/json' \ +--header 'Authorization: Bearer '\ +--data '' diff --git a/plugins/sap-success-factors-update-pronouns/.codeblocks/block_1.sh b/plugins/sap-success-factors-update-pronouns/.codeblocks/block_1.sh new file mode 100644 index 00000000..e5121fd0 --- /dev/null +++ b/plugins/sap-success-factors-update-pronouns/.codeblocks/block_1.sh @@ -0,0 +1,4 @@ +curl --location 'https:///odata/v2/PicklistOption?%24filter=picklist%20eq%20%27PersonPronouns%27&%24select=id%2CexternalCode' \ +--header 'Authorization: Bearer \ +--header 'Accept: application/json' \ + diff --git a/plugins/sap-success-factors-update-pronouns/.codeblocks/block_2.sh b/plugins/sap-success-factors-update-pronouns/.codeblocks/block_2.sh new file mode 100644 index 00000000..8565ba88 --- /dev/null +++ b/plugins/sap-success-factors-update-pronouns/.codeblocks/block_2.sh @@ -0,0 +1,16 @@ +curl --location 'https:///odata/v2/upsert?%24format=json' \ +--header 'Authorization: Bearer ' \ +--header 'Accept: application/json' \ +--header 'Content-Type: application/json' \ +--data '[ +{ + "__metadata": { + "uri": "/odata/v2/User('\''userId'\'')", + "type": "SFOData.User" + }, + "userId": "{{userId}}", + "pronouns": "{{pronouns}}" + } +] + +' diff --git a/plugins/sap-success-factors-update-pronouns/README.md b/plugins/sap-success-factors-update-pronouns/README.md index c02741c4..8dad3030 100644 --- a/plugins/sap-success-factors-update-pronouns/README.md +++ b/plugins/sap-success-factors-update-pronouns/README.md @@ -1,7 +1,9 @@ --- description: A plugin that enables a user to update their pronouns. -fidelity: IDEA +fidelity: GUIDE name: Update Pronouns +difficulty_level: BEGINNER +time_in_minutes: 15 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%22name%22%3A%22%22%2C%22imageUrl%22%3A%22%22%7D%2C%22mocks%22%3A%5B%7B%22id%22%3A4081%2C%22title%22%3A%22New+Mock%22%2C%22transcript%22%3A%7B%22messages%22%3A%5B%7B%22from%22%3A%22USER%22%2C%22text%22%3A%22%3Cp%3EI+need+to+update+my+pronouns.%3C%2Fp%3E%22%7D%2C%7B%22from%22%3A%22BOT%22%2C%22text%22%3A%22%3Cp%3ESure%2C+I+can+help+with+that.+Please+share+your+pronouns%3F%3C%2Fp%3E%22%7D%2C%7B%22from%22%3A%22USER%22%2C%22text%22%3A%22%3Cp%3EThey%2FThem%2FTheirs%3Cbr%3E%3C%2Fp%3E%22%7D%2C%7B%22from%22%3A%22BOT%22%2C%22text%22%3A%22%3Cp%3EOkay%2C+I+will+update+your+pronouns+to+They%2FThem%2FTheirs.%3C%2Fp%3E%22%2C%22cards%22%3A%5B%7B%22title%22%3A%22%3Cp%3EPlease+confirm+your+new+pronouns%3Cbr%3E%3C%2Fp%3E%22%2C%22text%22%3A%22%3Cp%3E%3Cb%3EPronouns%3A+%3C%2Fb%3EThey%2FThem%2FTheirs%3Cbr%3E%3C%2Fp%3E%22%2C%22buttons%22%3A%5B%7B%22style%22%3A%22PRIMARY%22%2C%22text%22%3A%22Update+Pronouns+in+Success+Factors%22%7D%2C%7B%22text%22%3A%22Edit+Pronouns%22%7D%2C%7B%22text%22%3A%22Cancel%22%7D%5D%7D%5D%7D%5D%2C%22settings%22%3A%7B%22colorStyle%22%3A%22LIGHT%22%2C%22startTime%22%3A%2211%3A43%2BAM%22%2C%22defaultPerson%22%3A%22GWEN%22%2C%22editable%22%3Atrue%2C%22botName%22%3A%22%22%2C%22botImageUrl%22%3A%22%22%7D%7D%7D%5D%7D solution_tags: - HR @@ -10,3 +12,93 @@ systems: - sap-success-factors --- +# Update Pronouns + +# **Introduction:** + +The **Update Pronouns** plugin allows users to easily update their pronouns in the system directly through the Moveworks AI Assistant. This ensures that their preferred pronouns are accurately reflected across all platforms. + +This guide will help you install and configure the plugin in Agent Studio quickly. Let’s get started! + +# **Prerequisites :** + +- Access to Agent Studio. + +# **What are we building?** + +### **Agent Design** + +This [purple chat](https://developer.moveworks.com/creator-studio/developer-tools/purple-chat-builder/?workspace=%7B%22title%22%3A%22My+Workspace%22%2C%22botSettings%22%3A%7B%22name%22%3A%22%22%2C%22imageUrl%22%3A%22%22%7D%2C%22mocks%22%3A%5B%7B%22id%22%3A4081%2C%22title%22%3A%22New+Mock%22%2C%22transcript%22%3A%7B%22messages%22%3A%5B%7B%22from%22%3A%22USER%22%2C%22text%22%3A%22%3Cp%3EI+need+to+update+my+pronouns.%3C%2Fp%3E%22%7D%2C%7B%22from%22%3A%22BOT%22%2C%22text%22%3A%22%3Cp%3ESure%2C+I+can+help+with+that.+Please+share+your+pronouns%3F%3C%2Fp%3E%22%7D%2C%7B%22from%22%3A%22USER%22%2C%22text%22%3A%22%3Cp%3EThey%2FThem%2FTheirs%3Cbr%3E%3C%2Fp%3E%22%7D%2C%7B%22from%22%3A%22BOT%22%2C%22text%22%3A%22%3Cp%3EOkay%2C+I+will+update+your+pronouns+to+They%2FThem%2FTheirs.%3C%2Fp%3E%22%2C%22cards%22%3A%5B%7B%22title%22%3A%22%3Cp%3EPlease+confirm+your+new+pronouns%3Cbr%3E%3C%2Fp%3E%22%2C%22text%22%3A%22%3Cp%3E%3Cb%3EPronouns%3A+%3C%2Fb%3EThey%2FThem%2FTheirs%3Cbr%3E%3C%2Fp%3E%22%2C%22buttons%22%3A%5B%7B%22style%22%3A%22PRIMARY%22%2C%22text%22%3A%22Update+Pronouns+in+Success+Factors%22%7D%2C%7B%22text%22%3A%22Edit+Pronouns%22%7D%2C%7B%22text%22%3A%22Cancel%22%7D%5D%7D%5D%7D%5D%2C%22settings%22%3A%7B%22colorStyle%22%3A%22LIGHT%22%2C%22startTime%22%3A%2211%3A43%2BAM%22%2C%22defaultPerson%22%3A%22GWEN%22%2C%22editable%22%3Atrue%2C%22botName%22%3A%22%22%2C%22botImageUrl%22%3A%22%22%7D%7D%7D%5D%7D) shows the experience we are going to build. + +# **Installation Steps** + +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 [SAP Successfactors Connector Guide](https://developer.moveworks.com/marketplace/package?id=sap-success-factors&hist=home%2Cbrws) for detailed instructions. Once completed, proceed to install the plugin and complete the setup efficiently. + +For this plugin, ensure the SAP Sucessfactors integration system user has the following permissions: + +**Required Permissions:** + +Ensure the **Pronouns feature is enabled** in SuccessFactors: + +- Go to **Admin Center > Picklist Center**. +- Create or update a picklist for pronouns (PersonPronouns picklist). +- Add appropriate pronoun values (e.g., she/her, he/him, they/them) + +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** + +### **API #1: Fetch User Information** + +The **Fetch User Information** API retrieves a userId using user email. + +```bash +curl --location --globoff 'https:///odata/v2/User?%24filter=email%20eq%20%27{{email}}%27&%24select=userId%2CfirstName%2ClastName%2CdisplayName%2Cnickname%2Cemail%2Clocation%2Cdepartment%2Cstatus%2Cgender%2CtimeZone%2CemployeeClass%2ChireDate%2CimpactOfLoss%2CriskOfLoss%2CjobCode%2CbusinessPhone%2Csalary%2CcompensationSalaryRateType%2CempId' \ +--header 'Accept: application/json' \ +--header 'Authorization: Bearer '\ +--data '' +``` + +**Query Parameters :** + +- $filter (string) – Filter items by property values +- $select (array[string]) – Select properties to be returned + +### **API #2: GET Picklist** + +The **GET Picklist** API retrieves a optionId of the Pronouns. + +```bash +curl --location 'https:///odata/v2/PicklistOption?%24filter=picklist%20eq%20%27PersonPronouns%27&%24select=id%2CexternalCode' \ +--header 'Authorization: Bearer \ +--header 'Accept: application/json' \ + +``` + +**Query Parameters :** + +- $filter (string) – Filter items by property values +- $select (array[string]) – Select properties to be returned + +### **API #3: Upserting an Existing User with Pronoun** + +The **Upserting an Existing User with Pronoun** API updates the pronouns of the user whose userId is specified in the URI. + +```bash +curl --location 'https:///odata/v2/upsert?%24format=json' \ +--header 'Authorization: Bearer ' \ +--header 'Accept: application/json' \ +--header 'Content-Type: application/json' \ +--data '[ +{ + "__metadata": { + "uri": "/odata/v2/User('\''userId'\'')", + "type": "SFOData.User" + }, + "userId": "{{userId}}", + "pronouns": "{{pronouns}}" + } +] + +' +``` \ No newline at end of file From f6199e32983f1d1685596bfe80a06d991a049662 Mon Sep 17 00:00:00 2001 From: Hariv Kannan <110089212+hariv24@users.noreply.github.com> Date: Fri, 23 May 2025 08:26:12 +0000 Subject: [PATCH 3/4] Fix typos in README for SAP SuccessFactors plugin installation instructions --- plugins/sap-success-factors-update-pronouns/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/plugins/sap-success-factors-update-pronouns/README.md b/plugins/sap-success-factors-update-pronouns/README.md index 8dad3030..ae5465cf 100644 --- a/plugins/sap-success-factors-update-pronouns/README.md +++ b/plugins/sap-success-factors-update-pronouns/README.md @@ -32,9 +32,9 @@ This [purple chat](https://developer.moveworks.com/creator-studio/developer-too # **Installation Steps** -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 [SAP Successfactors Connector Guide](https://developer.moveworks.com/marketplace/package?id=sap-success-factors&hist=home%2Cbrws) for detailed instructions. Once completed, proceed to install the plugin and complete the setup efficiently. +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 [ SAP SuccessFactors Connector Guide](https://developer.moveworks.com/marketplace/package?id=sap-success-factors&hist=home%2Cbrws) for detailed instructions. Once completed, proceed to install the plugin and complete the setup efficiently. -For this plugin, ensure the SAP Sucessfactors integration system user has the following permissions: +For this plugin, ensure the SAP SuccessFactors integration system user has the following permissions: **Required Permissions:** From 7191028ee1baea2406d2cb6244e69a0ab4afbfc3 Mon Sep 17 00:00:00 2001 From: hariv24 Date: Mon, 2 Jun 2025 16:45:24 +0530 Subject: [PATCH 4/4] made the requested changes --- .../.codeblocks/block_0.sh | 4 - .../.codeblocks/block_1.sh | 4 - .../.codeblocks/block_2.sh | 16 --- .../README.md | 101 ++---------------- 4 files changed, 8 insertions(+), 117 deletions(-) delete mode 100644 plugins/sap-success-factors-view-payslips/.codeblocks/block_0.sh delete mode 100644 plugins/sap-success-factors-view-payslips/.codeblocks/block_1.sh delete mode 100644 plugins/sap-success-factors-view-payslips/.codeblocks/block_2.sh diff --git a/plugins/sap-success-factors-view-payslips/.codeblocks/block_0.sh b/plugins/sap-success-factors-view-payslips/.codeblocks/block_0.sh deleted file mode 100644 index dcbf277e..00000000 --- a/plugins/sap-success-factors-view-payslips/.codeblocks/block_0.sh +++ /dev/null @@ -1,4 +0,0 @@ -curl --location --globoff 'https:///odata/v2/User?%24filter=email%20eq%20%27{{email}}%27&%24select=userId%2CfirstName%2ClastName%2CdisplayName%2Cnickname%2Cemail%2Clocation%2Cdepartment%2Cstatus%2Cgender%2CtimeZone%2CemployeeClass%2ChireDate%2CimpactOfLoss%2CriskOfLoss%2CjobCode%2CbusinessPhone%2Csalary%2CcompensationSalaryRateType%2CempId' \ ---header 'Accept: application/json' \ ---header 'Authorization: \ ---data '' diff --git a/plugins/sap-success-factors-view-payslips/.codeblocks/block_1.sh b/plugins/sap-success-factors-view-payslips/.codeblocks/block_1.sh deleted file mode 100644 index e5121fd0..00000000 --- a/plugins/sap-success-factors-view-payslips/.codeblocks/block_1.sh +++ /dev/null @@ -1,4 +0,0 @@ -curl --location 'https:///odata/v2/PicklistOption?%24filter=picklist%20eq%20%27PersonPronouns%27&%24select=id%2CexternalCode' \ ---header 'Authorization: Bearer \ ---header 'Accept: application/json' \ - diff --git a/plugins/sap-success-factors-view-payslips/.codeblocks/block_2.sh b/plugins/sap-success-factors-view-payslips/.codeblocks/block_2.sh deleted file mode 100644 index 8565ba88..00000000 --- a/plugins/sap-success-factors-view-payslips/.codeblocks/block_2.sh +++ /dev/null @@ -1,16 +0,0 @@ -curl --location 'https:///odata/v2/upsert?%24format=json' \ ---header 'Authorization: Bearer ' \ ---header 'Accept: application/json' \ ---header 'Content-Type: application/json' \ ---data '[ -{ - "__metadata": { - "uri": "/odata/v2/User('\''userId'\'')", - "type": "SFOData.User" - }, - "userId": "{{userId}}", - "pronouns": "{{pronouns}}" - } -] - -' diff --git a/plugins/sap-success-factors-view-payslips/README.md b/plugins/sap-success-factors-view-payslips/README.md index 4343abfd..01043e6e 100644 --- a/plugins/sap-success-factors-view-payslips/README.md +++ b/plugins/sap-success-factors-view-payslips/README.md @@ -1,99 +1,14 @@ --- -description: A plugin that enables a user to update their pronouns. -fidelity: GUIDE -name: Update Pronouns -difficulty_level: BEGINNER -time_in_minutes: 15 -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%22name%22%3A%22%22%2C%22imageUrl%22%3A%22%22%7D%2C%22mocks%22%3A%5B%7B%22id%22%3A4081%2C%22title%22%3A%22New+Mock%22%2C%22transcript%22%3A%7B%22messages%22%3A%5B%7B%22from%22%3A%22USER%22%2C%22text%22%3A%22%3Cp%3EI+need+to+update+my+pronouns.%3C%2Fp%3E%22%7D%2C%7B%22from%22%3A%22BOT%22%2C%22text%22%3A%22%3Cp%3ESure%2C+I+can+help+with+that.+Please+share+your+pronouns%3F%3C%2Fp%3E%22%7D%2C%7B%22from%22%3A%22USER%22%2C%22text%22%3A%22%3Cp%3EThey%2FThem%2FTheirs%3Cbr%3E%3C%2Fp%3E%22%7D%2C%7B%22from%22%3A%22BOT%22%2C%22text%22%3A%22%3Cp%3EOkay%2C+I+will+update+your+pronouns+to+They%2FThem%2FTheirs.%3C%2Fp%3E%22%2C%22cards%22%3A%5B%7B%22title%22%3A%22%3Cp%3EPlease+confirm+your+new+pronouns%3Cbr%3E%3C%2Fp%3E%22%2C%22text%22%3A%22%3Cp%3E%3Cb%3EPronouns%3A+%3C%2Fb%3EThey%2FThem%2FTheirs%3Cbr%3E%3C%2Fp%3E%22%2C%22buttons%22%3A%5B%7B%22style%22%3A%22PRIMARY%22%2C%22text%22%3A%22Update+Pronouns+in+Success+Factors%22%7D%2C%7B%22text%22%3A%22Edit+Pronouns%22%7D%2C%7B%22text%22%3A%22Cancel%22%7D%5D%7D%5D%7D%5D%2C%22settings%22%3A%7B%22colorStyle%22%3A%22LIGHT%22%2C%22startTime%22%3A%2211%3A43%2BAM%22%2C%22defaultPerson%22%3A%22GWEN%22%2C%22editable%22%3Atrue%2C%22botName%22%3A%22%22%2C%22botImageUrl%22%3A%22%22%7D%7D%7D%5D%7D +description: A plugin that allows employees to securely access and retrieve their + payslips. +fidelity: IDEA +name: View Payslips +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%22name%22%3A%22%22%2C%22imageUrl%22%3A%22%22%7D%2C%22mocks%22%3A%5B%7B%22id%22%3A7773%2C%22title%22%3A%22New+Mock%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%22GWEN%22%2C%22editable%22%3Atrue%2C%22botName%22%3A%22%22%2C%22botImageUrl%22%3A%22%22%7D%2C%22messages%22%3A%5B%7B%22from%22%3A%22USER%22%2C%22text%22%3A%22Can+you+show+me+my+paychecks+for+the+past+few+months%3F%22%7D%2C%7B%22from%22%3A%22BOT%22%2C%22text%22%3A%22%3Cp%3EHere%27s+a+summary+of+your+recent+paychecks.+%3Cbr%3E%3C%2Fp%3E%22%2C%22cards%22%3A%5B%7B%22title%22%3A%22Paycheck%3A+March+15%2C+2023%22%2C%22text%22%3A%22%3Cb%3EDate+Deposited%3A%3C%2Fb%3E+March+15%2C+2023%3Cbr%3E%3Cb%3EAmount%3A%3C%2Fb%3E+%241537.42%22%7D%2C%7B%22title%22%3A%22Paycheck%3A+March+1%2C+2023%22%2C%22text%22%3A%22%3Cb%3EDate+Deposited%3A%3C%2Fb%3E+March+1%2C+2023%3Cbr%3E%3Cb%3EAmount%3A%3C%2Fb%3E+%241542.75%22%7D%2C%7B%22title%22%3A%22Paycheck%3A+February+15%2C+2023%22%2C%22text%22%3A%22%3Cb%3EDate+Deposited%3A%3C%2Fb%3E+February+15%2C+2023%3Cbr%3E%3Cb%3EAmount%3A%3C%2Fb%3E+%241528.60%22%7D%2C%7B%22title%22%3A%22Paycheck%3A+February+1%2C+2023%22%2C%22text%22%3A%22%3Cb%3EDate+Deposited%3A%3C%2Fb%3E+February+1%2C+2023%3Cbr%3E%3Cb%3EAmount%3A%3C%2Fb%3E+%241530.99%22%7D%2C%7B%22title%22%3A%22Paycheck%3A+January+15%2C+2023%22%2C%22text%22%3A%22%3Cb%3EDate+Deposited%3A%3C%2Fb%3E+January+15%2C+2023%3Cbr%3E%3Cb%3EAmount%3A%3C%2Fb%3E+%241501.33%22%7D%2C%7B%22title%22%3A%22Paycheck%3A+January+1%2C+2023%22%2C%22text%22%3A%22%3Cb%3EDate+Deposited%3A%3C%2Fb%3E+January+1%2C+2023%3Cbr%3E%3Cb%3EAmount%3A%3C%2Fb%3E+%241503.22%22%7D%5D%7D%5D%7D%7D%5D%7D solution_tags: +- Finance +- Finance - Payroll - HR -- HR - Employee Records systems: - sap-success-factors ---- - -# **Introduction:** - -The **Update Pronouns** plugin allows users to easily update their pronouns in the system directly through the Moveworks AI Assistant. This ensures that their preferred pronouns are accurately reflected across all platforms. - -This guide will help you install and configure the plugin in Agent Studio quickly. Let’s get started! - -# **Prerequisites :** - -- Access to Agent Studio -- [SAP Successfactors Connector](https://developer.moveworks.com/creator-studio/resources/connector/?id=sap-success-factors&commit_id=21f2fb0f5f2b0852c62a72235121cd8d78d6b46b;) built in Creator Studio (follow the SAP Successfactors 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-builder/?workspace=%7B%22title%22%3A%22My+Workspace%22%2C%22botSettings%22%3A%7B%22name%22%3A%22%22%2C%22imageUrl%22%3A%22%22%7D%2C%22mocks%22%3A%5B%7B%22id%22%3A4081%2C%22title%22%3A%22New+Mock%22%2C%22transcript%22%3A%7B%22messages%22%3A%5B%7B%22from%22%3A%22USER%22%2C%22text%22%3A%22%3Cp%3EI+need+to+update+my+pronouns.%3C%2Fp%3E%22%7D%2C%7B%22from%22%3A%22BOT%22%2C%22text%22%3A%22%3Cp%3ESure%2C+I+can+help+with+that.+Please+share+your+pronouns%3F%3C%2Fp%3E%22%7D%2C%7B%22from%22%3A%22USER%22%2C%22text%22%3A%22%3Cp%3EThey%2FThem%2FTheirs%3Cbr%3E%3C%2Fp%3E%22%7D%2C%7B%22from%22%3A%22BOT%22%2C%22text%22%3A%22%3Cp%3EOkay%2C+I+will+update+your+pronouns+to+They%2FThem%2FTheirs.%3C%2Fp%3E%22%2C%22cards%22%3A%5B%7B%22title%22%3A%22%3Cp%3EPlease+confirm+your+new+pronouns%3Cbr%3E%3C%2Fp%3E%22%2C%22text%22%3A%22%3Cp%3E%3Cb%3EPronouns%3A+%3C%2Fb%3EThey%2FThem%2FTheirs%3Cbr%3E%3C%2Fp%3E%22%2C%22buttons%22%3A%5B%7B%22style%22%3A%22PRIMARY%22%2C%22text%22%3A%22Update+Pronouns+in+Success+Factors%22%7D%2C%7B%22text%22%3A%22Edit+Pronouns%22%7D%2C%7B%22text%22%3A%22Cancel%22%7D%5D%7D%5D%7D%5D%2C%22settings%22%3A%7B%22colorStyle%22%3A%22LIGHT%22%2C%22startTime%22%3A%2211%3A43%2BAM%22%2C%22defaultPerson%22%3A%22GWEN%22%2C%22editable%22%3Atrue%2C%22botName%22%3A%22%22%2C%22botImageUrl%22%3A%22%22%7D%7D%7D%5D%7D) shows the experience we are going to build. - -# **Installation Steps** - -While you can create a connector during plugin installation, we recommend creating a connector in **Agent Studio** beforehand to streamline the process. Please follow our [**SAP successfactors Connector Guide**](https://developer.moveworks.com/creator-studio/resources/connector/?id=sap-success-factors&commit_id=21f2fb0f5f2b0852c62a72235121cd8d78d6b46b;) to do so. Once completed, follow our plugin installation documentation to install the **Update Pronouns** plugin in minutes. - -After configuring the connector, refer to our installation documentation for more details on completing the setup. - -# **Appendix** - -### **API #1: Fetch User Information** - -The **Fetch User Information** API retrieves a userId using user email. - -```bash -curl --location --globoff 'https:///odata/v2/User?%24filter=email%20eq%20%27{{email}}%27&%24select=userId%2CfirstName%2ClastName%2CdisplayName%2Cnickname%2Cemail%2Clocation%2Cdepartment%2Cstatus%2Cgender%2CtimeZone%2CemployeeClass%2ChireDate%2CimpactOfLoss%2CriskOfLoss%2CjobCode%2CbusinessPhone%2Csalary%2CcompensationSalaryRateType%2CempId' \ ---header 'Accept: application/json' \ ---header 'Authorization: \ ---data '' -``` - -**Query Parameters :** - -- $filter (string) – Filter items by property values -- $select (array[string]) – Select properties to be returned - -### **API #2: GET Picklist** - -The **GET Picklist** API retrieves a optionId of the Pronouns. - -```bash -curl --location 'https:///odata/v2/PicklistOption?%24filter=picklist%20eq%20%27PersonPronouns%27&%24select=id%2CexternalCode' \ ---header 'Authorization: Bearer \ ---header 'Accept: application/json' \ - -``` - -**Query Parameters :** - -- $filter (string) – Filter items by property values -- $select (array[string]) – Select properties to be returned - -### **API #3: Upserting an Existing User with Pronoun** - -The **Upserting an Existing User with Pronoun** API updates the pronouns of the user whose userId is specified in the URI. - -```bash -curl --location 'https:///odata/v2/upsert?%24format=json' \ ---header 'Authorization: Bearer ' \ ---header 'Accept: application/json' \ ---header 'Content-Type: application/json' \ ---data '[ -{ - "__metadata": { - "uri": "/odata/v2/User('\''userId'\'')", - "type": "SFOData.User" - }, - "userId": "{{userId}}", - "pronouns": "{{pronouns}}" - } -] - -' -``` - -**Slots**: - -1. UserId. -2. Pronoun ID. \ No newline at end of file +--- \ No newline at end of file