40
Employee Central Advanced Reporting Configuration Guide November 2016 Release INTERNAL

Employee Central Advanced Reporting Configuration Guide

  • Upload
    others

  • View
    12

  • Download
    0

Embed Size (px)

Citation preview

Page 1: Employee Central Advanced Reporting Configuration Guide

Employee Central Advanced

Reporting Configuration GuideNovember 2016 Release

INTERNAL

Page 2: Employee Central Advanced Reporting Configuration Guide

© 2016 SAP SE or an SAP affiliate company. All rights reserved. 2Internal

Summary of Implementation Steps

Step(to perform a step you will need access to the tools

listed)

Purpose

1 SFSF Instance Configuration

Tools=Provisioning

• Create the Advanced Reporting instance and

enable Single Sign On between the SFSF

instance and the Advanced Reporting instance

2 Advanced Reporting Enablement

Tools=Analytics Admin; Analytics WST

Admin

• Enable Advanced Reporting data connection

and schemas

3 Golden Gate Enablement

Tools=Jira; Analytics WST Admin

• Enable replication of data using GoldenGate

4 SFSF User Configuration and Testing

Tools=SFSF Admin; SFSF Application

• Enable the appropriate SFSF permissions per

user or role to allow access to Advanced

Reporting

• Test access to Analytics Advanced Reporting

• Enable the default Advanced Reporting role

Note this guide does not include the deployment of the Employee Central report templates Refer to the Advanced Reporting –Implementing EC Report Templates guide in the SAP Marketplace.

Page 3: Employee Central Advanced Reporting Configuration Guide

Step 1: SFSF Instance Configuration

Page 4: Employee Central Advanced Reporting Configuration Guide

© 2016 SAP SE or an SAP affiliate company. All rights reserved. 4Internal

Notes for Step 1

This step will establish Single Sign On (SSO) between SFSF and create an analytics

Advanced Reporting instance.

To complete this step you will need access to:

• Provisioning for the customer.

If you are implementing Advanced Reporting for a customer who already has an existing

Analytics instance then:

• If SSO between SFSF and Analytics HAS already been set up then skip Step 1 and

proceed to Step 2. The Advanced Reporting Enablement will have to be done manually.

• If SSO between SFSF and Analytics HAS NOT been set up then proceed with the

instructions in Step 1.

Page 5: Employee Central Advanced Reporting Configuration Guide

© 2016 SAP SE or an SAP affiliate company. All rights reserved. 5Internal

Provisioning Service Provider Settings

• See the HCM Suite to Analytics Single Sign On (Reference Guide) in the SAP Marketplace to complete this section

• If the URLs that you need for this customer are not already configured then select “Add another Service Provide ACS”

• Enter the Assertion Consumer Service and the Logout Url fields

• Select SAVE

See HCM Suite to Analytics SSO guide See HCM Suite to Analytics SSO guide

Page 6: Employee Central Advanced Reporting Configuration Guide

© 2016 SAP SE or an SAP affiliate company. All rights reserved. 6Internal

Provisioning > Company Settings

Check the Reverse Proxy URL setting. If this field is not blank then record

the URL as you will need this next.

Page 7: Employee Central Advanced Reporting Configuration Guide

© 2016 SAP SE or an SAP affiliate company. All rights reserved. 7Internal

Provisioning Company Settings (part 1)

See HCM Suite to Analytics SSO guide

Enter the email address of the person Configuring this instance (you). One or

more email address can be separated by commas. An email will be sent to this

address when the Advanced Reporting instance creation completes, either

successfully or unsuccessfully.

Note it is very important to get the WFA/WFP/Talent Insight Company Identifier

right because this will be the name of the Analytics instance that will be created.

Once created you cannot change this identifier.

Enter the name of the SFSF instance that is in the Company ID field.

See HCM Suite to Analytics SSO guide

See HCM Suite to Analytics SSO guide

leave this field empty

• See the HCM Suite to Analytics Single Sign On (Reference Guide) in the SAP Marketplace to complete this section

• Find the Analytics and Dashboard Tabs & Misc Reporting section. The easiest way to find this is to search for the string

WFA on the page

• Complete the Single Sign On (SSO) and Enable SAML for SSO sections (note there is another section to be completed

on the next slide before you select the Save button).

Page 8: Employee Central Advanced Reporting Configuration Guide

© 2016 SAP SE or an SAP affiliate company. All rights reserved. 8Internal

Provisioning Company Settings (part 2)

Completing the Online Report Designer section: • Select the EC Client and the Platform Client

checkboxes. If other items are already selected then

leave them as is.

• If the Reverse Proxy URL (slide 7) was blank then

Save the section (see button below)

• If the Reverse Proxy URL was NOT blank then

enter the Reverse Proxy URL in the SF Public

Base Uri and the SAML IDP Base Uri fields. Do not

attempt to change any other fields as most of these

fields are read only. Save the section (see button

below).

• If the Analytics instance does not already exist then

when the Provisioning settings are saved the

Analytics instance creation process will be started.

Within 15 minutes the instance should be created

and then the Advanced Reporting instance will be

created.

• Wait until you receive an automated email indicating

the instance creation is complete.

Note! When you select the Save button the Company Settings page

will be redisplayed when the save action has completed. You may

notice that the tick boxes under Online Report designer are no longer

checked - this occurs while the Analytics instance is being created.

Once the instance has been created the tick boxes will reappear. It

may take up to 30 minutes for the Analytics instance to be created.

Page 9: Employee Central Advanced Reporting Configuration Guide

© 2016 SAP SE or an SAP affiliate company. All rights reserved. 9Internal

Advanced Reporting instance creation: completion emails

DO NOT Proceed further until you (or the person designated for the Email Ids to send ODS Creation Status

on slide 8) receive one of the below emails. If you do not receive any emails within a day of having completed

the Provisioning steps then raise a support case. For steps on how to create the support case refer to the

document called Implementing Advanced Reporting (ODS) for Live Employee Central Customers in the SAP

Marketplace.

FAILURE

email:

SUCCESS

email:

Page 10: Employee Central Advanced Reporting Configuration Guide

© 2016 SAP SE or an SAP affiliate company. All rights reserved. 10Internal

Advanced Reporting instance creation: Success email

If you received the Success email:

Step 2 of this guide has been completed automatically. Please proceed to Step 3, but retain this email

as it contains details you will need in Step 3.

Page 11: Employee Central Advanced Reporting Configuration Guide

© 2016 SAP SE or an SAP affiliate company. All rights reserved. 11Internal

Advanced Reporting instance creation: Failure email

If you received the Failure email:

Within approx. 1-2 days you should receive notification from Analytics Engineering or Support that the failed

process has now completed successfully. Proceed to Step 3, but retain this email as it contains details you

will need.

If you receive no notification from Analytics Engineering or Support please raise a support case. For steps

on how to create the support case refer to the document called Implementing Advanced Reporting (ODS) for

Live Employee Central Customers in the SAP Marketplace.

Page 12: Employee Central Advanced Reporting Configuration Guide

Step 2: Advanced Reporting

Enablement (Manual)

Page 13: Employee Central Advanced Reporting Configuration Guide

© 2016 SAP SE or an SAP affiliate company. All rights reserved. 13Internal

Notes for Step 2

This step will manually create the Advanced Reporting database step by step and should only

be used for EXISTING Analytics instances. (For new Analytics instances this step should have

been completed automatically as part of Step 1).

To complete this step you will need access to:

• a Workforce Analytics administration user account.

Partners will need to create a support case to have this step and step 3 of this document

completed for them. This is because Partners do not have access to the tools required for

these steps. Please refer to the document called Implementing Advanced Reporting (ODS) for

Live Employee Central Customers in the SAP Marketplace for steps on how to create the

support case.

Page 14: Employee Central Advanced Reporting Configuration Guide

© 2016 SAP SE or an SAP affiliate company. All rights reserved. 14Internal

Advanced Reporting (ODS) technical enablement:

High Level Process

The workflow below describes the high level process for the Advanced Reporting technical enablement

that is documented in Steps 2 and 3.

Create ODS

through WST

application

CloudOperations steps

Create a JIRA to

set up

GoldenGate

Replication

Set up Replication

from Source to

Target and set up

Monitoring

Perform reload

after ReplicationWorking?

Troubleshoot

Replication

Close JIRA

Yes

No

Test

functionality

Page 15: Employee Central Advanced Reporting Configuration Guide

© 2016 SAP SE or an SAP affiliate company. All rights reserved. 15Internal

Create ODS through Workforce Support Tool (WST )

1. Login to the Analytics application

2. Navigate to the appropriate URL for the Data Center the instance is in. eg:

3. Select Company Management at the top of the screen

4. Select Create New Company

Data

Center

Preview Production

DC2 https://analytics2preview.sapsf.eu/wstwebapp/Default.aspx https://analytics2.successfactors.eu/wstwebapp/Default.aspx

DC4 https://analytics4preview.sapsf.com/wstwebapp/Default.aspx https://analytics4.successfactors.com/wstwebapp/Default.aspx

DC8 https://analytics8preview.sapsf.com/wstwebapp/Default.aspx https://analytics8.successfactors.com/wstwebapp/Default.aspx

DC10 https://analytics10preview.sapsf.com/wstwebapp/Default.aspx https://analytics10.successfactors.com/wstwebapp/Default.aspx

DC12 https://analytics12preview.sapsf.eu/wstwebapp/Default.aspx https://analytics012.successfactors.eu/wstwebapp/Default.aspx

DC15 n/a https://analytics15.successfactors.cn/wstwebapp/Default.aspx

DC17 https://analytics17preview.sapsf.com/wstwebapp/Default.aspx https://analytics17.successfactors.com/wstwebapp/Default.aspx

DC18 https://analytics18preview.sapsf.com/wstwebapp/Default.aspx https://analytics18.successfactors.com/wstwebapp/Default.aspx

DC19 https://analytics19preview.sapsf.com/wstwebapp/Default.aspx https://analytics19.successfactors.com/wstwebapp/Default.aspx

Page 16: Employee Central Advanced Reporting Configuration Guide

© 2016 SAP SE or an SAP affiliate company. All rights reserved. 16Internal

Create New Company on HANA

An example of the New Company

Creation screen.

The following slides explain the fields on

the screen and what values to use.

Page 17: Employee Central Advanced Reporting Configuration Guide

© 2016 SAP SE or an SAP affiliate company. All rights reserved. 17Internal

Create New Company on HANA > General Section

General

• Successfactors Company Id: Enter the SFSF company identifier (refer to slide 8). Note this field is

case sensitive and must exactly match the SFSF company identifier. It cannot be changed later.

• Org Id: Enter the value entered in the WFA/WFP/Talent Insight Company Identifier in Provisioning

(refer to slide 8). This field must exactly match that field and cannot be changed later.

• ODS Reporting Type: Select Reporting off the Source with Replication (BizX: Oracle; ODS: Hana)

• Schema Version: The schema version represents the set of tables supporting the ODS. Choose

Schema8

Page 18: Employee Central Advanced Reporting Configuration Guide

© 2016 SAP SE or an SAP affiliate company. All rights reserved. 18Internal

Create New Company on HANA > Databases Section

Databases

• OLTP Sources: Select Sources. Select Add BizX Source. BizX will appear in the Source Location

field. In the OLTP Server field a default server will appear, leave this unchanged. Select Save.

• ODS Database Type: Select HANA.

• ODS Server: Pick the database name that matches the default for the instance. Eg: in the above

example, dc4wfahanadb05 would be selected from the drop down list.

Page 19: Employee Central Advanced Reporting Configuration Guide

© 2016 SAP SE or an SAP affiliate company. All rights reserved. 19Internal

Create New Company on HANA > Modules Section

Modules

The list of modules should include Employee Central, Employee Profile and Role Based Permissions.

These are the base modules that will be selected by default.

If the instance has GM, PM and / or Succession, then use CTRL + click to also select Goals Management,

Performance Management and Succession.

Page 20: Employee Central Advanced Reporting Configuration Guide

© 2016 SAP SE or an SAP affiliate company. All rights reserved. 20Internal

Create New Company on HANA

Consumer Setup

• API Username: Enter v4admin. This is

a SFSF user needed to make API calls

• Data Check Interval (ms): Leave this

value unchanged

• OLTP record count to process at a time:

Leave this value unchanged

• SSIS Windows Service: This field will

have a default setting and cannot be

changed

Optional:

• Leave as default – these settings are

sourced directly from SFSF

automatically.

Select consumer to register company to:

• This field will have a default setting and cannot be changed

Select Create ODS to save these changes and start the company creation process.

Page 21: Employee Central Advanced Reporting Configuration Guide

© 2016 SAP SE or an SAP affiliate company. All rights reserved. 21Internal

Monitoring the Create New Company process

• After selecting Save Changes you will directed to a screen (sample below) where you can monitor the Create

New Company process.

• You can set the screen to refresh automatically for a time interval so you can monitor the status.

• Depending on the company and how much data there is this load can take anything upward from a few hours

to complete

• You may close the browser and the company create will continue to run. To return to this monitoring page

later on to check the status select Company Management choose the company from the list select Oltp

Data Load Status in the Data Load section. Note you can also monitor the progress of the Create New

Company process from the Load Status page (available on the top toolbar)

Page 22: Employee Central Advanced Reporting Configuration Guide

© 2016 SAP SE or an SAP affiliate company. All rights reserved. 22Internal

Create new Company process completed

• When the load has finished the steps should look similar to the screenshot below

• For the ItInitial step the status should be IsSuccess.

• For the ItOdsCreation step the status should be IsSuccess and a message should indicate ODS creation

complete!

Page 23: Employee Central Advanced Reporting Configuration Guide

© 2016 SAP SE or an SAP affiliate company. All rights reserved. 23Internal

Troubleshooting

• If the Create New Company process fails with an error then you can restart the creation

process. This will recommence the process from the point where it failed. There is no harm

in attempting this and in some cases the creation will continue successfully.

• Select Company Management select the customer from the list Resume ODS

Creation.

• If the process fails again with the exact same error then raise a Jira in the WST project and

include all the details of the failure.

Page 24: Employee Central Advanced Reporting Configuration Guide

Step 3: Golden Gate

Enablement

Page 25: Employee Central Advanced Reporting Configuration Guide

© 2016 SAP SE or an SAP affiliate company. All rights reserved. 25Internal

Notes for Step 3

This step will establish GoldenGate replication between the SFSF Oracle database and the Advanced

Reporting (ODS) database. You will need replication working before you can proceed with the remainder of

Advanced Reporting (ODS) enablement.

To complete this step you will need access to:

• a Workforce Analytics administration user account

• Jira.

Partners will need to create a support case to have this step completed for them. This is because Partners

do not have access to the tools required for these steps. For steps on how to create the support case please

refer to the document called Implementing Advanced Reporting (ODS) for Live Employee Central

Customers in the SAP Marketplace.

Page 26: Employee Central Advanced Reporting Configuration Guide

© 2016 SAP SE or an SAP affiliate company. All rights reserved. 26Internal

Setting up GoldenGate Replication

If you have either the success or failure emails shown in slides 10 and 11 then they will

have the details in them that you need to ask for GoldenGate replication to be set up by

Cloud Operations. Proceed to slide 28 “Create GoldenGate Replication Jira”.

If you do not have these emails then proceed to the next slide.

Page 27: Employee Central Advanced Reporting Configuration Guide

© 2016 SAP SE or an SAP affiliate company. All rights reserved. 27Internal

Setting up GoldenGate Replication (continued)

Before you continue you will need the following information:

1. BizX Customer Identifier (Note: use the exact correct case)

2. Oracle Schema Name. To find the schema name Company Management select the customer from

the list Edit Company the schema name is in the top section labelled Oracle DB Schema

Return.

3. Database Pool. Found on the Company Summary under Oracle Instance. You can also find the

Database Pool on the same page as you found the Oracle DB Schema above.

4. WFA OLTP database. Found on the Company Summary under Source Locations.

5. WFA SQL server. Found on the Company Summary under Source Locations.

Page 28: Employee Central Advanced Reporting Configuration Guide

© 2016 SAP SE or an SAP affiliate company. All rights reserved. 28Internal

Create GoldenGate Replication Jira

Create a Jira (details below). Use the default assignee for this Jira (Level 1 / NOC [ sfalerts]). Below are the

recommended field settings for the Jira:

• Project: Cloud Operations Service Request (COSR)

• Issue Type: Database Script Request

• Customer Name: Use the BizX Customer Identifier

• Product Module/s: BizX Core

• Environment Type: Production

• Datacentre Location: Choose the name of the SFSF data center that matches the customer you are

working on.

• CS Ticket Number: Enter the ticket number if available otherwise enter N/a

Page 29: Employee Central Advanced Reporting Configuration Guide

© 2016 SAP SE or an SAP affiliate company. All rights reserved. 29Internal

Create GoldenGate Replication Jira (cont)

Create a Jira (details below). Use the default assignee for this Jira (Level 1 / NOC [ sfalerts]). Below are the

recommended field settings for the Jira:

• Summary: Enable GoldenGate replication for Advanced Reporting (ODS) for BizX Customer

Identifier.

• Description:

Please enable GoldenGate replication for the BizX Customer Identifier instance in Data Center.

Source:

Database = Database Pool

Schema = Oracle Schema Name

Target:

Database = WFA SQL Server

Schema = WFA OLTP Database

• SLA: P3

• Customer Region: Choose the region that matches the customer you are working on

• Request Source: Choose Customer Success

Page 30: Employee Central Advanced Reporting Configuration Guide

© 2016 SAP SE or an SAP affiliate company. All rights reserved. 30Internal

Confirming that GoldenGate replication is running

• Once the JIRA to enable GoldenGate Replication for the customer has been actioned you can use the WST

tool to determine if GoldenGate is running as expected.

• Select Company Management

• Select the company name from the list

• Select Click here beside View GoldenGate Monitoring Data in the Replication section.

Page 31: Employee Central Advanced Reporting Configuration Guide

© 2016 SAP SE or an SAP affiliate company. All rights reserved. 31Internal

Confirming that GoldenGate replication is running

• Replication is running

successfully if the timestamps

are recent and there is a row of

information updated every

minute. If there are no rows of

information in the table then

replication is not running.

• The default view shows the

replication entries in reverse

order of time so you will need to

scroll to the bottom of the page

to see the latest entries. The

latest entry should match the

time in data center.

• Timestamps are in the local

data center server time.

• Note: The Oracle and SQL

server times may be negative or

vary vastly depending on how

much out of sync the server

clocks are.

Page 32: Employee Central Advanced Reporting Configuration Guide

© 2016 SAP SE or an SAP affiliate company. All rights reserved. 32Internal

Reload Company Data

• Once it has been confirmed that GoldenGate replication is running correctly for the customer a full reload

of the customer‘s Advanced Reporting (ODS) database may needed to ensure that the latest data is

available for reporting. This step is required if it has been more than 3 days since the Create New

Company step was performed. GoldenGate only holds 3 days of audit logs and if more than that amount of

time has passed then replication will not provide all the data.

• Select Company Management at the top of the screen

• Select the company name from the list

• Select the Re-create Company button

• This will start the company re-creation process. You can monitor this process the same way you did for the

initial Create New Company step

Page 33: Employee Central Advanced Reporting Configuration Guide

Step 4: SFSF User

Configuration and Testing

Page 34: Employee Central Advanced Reporting Configuration Guide

© 2016 SAP SE or an SAP affiliate company. All rights reserved. 34Internal

Notes on Step 4

This step assigns the appropriate permissions to a SFSF user/role to allow access to

Analytics.

To complete this step you will need access to:

• the SFSF customer instance and an administration/test user account.

Note if this is a new Advanced Reporting instance then the first user to attempt to access the

Analytics instance will be placed in the Implementation Partner role. This role has all the

appropriate permissions to configure Advanced Reporting users, roles and reports and also to

place other users in to the Implementation Partner role.

If you are implementing Advanced Reporting access Analytics for the first time using your

SFSF administration user account.

Subsequent access attempts by different users not be granted the Implementation Partner

role.

Page 35: Employee Central Advanced Reporting Configuration Guide

© 2016 SAP SE or an SAP affiliate company. All rights reserved. 35Internal

Configuring access to Analytics using the RBP

Permission Framework

From Manage Permission Roles > Choose a Role >

Select Permission button > Select Analytics

Permissions group> select Show Analytics (sub

tab) > Done

If you do not see this option, then Provisioning

(Company Settings and Assertion Consumer

Settings) has not been set up correctly.

Depending on your Admin Configuration, follow

path A, B or C:

A. If using OneAdmin, under Set User

Permissions, choose Manage Permission

Roles.

B. If using Admin Tools, navigate from

Manage Security to Manage Permission Roles.

C. If using Admin Center navigate to Manage

Permission Roles.

Page 36: Employee Central Advanced Reporting Configuration Guide

© 2016 SAP SE or an SAP affiliate company. All rights reserved. 36Internal

Accessing Analytics Advanced Reporting

• In the SFSF Application login with an appropriately permissioned user

• Navigate to Analytics in the module picker and then navigate to the Analytics sub-tab

• Once in Analytics you can access Advanced Reporting from the Tools menu at bottom

left:

Page 37: Employee Central Advanced Reporting Configuration Guide

© 2016 SAP SE or an SAP affiliate company. All rights reserved. 37Internal

Role Maintenance: Set default role

This step enables the Default Role,

allowing users’ accounts to be

automatically created when they attempt

to access Analytics. Typically you would

choose a role that has the minimum

required permissions. It is recommended

that that the Report Consumer role is

chosen as it is designed for users who

can run reports but not edit their content.

Steps:

• Admin > Role Maintenance

• Select the Role button

• Select the role from the list

• Tools > Make this the default role

Page 38: Employee Central Advanced Reporting Configuration Guide

© 2016 SAP SE or an SAP affiliate company. All rights reserved. 38Internal

Coding Samples

Any software coding and/or code lines / strings ("Code") included in this documentation are

only examples and are not intended to be used in a productive system environment. The Code

is only intended to better explain and visualize the syntax and phrasing rules of certain coding.

SAP does not warrant the correctness and completeness of the Code given herein, and SAP

shall not be liable for errors or damages caused by the usage of the Code, unless damages

were caused by SAP intentionally or by SAP's gross negligence.

Accessibility

The information contained in the SAP documentation represents SAP's current view of

accessibility criteria as of the date of publication; it is in no way intended to be a binding

guideline on how to ensure accessibility of software products. SAP in particular disclaims any

liability in relation to this document. This disclaimer, however, does not apply in cases of wilful

misconduct or gross negligence of SAP. Furthermore, this document does not result in any

direct or indirect contractual obligations of SAP.

Important Disclaimers and Legal Information

Page 39: Employee Central Advanced Reporting Configuration Guide

© 2016 SAP SE or an SAP affiliate company. All rights reserved. 39Internal

Gender-Neutral Language

As far as possible, SAP documentation is gender neutral. Depending on the context, the

reader is addressed directly with "you", or a gender-neutral noun (such as "sales person" or

"working days") is used. If when referring to members of both sexes, however, the third-person

singular cannot be avoided or a gender-neutral noun does not exist, SAP reserves the right to

use the masculine form of the noun and pronoun. This is to ensure that the documentation

remains comprehensible.

Internet Hyperlinks

The SAP documentation may contain hyperlinks to the Internet. These hyperlinks are intended

to serve as a hint about where to find related information. SAP does not warrant the availability

and correctness of this related information or the ability of this information to serve a particular

purpose. SAP shall not be liable for any damages caused by the use of related information

unless damages have been caused by SAP's gross negligence or willful misconduct. All links

are categorized for transparency (see: http://help.sap.com/disclaimer).

Page 40: Employee Central Advanced Reporting Configuration Guide

© 2016 SAP SE or an SAP affiliate company. All rights reserved. 40Internal

No part of this publication may be reproduced or transmitted in any form or for any purpose

without the express permission of SAP SE or an SAP affiliate company. The information

contained herein may be changed without prior notice.

Some software products marketed by SAP SE and its distributors contain proprietary software

components of other software vendors. National product specifications may vary.

These materials are provided by SAP SE or an SAP affiliate company for informational

purposes only, without representation or warranty of any kind, and SAP or its affiliated

companies shall not be liable for errors or omissions with respect to the materials. The only

warranties for SAP or SAP affiliate company products and services are those that are set forth

in the express warranty statements accompanying such products and services, if any. Nothing

herein should be construed as constituting an additional warranty.

SAP and other SAP products and services mentioned herein as well as their respective logos

are trademarks or registered trademarks of SAP SE (or an SAP affiliate company) in Germany

and other countries. All other product and service names mentioned are the trademarks of

their respective companies.

Please see http://www.sap.com/corporate-en/legal/copyright/index.epx for additional

trademark information and notices.

© 2016 SAP SE or an SAP affiliate company. All rights

reserved.