sap hybris cloud for customer data workbench user guide · pdf fileject documentation. ......

54
PUBLIC 2017-02-23 SAP Hybris Cloud for Customer Data Workbench User Guide

Upload: ngocong

Post on 15-Feb-2018

256 views

Category:

Documents


10 download

TRANSCRIPT

PUBLIC

2017-02-23

SAP Hybris Cloud for Customer Data Workbench User Guide

Content

1 Data Workbench User Guide. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31.1 Cleanse Data in a CSV File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71.2 Import Data into SAP Hybris Cloud for Customer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Import Data for Individual Objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10(Beta) Import Data for Complete Business Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Import Attachments into SAP Hybris Cloud for Customer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

1.3 Export Data from SAP Hybris Cloud for Customer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231.4 Update Data in SAP Hybris Cloud for Customer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Data Simulation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241.5 Mapping Template Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .251.6 Template Usage Across SAP Hybris Cloud for Customer Tenants. . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

2 Object Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292.1 Deal Registration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292.2 Maintenance Plan. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322.3 Attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362.4 Installed Base. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412.5 Measurement Point. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Measurement Reading. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

3 Frequently Asked Questions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493.1 Why is it mandatory to select a template or an object?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493.2 Can I map my ID key to the Internal ID key in SAP Hybris Cloud for Customer?. . . . . . . . . . . . . . . . . . . 493.3 Why am I unable to use a template for an extended business object?. . . . . . . . . . . . . . . . . . . . . . . . . . 493.4 I imported data for an object but Unable to See Any Status in the Monitor view?. . . . . . . . . . . . . . . . . . 503.5 Why do I see the error ‘Please upload a valid CSV file in the required format’?. . . . . . . . . . . . . . . . . . . . 503.6 I have data in a spreadsheet. Any recommendation on how I should create a CSV file?. . . . . . . . . . . . . .503.7 Can I delete an existing task from the Monitor view?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

4 Support Incidents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

2 P U B L I CSAP Hybris Cloud for Customer Data Workbench User Guide

Content

1 Data Workbench User Guide

This document describes all the features available in Data Workbench, and takes you through the process of importing and exporting your data into or from SAP Hybris Cloud for Customer. You can import the following:

● Data from a legacy system into SAP Hybris Cloud for Customer. For example, you want to transfer all the existing data from any Cloud CRM system to SAP Hybris Cloud for Customer

● Operational data from third-party systems into SAP Hybris Cloud for Customer. For example, import accounts and contacts from Microsoft Outlook to SAP Hybris Cloud for Customer

● Data that is manually maintained in a CSV file format into SAP Hybris Cloud for Customer. For example, the sales leads data collected from a campaign and maintained in a CSV file.

NoteData Workbench will only work in HTML & Extended Edition versions of the SAP Hybris Cloud for Customer

RememberBefore you start working through this document, ensure that you have downloaded the most recent version of this document available on SAP Service Marketplace.

What's New

● New workcenter view Templates for key users to help map templates and template maintenance● Import data in Initial Load mode to avoid Business Object validations● Standard CSV delimiters are now supported for data import● Task deletion is now available in Monitor view● Template CSV, Field Definition and Code List Values files can now be downloaded in one ZIP file.

Target Audience for this Document

Here is an outline of experts who may be involved in the import process. Now download Template CSV, Field Definition, and Code List Values in a single ZIP file

SAP Hybris Cloud for Customer Data Workbench User GuideData Workbench User Guide P U B L I C 3

Table 1:

Role Description

Key User As an administrator, you know/understand the following:

● Now download Template CSV, Field Definition, and CoObjects that need to be imported into SAP Hybris Cloud for Customer (business requirement)

● Sequence in which the objects and the nodes should be imported. For information on each of the objects, see ob­ject documentation.

● For each of the object, a business understanding of map­ping the CSV fields to the fields in SAP Hybris Cloud for Customer

Typical tasks include

● Cleansing your data to an acceptable format● Creating templates for various objects and nodes.● Importing, exporting, and updating data

Business User Typical tasks include:

● Importing data using a template● Importing attachments● Exporting data● Updating data

Comparison

SAP Hybris Cloud for Customer offers both Migration Workbench and Data Workbench to import data. Here is a quick comparison on the advantages of the two options:

Table 2:

Feature Data Workbench Migration Workbench

Import data of custom objects Yes No

Import Attachments Yes No

Support for CSV files with custom-de­fined fields, extended fields

Yes Yes

Flexibility and ease of use in defining and uploading templates

Yes Yes

4 P U B L I CSAP Hybris Cloud for Customer Data Workbench User Guide

Data Workbench User Guide

Feature Data Workbench Migration Workbench

User can do on-the-fly mapping between CSV and SAP Hybris Cloud for Customer fields

Yes Yes

User can save their own mapping and CSV columns as a template for repeated import

Yes Yes

Flexibility in defining code list mapping ● Per import● Per template● Across objects

Across objects

Sophisticated monitoring capabilities of an import task, with e-mail notification and errors highlighted in CSV files

Yes No

Online correction of errors highlighted in each record

No Yes

Import data maintained in a spreadsheet No (Only CSV files are supported) Yes

Import data from all nodes within an ob­ject at once

No Yes

Import data of any object available in SAP Hybris Cloud for Customer

Restricted (Check supported objects ) Yes

Update data in SAP Hybris Cloud for Customer

Yes Yes

Export data from SAP Hybris Cloud for Customer

Yes No

Basic Checklist

Fulfill all the requirements in this checklist before you use Data Workbench.

SAP Hybris Cloud for Customer Data Workbench User GuideData Workbench User Guide P U B L I C 5

Table 3:

Task

Technical For each of the objects you want to import data, you have the CSV files for all the nodes in that object.

Example: The node dependency in contract object is as fol­lows: Covered Object, Price, Item, Entitled Product, Item Price Now, ensure that you have separate CSV files for each of the above nodes.

These CSV files may be the one downloaded from a system or the ones you have maintained manually. To check if the file is in an acceptable format, do the following:

1. Open the CSV file in Notepad.

2. Click File Save As3. In the Save As dialog, choose Encoding as UTF-8. Keep

the file extension as .CSV.4. Once the file is saved, check if all the contents are dis­

played correctly.

Functional You have discussed the business requirement on the data that needs to be imported into SAP Hybris Cloud for Customer

For each of the objects you want to import data, you have read through the Dependency within the object section of the respective object document. For more information, see object documentation.

List of Objects supported in Data Workbench

Table 4:

Object Name in SAP Hybris Cloud for Customer UI

OData Service Name in Data Work­bench

Entity Set Name

BUPA_HIERARCHY_DWB_STAGING accounthierarchy Account Hierarcy

Customer customer Account, Individual Customer

PDM_MATERIAL product Product

BUSINESS_PARTNER contact Contact

PRC_SALES_PRICE_LIST price list Price List

BUSINESS_ACTIVITY activity Appointment

BUSINESS_ACTIVITY activity Email

6 P U B L I CSAP Hybris Cloud for Customer Data Workbench User Guide

Data Workbench User Guide

Object Name in SAP Hybris Cloud for Customer UI

OData Service Name in Data Work­bench

Entity Set Name

OPPORTUNITY opportunity Opportunity

BUSINESS_ACTIVITY activity Phone Call

LEAD lead Lead

CUSTOMER_QUOTE salesorderprocessing Sales Order

SERVICE_REQUEST ticket Ticket

BUSINESS_ACTIVITY activity Appointment, Email, PhoneCall, Tasks, Visit

PRODUCT_CATEG_HIERARCHY productcategoryhierarchy Product Categories

CONTRACT contract Contract

BUSINESS_PARTNER_RELATIONSHIP accountcontactrelationship Account Contact Relationship

SALES_ARRANGEMENT salesarrangement Account Sales Data

BUSINESS_ATTRIBUTE salesarrangement Attribute

1.1 Cleanse Data in a CSV File

Overview

The data that is either downloaded from a legacy system, a third-party system, or manually maintained in a CSV file, should be cleansed before it can be successfully imported into SAP Hybris Cloud for Customer. For example, you need to ensure that all the reference IDs are maintained based on the dependency, and also check if the data is in acceptable formats.

RememberWe recommend that you import data of all the objects in a hierarchy. For example, if the hierarchy is

Opportunity Opportunity Item , you must import both opportunities and opportunity items. It is not allowed to create opportunities in SAP Hybris Cloud for Customer and import opportunity items.

SAP Hybris Cloud for Customer Data Workbench User GuideData Workbench User Guide P U B L I C 7

Prerequisites

You have the CSV file for the object (node) data you want to import.

Procedure

1. Ensure that each CSV file has a reference to all the parents in the hierarchy.

Posting InstructionsExample: If the hierarchy is as shown below:

Opportunity Opportunity○ Opportunity Item

○ Revenue Plan ReportingThen ensure that the○ Opportunity CSV file has an external key Opportunity CSV file

Table 5:

Opportunity External Key Priority Primary Contact Expected Revenue

○ Opportunity item CSV file has a column that represents the external key of the opportunity object Opportunity Item CSV file

Table 6:

Opportunity Iten External Key

Opportunity External Key Product ID Net Amount

○ • Revenue Plan Reporting CSV has columns that represent the external key of both opportunity item and opportunity Revenue Plan Reporting CSV file

Table 7:

Revenue Plan External Key

Opportunity Item Exter­nal Key

Opportunity External Key Distribution Date

During upload, you can now maintain a reference to parent object in the sub objects by maintaining an internal ID. For example, if you are importing opportunity items, you can maintain an internal ID of an opportunity in the opportunity item CSV file. This is in addition to the external ID.

You can maintain references up to the second level in the hierarchy. The first reference based on root node and the second level of reference based on a sub node.

Example: If the hierarchy is as shown below:

8 P U B L I CSAP Hybris Cloud for Customer Data Workbench User Guide

Data Workbench User Guide

○ Opportunity○ Opportunity Item

Then, ensure that the: Opportunity item CSV file has a column that represents the internal ID of the opportunity object Opportunity Item CSV file

Table 8:

ID OpportunityID Product ID Net Amount

2. Ensure that column names are a single word without any space. For example, the column name Opportunity Type should be written as OpportunityType in the CSV file.

3. If you have a date field in your CSV file, do the following:○ Format it as yyyy-mm-dd. Only this format is currently accepted.

Example: November 24, 2015 is formatted as 2015-11-24○ To import a timestamp field, maintain it in the format: 2015-11-24Thh:mm:ss

4. If you have a Boolean entry, ensure that the value is entered either as true or false in small case.

Table 9:

Accepted Value Not Accepted Values

○ true○ True○ X

0

○ false○ False○ <space>

1

5. Columns with numbers that are treated as text.Data of a few columns that display numbers may need to be treated as text. For example, code list values for ActivityGroupCode. Here, the value 0001 is the code, and 1 would not be an accepted code value.

Table 10:

ActivityGroupCode Description

0001 Customer visit

0002 Telephone Call

0003 Business email

0004 Workshop

0005 Customer Request

SAP Hybris Cloud for Customer Data Workbench User GuideData Workbench User Guide P U B L I C 9

RememberIt is recommended to use any notepad application to modify the CSV data file before importing in Data Workbench tool. This would avoid any format changes to the CSV data file.

When using any excel application to modify the CSV data file, make sure to import the .csv file using UTF-8 character encoding.

1.2 Import Data into SAP Hybris Cloud for Customer

Import Data for Individual Objects [page 10]

(Beta) Import Data for Complete Business Object [page 17]

Import Attachments into SAP Hybris Cloud for Customer [page 20]

1.2.1 Import Data for Individual Objects

Key User: Import Data into SAP Hybris Cloud for Customer [page 10]

Business User: Import Data into SAP Hybris Cloud for Customer [page 15]

1.2.1.1 Key User: Import Data into SAP Hybris Cloud for Customer

Overview

Only key users or someone with administrator authorization can perform activities explained in this chapter.

To create a data mapping template, refer to the section Mapping Template Management in this document.

Once you have cleansed the data, you can spontaneously import that data at any point in time, into SAP Hybris Cloud for Customer If you or any other user in your organization is going to import data for the same object later, you can save the mapping in the form of a template. Mapping template can be created from Templates workcenter view.

Templates store the mapping information between the columns of a CSV file and the corresponding fields of an object (node) in SAP Hybris Cloud for Customer. Once you define the mapping in a template, the template can be

10 P U B L I CSAP Hybris Cloud for Customer Data Workbench User Guide

Data Workbench User Guide

used by any SAP Hybris Cloud for Customer user to import data anytime. This ensures consistency in mapping across all users.

NoteTemplates are typically created by a key user or by someone who has a business understanding of the fields that needs to be mapped between systems.

Prerequisites

● You know the name of the object (node) in SAP Hybris Cloud for Customer● You have a CSV file for the corresponding object (node)

Procedure

1. Logon to SAP Hybris Cloud for Customer as a system administrator.2. Go to Data Workbench work center, and choose Import.3. Click Import Data.4. You can choose to import data with or without a template.

Table 11:

If You You Can Description

Select a template and Download the template details into a CSV file by clicking Download CSV file

This file can be used, for example, to check if you have maintained your data in the right format.

Select a template and Turn on Review Mapping before Import You can:○ Review the field and code list map­

ping maintained in the template.○ Update the mappings and your

changes into the template.

Select an object Download the object details into a CSV file by clicking Download CSV file

This file can be used, for example, to check if you have maintained your data in the right format.

5. If you have connected the SAP Hybris Cloud for Customer system with an external system, and would like to maintain the external ID of this objects in the imported data, you can select the Business System ID of that system.

NoteThis ID represents the system that contains the external key to internal key mapping. If this ID mapping does not exist in the SAP Hybris Cloud for Customer system, then data will not be imported.

SAP Hybris Cloud for Customer Data Workbench User GuideData Workbench User Guide P U B L I C 11

If you select a business system ID, then you must have a new column named ExternalKey in the CSV file with the external ID of each of the records. If the external key does not exist for the imported data, then a new ID mapping will be generated.

6. Click Next.7. Select a CSV file for which the data is to be imported for the corresponding object or template. The column

headings and data in this CSV file should be according to the object or template. The supported CSV delimiters are Comma (,), Tab ( ), Colon (:), Pipe (|), Semi-Colon (;) and Caret (^).

8. Click Upload, and then either select format validation for “Sample Data” or for “All Data” and then click Next. Format validation check reports any format errors in the review step before importing data in SAP Hybris Cloud for Customer.

9. The next steps depends on your previous selection.

Table 12:

If you Had Action

Selected an object Using drag and drop feature, manually map the fields in the CSV file to the appropriate fields in SAP Hybris Cloud for Customer.

TipTo delete a mapping, click on the mapping line, and press Del key

Selected a template and turned ON Review Mapping before Import

Review the Existing Mapping: Using drag and drop feature, update any mapping of the fields in the CSV file to the ap­propriate fields in SAP Hybris Cloud for Customer.

Selected a template and turned ON Review Mapping before Import

Maintain Code List Mapping: All the code lists applicable for the mapped fields in the selected object will be dis­played.1. Select a code list. This code list can have multiple val­

ues. For example, Salutation code list can have Mr., Ms., Dr. and Prof.

2. Maintain the code list mapping between the code list values in SAP Hybris Cloud for Customer (internal) and the code values maintained in the CSV file (external).

3. For all the values in the CSV file for which there is no code list value in SAP Hybris Cloud for Customer, you may also maintain a default mapping.

4. Repeat the steps for each of the code lists.5. You may also save this code list mapping as a template

for future use.6. Code list mapping can also be maintained by down­

loading a template CSV file, maintain the mapping & upload the updated template back.

12 P U B L I CSAP Hybris Cloud for Customer Data Workbench User Guide

Data Workbench User Guide

If you Had Action

Selected a template and turned OFF Review Mapping before Import

Click Next, and review the summary.

10. Review the summary.11. To import data in the CSV file into SAP Hybris Cloud for Customer, click Import.

Result

If you had:

● Imported data from the CSV file: The system displays a message on the status of the import. You can check the status and any errors, in the Monitor view.

Related Information

Mapping Template Management [page 25]

1.2.1.1.1 Data Simulation

Overview

Before importing data into SAP Hybris Cloud for Customer, you can import the data in simulation mode to get the processing errors. Data imported in simulation mode will not be saved into SAP Hybris Cloud for Customer.

Procedure

1. 1. Go to Data Workbench work center, and choose either Import or Import Attachment or Update from the Import work center view.

2. Switch ON the Simulation Mode.3. Select the object/template for which you want to import data.4. Click Next.5. Browse for the CSV data file/ZIP file you want to upload.6. Click Upload, and then click Next.

SAP Hybris Cloud for Customer Data Workbench User GuideData Workbench User Guide P U B L I C 13

7. Review the summary of your selection.8. Click Simulate.

Result

The system displays a message on the status of the data simulation. You can go to the Monitor view, and check the status of your data simulation. Any processing errors during simulation can be downloaded by clicking on error count link.

NoteIn Simulation Mode, data is not created into SAP Hybris Cloud for Customer.

1.2.1.1.2 Initial Load

Overview

Data can be migrated into SAP Hybris Cloud for Customer in Initial Load mode so that applications react differently, for example by relaxing checks/update number ranges etc. By default, the Initial Load switch is set to ON, which sets the migration context during data import.

Procedure

1. Go toData Workbench work center and choose either Individual Objects / (Beta) Complete Business Objects from the Import work center view.

2. By default the Initial Load switch is set to ON.3. Select the object/template for which you want to import data.4. Click Next.5. Browse for the CSV data file/ZIP file you want to upload.6. Click Upload, and then click Next.7. Review the summary of your selection.8. Click Import.

14 P U B L I CSAP Hybris Cloud for Customer Data Workbench User Guide

Data Workbench User Guide

Result

The system displays a message on the status of the data import. You can go to the Monitor view, and check the status of your data simulation. Any processing errors during import can be downloaded by clicking on error count link.

1.2.1.2 Business User: Import Data into SAP Hybris Cloud for Customer

Overview

You can import data of the following into SAP Hybris Cloud for Customer:

● Standard business object● Extended fields of a standard business object● Custom business object

When you import data, new records are created in SAP Hybris Cloud for Customer. If the record exists, then the data in the existing record is updated.

Prerequisites

You have:

● Completed all the activities listed in the Basic Checklist section in this chapter.● The name of the template for the object (node) that you want to import data.● The sequence in which the nodes of an object should be imported into SAP Hybris Cloud for Customer● The CSV file with the required data.

NoteThe fields in this CSV file should be in the same order as in the CSV file that was used for the template

Procedure

1. Logon to SAP Hybris Cloud for Customer as a business user.2. Go to Data Workbench work center, and choose Import.3. Choose Import Data.

SAP Hybris Cloud for Customer Data Workbench User GuideData Workbench User Guide P U B L I C 15

4. Select the required template.

NoteYou can also download the template into a CSV file by clicking Download CSV file. This file can be used, for example, as a template to check if you have maintained your data in the right format.

5. Click Next. Browse for the CSV file you want to upload. The supported CSV delimiters are Comma (,), Tab ( ), Colon (:), Pipe (|), Semi-Colon (;) and Caret (^).

6. Click Upload, and then either select format validation for “Sample Data” or for “All Data” and then click Next. Format validation check reports any format errors in the review step before importing data in SAP Hybris Cloud for Customer.

7. Click Import. The system displays a message on the status of the import. You can go to the Monitor view, and check the status of your import.

1.2.1.2.1 Data Simulation

Overview

Before importing data into SAP Hybris Cloud for Customer, you can import the data in simulation mode to get the processing errors. Data imported in simulation mode will not be saved into SAP Hybris Cloud for Customer.

Procedure

1. 1. Go to Data Workbench work center, and choose either Import or Import Attachment or Update from the Import work center view.

2. Switch ON the Simulation Mode.3. Select the object/template for which you want to import data.4. Click Next.5. Browse for the CSV data file/ZIP file you want to upload.6. Click Upload, and then click Next.7. Review the summary of your selection.8. Click Simulate.

Result

The system displays a message on the status of the data simulation. You can go to the Monitor view, and check the status of your data simulation. Any processing errors during simulation can be downloaded by clicking on error count link.

16 P U B L I CSAP Hybris Cloud for Customer Data Workbench User Guide

Data Workbench User Guide

NoteIn Simulation Mode, data is not created into SAP Hybris Cloud for Customer.

1.2.2 (Beta) Import Data for Complete Business Object

Overview

You can update data of the following from SAP Hybris Cloud for Customer:

● Standard business object● Custom business object

Prerequisites

You have performed the following steps:

1. Go to Data Workbench work center, and choose Import.2. Select radio selection (Beta) Complete Business Objects.3. Select the object for which you want to import data.4. Click on Download CSV File Template to download a zip file which contains template CSV files. The user

should maintain the data to be imported in the CSV files corresponding to objects.5. Click on Download Field Definitions to download a zip file with field definitions of the selected object & sub-

objects.

Procedure

1. Go to Data Workbench work center, and choose Import.2. Select radio selection (Beta) Complete Business Objects.3. Select the object for which you want to import data.

TipOnly root nodes are listed.

4. Click Next.5. Browse for the *.zip data file you want to upload.

SAP Hybris Cloud for Customer Data Workbench User GuideData Workbench User Guide P U B L I C 17

NoteThe ZIP file size is limited to 10MB.

6. Click Upload, and then either select format validation for “Sample Data” or for “All Data” and then click Next. Format validation check reports any format errors in the review step before importing data in SAP Hybris Cloud for Customer.

7. Review the summary of your selection.8. Click Next.9. Maintain code list mappings by mapping code values maintained in data file with code values in the system.

All the code list properties applicable for the selected object will be displayed.○ Select a code list. This code list can have multiple values. For example, Salutation code list can have Mr.,

Ms., Dr. and Prof.○ Maintain the code list mapping between the code list values in SAP Hybris Cloud for Customer (internal)

and the code values maintained in the CSV file (external).○ For all the values in the CSV file for which there is no code list value in SAP Hybris Cloud for Customer,

you may also maintain a default mapping.○ Repeat the steps for each of the code lists.○ You may also save this code list mapping as a template for future use. Code list mapping can also be done

by downloading a template CSV file, maintain the mapping & upload the updated template back.10. Click Next.11. Review and click Import.

The system displays a message on the status of the import. You can go to the Monitor view, and check the status of your import.

NoteOnce the business object is successfully imported, the same business object cannot be reimported. Updates to the business object can then be made done using Import Data for Individual Objects.

Related Information

Export Data from SAP Hybris Cloud for Customer [page 23]

1.2.2.1 Data Simulation

Overview

Before importing data into SAP Hybris Cloud for Customer, you can import the data in simulation mode to get the processing errors. Data imported in simulation mode will not be saved into SAP Hybris Cloud for Customer.

18 P U B L I CSAP Hybris Cloud for Customer Data Workbench User Guide

Data Workbench User Guide

Procedure

1. 1. Go to Data Workbench work center, and choose either Import or Import Attachment or Update from the Import work center view.

2. Switch ON the Simulation Mode.3. Select the object/template for which you want to import data.4. Click Next.5. Browse for the CSV data file/ZIP file you want to upload.6. Click Upload, and then click Next.7. Review the summary of your selection.8. Click Simulate.

Result

The system displays a message on the status of the data simulation. You can go to the Monitor view, and check the status of your data simulation. Any processing errors during simulation can be downloaded by clicking on error count link.

NoteIn Simulation Mode, data is not created into SAP Hybris Cloud for Customer.

1.2.2.2 Initial Load

Overview

Data can be migrated into SAP Hybris Cloud for Customer in Initial Load mode so that applications react differently, for example by relaxing checks/update number ranges etc. By default, the Initial Load switch is set to ON, which sets the migration context during data import.

Procedure

1. Go to Data Workbench work center and choose either Individual Objects / (Beta) Complete Business Objects from the Import work center view.

2. By default the Initial Load switch is set to ON.3. Select the object/template for which you want to import data.4. Click Next.

SAP Hybris Cloud for Customer Data Workbench User GuideData Workbench User Guide P U B L I C 19

5. Browse for the CSV data file/ZIP file you want to upload.6. Click Upload, and then click Next.7. Review the summary of your selection.8. Click Import.

Result

The system displays a message on the status of the data import. You can go to the Monitor view, and check the status of your data simulation. Any processing errors during import can be downloaded by clicking on error count link.

1.2.3 Import Attachments into SAP Hybris Cloud for Customer

Overview

You can import attachments of an object into SAP Hybris Cloud for Customer.

Prerequisites

● You know the name of the object in SAP Hybris Cloud for Customer for which you are importing attachments● You have consolidated all the attachments of an object in an archive file (for example, .ZIP, .RAR) format.

Each archive file should contain a manifest file along with the attachments. You can also download the manifest file for a selected object. The data that should be entered are:○ External key of the object (node) for which you are importing attachment○ Internal ID of the object (node) for which you are importing attachment

NoteIf both External key and Internal ID are entered, the External key will be ignored during attachment import.

○ Type code defined for an attachment type○ Name of the attachment○ Mime type or the media type of the attachment, say, text/html○ Path from the root within the archive file

Example:If you are importing the attachments of a corporate account, and the attachments are all placed in the root folder, then the manifest file looks like the following:

20 P U B L I CSAP Hybris Cloud for Customer Data Workbench User Guide

Data Workbench User Guide

Table 13:

CorporateAccoun­tExternalKey

CorporateAccoun­tInternalID

TypeCode AttachmentName MimeType Path

SAP_43091 1000940 10001 Report application/msword

Rep_CA.doc

SAP_43092 1001240 10001 Analysis_Chart image/png Chart.png

TipEnsure that the name of the manifest file is always the following: manifest.csv. It is case sensitive.

Procedure

1. Logon to SAP Hybris Cloud for Customer.2. Go to Data Workbench work center, and choose Import.3. To import attachments of an object, choose Import Attachment.4. If you have connected the SAP Hybris Cloud for Customer system with an external system, and would like to

maintain the external ID of this objects in the imported data, you can select the Business System ID of that system.

NoteThis ID represents the system that contains the external key to internal key mapping. If this ID mapping does not exist in the SAP Hybris Cloud for Customer , then data will not be imported. If you select a business system ID, then you must have a new column named ExternalKey in the CSV file with the external ID of each of the records. If the external key does not exist for the imported data, then a new ID mapping will be generated.

5. Select the object to which you want to import attachments, and click Next6. Browse for the archive file, click Upload, and click Next.

NoteThe ZIP file size is limited to 100MB and the individual attachment file size is limited to 10MB.

7. Review the data and click Import. The system displays a message on the status of the import. You can go to the Monitor view, and check the status of your import.

The system displays a message on the status of the import. You can go to the Monitor view, and check the status of your import.

SAP Hybris Cloud for Customer Data Workbench User GuideData Workbench User Guide P U B L I C 21

1.2.3.1 Data Simulation

Overview

Before importing data into SAP Hybris Cloud for Customer, you can import the data in simulation mode to get the processing errors. Data imported in simulation mode will not be saved into SAP Hybris Cloud for Customer.

Procedure

1. 1. Go to Data Workbench work center, and choose either Import or Import Attachment or Update from the Import work center view.

2. Switch ON the Simulation Mode.3. Select the object/template for which you want to import data.4. Click Next.5. Browse for the CSV data file/ZIP file you want to upload.6. Click Upload, and then click Next.7. Review the summary of your selection.8. Click Simulate.

Result

The system displays a message on the status of the data simulation. You can go to the Monitor view, and check the status of your data simulation. Any processing errors during simulation can be downloaded by clicking on error count link.

NoteIn Simulation Mode, data is not created into SAP Hybris Cloud for Customer.

22 P U B L I CSAP Hybris Cloud for Customer Data Workbench User Guide

Data Workbench User Guide

1.3 Export Data from SAP Hybris Cloud for Customer

Overview

You can export data of the following from SAP Hybris Cloud for Customer:

● Standard business object● Custom business object

Procedure

1. 1. Go to Data Workbench work center, and choose Export.2. Select the object for which you want to export data. For example, if you want to export all activities, select

Activities.3. To export all data of an object, choose All Data.4. To specify a criteria and export a subset of data, choose Select Data. You can add multiple criteria on various

fields. For example, you may want to export only those accounts whose role is set as a prospect.5. Click Next, and review the summary of your selection.6. Click Export Data. The system displays a message indicating that the process has been initiated.

You can view the status of data export in the Monitor view. Once the status is set to Completed, click on the .CSV file under File Name column, to view the exported data file.

1.4 Update Data in SAP Hybris Cloud for Customer

Overview

You can update data of the following from SAP Hybris Cloud for Customer:

● Standard business object● Custom business object

SAP Hybris Cloud for Customer Data Workbench User GuideData Workbench User Guide P U B L I C 23

Prerequisites

You have done the following:

● Exported data using Data Workbench into a CSV file● Updated the data in the CSV file, and followed these guidelines:

Table 14:

If you want to do this in SAP Hybris Cloud for Customer Ensure you have maintained this in the CSV file

Create an entry Leave the Object ID column empty

Update an entry

Procedure

1. Go to Data Workbench work center, and choose Update.2. Select the object for which you want to update data.3. Click Next. Browse for the CSV file you want to upload.4. Click Upload, and then either select format validation for “Sample Data” or for “All Data” and then click Next.

Format validation check reports any format errors in the review step before importing data in SAP Hybris Cloud for Customer.

5. Review the summary of your selection.6. Click Update.The system displays a message on the status of the import. You can go to the Monitor view, and

check the status of your import.

Note○ To delete a record in SAP Hybris Cloud for Customer system, add an additional header ToBeDeleted at

end of the exported CSV data file, and mark the records to be deleted as True.○ If any record is added in the exported CSV data file, for which ObjectID is empty, will be created in SAP

Hybris Cloud for Customer system.

1.4.1 Data Simulation

Overview

Before importing data into SAP Hybris Cloud for Customer, you can import the data in simulation mode to get the processing errors. Data imported in simulation mode will not be saved into SAP Hybris Cloud for Customer.

24 P U B L I CSAP Hybris Cloud for Customer Data Workbench User Guide

Data Workbench User Guide

Procedure

1. 1. Go to Data Workbench work center, and choose either Import or Import Attachment or Update from the Import work center view.

2. Switch ON the Simulation Mode.3. Select the object/template for which you want to import data.4. Click Next.5. Browse for the CSV data file/ZIP file you want to upload.6. Click Upload, and then click Next.7. Review the summary of your selection.8. Click Simulate.

Result

The system displays a message on the status of the data simulation. You can go to the Monitor view, and check the status of your data simulation. Any processing errors during simulation can be downloaded by clicking on error count link.

NoteIn Simulation Mode, data is not created into SAP Hybris Cloud for Customer.

1.5 Mapping Template Management

Overview

Templates store the mapping information between the headers of a CSV file and the corresponding fields of an object (node) in SAP Hybris Cloud for Customer. Once you define the mapping in a template, the template can be used by any SAP Hybris Cloud for Customer user to import data anytime. This ensures consistency in mapping across all users.

SAP Hybris Cloud for Customer Data Workbench User GuideData Workbench User Guide P U B L I C 25

Create Template

Procedure

1. Go to Data Workbench work center, and choose Templates.2. Select Create button.3. Select Business System ID (Optional).4. Select an Object.5. Click Next.6. Browse & Upload a CSV(Comma Delimited) File.7. Click Next.8. Maintain the data mapping and click Next.9. Maintain code list mapping, if any code list property is mapped in data mapping step.10. Select a template name & select Create.11. The template is available in list of templates.

Update Template

Procedure

1. Go to Data Workbench work center, and choose Templates.2. Select hyperlink on the template name for which template to be updated.3. Select Business System ID (Optional).4. Browse & Upload a CSV(Comma Delimited) File.5. Click Next.6. Maintain the data mapping and click Next.7. Maintain code list mapping, if any code list property is mapped in data mapping step.8. Select Update.

The updated template is now available in list of templates.

Copy Template

Procedure

1. Go to Data Workbench work center, and choose Templates.2. Select the template to be copied.3. Select More to open a menu option and select Copy.4. Enter template name and select Copy.

The copied template is available in list of templates.

26 P U B L I CSAP Hybris Cloud for Customer Data Workbench User Guide

Data Workbench User Guide

Delete Template

Procedure

1. Go to Data Workbench work center, and choose Templates.2. Select the template to be deleted.3. Select More to open a menu option and select Delete.4. Confirm the deletion.

The deleted template will be removed from list of templates.

Template usage across SAP Hybris Cloud for Customer tenants

Overview

In order to use a template across SAP Hybris Cloud for Customer tenants, the template should first be downloaded from the source tenant in the client file system & the same file can then be uploaded in target tenants for reuse.

Procedure

1. Go to Data Workbench work center in the source tenant, and choose Templates.2. Select the template to be downloaded.3. Select More to open a menu option and select Download.4. Save the .dwbtmpl file in client file system.

NoteIf the file is tampered, it will be unusable.

5. Go to Data Workbench work center in the target tenant, and choose Templates.6. Select More to open a menu option and select Upload.7. Browse the .dwbtmpl file from client file system and enter template name.8. Select Upload.

The uploaded template will be available in list of templates in the target tenant.

SAP Hybris Cloud for Customer Data Workbench User GuideData Workbench User Guide P U B L I C 27

1.6 Template Usage Across SAP Hybris Cloud for Customer Tenants

In order to use a template across SAP Hybris Cloud for Customer tenants, the template should first be downloaded from the source tenant in the client file system and the same file can then be uploaded in target tenants for reuse.

Procedure

1. Go to Data Workbench work center in the source tenant, and choose Templates.2. Select the template to be downloaded3. Select More button to open a menu option and select Download .4. Save the .dwbtmpl file in client file system.

NoteThe file will be unusable if it is tampered.

5. Now, go to Data Workbench work center in the target tenant, and choose Templates.6. Select the More button to open a menu option and select Upload.7. Browse the .dwbtmpl file from client file system and enter a name for the template.8. Select Upload.

NoteYou will find the uploaded template in the list of templates in the target tenant

28 P U B L I CSAP Hybris Cloud for Customer Data Workbench User Guide

Data Workbench User Guide

2 Object Documentation

Deal Registration [page 29]

Maintenance Plan [page 32]

Attributes [page 36]

Installed Base [page 41]

Measurement Point [page 44]

2.1 Deal Registration

Business Overview

Deal registration is a feature of some vendors' channel programs in which a channel partner, often a VAR (value-added reseller) or SI (systems integrator), informs the vendor about a lead and is given priority for it. Once a lead is registered with a vendor, the partner usually has a set period of time to close the deal. During this time other channel members, or even the vendor's own sales team, are not allowed to negotiate a similar deal with that lead.

The lifecycle followed by such a deal is Draft In Review Accepted/Rejected Converted . A deal is always associated with an Account and has a Partner and Partner Contact assigned to Deal. One can process a Deal only if it has products, an accepted Deal can then be converted to Opportunity.

This release supports the import of the Root/Header data, Products, Party and BTD Reference using separate csv files. Currently the import of the Deal is supported only for existing Accounts. The Accounts, Products, Party and Questions are identified using the internal keys (Already exists in the target System). However the user can import new deals using the External IDs of their legacy system.

Prerequisites

Before you load your Deal Registrations to SAP Hybris Cloud for Customer using Data Workbench, check if you have:

● Carried out all the checks outlined in the Basic Checklist.● Scoped deal registration, and maintained all relevant fine tuning activities in SAP Hybris Cloud for Customer.● Custom questions, and if so they are maintained in the target system.● Maintained master data in target system for product, business partner, and organization data.

SAP Hybris Cloud for Customer Data Workbench User GuideObject Documentation P U B L I C 29

● Maintained all relevant referenced documents like opportunity and campaign in the target system.

Dependency

Dependency with Other Objects

● Account: The deal creation using this import is supported with active accounts.● Products: An active deal should always have products assigned to it.● Party: The party being assigned to a deal should be existing in the system.● Questions: Questions should already be maintained in Business Configuration.● Linked Documents: For example, opportunities for the imported deals should already exist in the system.

Posting InstructionsDependency within the Object

● For deals to exist in any status other than Draft status, product assignment is mandatory.● In order to import the follow-up documents for a deal (represented by entity DealBTDRef), the deal should

be in status Converted.● Keeping the above points in mind, the import should be done in the following sequence :

1. DealRegistration2. DealItem3. DealRegistration: Upsert for changing the status4. Party5. Question6. DealBTDref

Tasks

● Ensure that you load the data of the nodes in the sequence as outlined in the Dependency section in this topic.

● The start/end date/time is entered in the following format: ‘2015-01-09’

Field Information

Following is the entity-wise field information expected in the CSVs (ones marked with* are mandatory)

30 P U B L I CSAP Hybris Cloud for Customer Data Workbench User Guide

Object Documentation

Follow-On Activities

Once you load contracts, you should see the following success message: Objects loaded successfully. If you see any errors or warnings, refer to the chapter on Support Incidents.

Table 15: Deal Registration

Field Description

ExternalKey* The key of Deal in the legacy system

DealName* Name of the Deal

StartDate* Format ‘yyyy-mm-dd’

EndDate* Format ‘yyyy-mm-dd’

AccountID* Internal ID already in target system

CampaignID CampaignID already in target system

EngagementType

TotalValueAmount*

TotalValueCurrencyCode*

UserStatusCode Defaulted to status : ‘Draft’

Table 16: Deal Item

Field Description

DealRegistrationExternalKey* Same key provided as ‘ExternalKey ‘ in CSV for entity ‘DealRe­gistration’

ProductID* Internal ID in target system

ProductQuantity*

ProductQuantityUnitCode*

Table 17: Party

Field Description

DealRegistrationExternalKey* Same key provided as ‘ExternalKey ‘ in CSV for entity ‘DealRe­gistration’

PartyID* Internal ID in target system

RoleCode*

SAP Hybris Cloud for Customer Data Workbench User GuideObject Documentation P U B L I C 31

Table 18: Question

Field Description

DealRegistrationExternalKey* Same key provided as ‘ExternalKey ‘ in CSV for entity ‘DealRe­gistration’

QID* As maintained in Business Configuration work center.

Should be mapped to ‘ExternalKey’ of the entity ‘Question’

AnswerCode*

AnswerDescription

Table 19: DealBTDRef

Field Description

DealRegistrationExternalKey* Same key provided as ‘ExternalKey ‘ in CSV for entity ‘DealRe­gistration’

ID* ID*

CautionThe column headers should be not contain spaces.

2.2 Maintenance Plan

Business Overview

Maintenance Plan is a new feature in SAP Hybris Cloud for Customer (available from 1508 release). It helps the service organization execute preventive maintenance scenarios, by automatically creating work tickets based on the maintenance schedule.

A maintenance plan is created by combining the following:

● Schedule Conditions: They are determined based on a counter, time period, and a combination of a counter and a time period.

● Schedule Types: Supported types are Cyclical, Fixed, and One Time

A maintenance plan lifecycle sprints from In Preparation Active Complete . Once a maintenance plan is activated, the plan definitions inside a plan cannot be changed.

32 P U B L I CSAP Hybris Cloud for Customer Data Workbench User Guide

Object Documentation

Prerequisites

Before you load your maintenance plans to SAP Hybris Cloud for Customer using Data Workbench, you have:

● Carried out all the checks outlined in the Basic Checklist.● Loaded relevant data of all the objects as listed in the Dependency section

Dependency

Table 20: Dependency with Other Objects

Object Description

Registered Product Registered products are added as maintenance Items in the maintenance plan

Contracts Contracts can be associated to a maintenance item in the maintenance plan

Product List Product list can be assigned to a maintenance plan

Table 21: Dependency within the Object (Import to be done in the Specified Sequence)

Node Description

Root & Service Ticket Info MaintenancePlan

Covered Objects MaintenancePlanCoveredObjects

Tasks

1. Ensure that you load the data of the nodes in the sequence as outlined in the Dependency section. In other words, import the CSV files in this order: Maintenance Plan (Root & Service Ticket Info) Covered Objects . For information on how to import objects to SAP Hybris Cloud for Customer, see the Data Workbench user guide.

2. For covered objects, the InstallationPoint internal ID in SAP Hybris Cloud for Customer has to be entered in the field InstallationPointID in the CSV file.

SAP Hybris Cloud for Customer Data Workbench User GuideObject Documentation P U B L I C 33

Field Information

Table 22: Maintenance Plan

Field Description

ScheduleType Mandatory field. Can have the following values:

● 01 – Cyclical● 02 – One Time● 04 – Fixed values● 05 – One Time – No Conditions

ScheduleCondition Mandatory field. Can have the following values:

● 01 – Time Based● 02 – Counter Based● 03 – Time and Counter based

Name Mandatory field

MDRORunID Maintenance Plan Run ID

Subject Used while creating the work ticket (Service Request).

DocumentType Used to create the work ticket Example: SRRQ

PreventCreateMultipleTickets No additional work tickets are generated for a Maintenance Plan if there are any existing open or in-process tickets for a maintained item. Can have the following values: true, false

AppendObjectNameToSubject Can have the following values: true, false If the value is true, this means appends Registered Product name to the Subject of work ticket.

CauseCategoryID Used while creating the work ticket. Cause Category of the work ticket.

IncidentCategoryID Used while creating the work ticket. Incident Category of the work ticket.

ObjectCategoryID Used while creating the work ticket. Object Category of the work ticket.

ServiceIssueCategoryID Used while creating the work ticket. Service Issue Category of the work ticket.

34 P U B L I CSAP Hybris Cloud for Customer Data Workbench User Guide

Object Documentation

Field Description

PriorityCode Used while creating the work ticket. Can have the following values:

1 – Immediate

2 – Urgent

3 – Normal

4 – Low

ProductListID Used while creating the work ticket. In the work ticket created, the items will get populated from the product/s maintained from the Product List selected.

ConsiderContractStatus Used while creating the work ticket. In the work ticket created, the Requested Start Date will be calculated based on the rela­tive duration maintained in this field.

Can have the following values in SetRequestedStartDateUnit:

- Days

- Month

Eg: 2 Days

If a ticket is created from the plan on 10th December, the Re­quested Start Date in the ticket will be 12th December, 2 days from ticket creation date.

SetRequestedEndDate & SetRequestedEndDateUnit Used while creating the work ticket. In the work ticket created, the Requested End Date will be calculated based on the rela­tive duration maintained in this field. Can have the following values in SetRequestedEndDateUnit:

- Days

- Month

For Example:

SetRequestedStartDate : 2 Days

SetRequestedEndDate: 5 Days

If a ticket is created from the plan on 10th December, the Re­quested Start Date in the ticket will be 12th December. Re­quested End Date will be 17th Dec, 5 days from Requested Start Date.

SAP Hybris Cloud for Customer Data Workbench User GuideObject Documentation P U B L I C 35

Field Description

Status Maintenance Plan Life Cycle status. Can have the following values:

1 – In Preparation (default status)

2 – Active

3 – Blocked

4 – Complete

Table 23: MaintenancePlanCoveredObjects

Field Description

InstallationPointID Mandatory field - InstallationPoint Internal ID in SAP Hybris Cloud for Customer

ContractID Contract Internal ID in SAP Hybris Cloud for Customer

Table 24: MaintenancePlanTextCollection

Field Description

TypeCode Text collection type code.

Default Value : 10011

Text Text Content

Follow-On Activities

Once you load this Maintenance Plan, you should see the following success message: “Successfully Submitted". If you see any errors or warnings, refer to Support Incidents.

2.3 Attributes

Attributes are associated to master data objects like accounts and contacts. They allow users to define and maintain attributes or attribute values for master data. They are similar to Attributes in SAP CRM.

There are two parts to maintaining Attributes:

1. Create and maintain a definition. This involves creating Attributes and attribute sets:1. Attributes have an ID and description along with a representation format such as character, numeric,

date, time, or currency. It is also possible to maintain characteristics for an Attribute such as mandatory, multivalued, negative value allowed, interval allowed, and so on. Attributes could also have a value list, which appears as a dropdown.

36 P U B L I CSAP Hybris Cloud for Customer Data Workbench User Guide

Object Documentation

2. Attribute sets are groups of attributes. Attribute sets have an ID, description, and associated attributes.3. Assign ttributes to an attribute set.

2. Associate created attributes set to master data objects and maintain values for these attributes.

Prerequisites

Before you upload your Attributes to SAP Hybris Cloud for Customer using the data workbench, you must:

● Carry out all the checks outlined in the Basic Checklist section of the Data Workbench User Guide chapter in this document.

● Load relevant data of all the objects listed in the dependency section.

Dependency

Dependency with Other Objects

Table 25:

Object Description

Master Data If you would like to upload attribute assignments to master data objects like accounts or contacts, an active instance of these entities should exist.

Dependency within the Object

Table 26:

Business Object Node OData Description

BUSINESS_ATTRIBUTE Root

Description

Value List

Value List Description

BUSINESS_ATTRIBUTE_SET Root Attribute Set (BusinessAttri­buteSet)

Can be used to create new business attribute set with ID, description for default lan­guage

Description Attribute Set Description (BusinessAttributeSetDe­scription)

If description exists in more than one language

SAP Hybris Cloud for Customer Data Workbench User GuideObject Documentation P U B L I C 37

Business Object Node OData Description

Attribute Assignment Attribute Set Attribute As­signment (BusinessAttribute­SetAttributeAssignment)

Associate attributes created in earlier step to attribute sets

BUSINESS_ATTRIBUTE_AS­SIGNMENT

Root Attribute Assignment (Busi­nessAttributeAssignment)

Create a new assignment in­stance for a business partner ID

Item Attribute Assignment Item (BusinessAttributeAssign­mentItem)

Associate attributes and at­tribute sets to the assignment instance and maintain values for them.

Tasks

● Ensure that you load the data of the nodes in the sequence as outlined in the Dependency section.

● Upload the CSV files in the recommended order Business Attribute Business Attribute Set Business Attribute Assignment .

Field Information

Table 27:

OData Field Description

Attribute (BusinessAttribute) ID Unique ID of an attribute

Representation Format Code Define data type of attribute. Possible values :

Code - Description

CHAR Character Format

CURR Currency Format

DATE Date Format

NUM Numeric Format

TIME Time Format

Character Number Value If attribute has character format , then mention number of characters that are allowed

38 P U B L I CSAP Hybris Cloud for Customer Data Workbench User Guide

Object Documentation

OData Field Description

Decimal Number Value If attribute has numeric format , then mention number of values possible after decimal point

Life Cycle Status Code Status of the business attribute. Follow­ing are the possible values :

Table 28:

Code Descrip­tion

1 In Prepara­tion

2 Released

3 Locked

Mandatory Indicator Mandatory characteristic for attribute

Multivalue Indicator Multivalue characteristic for attribute. This allows users to maintain multiple values to the attribute when linked to an account or contact

Negative Allowed Indicator For numeric formats, allow negative value

Case Sensitive Indicator For characters formats, maintain case sensitivity

Interval Allowed Indicator Interval characteristic for attribute

Attribute Description (BusinessAttribu­teDescription)

Language Code Maintain language code, such as EN for English, DE for German, and so on.

Name Attribute description

Attribute Value List (BusinessAttribute­ValueList)

ID Value ID or code for the dropdown list

Default Indicator Indicates whether a particular value in dropdown is default

Attribute Value List Description (Busi­nessAttribute ValueListDescription)

Language Code Maintain language code, such as EN for English, DE for German, and so on.

Name Description for value in dropdown list

SAP Hybris Cloud for Customer Data Workbench User GuideObject Documentation P U B L I C 39

OData Field Description

Attribute Set (BusinessAttributeSet) ID Unique ID of an attribute set

Object Type Code Specifies the master data entity, which the attribute set, is linked to. Possible values :

147 : Business Partner

Organization Relevance Indicator Indicates if set is relevant for customer / account only

Person Relevance Indicator Indicates if set is relevant for contact only

Language Code Maintain language code, such as EN for English, DE for German, and so on.

Name Attribute Set description

Attribute Set Description (BusinessAttri­buteSetDescription)

Language Code Maintain language code, such as EN for English, DE for German, and so on.

Name Attribute set description

Attribute Set Attribute Assignment (BusinessAttributeSet AttributeAssign­ment)

Business Attribute ID Business attribute ID linked to the attrib­ute set

Attribute Assignment (BusinessAttribu­teAssignment)

Object Type Code Specifies the master data entity that the attribute set is linked to. Possible val­ues :

147 : Business Partner

Business Partner ID ID of business partner to which the at­tribute is associated

Attribute Assignment Item (BusinessAt­tributeAssignmentItem

Business Attribute ID Business attribute ID to be linked to business partner

Business Attribute Set ID Business attribute Set ID to be linked to business partner

Object Type Code Object type code from business attrib­ute set definition, such as 147 for busi­ness partner based attribute sets

Attribute Value Actual value for the attribute. If attribute was defined with value list , then value ID needs to be maintained

40 P U B L I CSAP Hybris Cloud for Customer Data Workbench User Guide

Object Documentation

Follow-On Activities

Once you load attributes, you should see the following success message: Objects loaded successfully.

For attribute definition, such as business attributes and business attribute sets, you can confirm uploaded entries under Administrator Sales & Marketing Settings Maintain Business Attribute / Maintain Business Attribute Sets .

For attributes assigned to business partner, such as business attribute assignment, you can confirm uploaded entries by checking customer or contact details page. If you see any errors or warnings, refer to the Troubleshooting section in the Data Workbench documentation

2.4 Installed Base

Business Overview

Data work bench for Installed Base is a new feature in SAP Hybris Cloud for Customer 1702 release. It helps the service organization mass create Installed Base, and also upload the existing ones at a header level.

Create

You can create an installed base header with a combination of steps in data work bench:

1. Select the installed base object2. Down load the meta data3. The meta data is the representation of the fields below4. Fill all the required fields in the meta data5. Upload the meta data file6. The installed base objects gets created

The created objects can be monitored in the Monitor tab, and the objects can be checked in the system once the success message shows up in this tab.

Using the data work bench, you can only create the installed base header; not any items.

Update

We can update the installed base fields by downloading the meta data. The fields can be updated in the downloaded meta data file. This file has to be uploaded back into the system as we did for the create scenario.

SAP Hybris Cloud for Customer Data Workbench User GuideObject Documentation P U B L I C 41

Exporting the field is entity based, and we have to be specific about the installed base we need to export. The updated fields will display in the system.

Ensure that fields provided in meta data file are used in create and update scenario for installed base.

Table 29: Field Information

Field Description

ID Installed Base ID. Auto generated. Can also be entered man­ually.

SalesTerritoryID Gets determined based on Customer assigned to IBase, if no value provided by the user.

ServiceTerritoryID Gets determined based on Customer assigned to IBase, if no value provided by the user.

Address:

● CountryCode● CountyName● CityName● AdditionalCityName● DistrictName● StreetPostalCode● AdditionalStreetPrefixName● AdditionalStreetSuffixName● StreetName● HouseID● FloorID● RoomID● BuildingID● RegionCode● StreetPrefixName● StreetSuffixName●

Address for Installed Base. Address is copied from customer assigned to IBase. Address gets updated on change of cus­tomer information.

If user provides the address manually, then that address takes precedence.

Status Life cycle status of Installed Base. Default: In Preparation.

42 P U B L I CSAP Hybris Cloud for Customer Data Workbench User Guide

Object Documentation

Field Description

Standard Parties:

● CustomerPartyID● CustomerMainContactPartyID● ShipToPartyID● ShipToMainContactPartyID● EmployeeResponsiblePartyID● ServiceTechnicianPartyID● ServiceTeamPartyID● OwnerPartyID● PayerPartyID● PayerMainContactPartyID● OwnerMainContactPartyID● BillToPartyID● BillToMainContactPartyID

CustomerPartyID(Customer) is mandatory field.

CustomerMainContactPartyID(main contact party for Cus­tomer) gets determined from the Customer, if left blank.

Similarly, Main Contact get determined for ShipToParty, Own­erParty, PayerParty and BillToParty.

Table 30: InstalledBaseCompetitorProduct

Field Description

CompetitorProductID Competitor Product ID

InstalledBaseID Installed Base ID to which the Competitor Product is assigned

Table 31: InstalledBaseDescription

Field Description

Description Description of Installed Base. Mandatory field

LanguageCode Language code of description. By default it is EN

Table 32: InstalledBaseNotes

Field Description

Text Text(notes) content

LanguageCode Language code of text. By default it is EN

Table 33: Dependency with Other Objects

Object Description

Party Parties being assigned should exist in the system

Competitor Product Competitor Products already existing in the system can be as­signed to an Installed Base

SAP Hybris Cloud for Customer Data Workbench User GuideObject Documentation P U B L I C 43

NoteFor creating a new Installed Base, Import as Complete Business Object must be used.

2.5 Measurement Point

Business Overview

Data work bench for measurement point is a new feature in SAP Hybris Cloud for Customer 1702 release. It helps the service organization mass create Measurement Point, and also upload the existing measurement points at a header level.

Create

Measurement point header can be created in a combination of steps in the data work bench tab:

1. Select the object measurement from data work bench menu.2. Download the meta data.3. The meta data is the representation of the fields below.4. Fill in all required fields in the meta data.5. Upload the meta data file.6. The measurement points get created.

The above created objects can be monitored in the Monitor tab. The objects can be checked in the system once the success message shows up in the monitor tab.

Export

1. Click the Export tab.2. Select the measurement point from the drop down to select an object.3. Click next.4. Select the file.5. Click Upload.6. The file line items would appear in the screen7. The line items can be verified and uploaded.

44 P U B L I CSAP Hybris Cloud for Customer Data Workbench User Guide

Object Documentation

Monitor

1. Click the Monitor tab.2. Click the hyperlink to open the file and verify it.

Update

We can update the measurement point fields by downloading the meta data. The fields can be updated in the downloaded meta data file, which has to be uploaded back into the system (as we did in the create scenario).

Exporting the field is entity based, and have to specify which measurement point we need the export for.

The fields thus updated will be displayed in the system.

Tasks

Ensure the fields provided in the meta data file are used to create and update scenario for Installed Baase.

SERVICE NAME: measurementpoint

Field Information

Table 34: MeasurementPoint:

Field Description

ID Measurement Point ID (Auto generated if not provided)

MeasurementAttributeID Measurement Attribute ID (Mandatory)

InstallationPointID Intallation Point to which this Measurement Point is added (Mandatory)

Description Description for measurement point

Language Code Maintain language code, such as EN for English

Template Flag which indicates whether this Measurement Point is a template

SAP Hybris Cloud for Customer Data Workbench User GuideObject Documentation P U B L I C 45

Table 35: Dependency with Other Objects

Object Description

Installation Point/Registered Product

2.5.1 Measurement Reading

Business Overview

Data work bench for measurement reading is a new feature in SAP Hybris Cloud for Customer1702 release. It helps the service organization mass create values for a Measurement Point.

Create

Measurement reading can be created using a combination of steps in the data work bench tab:

1. Select the object measurement document from data work bench menu.2. Download the metadata.3. The meta data is the representation of the fields below.4. Fill all the required fields in the meta data.5. Upload the meta data file.6. The measurement points gets created.

These are the mandatory fields:

● Measured on● Measured value● Measurement Point ID

The objects, created above, can be monitored in the Monitor tab, and can be checked in the system once the success message shows up in the monitor tab.

Export

1. Click the Export tab.2. Select the measurement point from the drop down to select an object.3. Click next.4. Select the file.5. Click upload.

46 P U B L I CSAP Hybris Cloud for Customer Data Workbench User Guide

Object Documentation

6. The file line items will appear on your screen.7. Verify and upload the line items.

Monitor

Click the Monitor tab, then on the hyperlink to open and verify the file.

Update

Update the measurement reading fields by downloading the meta data. You can update the fields in the downloaded meta data file. This file has to be uploaded back into the system (as we did in the create scenario).

Exporting the field is entity based, and requires us to be specific about the measurement point we need the export for.

The fields thus updated will be displayed in the system.

Tasks

Ensure the provided fields in meta data file are used in create and update scenario for Installed Baase.

SERVICE NAME: measurementreading

Field Information

Table 36: MeasurementDocument

Field Description

ID Measurement reading ID (Auto generated if not provided)

MeasuredOn Measured Date Time. This will be defaulted to current time if not entered

MeasuredValue Measured reading (Mandatory)

MeasurementPointID Measurement Point to which this reading is added (Manda­tory)

Description Description for measurement reading

Language Code Description for measurement reading

SAP Hybris Cloud for Customer Data Workbench User GuideObject Documentation P U B L I C 47

Field Description

InstallationPointID Installation Point to which this Reading is added

Dependency with Other Objects

Table 37:

Object Description

Measurement Point

48 P U B L I CSAP Hybris Cloud for Customer Data Workbench User Guide

Object Documentation

3 Frequently Asked Questions

Why is it mandatory to select a template or an object? [page 49]

Can I map my ID key to the Internal ID key in SAP Hybris Cloud for Customer? [page 49]

Why am I unable to use a template for an extended business object? [page 49]

I imported data for an object but Unable to See Any Status in the Monitor view? [page 50]

Why do I see the error ‘Please upload a valid CSV file in the required format’? [page 50]

I have data in a spreadsheet. Any recommendation on how I should create a CSV file? [page 50]

Can I delete an existing task from the Monitor view? [page 51]

3.1 Why is it mandatory to select a template or an object?

The template or the object defines the data that is imported into SAP Hybris Cloud for Customer. For example, if you want to import customer data, then you either choose the Customer object or the Customer template. The system pre-validates the files with metadata check. For example, if you choose a Customer template and then choose an Order CSV file, you will receive an error, and will not be able to proceed with the import.

3.2 Can I map my ID key to the Internal ID key in SAP Hybris Cloud for Customer?

We recommend that you do not map any columns from the CSV file to internal ID key. If you have a use case where this might be necessary, please create a support incident with your use case.

3.3 Why am I unable to use a template for an extended business object?

There can be two situations where extensions have been made:

● You have added more fields to your CSV file. These fields may or may not be available in the standard object in SAP Hybris Cloud for Customer

● You have extended SAP’s standard business object with new fields.

SAP Hybris Cloud for Customer Data Workbench User GuideFrequently Asked Questions P U B L I C 49

In both these situations, you cannot use an existing template. If there are any changes to the fields on SAP Hybris Cloud for Customer or in the CSV files, you must create a new template along with all required mappings.

3.4 I imported data for an object but Unable to See Any Status in the Monitor view?

Ideally, you should see a success or failure status for each import. At times, there might be a delay. Wait for a few minutes, and then click Refresh in the Monitor view. If the status still does not appear, create a support incident.

3.5 Why do I see the error ‘Please upload a valid CSV file in the required format’?

This can happen, if the:

● Order of the fields in the CSV file does not match the order of the fields in the SAP Hybris Cloud for Customer object

● Field names have a space in the CSV file

Open the CSV file, check the order of the fields, and remove any spaces in the column headings, and retry importing data.

3.6 I have data in a spreadsheet. Any recommendation on how I should create a CSV file?

The key requirement is to have your data in CSV file with UTF-8 encoding. UTF-8 format ensures that files containing non-English characters and special characters are secured in its original form, and do not get converted into special characters.

Let us assume that you have your data in a Microsoft Excel spreadsheet. Save the spreadsheet in the Comma delimited CSV format, using File Save As menu option. Files are usually saved in ANSI format. To ensure that your CSV file is saved with UTF-8 encoding, follow the steps described in the Technical section under Basic Checklist (in the Data Workbench User Guide chapter).

50 P U B L I CSAP Hybris Cloud for Customer Data Workbench User Guide

Frequently Asked Questions

3.7 Can I delete an existing task from the Monitor view?

Tasks which are in Finished status, can be deleted from the Monitor view. To delete, select the task and click Remove.

SAP Hybris Cloud for Customer Data Workbench User GuideFrequently Asked Questions P U B L I C 51

4 Support Incidents

In case you receive an error and are unable to resolve it based on the information provided in this document, please raise an incident in SAP Hybris Cloud for Customer, under the component LOD-CRM-INT-DWB.

52 P U B L I CSAP Hybris Cloud for Customer Data Workbench User Guide

Support Incidents

Important Disclaimers and Legal Information

Coding SamplesAny 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.

AccessibilityThe 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 willful misconduct or gross negligence of SAP. Furthermore, this document does not result in any direct or indirect contractual obligations of SAP.

Gender-Neutral LanguageAs 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 HyperlinksThe 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).

SAP Hybris Cloud for Customer Data Workbench User GuideImportant Disclaimers and Legal Information P U B L I C 53

go.sap.com/registration/contact.html

© 2017 SAP SE or an SAP affiliate company. All rights reserved.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.