Parts Catalog

for

Versions 4.5-15.8

Part Number: E67887-01

Oracle, 2015

Table of Content

1 Document Purpose and Scope...................................................................................................3

2 Glossary................................................................................................................................3

3 Introduction to Parts Catalog....................................................................................................3

4 Data Used in Parts Catalog.......................................................................................................4

5 Parts Catalog Restrictions and Permissions..................................................................................4

6 Searching in Parts Catalog........................................................................................................4

6.1 Parts Catalog Item Search in Manage Application...........................................................................4

6.2 Parts Catalog Item Search in Mobility Application...........................................................................6

7 Offline Work..........................................................................................................................11

Parts Catalog

Copyright © 2015 Oracle Corporation. All rights reserved.

Oracle Field Service Cloud is a registered trademark of Oracle Corporation.

This software and related documentation are provided under a license agreement containing restrictions on use and

disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement

or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute,

exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or

decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you

find any errors, please report them to us in writing.

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on

behalf of the U.S. Government, the following notice is applicable: U.S. GOVERNMENT END USERS: Oracle

programs, including any operating system, integrated software, any programs installed on the hardware, and/or

documentation, delivered to U.S. Government end users are “commercial computer software” pursuant to the

applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication,

disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any

programs installed on the hardware, and/or documentation, shall be subject to license terms and license

restrictions applicable to the programs. No other rights are granted to the U.S. Government.

This software or hardware is developed for general use in a variety of information management applications. It is

not developed or intended for use in any inherently dangerous applications, including applications that may create

a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be

responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle

Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in

dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their

respective owners. Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC

trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD,

Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro

Devices. UNIX is a registered trademark of The Open Group. This software or hardware and documentation may

provide access to or information on content, products, and services from third parties. Oracle Corporation and its

affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party

content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or

damages incurred due to your access to or use of third-party content, products, or services.

Documentation Accessibility

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at

http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc .

Access to Oracle Support: Oracle customers have access to electronic support through My Oracle Support. For

information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit

http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.

Page 4 of 13 Confidential || Oracle

Document Purpose and Scope Parts Catalog

1 Document Purpose and Scope

This document is intended as a description and instruction on using the Parts Catalog and inventory

search functionality of ETAdirect. It is assumed that the reader is familiar with the ETAdirect

functionalities and operating principles.

Note: this document has been updated in accordance with the actual functionality implemented in

ETAdirect version 4.5.12.

2 Glossary

The glossary below contains the basic ETAdirect terms used in this document.

Term Explanation

Activity Any time-consuming work of a resource

API Application Programming Interface – a particular set of rules and specifications that software programs follow to communicate and interact with each other

Company 1) Legal entity, using ETAdirect2) Entity that represents a Client in ETAdirect system; company is created by TOA Technologies during the process of implementation

Inventory Equipment that can be installed or deinstalled during an activity

Manage Application

Product that allows to manage workforce and activities in realtime. Usually serves as an interface for dispatcher

Mobility Application

Product that allows field personnel to interact with the system

Property Field and field value, assigned to an entity in ETAdirect (to user, resource, activity orinventory). There are fields and custom properties

User 1) Person using ETAdirect2) Entity used for authentication and authorization, allowing people or external software to access ETAdirect

3 Introduction to Parts Catalog

The Parts Catalog functionality has been designed as a means of remote access to the company's

spare parts index to be used by mobile personnel. The idea behind it is that while technicians assigned

installation jobs usually know fairly well which inventory they are going to install and load their trucks

accordingly; however, those to perform repairs often will be able to determine the parts necessary for

replacement only at the customer's site after tests and diagnostics. Therefore, the Parts Catalog has

been developed with a focus on maintenance and repair jobs. It enables the technician to look up the

spare part required for replacement, discuss the replacement terms (price, period, etc.) with the

customer, place an order for the spare part, find an alternative if the customer does not accept the

initial offer and issue an invoice.

ETAdirect Parts Catalog is available as a module within the Manage and Mobility Applications and as an

API ensuring integration with the customer's external systems.

4 Data Used in Parts CatalogThe Parts Catalog is created and updated via the dedicated Parts Catalog API. One or more catalogs

Confidential || Oracle Page 5 of 13

Parts Catalog Data Used in Parts Catalog

can be created and used. A catalog is identified by its unique label (the catalog identifier in the

system) and the language in which the catalog is created. The structure of data (the list of fields)

available in the Parts Catalog is also defined by the API operation creating the catalog. On the other

hand, the values of the fields defined in the Parts Catalog can be used in inventory forms of ETAdirect.

5 Parts Catalog Restrictions and Permissions

Similar to most functions of ETAdirect, access to the Parts Catalog is controlled by Permissions. The

dedicated 'Parts Catalog' permission enables or disables access to the Parts Catalog functionality in

Manage and Mobility Applications. For the user to be able to use the Parts Catalog, the permission has

to be set to 'Show' for the corresponding profile.

The user having the permission to use the Parts Catalog has access to all catalogs in the same

language which has been set for the user in 'My Display' → 'User Attributes' (Manage Application) or

'User options' (Mobility Application).

6 Searching in Parts Catalog

The approach to Parts Catalog item search in the Manage and Mobility Application is somewhat

different due to the basic concept and purpose of both applications (Manage is mainly intended for

dispatchers and managers while Mobility is used by mobile personnel in the course of actual job

performance). The Parts Catalog item search principles and guidelines in both applications are

described below.

6.1 Parts Catalog Item Search in Manage Application

In the Manage Application the Parts Catalog search has been added as one of the search categories in

the 'Search preferences' window. If 'by Parts Catalog' is selected as one of search categories (or the

only search category), the search will be performed among the Parts Catalog items. The search key

(the minimum length is 3 symbols, spaces in the beginning and/or end are not included in the search

key) is matched against all searchable text fields defined in the Parts Catalog.

Page 6 of 13 Confidential || Oracle

Figure 1: Parts Catalog permissions

Parts Catalog Item Search in Manage Application Parts Catalog

The search results are organized in a list containing the Parts Catalog item models and other

properties defined in the Parts Catalog.

The 'Search' window size is adapted to the device screen size, therefore, the initial search results list

Confidential || Oracle Page 7 of 13

Figure 2: 'by Parts Catalog' option in 'Search preferences'

Figure 3: Search results list

Parts Catalog Parts Catalog Item Search in Manage Application

contains the number of entries fitting the window length. The list header shows the total number of

matches found and the number of entries currently displayed. If the results list is longer than the

window length, the window contains the 'Show more results' link loading 10 more search results. The

search results list can be scrolled by means of the vertical scroll bar.

If a search result is clicked, the 'Item details' window is opened where the details of the selected item

are displayed.

The fields of the 'Item details' window correspond to the properties defined for the catalog through the

Parts Catalog API.

6.2 Parts Catalog Item Search in Mobility Application

The Mobility Application has been enhanced with the 'Search' functionality allowing to search inventory

in the resource's inventory pool and all related pools ('Install', 'Deinstall' and customer pools) as well

as in the Parts Catalog. The search in inventory pools is performed in searchable text fields occurring

in such inventory pools. The searchable fields are defined in the 'Inventory Search Fields' section of

the 'Business Rules' screen.

In the Parts Catalog search is performed in all fields having the 'searchable' flag (defined via the API

during the catalog creation) and their labels. Search is performed first in the cache among the

Page 8 of 13 Confidential || Oracle

Figure 4: 'Item details' window

Figure 5: 'Inventory Search Fields' configuration

Parts Catalog Item Search in Mobility Application Parts Catalog

elements loaded there (only the fields having the 'preview' flag are cached, therefore, only such fields

are available for search) and then on the server.

The 'Search' functionality is accessed by the 'Search' icon ('magnifying glass') in the title bar of the

Mobility Application. Clicking this icon, the user opens the 'Search' popup window where they are

prompted to enter the keyword.

As soon as the user enters the keyword (the minimum length is 3 symbols, spaces in the beginning

and/or end are not included in the search key) and clicks 'Search', the functionality starts searching

for the specified keyword in all inventory pools associated with the current resource and in the Parts

Catalog. The search results are displayed as the list of items matching the keyword.

The list is broken down in 2 sections – 'Inventory' and 'Parts Catalog'. If the search key is only found

in either inventory or Parts Catalog, the other section is not shown. The figure in parenthesis is the

Confidential || Oracle Page 9 of 13

Figure 6: 'Search' window

Figure 7: Search results

Parts Catalog Parts Catalog Item Search in Mobility Application

count of matches currently displayed on the screen. The initial batch is 10 matches. If search returns

more than 10 matching items, the corresponding section (or both sections) contains the 'Load more'

link which loads 10 more matches. The list header count changes with each batch to reflect the

currently displayed number of matches. Long lists can be scrolled by means of the scroll bar.

The search results in the 'Inventory' list are marked with pool icons by which the user can easily

determine the pools in which the inventory item is. If an item found in the Parts Catalog also happens

to be in the resource's pool, such item is marked with a 'truck' icon.

If images have been uploaded for the Parts Catalog items, such images are shown as previews in the

list of search results.

When the user selects an inventory item from the search results, the 'Search' window is hidden. If an

item from the resource's inventory is selected, the user is redirected to the 'Inventory details' screen.

If an item is selected from the Parts Catalog, the 'Catalog item details' screen is opened.

Page 10 of 13 Confidential || Oracle

Figure 8: Pool icons

Parts Catalog Item Search in Mobility Application Parts Catalog

The 'Catalog item details' screen contains the details of the selected catalog item, the 'Linked items'

section with the list of alternative items to substitute the initially selected Parts Catalog item and the

'Images' section showing the images associated with the selected item, if any. Clicking a linked item

leads to the screen with the linked item details which is organized in the same manner.

If the selected item can be found in the resource's inventory, the 'Catalog item details' screen also

includes the 'Quantity in the truck' section showing how many units of such inventory the resource

has.

Confidential || Oracle Page 11 of 13

Figure 9: 'Inventory details' screen

Figure 11: 'Quantity in the truck' section

Figure 10: 'Catalog item details' screen

Parts Catalog Parts Catalog Item Search in Mobility Application

If the icon is clicked, the current search stops, the search results and the keyword are cleared. A

new search can be started.

If 'Search' is called from the 'Add to installed' or 'Add to deinstalled' screen of a started activity, the

matching items found in the Parts Catalog are accompanied with the 'Select' button.

Clicking 'Select' copies the inventory properties to the 'Add to installed/deinstalled' form filling its

fields. After the form is submitted, the selected item is added to the 'Install' or 'Deinstall' pool,

respectively. The fields of the 'Add to installed/deinstalled' form correspond to the catalog fields

defined through the API and their values – to the values defined for each catalog item also through

the API.

Page 12 of 13 Confidential || Oracle

Figure 12: 'Select' button

Figure 13: 'Add to installed' form filled withcatalog item properties

Parts Catalog Item Search in Mobility Application Parts Catalog

Afterwards the inventory can be handled as any other inventory item in an inventory pool.

7 Offline Work

Parts Catalog supports offline operation. For that purpose, Parts Catalog data is loaded in the cache.

As soon as ETAdirect is started, the process of data loading to the cache begins. When the user starts

the application again, either in online or offline mode, the data is retrieved from the cache and is

available for search.

The Parts Catalog cache is updated automatically, every 30 minutes from the application start. During

the update old data is overwritten with new data. This ensures data accuracy and consistency.

Confidential || Oracle Page 13 of 13