workday integration documentation - s3. · pdf filepage 2 get help [email protected] this...

30
Workday Integration Documentation

Upload: vuongxuyen

Post on 23-Mar-2018

220 views

Category:

Documents


1 download

TRANSCRIPT

Page 1: Workday Integration Documentation - s3. · PDF filepage 2 Get help support@7geese.com This document outlines the design and configuration steps for Workday and 7Geese customers to

Workday Integration Documentation

Page 2: Workday Integration Documentation - s3. · PDF filepage 2 Get help support@7geese.com This document outlines the design and configuration steps for Workday and 7Geese customers to

page 2Get help [email protected]

This document outlines the design and configuration steps for Workday and 7Geese customers to implement an integration.

Introduction

Page 3: Workday Integration Documentation - s3. · PDF filepage 2 Get help support@7geese.com This document outlines the design and configuration steps for Workday and 7Geese customers to

page 3Get help [email protected]

Architecture OverviewWorker Profile Data flows one-way from Workday to 7Geese. New user accounts are created, updated, and deactivated on a daily basis.

Design ConsiderationsWorkday customers have some degree of flexibility with how to configure the custom reports found in the integration setup:

> You can include or exclude any specific worker populations by adjusting the logic in the report filter. Suggested configurations are provided in this document.

> Depending on your requirements, you may adjust these configurations according to your Workday tenant as long as all field names are outputted with the expected 7Geese Alias.

Workday Configuration ExpectationsCustomers are expected to make the following configuration changes in your workday tenant (detailed steps are documented in the Appendices to this document):

1. Create an integration system user and assign appropriate security permissions

2. Configure two calculated fields

3. Create three custom reports and expose them as a web service

4. Provide 7Geese with a web service URL for each of the reports

Page 4: Workday Integration Documentation - s3. · PDF filepage 2 Get help support@7geese.com This document outlines the design and configuration steps for Workday and 7Geese customers to

page 4Get help [email protected]

Architecture DetailThe integration consists of up to three separate custom reports exposed as a web service. 7Geese accesses the data found in these reports via an integration system user. The basic integration requires only the first report while customers choosing to sync worker photos will need the additional two reports.

# Report Name Purpose Data Source Filtering

1 7Geese Worker Sync Integration

- Initial sync of worker profile data

- Daily sync of new hires and terminations

- Daily sync of worker profile data

All Active & Terminated Workers

All Active Employees (hired as of today or earlier) plus terminated workers (terminated since 12 months ago)

2 7Geese Worker Sync Photos

- Initial sync of worker photos

-Periodic syncs of worker photos as needed

All Active & Terminated Workers

All Active Employees; terminated workers are not returned

3 7Geese Photo Changes

- Daily sync of worker photos

Business Process Transactions

Photo Change events completed on or after 12am Pacific yesterday.

Page 5: Workday Integration Documentation - s3. · PDF filepage 2 Get help support@7geese.com This document outlines the design and configuration steps for Workday and 7Geese customers to

page 5Get help [email protected]

Follow these steps, or equivalent, to achieve the required security configuration.

Appendix A - Security Configuration

Page 6: Workday Integration Documentation - s3. · PDF filepage 2 Get help support@7geese.com This document outlines the design and configuration steps for Workday and 7Geese customers to

page 6Get help [email protected]

Step 1Access the Create Integration System User task (you must have modify security in the Integration Security domain):

1. Assign a User Name

2. Assign a strong password

3. Re-enter the password

4. Leave the Require New Password at Next Sign In unchecked

5. Leave Session Timeout Minutes at 0

6. OK

Step 2Access the Create Security Group task (you must have modify security in the Security Configuration domain):

1. Select Integration System Security Group (Unconstrained)

2. Name the security group 7Geese Integration System Security Group

3. OK

4. Assign the integration system user ISU_7Geese

5. OK

Page 7: Workday Integration Documentation - s3. · PDF filepage 2 Get help support@7geese.com This document outlines the design and configuration steps for Workday and 7Geese customers to

page 7Get help [email protected]

Step 3Modify the domain security policies shown below so that the security group 7Geese Integration System Security Group has Get Only access (you must have modify security in the Security Configuration domain):

Example steps for editing the Business Process Reporting domain security policy. You must repeat these steps for all domain security policies listed above:

1. Access the View Domain task

2. Search for the domain, in this example it is Business Process Reporting

3. OK

4. Click on the related action to the Domain Security Policy

5. Click on the Domain Security Policy menu

6. Click on Edit Permissions

Page 8: Workday Integration Documentation - s3. · PDF filepage 2 Get help support@7geese.com This document outlines the design and configuration steps for Workday and 7Geese customers to

page 8Get help [email protected]

Step 3 (con’t)

Reminder: the steps above described how to change security for one domain security policies. You will need to repeat these steps for all domain security policies listed at the beginning of Step 3.

1. Add a row on the Integration Permissions section for the security group 7Geese Integration System Security Group

2. Ensure the Get permission is checked

3. OK

Page 9: Workday Integration Documentation - s3. · PDF filepage 2 Get help support@7geese.com This document outlines the design and configuration steps for Workday and 7Geese customers to

page 9Get help [email protected]

Step 4Modify the business process security policies shown below so that the security group 7Geese Integration System Security Group has View All access (you must have modify security in the Security Configuration domain):

1. Use the bp search prefix to find the Photo Change business process definition by typing bp:photo change into the search bar

2. Click on the related action to the Photo Change business process definition

3. Access the Business Process Policy menu

5. Scroll through the Edit Business Process Security Policy screen to get to the Who Can Do Actions on Entire Business Process section

6. For the View All action assign the security group 7Geese Integration System Security Group

7. OK

Step 5Access the Activate Pending Security Policy Changes task.

Page 10: Workday Integration Documentation - s3. · PDF filepage 2 Get help support@7geese.com This document outlines the design and configuration steps for Workday and 7Geese customers to

page 10Get help [email protected]

Appendix B - Calculated Field Configuration

Page 11: Workday Integration Documentation - s3. · PDF filepage 2 Get help support@7geese.com This document outlines the design and configuration steps for Workday and 7Geese customers to

page 11Get help [email protected]

The integration setup requires you to create two new calculated fields in your tenant which you will use in your report configuration. The steps below describe how to create these as tenant-wide Calculated Fields; however, you may choose to create these fields as a Calculated Field for Report (if that’s the case move on to creating the reports and refer back to this section when adding the calculated fields into the report).

1. Access the Create Calculated Field task

2. Name the field Termination Date (blank if Worker Active) or any other desired name (you will define an XML alias which is important for the integration later on)

3. Select the Business Object Worker

4. Select the Function Evaluate Expression

5. OK

6. Select Date as the Field Type

7. Assign a Default Value of the Workday-delivered field Termination Date

8. Add one row

9. Assign the Workday-delivered field Worker Active as the Condition field

10. Assign the Workday-delivered field Blank Date as the Return Value If Condition is True field

11. OK

Steps to Create the calculated field Termination Date (blank if Worker Active)

Business Object Field Name Calculated Field Type

Worker Termination Date (blank if Worker Active)

Evaluate Expression

Action Event Worker Photo Lookup Related Value

Page 12: Workday Integration Documentation - s3. · PDF filepage 2 Get help support@7geese.com This document outlines the design and configuration steps for Workday and 7Geese customers to

page 12Get help [email protected]

Steps to Create the calculated fieldWorker Photo

1. Access the Create Calculated Field task

2. Name the field Worker Photo or any other desired name (you will define an XML alias which is important for the integration later on)

3. Select the Business Object Action Event

4. Select the Function Lookup Related Value

5. Assign the Workday-delivered field Worker as the Lookup Field

6. Assign the Workday-delivered field Photo as the Return Value field

7. OK

Page 13: Workday Integration Documentation - s3. · PDF filepage 2 Get help support@7geese.com This document outlines the design and configuration steps for Workday and 7Geese customers to

page 13Get help [email protected]

Appendix C - Configuration of Custom Report 1

Page 14: Workday Integration Documentation - s3. · PDF filepage 2 Get help support@7geese.com This document outlines the design and configuration steps for Workday and 7Geese customers to

page 14Get help [email protected]

Follow these steps to configure the custom report 7Geese Worker Sync Integration:

1. Access the Create Custom Report task

2. Name the report 7Geese Worker Sync Integration or any other desired name

3. Select the Advanced Report Type

4. Select the All Active and Terminated Workers Data Source

5. Check the Web Service Enable box

6. OK

7. Configure the report Columns, paying special attention to each area:

a. Business Object

b. Field

c. Column Heading Override XML Alias. Note that the Column Heading Override XML Alias is critical to the integration functioning correctly.

d. The Column Heading Override (though this is not critical to the integration)

e. The Group Column Heading XML Alias (though this is not critical to the integration)

Page 15: Workday Integration Documentation - s3. · PDF filepage 2 Get help support@7geese.com This document outlines the design and configuration steps for Workday and 7Geese customers to

page 15Get help [email protected]

11. Configure the report Advanced tab:

a. Ensure that Enable as Web Service is checked

b. Note the default Web Service API Version and inform your 7Geese contact

c. Note the default Namespace and inform your 7Geese contact

10. Configure the report Share tab:

a. Share with specific authorized groups and users

b. Assign 7Geese Integration System Security Group as an Authorized Group

1. When you have finished configuring the report, click on the related action to the custom report

2. Click on the Web Service menu

3. Click on View URLs

4. Right click on the JSON hyperlink

5. Click Copy URL

6. Note the JSON URL and provide to your 7Geese contact

Page 16: Workday Integration Documentation - s3. · PDF filepage 2 Get help support@7geese.com This document outlines the design and configuration steps for Workday and 7Geese customers to

page 16Get help [email protected]

Please use this table to obtain the exact names of the fields used in the Column Heading Override XML Alias:

8. Configure the report Filter, paying special attention to all highlighted areas. Note that the field Termination Date (blank if Worker Active) is a tenanted Calculated Field you will need to create if you didn’t already create in Appendix B)

Design Tip: for the Cost Center / Department field mapping, you can configure any single or multi-instance field that you would like mapped to the Department field in 7Geese as long as you keep the label Department as the Column Heading Override XML Alias. The configuration shown here is for Cost Center to map to Department.

Page 17: Workday Integration Documentation - s3. · PDF filepage 2 Get help support@7geese.com This document outlines the design and configuration steps for Workday and 7Geese customers to

page 17Get help [email protected]

Appendix D - Configuration of Custom Report 2

Page 18: Workday Integration Documentation - s3. · PDF filepage 2 Get help support@7geese.com This document outlines the design and configuration steps for Workday and 7Geese customers to

page 18Get help [email protected]

Follow these steps to configure the custom report 7Geese Worker Sync Photos:

7. Configure the report Columns, paying special attention to each area:

a. Business Object

b. Field

c. Column Heading Override XML Alias. Note that the Column Heading Override XML Alias is critical to the integration functioning correctly.

d. The Column Heading Override (though this is not critical to the integration)

e. The Group Column Heading XML Alias (though this is not critical to the integration)

1. Access the Create Custom Report task

2. Name the report 7Geese Worker Sync Photos or any other desired name

3. Select the Advanced Report Type

4. Select the All Active and Terminated Workers Data Source

5. Check the Web Service Enable box

6. OK

Page 19: Workday Integration Documentation - s3. · PDF filepage 2 Get help support@7geese.com This document outlines the design and configuration steps for Workday and 7Geese customers to

page 19Get help [email protected]

Please use this table to obtain the exact names of the fields used in the Column Heading Override XML Alias:

8. Configure the report Filter, paying special attention to all highlighted areas.

9. Configure the report Share tab:

a. Share with specific authorized groups and users

b. Assign 7Geese Integration System Security Group as an Authorized Group

Page 20: Workday Integration Documentation - s3. · PDF filepage 2 Get help support@7geese.com This document outlines the design and configuration steps for Workday and 7Geese customers to

page 20Get help [email protected]

10. Configure the report Advanced tab:

a. Ensure that Enable as Web Service is checked

b. Note the default Web Service API Version and inform your 7Geese contact

c. Note the default Namespace and inform your 7Geese contact

11. When you have finished configuring the report, click on the related action to the custom report

12. Click on the Web Service menu

13. Click on View URLs

14. Right click on the JSON hyperlink

15. Click Copy URL

16. Note the JSON URL and provide to your 7Geese contact

Page 21: Workday Integration Documentation - s3. · PDF filepage 2 Get help support@7geese.com This document outlines the design and configuration steps for Workday and 7Geese customers to

page 21Get help [email protected]

Appendix E - Configuration of Custom Report 3

Page 22: Workday Integration Documentation - s3. · PDF filepage 2 Get help support@7geese.com This document outlines the design and configuration steps for Workday and 7Geese customers to

page 22Get help [email protected]

Follow these steps to configure the custom report 7Geese Photo Changes:

1. Access the Create Custom Report task

2. Name the report 7Geese Photo Changes or any other desired name

3. Select the Advanced Report Type

4. Select the Business Process Transactions Data Source

5. Check the Web Service Enable box

6. OK

7. Configure the report Columns, paying special attention to each area:

a. Business Object

b. Field

c. Column Heading Override XML Alias. Note that the Column Heading Override XML Alias is critical to the integration functioning correctly.

d. The Column Heading Override (though this is not critical to the integration)

e. The Group Column Heading XML Alias (though this is not critical to the integration)

Page 23: Workday Integration Documentation - s3. · PDF filepage 2 Get help support@7geese.com This document outlines the design and configuration steps for Workday and 7Geese customers to

page 23Get help [email protected]

Please use this table to obtain the exact names of the fields used in the Column Heading Override XML Alias:

8. Configure the report with no Filter. You will apply filtering on the build-in-Prompts for the Business Process Transactions data source instead. Go to the next step.

Page 24: Workday Integration Documentation - s3. · PDF filepage 2 Get help support@7geese.com This document outlines the design and configuration steps for Workday and 7Geese customers to

page 24Get help [email protected]

9. Configure the report Prompts tab. You can pre-populate all of the prompt fields by clicking on the check box Populate undefined Prompt Defaults. Pay close attention to the areas highlighted. A text version of the screenshot is shown below:

Page 25: Workday Integration Documentation - s3. · PDF filepage 2 Get help support@7geese.com This document outlines the design and configuration steps for Workday and 7Geese customers to

page 25Get help [email protected]

10. Configure the report Share tab:

a. Share with specific authorized groups and users

b. Assign 7Geese Integration System Security Group as an Authorized Group

11. Configure the report Advanced tab:

a. Ensure that Enable as Web Service is checked

b. Note the default Web Service API Version and inform your 7Geese contact

c. Note the default Namespace and inform your 7Geese contact

Page 26: Workday Integration Documentation - s3. · PDF filepage 2 Get help support@7geese.com This document outlines the design and configuration steps for Workday and 7Geese customers to

page 26Get help [email protected]

12. When you have finished configuring the report, click on the related action to the custom report

13. Click on the Web Service menu

14. Click on View URLs

15. Right click on the JSON hyperlink

16. Click Copy URL

17. Note the JSON URL and provide to your 7Geese contact

Page 27: Workday Integration Documentation - s3. · PDF filepage 2 Get help support@7geese.com This document outlines the design and configuration steps for Workday and 7Geese customers to

page 27Get help [email protected]

Appendix F - Configuration Checklist

After completing all configuration changes, review the checklist below to ensure you have completed the required configuration.

Page 28: Workday Integration Documentation - s3. · PDF filepage 2 Get help support@7geese.com This document outlines the design and configuration steps for Workday and 7Geese customers to

page 28Get help [email protected]

Page 29: Workday Integration Documentation - s3. · PDF filepage 2 Get help support@7geese.com This document outlines the design and configuration steps for Workday and 7Geese customers to

page 29Get help [email protected]

Page 30: Workday Integration Documentation - s3. · PDF filepage 2 Get help support@7geese.com This document outlines the design and configuration steps for Workday and 7Geese customers to

page 30Get help [email protected]

you can’t make a stellar meal without prep work - achievement is no differentThank you so much again for choosing 7Geese as your OKR and Performance Management platform! Feel free to reach out to us at [email protected] for any questions you may have.

SO, LET’S GO CREATE A DAMN GOOD MEAL... ERRR, GOAL!