Data Exporter

Attention: SAP Field Service Management documentation is now available at the SAP Help Portal. On 31 December 2020, docs.coresystems will no longer be available. Until that time, documentation will NOT be updated in docs.coresystems.

In a Nutshell

The Data Exporter feature is used to export master data for the following data objects:

  • Business Partners
  • Contacts
  • Equipment
  • Items
  • People
  • People - Skills Assignment

This functionality allows you to export SAP Field Service Management master data for supported objects in order to backup data, store data in another data management system or use it in another tool, or for auditing/reporting purposes.

Additionally, the master data can be exported in order to perform master updates that are then imported back into SAP Field Service Management using the Data Loader tool.


Identifiers

Identifiers are the key, unique value for each data object record. They are used to form connections between various data object records.

For example, a Business Partner, Contact, Equipment record, and Activity could all be connected through the businessPartnerID with the the Business Partner. The businessPartnerID can be represented by the code or the name of the Business Partner.

Note: The objectId field which refers one object to another object always uses externalId as the identifier.

The following is a example of how equipmentId and businessPartnerId connect business partners, projects, equipment, and activities:




ID Logic

Import Logic

When uploading data, the id column of your data will be stored as the externalid in the database. The application assigns its own, internal ID to the records.

Attention: When an externalId is uploaded, it may only be comprised of alphanumeric characters, underscores or hyphens.


Export Logic

When exporting the data, the externalID is displayed as the id and the internal ID of the record is not exported.


Update vs Create New Logic

Please note the following differences between the identification logic used to determine a record match when updating a record, and how IDs are assigned when creating a new record:

Update Existing Record Create New Record
When updating an existing record, the cloudID, code, and externalId are checked by the application to determine if a match exists. When creating a new record, the ID from the uploaded file template will become the externalId value in the cloud.

User-defined Fields

You can expand on data object templates by adding user-defined columns to the file. Upon successful upload and validation, these values will be available for the selected data object type.

UDF column names use the following pattern:

udf.general_image[string]

With the user-defined field column name preceded by udf and a period (.) and followed by the data type in square brackets.


CSV Format

CSV stands for “comma-separated values”, and is a flat format commonly used to exchange tabular data between programs, as most programs support CSV format for data import and export. CSV-formatted data is commonly used to transfer information from database programs that stores data in a proprietary format to a spreadsheets that use another format.

The following is an example of CSV-formatted tabular data:


Columns without data are still reprsented with a comma-dileneated break, as seen in the missing dateOfBirth field in the last entry in the above image.

Rules for formatting data in CSV

  • Column order can differ from that contained in the template, but record data must remain consistent.
  • Column names must align with those present in the templates.
  • Rows with missing column data must use a comma-delimited break.
  • The Data Loader currently only supports column separation using comma.

Using these rules, we could then represent CSV-formatted data as follows:


This would then be processed the same as the data contained in the first image.


A Closer Look

The Data Exporter feature exports master data in CSV format. In additon to custom fields, supported data objects will consist of the following:


Business Partners


Field Description
additionalName The additional name for this business partner.
city The city of the main address of this businesspartner (used to search and display in list) -> may overlap with the default address city.
code System code of this object, normally this correlates to the erp id given by the source system.
country The country associated in which the main address of the Business Partner is located.
creditLimit.amount The credit limit of this businesspartner, specified as a monetary amount to be most precise and formattable.
creditLimit.currency The currency associated with the credit limit.
currency Currency of this business partner. Business partners that have multiple currencies are indicated by not assigning any currency.
emailAddress The public email address.
fax The fax machine number.
groupCode The code of the group which the business partner belongs to. This must be a value which is also present in the BusinessPartnerGroup model.
groupName The name of the group which the business partner belongs to. This must be a value which is also present in the BusinessPartnerGroup model.
id* The unique ID of the business partner.
language The default language settings value when an offline reports is generated on the client.
mobilePhone The mobile phone.
name The name of the business partner.
officePhone The office phone number.
otherPhone If applicable, another phone number associated with the business partner.
password The business partner password.
paymentTerm Associated payment term.
paymentType Link to default payment type.
priceList Specifies the pricelist assigned to this businesspartner. The pricelist is used during creation of sales orders, materials and other objects which allow to choose items to calculate the prices.

Contacts


Field Description
birthDate The birth date of the contact.
code System code of this object, normally this correlates to the ERP id given by the source system.
defaultContact Indicates if this is the default contact of a business partner.
emailAddress The email address of the contact.
fax The fax machine number.
firstName The first name of the contact.
gender The gender of the contact.
id* Required. The unique ID associated with the contact.
lastName The last name of the contact.
mobilePhone The mobile phone number.
object.objectId The ID of the object to which the contact information refers to (i.e. a specific BUSINESSPARATNER).
object.objectType The type of object which the object references (e.g. a BusinessPartner if this is a BUSINESSPARNTER contact).
officePhone The office phone.
otherPhone If applicable, another phone.
pager If applicable, the pager number.
positionName The name of the contact's position.
profession The name of the contact's profession.
remarks Any remarks related to the contact.
remarks2 Additional remarks related to the contact.
skypeName The skype name/ID of the contact.
title The title of the contact.

Equipment


The Equipment tab is used to create and manage equipment records used throughought the Field Service application. Equipment is a specific item or machine installed on the customer side with a certain address and serial number.


Field Description
General Info
Equipment The unique ID of the Equipment.
Name The name of the equipment.
Serial No. The serial number associated with the equipment.
Manufacturer Serial Number If applicable, the manufacturer serial number.
Parent If the equipment is a component or part of a kit, the parent equipment.
Item Name The name of the item.
Item Code The code associated with the item.
Attachments
Attachments associated with the equipment record.
User Defined Fields
In this section, any user defined fields associated with the equipment record will be displayed.
Business Partner
Business Partner Required. The name of the business partner associated with the equipment.
Contact The contact associated with the equipment business partner.
Location
Address Name The name or entity to which mail is addressed.
Address Type The type of address associated with the equipment business partner. Options include:
  • Bill to
  • Ship to
  • Unknown
Address The address of the business partner. This can include the following:
  • Street
  • Street No.
  • Zip Code
  • City
  • State
  • Country
  • County
  • Block
  • Building
  • Floor
  • Remarks (3000 character limit)
Skills
Skills Here you will see any skills that have been associated with the item. Additionally, you can add or create skills by selecting the + icon.

Items


Field Description
code.groupCode System code of the assigned ItemGroup's object.
groupName System name of the assigned itemGroup's object.
id* Required. The unique ID associated with the equipment record.
inventoryItem Indicates if this item is an inventory item
mangedByBatches Indicates that the item is managed by batches.
managedBySerialNumbers Indicates that the item is managed by serial numbers.
name Display name of the item.
nameTranslations If applicable, the displayed translation name of the item.
ordinal Ordinal number of the item.
properties Additional properties to detailed specify the item and its properties
purchaseItem Indicates if this item can be used for purchase orders.
remarks Remarks or notes of this item, can be used for any string based content which contains necessary information.
salesItem Indicates if this item can be used for sales documents.
serialNumberItem Indicates if this item can have serial numbers assigned.
typeCode System code of the assigned ItemType's object.
typeName System name of the assigned ItemType's object.
unitofMeasure Unit of measure used for this item.

People


Field Description
address Address of the person.
branchCode System code of the employee branch object.
branchName System name of the employee branch object.
code System code of this object, normally this correlates to the erp id given by the source system.
departmentCode System code of the employee department object.
departmentName System name of the employee department object.
emailAddress Email address.
externalResource Indicated whether the resource is external.
fax The fax number associated with the person receord.
firstName The first name of the person.
homePhone The home phone number of the person.
id* The unique ID associated with the person record.
jobTitle The job title of the person.
lastName The last name of the person.<