SGG SOM Configuration Guide v2 1-0-3123
SGG SOM Configuration Guide v2 1-0-3123
SGG SOM Configuration Guide v2 1-0-3123
May 2015
Oracle Utilities Smart Grid Gateway/Smart Grid Gateway Installation and Configuration Guide, Release 2.1.0
Service Pack 3
E63089-01
Copyright © 2011, 2015 Oracle and/or its affiliates. All rights reserved.
Primary Author: Lou Prosperi
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, then 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 about 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 unless otherwise
set forth in an applicable agreement between you and Oracle. 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, except as set forth in an applicable agreement between you and Oracle.
Contents
Chapter 1
Overview............................................................................................................................................................. 1-1
What Is This Book?........................................................................................................................................................ 1-2
Other Documentation................................................................................................................................... 1-2
Oracle Utilities Application Framework Configuration Tools................................................................................ 1-4
Chapter 2
Understanding Service Order Management..................................................................................................... 2-1
Service Order Management Overview ........................................................................................................................ 2-2
What is Service Order Management?.......................................................................................................... 2-2
How Does Service Order Management Work?......................................................................................... 2-2
Supported Service Order Processes ............................................................................................................ 2-3
Understanding Service Order Orchestration Activities............................................................................................ 2-7
Understanding Service Order Processing................................................................................................... 2-7
Are SP and Device Ready? - Algorithm Types.......................................................................................... 2-9
Service Order Management Service Providers ........................................................................................ 2-16
Understanding Field Activities ................................................................................................................................... 2-18
What are Field Activities? ........................................................................................................................... 2-18
How Do Field Activities Work? ................................................................................................................ 2-18
Field Task Types .......................................................................................................................................... 2-19
Field Activity Processing and Communication ....................................................................................... 2-20
Unrelated Pickup Orders ............................................................................................................................ 2-29
Understanding Smart Meter Commands .................................................................................................................. 2-30
Service Order Orchestration Activities In Detail .................................................................................................... 2-31
Smart Grid Gateway Base Package Service Order Orchestration Activity Business Objects ......... 2-31
Example Service Order Orchestration Activity - D1-EnableService .................................................. 2-32
Field Activities In Detail.............................................................................................................................................. 2-34
Service and Measurement Data Foundation Base Package Field Activity Business Objects........... 2-34
Example Field Activity - D1-FieldActivity .............................................................................................. 2-34
Base Package Field Task Types ................................................................................................................. 2-36
Field Activity Task Types - Base Package Processing Scripts............................................................... 2-37
Field Activity Task Types - Base Package Field Activity Completion Events ................................... 2-38
Example Field Task Type - D1-ConnectSPAtMeter.............................................................................. 2-39
Service Order Operational Dashboards.................................................................................................................... 2-40
Service Order Activity Aggregation .......................................................................................................... 2-40
Batch Processing .......................................................................................................................................... 2-42
Service Order Management Master Configuration................................................................................. 2-43
Service Order Management Integrations.................................................................................................................. 2-46
Oracle Utilities Customer Care and Billing to Service Order Management ....................................... 2-46
Service Order Management to Oracle Utilities Mobile Workforce Management ............................. 2-47
i
Chapter 3
Service Order Management Process Configuration ......................................................................................... 3-1
Data Setup for All Processes ........................................................................................................................................ 3-2
Customer Care and Billing............................................................................................................................ 3-2
Service Order Management.......................................................................................................................... 3-3
Mobile Workforce Management.................................................................................................................. 3-4
Enable Service for Meters ............................................................................................................................................. 3-5
Customer Care and Billing............................................................................................................................ 3-5
Service Order Management.......................................................................................................................... 3-6
Mobile Workforce Management.................................................................................................................. 3-8
Enable Service for Items ............................................................................................................................................. 3-10
Customer Care and Billing.......................................................................................................................... 3-10
Service Order Management........................................................................................................................ 3-11
Mobile Workforce Management................................................................................................................ 3-13
Disable Service for Meters .......................................................................................................................................... 3-15
Customer Care and Billing.......................................................................................................................... 3-15
Service Order Management........................................................................................................................ 3-16
Mobile Workforce Management................................................................................................................ 3-18
Disable Service for Items ............................................................................................................................................ 3-20
Customer Care and Billing.......................................................................................................................... 3-20
Service Order Management........................................................................................................................ 3-21
Mobile Workforce Management................................................................................................................ 3-22
Cut Service for Non-Payment for Meters ................................................................................................................ 3-24
Customer Care and Billing.......................................................................................................................... 3-24
Service Order Management........................................................................................................................ 3-25
Mobile Workforce Management................................................................................................................ 3-27
Cut Service for Non-Payment for Items .................................................................................................................. 3-29
Customer Care and Billing.......................................................................................................................... 3-29
Service Order Management........................................................................................................................ 3-30
Mobile Workforce Management................................................................................................................ 3-32
Reconnect Service for Payment for Meters.............................................................................................................. 3-34
Customer Care and Billing.......................................................................................................................... 3-34
Service Order Management........................................................................................................................ 3-35
Mobile Workforce Management................................................................................................................ 3-37
Reconnect Service for Payment for Items................................................................................................................ 3-39
Customer Care and Billing.......................................................................................................................... 3-39
Service Order Management........................................................................................................................ 3-40
Mobile Workforce Management................................................................................................................ 3-42
Meter Exchange............................................................................................................................................................ 3-44
Customer Care and Billing.......................................................................................................................... 3-44
Service Order Management........................................................................................................................ 3-45
Mobile Workforce Management................................................................................................................ 3-48
Item Exchange .............................................................................................................................................................. 3-51
Customer Care and Billing.......................................................................................................................... 3-51
Service Order Management........................................................................................................................ 3-52
Mobile Workforce Management................................................................................................................ 3-54
Back-to-Back for Meters ............................................................................................................................................. 3-56
Customer Care and Billing.......................................................................................................................... 3-56
Service Order Management........................................................................................................................ 3-57
Mobile Workforce Management................................................................................................................ 3-59
Cancel Orchestration for Meters ............................................................................................................................... 3-61
Service Order Management........................................................................................................................ 3-61
Update Orchestration for Meters .............................................................................................................................. 3-62
Service Order Management........................................................................................................................ 3-62
ii
Chapter 1
Overview
This chapter provides an overview of this configuration guide and an introduction to the Oracle
Utilities Smart Grid Gateway adapter for Itron OpenWay, including the following:
• What Is This Book?
• Other Documentation
• Oracle Utilities Application Framework Configuration Tools
Overview 1-1
What Is This Book?
Other Documentation
This section describes other documentation provided with the Oracle Utilities Smart Grid
Gateway Service Order Management.
Installation Documentation
Installation documentation describes the steps involved in the installation and initial set up of the
system, and includes the following documents:
• Oracle Utilities Smart Grid Gateway Quick Install Guide
• Oracle Utilities Smart Grid Gateway DBA Guide
• Oracle Utilities Smart Grid Gateway Installation Guide
User Documentation
User documentation provides conceptual information and procedures related to working with the
various objects used in the system, and includes the following documents:
• Oracle Utilities Application Framework Business Process Guide
• Oracle Utilities Application Framework Administration Guide
• Oracle Utilities Service and Measurement Data Foundation User’s Guide
Supplemental Documentation
Supplemental documentation provides technical information related to system administration
tasks and include the following documents:
• Oracle Utilities Smart Grid Gateway Server Administration Guide
1-2 Oracle Utilities Smart Grid Gateway Adapter for Itron OpenWay Configuration Guide
What Is This Book?
Embedded Help
Oracle Utilities Smart Grid Gateway, like all Oracle Utilities Application Framework applications,
provides extensive internal documentation. For example, detailed descriptions of system objects
are included in the objects' maintenance portals. The lifecycle of each business object is described
on the Lifecycle tab and depicted in flow diagrams on the Summary tab. This information is
extremely useful for implementers and system administrators.
Embedded help is provided for all non-obvious fields in most portals and zones. If a field has
associated help text, a ? icon appears next to the field when the zone is displayed.
Online Help
Oracle Utilities Smart Grid Gateway also includes context-sensitive help for all the user interface
screens users will typically work with as they use the system. Online help contains conceptual
information and procedures related to working with the various objects used in the system.
The online help is divided into the following three sections:
• Oracle Utilities Application Framework: Describes the features and functions of the
application framework (F1)
• Oracle Utilities Service and Measurement Data Foundation: Describes the features and
functions provided in the service and measurement data foundation (D1)
Overview 1-3
Oracle Utilities Application Framework Configuration Tools
1-4 Oracle Utilities Smart Grid Gateway Adapter for Itron OpenWay Configuration Guide
Chapter 2
Understanding Service Order Management
This chapter provides a description of the Oracle Utilities Smart Grid Gateway Service Order
Management. This chapter includes:
• Service Order Management Overview
• Understanding Service Order Orchestration Activities
• Understanding Field Activities
• Service Order Orchestration Activities In Detail
• Field Activities In Detail
• Service Order Operational Dashboards
• Service Order Management Integrations
Enable Service
Enable Service is a request to start service for a particular service point. It is typically initiated
from a CIS application.
A "Start Service" field activity request from a CIS for a meter will result in the creation of an
"Enable Service" orchestration activity in Service Order Management. The "Enable Service"
orchestration activity will initiate field activities and smart meter commands necessary to change
the state of service at a service point to the enabled state and confirm an initial measurement
exists.
For example, a service order request is received to start service for a meter, the following field
activities smart meter commands may occur:
• If there is no meter at the service point and the service point is not connected as the source, a
field activity will be created to connect the service point to its source and install the meter.
• If a smart meter exists at the service point, but it is in a disconnected state, a smart meter
command will be sent to the appropriate head-end system to connect the meter.
• If there is a non-smart (manual) meter at the service point and it's on, a field activity will be
created to request the reading on / near the start date (assuming that the next scheduled
meter read date is not close to the start date).
Disable Service
Disable Service is a request to stop service for a particular service point. It is typically initiated
from a CIS application.
A "Stop Service" field activity request from a CIS for a meter will result in the creation of an
"Disable Service" orchestration activity in Service Order Management. The "Disable Service"
orchestration activity will initiate field activities and/or smart meter commands necessary to
change the state of service at a service point to the disabled state and confirm a final measurement
exists.
For example, a service order request is received to stop service for a meter, the following field
activities and smart meter commands may occur:
• If there is a non-smart (manual) meter at the service point and it's on, a field activity will be
created to turn off the meter
• If a smart meter exists at the service point and its state is connected/commissioned, a smart
meter command will be sent to the appropriate head-end system to perform a remote
disconnect of the meter
A "Reconnect for Payment" field activity request from the CIS will result in the creation of a
"Reconnect Service for Payment" orchestrator activity in Service Order Management. The
"Reconnect for Payment" orchestration activity will initiate field activities and/or smart meter
commands necessary to change the state of service at a service point to the enabled state.
For example, if a service order request to reconnect service is received for a meter service, the
following field activities and smart meter commands may ensue:
• If there is a non-smart (manual) meter at the service point and it's turned off, a field activity
will be created to turn on the meter
• If a smart meter exists at the service point, but it is in a disconnected state, a smart meter
command will be sent to the appropriate head-end system to connect the meter
Meter Exchange
Meter Exchange service is basically an exchange of an old meter with a new meter. A meter
exchange request may be initiated as the result of a smart meter rollout, an individual customer's
smart meter opt-out, a meter no longer working correctly, a meter reaching the end of its expected
life, a customer with a manual meter enrolling in a program that requires a smart meter, or a need
to upgrade measurement capabilities etc.
Meter exchanges can be initiated from a variety of applications, including a CIS such as Oracle
Utilities Customer Care and Billing, Service Order Management (internally), and an asset
management system such as Oracle Utilities Operational Device Management. Meter exchange
requests can also be requested as pick-up orders from a field work application such as Oracle
Utilities Mobile Workforce Management.
Meter Exchanges involving smart meters will involve smart meter commands in addition to field
activities. A requesting system should be able to optionally provide some input as to the type of
meter needed, and depending upon the requesting system, this input could be specific (the type of
configuration) or general (smart or manual).
Back-to-Back
Back to Back service is basically service disablement and enablement in single step. The main
purpose of this service is to minimize the dispatching (and obviously cost) of field work to obtain
readings for both start and stop event for correct billing to the customer.
An example of a back-to-back scenario would involve an outgoing tenant calling their utility
company for a move-out and an incoming tenant calls for a move-in at the same premise. As long
as the gap period during which the premise is vacant is within the utility company's threshold, the
change would be considered as a back to back event. In this case, a single field task is dispatched to
take the meter reading used for this event and typically initiated from a CIS application.
A "Back to Back Service" field activity request from a CIS for a premise will result in the creation
of a "Back to Back Service" orchestration activity in Service Order Management. The "Back to
Back Service" orchestration activity will initiate field activities and smart meter commands
necessary to change the state of the service of both customers at a service point to the desired
state and confirm that the measurements exists for that period.
If the cancel is not successful then the “Cancel" orchestration activity will be discarded. When it is
discarded, it will send a response message to the requester indicating the cancel was unsuccessful.
If cancel service is for field work system then "Cancel" orchestration activity will be initiated and a
Cancel Command will be initiated in case of smart meter commands.
Cancellation of service can be initiated from a variety of applications, including a CIS such as
Oracle Utilities Customer Care and Billing, Service Order Management (internally), and an asset
management system such as Oracle Utilities Operational Device Management. Cancellation of
service can also be requested as pick-up orders from a field work application such as Oracle
Utilities Mobile Workforce Management.
State Description
Validation Error If the business object fails any of the validations in the
Pending state, it enters this state.
Waiting for Effective Date If an orchestration activity has a future effective date, it
remains in this state until the effective date is reached.
State Description
Are SP and Device Ready? Each type of orchestration activity business object has a
unique set of Enter algorithms that perform operations as
appropriate for the type of service order request.
Activity in Progress Orchestration activities remain in this state while their child
activities are processed.
Activity Error If one or more child activities enters an Error state, the
orchestration activity enters this state.
Completed Orchestration activities enter this state when all child activities
have successfully completed.
Use the Business Object and Algorithm portals to view additional details about this business
object and its lifecycle algorithms.
• In place of the "Are SP and Device Ready?” state, they have "Cancel Specific
Activity" / "Update Specific Activity" states. Enter algorithms on these states
attempt to cancel or update a specific child activity.
• In the place of "Activity In Progress" and "Activity Error" states, they have
"Communication in Progress" and "Communication in Error" states.
Use the Business Object and Algorithm portals to view additional details about this business
object and its lifecycle algorithms.
Mnemonic Description
For example, to create a field activity based on the D1-FieldActivity business object and the
Exchange Meter field task type, these mnemonics would be configured as follows:
activityBOToCreate=D1-FieldActivity specificFieldTask=D1-ExchangeMeter
Mnemonic Description
For example, to create a smart meter command activity based on the D1-DeviceDecommission
business object, this parameter would be configured as follows:
activityBOToCreate=D1-DeviceDecommission
Mnemonic Description
Based on the unique combination of these mnemonics, a specific activity is created, as defined by
the following mnemonics:
Mnemonic Description
Mnemonic Description
specificFieldTask Specifies the field task type when creating a field activity.
This value comes from the Field Task Type extendable
lookup.
For example, the following parameter configuration would create a "Connect Service Point and
Install Meter" field activity given the following conditions:
• Service Point Connected: False
• Disconnect Location: Source
• Device Installed at Service Point: False
• Service Point Category: Meter
servicePointConnected=false disconnectLocation=D1SR
deviceInstalledAtSP=false specificFieldTask=D1-ConnSPAtSrceAndInstMtr
spTypeCategory=D1MT
condition to the least restrictive. This parameters uses the following mnemonic to indicate the
state (any combination of the following) of the service point:
Mnemonic Description
Based on the value of this mnemonic, a specific activity is created, as defined by the following
mnemonics:
Mnemonic Description
For example, the following parameter configuration would create a "Turn On Meter" field activity
given the following conditions:
• Installation Status: Manual Off
• Service Point Category: Meter
installEventStatusOverride=ManualOff specificFieldTask=D1-TurnOnMeter
spTypeCategory=D1MT
• XPath of Activity Element controlling Activity creation: Defines an element within the
activity business object schema that can be used to control whether or not this algorithm
should create an activity. For example, to specify that the value of the "Connect New Device"
flag be used to determine whether or not the algorithm should create an activity, this
parameter could be set to "connectNewDevice".
• Element value indication that Activity creation should not proceed: Specifies a value for
the element defined in the "XPath of Activity Element controlling Activity creation"
parameter that would indicate that the algorithm should not create an activity. Valid values are
based on the element defined for the "XPath of Activity Element controlling Activity
creation" parameter. For example, to specify that an activity should not be created if the
"Connect New Device" flag is set to "Do Not Connect / Turn On", this parameter should be
set to "D1NC" (from the D1_CONNECT_NEW_DEVICE_FLG lookup).
• End Range for Normal Measurement Condition: The end of the range of conditions that
indicate "normal" measurements when the algorithm is searching for measurements for the
service point.
• Minimum Range for bottom Measurement condition: The minimum measurement
condition used when searching for measurements for the service point. Used only when no
measurements are found in the "normal" range defined by the "Start/End Range Normal
Measurement Condition” parameters.
The following parameters on the orchestration activity type are also used by algorithms of this
type when searching for measurements for the service point:
• Look for Measurement within the Day: Limits the search to the reference date (the service
date).
• Minimum and Maximum Offset Number of Days: Numbers of days added to /
subtracted from the reference date to expand the search period.
Customer-Device X X
Compatibility Check
Connect Only If X
Previously
Connected
Create Specific X
Activity
Create Meter X
Exchange Field
Activity
Update Device X X X X X X
Decommission X
Removed Meter
Check For X X X X
Measurement:
Create Meter Exchange Field Activity Create Meter Exchange Field Activity
(D1-CREMTREXC) (D1-CREMTREXC)
Use the Algorithm Type and Algorithm portals to view additional details about these algorithms.
Use the Algorithm Type and Algorithm portals to view additional details about these algorithms.
• Utility Device ID Type: This is the Device ID Type that will be used when communicating
with the external application and it will be the assumed Device ID Type for any device
identifiers sent from the external application.
• Utility Service Point ID Type: This is the Service Point ID Type that will be used when
communicating with the external application and it will be the assumed Service Point ID Type
for any service point identifiers sent from the external application.
Processing Roles
The service provider’s processing roles define how data relevant to the field work system is sent
and/or created.
Field work service providers can use the following processing roles:
• Activity Notification: Used to send notifications to subscribing and/or requesting systems
about the status of orchestration and/or field activities.
• Appointment Request: Used to send a request for an appointment to the field work system.
• Cancelation Activity: Used to send notifications to requesting systems when canceling
orchestration and/or field activities.
• Collection Details: Used to retrieve details about collections processing (used with "Cut
Service for Non-Payment" and "Restore Service for Payment" orchestration activities).
• Customer Contact: Used to send a contact to a customer regarding a service request
• Field Activity: Used to send a field activity to the field work system.
• Field Activity Completion: Used to send a notification regarding completion of a field
activity.
• Interim Status Update: Used to send updates regarding the status of orchestration and field
activities to requesting systems.
• Meter Exchange Mapping: Used to define how to define different types of meter
exchanges based specific roles and device configurations. This can provide context to field
crews to help ensure they install the correct type of device and device configuration when
exchanging a meter.
• Response - Appointment: Used to send a request for an appointment to the field work
system.
• Response - Fail: Used to send a response to an external system when Service Order
Management fails to respond.
• Response - Missed Appointment: Used to send a response to the field work system when
notification of a missed appointment is received.
• Response - Negative Acknowledgement: Used to send a negative acknowledgement
response to an external system in the event that a request is rejected.
• Response - Received: Used to send a response to an external system to acknowledge receipt
of a request.
• Response - Success: Used to send a response to an external system when Service Order
Management successfully processes a request.
• Send Field Activity Remark: Used to send a field activity remark to a subscribing system
• Update Activity: Used to send notifications to requesting systems when updating
orchestration and/or field activities.
Complete Processing
The field activity completes its processing by doing the following:
• Updating the parent orchestration activity
• Sending a success response to the requester
• Transitioning the parent orchestration activity to the next state in its lifecycle
• Sending a field activity completion outbound communication to subscribing systems.
State Description
State Description
Validation Error If the business object fails any of the validations in the
Pending state, it enters this state.
Waiting to Request If a field activity has a future effective date, it remains in this
state until the effective date is reached.
State Description
Waiting for Appointment If the field activity passes its validations and the effective date
has been reached, the activity enters this state.
Communication in Progress Field activities enter this state following the "Waiting for
Appointment" or "Retry" states.
State Description
Completion Event Error If an error occurs during completion event processing, the
field activity enters this state.
State Description
Completed Field activities enter this state when all completion events
have successfully completed.
Canceled in Field If the "Field Activity Completed" flag on the field activity is
set to "No", the field activity enter this state.
The response from the field work system can be received by creating an Inbound Web Service that
references the "Book selected appointment to Field Activity" (D1-BookAppt) service script.
While in this state, monitor algorithms verify if an appointment has been supplied and send
notifications to the field work system.
Communication in Progress
Field Activity communications are records of messages sent between Service Order Management
and an external field work system, such as Oracle Utilities Mobile Workforce Management.
Communications can flow both outbound and inbound.
When a field activity enters the "Communication in Progress" state, it sends an outbound
communication to the field work system, and waits for an inbound communication response.
See Understanding the Field Activity Communication Process below for more information
about the role of communications in the field activity communication process.
Outbound Communications
Outbound Communications represent messages sent from Service Order Management to. an
external field work system Outbound communications use the following types of objects:
• Outbound Communication Business Objects
• Outbound Message Types
• External Systems
Outbound Communication Business Objects
An outbound communication business object exists for each type of message to be sent to an
external system. For field activities, the following base package outbound communication objects
can be used.
Type of Outbound
Outbound Communication Business Object
Communication
Type of Outbound
Outbound Message Type
Communication
Refer to the Oracle Utilities Application Framework documentation for more information about
outbound message types.
External Systems
You must also create an External System for each external system to which Service Order
Management will send messages. Each external system defines a set of outbound message types
that will be sent to that system. Each external system outbound message type also specifies the
following:
• The processing method used to send the message (Batch, XAI, or Real-time)
• XAI Sender (if Processing Method is set to Real-time or XAI)
• Batch Control (if Processing Method is set to Batch)
• Message XSL, W3C Schema, and Response XSL (as applicable)
To continue the example above, you might create the following external system:
External Application
Processing
Outbound Message Type Batch Control
Method
Refer to the Oracle Utilities Application Framework documentation for more information about
external systems.
Inbound Communications
Inbound Communications represent messages sent from an external field work system such as
Oracle Utilities Mobile Workforce to Service Order Management. Inbound communications are
typically sent in response to a field activity. Inbound communications use the following types of
objects:
• Inbound Communication Business Objects
• XAI Inbound Service
• Field Activity Remarks
Inbound Communication Business Objects
An inbound communication business object must be created for each type of message to be
received from an external system. For field activities, the following base package inbound
communication object can be used.
the types of messages the system is designed to send. To continue the example above, you might
create the following XAI inbound services:
Schema
XAI Inbound Service
(Inbound Communication Business Object)
Refer to the Oracle Utilities Application Framework documentation for more information about
XAI Inbound Services.
Field Activity Remarks
Inbound communications can contain activity remarks, which represent notes entered by the field
worker as they perform and complete their field work. These can be solely informational, or can
reference completion events via the "Remark Processing" section of the Field Activity Remark
Type extendable lookup. This allows information sent with the inbound communication to initiate
business processing if necessary.
Completion events specified on this extendable lookup are created by the inbound
communication, and then executed when the field activity enters the "Execute Completion
Events" state.
1. An orchestration activity creates a field activity Field Activity Business Object: Field
as part of its processing. Activity (D1-FieldActivity)
3. A Enter algorithm on the "Awaiting Response" Enter Algorithm: Populate Send Detail for
state of the outbound communication retrieves Field Activity (D1-POPSNDDTL)
information needed by the outbound message
to be sent to the field work system based on
processing scripts specified on the field task
type.
7. When the field work system sends a response, XAI Inbound Service: D1-
the middleware receives the response message FieldActivityIBComm (D134794183)
from the field work system, and converts it from
the format used by the field work system to
SOM format and invokes an XAI Inbound
Service.
8. The XAI Inbound Service picks up the message, XAI Inbound Service: D1-
and creates a corresponding inbound FieldActivityIBComm (D134794183)
communication.
Inbound Communication Business Object:
The specific type of inbound communication Field Activity Inbound Communication
business object created is determined by the (D1-FieldActivityIBComm)
XAI Inbound Service.
10. The inbound communication creates the Inbound Communication Business Object:
completion events defined on the field activity Field Activity Inbound Communication
field task type (Successful or Canceled, as D1-FieldActivityIBComm
appropriate) in the "Pending" state.
11. The inbound communication updates the Inbound Communication Business Object:
outbound communication. Field Activity Inbound Communication
D1-FieldActivityIBComm
This update is performed by an Enter algorithm
on the “Completed” Status of the inbound Outbound Communication Business
communication business object’s lifecycle. Object: Field Activity Outbound
Communication
(D1-FieldActivityOBComm)
12. The outbound communication updates the Outbound Communication BO: Initiate
“Completion Flag” and the original field activity Connect Disconnect (D3-
business object. InitiateConnectDisconnect)
This update is performed by an Enter algorithm Field Activity Business Object: Field
on the “Completed” Status of the outbound Activity (D1-FieldActivity)
communication business object’s lifecycle.
Use the Business Object portal to view additional details concerning these business objects.
Option Description
Option Description
Use the Business Object portal to view additional details concerning this business object.
Option Description
Option Description
Option Description
Use the Business Object portal to view additional details concerning this business object.
Use the Extendable Lookup portal to view additional details for these field task types.
External System Service Order - Populate External System and Identifiers (D1-
Identifier Retriever RetExtIdf)
MDM Data Retriever Service Order- Retrieve Meter Data Details (D1-RetMtrDtl)
Service Order - Retrieve Item Data Details (D1-RetItmDtl)
Field Activity Task Types - Base Package Field Activity Completion Events
The completion events defined on the field task type are created by the "Create Completion Event
for Field Activity" (D1-COMPEVSA) algorithm on the inbound communication sent by the field
work system. These completion events are then executed by the "Execute Completion Events"
(D1-EXCMPEVTS) algorithm on the field activity. The table below lists the base package field
task type completion events.
Option Description
Status Active
Routing SP Required
Processing Scripts • CIS Data Retriever: Service Order - Retrieve CIS Data
• Asset System Data Retriever
• Internal Data Retriever: Service Order - Retrieve Internal
Data
• Criteria Script: Service Order - Retrieve Criteria Value
• External System Identifier Retriever: Service Order - Populate
External System and Identifiers
• MDM Data Retriever: Service Order- Retrieve Meter Data
Details
Accumulation-Based Aggregation
Some of the data accessed on the dashboards is aggregated using a traditional "accumulation"-
style aggregation of activity data. With accumulations, data is refreshed when changes occur, and
when a request to refresh the data is submitted (either via scheduled batch process or via the
Activity Statistics dashboard zone).
For example, assume that 400 activities were created on June 15, and 300 were "In Progress" as of
the last time the data was updated. Then on June 16 if an update was requested, while there would
still 400 activities that had been created on June 15, if at this time only 200 were "In Progress", the
data would be updated to reflect 200 "In Progress".
SnapShot Aggregation
Some data on the dashboards is generated using a "snapshot"-style aggregation of activity data.
Snapshots are typically used whenever there is a need to look at trends over time. For example, to
view trends of in-flight activities, the system can take periodic snapshots to hold capture data.
Note that snapshot data is preserved, but not updated. This means that snapshot data becomes
stale as soon as the snapshot is taken.
Use the Business Object portal to view additional details for these business objects.
Use the Business Object portal to view additional details for this business objects.
Batch Processing
The activity statistics processing uses the following batch controls.
Summary To Do Types
This section defines To Do Roles for Summary To Do entries. For each To Do Type specified, you
can specify a To Do Role.
between 8 and 16 hours to complete is considered "late”. If the "Very Late Completion Tolerance"
is 24, an activity that takes between 16 and 24 hours to complete is considered "very late”.
In progress time options include the following:
• Normal In Progress Time: The number of hours in which an activity’s progress is
considered to be "normal".
• Long In Progress Time: The number of hours in which an activity’s progress is considered
to be "long".
• Very Long In Progress Time: The number of hours in which an activity’s progress is
considered to be "very long".
For example, if the "Normal In Progress Time" is 8, an activity that takes up to 8 hours to
complete is considered "normal". If the "Long In Progress Time" is 16, an activity that takes
between 8 and 16 hours to complete is considered "long". If the "Very Long In Progress Time" is
24, an activity that takes between 16 and 24 hours to complete is considered "very long".
Update Statistics
This section specifies the batch control used to update statistics for the Service Order
Management dashboards.
The Service Order Management Master Configuration can be used to configure details concerning
how data is displayed on these dashboards.
Chart Options
The Chart Options section is used to define specifics for how data its displayed on the dashboard.
The Number of Historical Days to Include in Summary Charts options specifies the number
of days of historical data to display in summary charts.
Colors used in the dashboard charts are defined by values for the "Colors" (D1-COLOR)
characteristic type. Colors are defined by HTML color codes.
Processing Statistics
This section defines the color to use when displaying processing statistics on dashboard charts and
graphs.
Available processing statistic types are based on Value Identifiers defined on a measuring
component type that references the "Activity Process Accumulation Aggregator" (D1-
ActivityProcsAggregator) measuring component business object. The business object for this
measuring component type must be "Activity Statistic Master Aggregator Type".
Aging Statistics
This section defines the color to use when displaying aging statistics on dashboard charts and
graphs.
Available aging statistic types are based on Value Identifiers defined on a measuring component
type that references the "Activity Aging Snapshot Aggregator" (D1-ActivityAgingSnapAggtor)
measuring component business object. The business object for this measuring component type
must be "Activity Statistic Master Aggregator Type".
Activity Types
This section defines the color to use when displaying activity types on dashboard charts and
graphs.
Available activity types are based on values defined for the "External Activity Type Identifier"
(D1-ExternalActTypeIdentifier) extendable lookup.
Process Description
Field Activity Creation Field activities can be sent from Oracle Utilities
Customer Care and Billing to Service Order
Management.
Field Activity Completion For activities that are handled in Service Order
Management, Service Order Management sends a
success/failure response to Oracle Utilities Customer
Care and Billing.
Service Request Update / Field Customer contacts can be created as part of completion
Activity Customer Contact for activities handled in Service Order Management.
Oracle Utilities Service Order Management will send a
message to Oracle Utilities Customer Care and Billing to
create a customer contact.
Refer to the Oracle Utilities Service Order Management Integration to Oracle Utilities Mobile Workforce
Management Implementation Guide for details about configuring this integration.
Process Field Activities Service Order Management sends the details of field
activities that need to be created/updated/cancelled to
Oracle Utilities Mobile Workforce Management.
Interim Activity Status Request Service Order Management requests interim activity
status from Oracle Utilities Mobile Workforce
Management. Oracle Utilities Mobile Workforce
Management provides the status of interim activities such
as work in progress or en route.
Create Pickup Order /Create Oracle Utilities Mobile Workforce Management requests
Activity Service Order Management to create unrelated pickup
orders.
Query Service Point / Unrelated Oracle Utilities Mobile Workforce Management supplies
Pickup Order criteria to identify a service point in Service Order
Management when creating unrelated pickup activities.
Refer to the Oracle Utilities Service Order Management Integration to Oracle Utilities Mobile Workforce
Management Implementation Guide for details about configuring this integration.
This chapter provides an overview of the data configuration required for each of the service order
processes supported by Service Order Management, including:
• Data Setup for All Processes
• Enable Service for Items
• Disable Service for Meters
• Disable Service for Items
• Cut Service for Non-Payment for Meters
• Cut Service for Non-Payment for Items
• Reconnect Service for Payment for Meters
• Reconnect Service for Payment for Items
• Meter Exchange
• Item Exchange
• Back-to-Back for Meters
• Cancel Orchestration for Meters
• Update Orchestration for Meters
To view additional details about the objects referenced in this guide, use the appropriate
application portal.
External Systems
You must create External Systems for both Oracle Utilities Customer Care and Billing and Oracle
Utilities Mobile Workforce Management in order to Service Order Management to communicate
with them. The minimum information that must be defined for each of these external systems is
outlined below.
Oracle Utilities Customer Care and Billing:
• Description: Oracle Utilities Customer Care and Billing
• Our Name In Their System: SOM
Refer to the Oracle Utilities Service Order Management Integration to Oracle Utilities Mobile Workforce
Management Implementation Guide for details regarding outbound message and XAI Senders
associated with this external system.
Oracle Utilities Mobile Workforce Management.:
• Description: Oracle Utilities Mobile Workforce Management
• Our Name In Their System: SOM
Refer to the Oracle Utilities Service Order Management Integration to Oracle Utilities Mobile Workforce
Management Implementation Guide for details regarding outbound message and XAI Senders
associated with this external system.
Service Providers
You must create Service Providers for both Oracle Utilities Customer Care and Billing and Oracle
Utilities Mobile Workforce Management. The minimum information that must be defined for
each of these is outlined below.
Oracle Utilities Customer Care and Billing:
• Description: Oracle Utilities Customer Care and Billing
• External System: Oracle Utilities Customer Care and Billing
• Utility Device ID Type: Badge Number
• Utility Measuring Component ID Type: Channel ID
• Utility Service Point ID Type: External ID
• Processing Methods: Define the following processing methods for each of the service
providers defined in Service Order Management.
Refer to the Oracle Utilities Service Order Management Integration to Oracle Utilities Mobile Workforce
Management Implementation Guide for details regarding outbound message types used by these
processing methods.
Oracle Utilities Mobile Workforce Management.:
• Description: Oracle Utilities Mobile Workforce Management
• External Reference ID: SOM
• External System: Oracle Utilities Mobile Workforce Management
• Utility Device ID Type: Badge Number
• Utility Measuring Component ID Type: External ID
• Utility Service Point ID Type: External ID
• Processing Methods: Define the following processing methods for each of the service
providers defined in Service Order Management.
Master Configuration
Define the following options on the Service Order Management master configuration.
Master Configuration: Service Order Management Master Configuration
• Business Object: Service Order Management Master Configuration
• Field Work System: Oracle Utilities Mobile Workforce Management
• CIS External Requestor: Oracle Utilities Customer Care and Billing
Note: The example above does not capture the complete list of fields and their corresponding
values.
External System
You need to an create External System for Service Order Management in order for Oracle Utilities
Mobile Workforce Management to communicate with it. The minimum information that must be
defined for each of these external systems is outlined below.
Service Management.:
• Description: Oracle Utilities Service Order Management
• Our Name In Their System: MWM
Refer to the Oracle Utilities Service Order Management Integration to Oracle Utilities Mobile Workforce
Management Implementation Guide for details regarding outbound message and XAI Senders
associated with this external system.
Activity Type
You must create an Activity Type for the Enable Service process.
Example: Activity Type: Enable Service
• Activity Type: ENABLESERVICE
• Description: Enable Service Activity Type
• Activity Type Status: Active
• Activity Expiration Days: 10
• Override Device/Task Algorithm:
• Customer Device Compatibility Algorithm:
• Exception Handling:
• To Do Type: Activity To Do Type
• To Do Role: System Default Role
• Retry Frequency: 00:10:00
• Maximum Retries: 2
• Discard Reason:
• Find Measurement Criteria:
• Field Read Option: Use on Service Date
• Prorate Fail Action: Use Field Read
• To Do Type:
• To Do Role:
• Search Within the Day: No
• Minimum Offset Days: 2
• Maximum Offset Days: 2
Task Type
You must create task types that correspond to the field task types defined in Service Order
Management.
For example, the "Turn On Meter" field task type in Service Order Management could be mapped
to an "Electric Turn On Meter" task type in Oracle Utilities Mobile Workforce Management.
Mappings between Service Order Management field task types and Oracle Utilities Mobile
Workforce Management task types are defined using the SOM_MWM_TaskType domain value
map (DVM). Refer to the Oracle Utilities Service Order Management Integration to Oracle Utilities Mobile
Workforce Management Implementation Guide for more information about this DVM.
Example: Task Type: E-ON
• Activity Type: E-ON
• Description: Electric Turn On Meter
• Status: Active
• Average Duration: 00:10:00
• Auto Dispatch: Yes
• Acknowledgement Required: No
• Work Calendar: Default
• Eligible for Contracting: No
• Eligible for Assist: No
• Allow Breaks: No
• Allow Crew Time: No
• Activity Business Object: Activity
• Priority:
• Queue: Normal
• Preferred Time Factor: 1
• Ignore Sequence Locking: No
• Priority Profile: High
• Scheduling Priority: 1.00
• Procedures:
• Procedure Clearance Required: Yes
• Procedure Type: Meter Work Procedure
• Activities Creation:
• Create by Crew: Allowed
• Activity Expiration:
• Auto Extension: No
• Auto Cancel: No
• Capabilities:
• Crew Size: 1
• Worker Capability: Electric Meter Reading, Usage: Required, Count: 1
• Equipment: Basic Service Tools, Usage: Required
• Valid Remark Types:
• Remark Type: Mark for Review, Sort Sequence: 1
Note: The example above does not capture the complete list of fields and their corresponding
values.
Activity Type
You must create an Activity Type for the Enable Service process.
Example: Activity Type: Enable Service
• Activity Type: ENABLESERVICE
• Description: Enable Service Activity Type
• Activity Type Status: Active
• Activity Expiration Days: 10
• Override Device/Task Algorithm:
• Customer Device Compatibility Algorithm:
• Exception Handling:
• To Do Type: Activity To Do Type
• To Do Role: System Default Role
• Retry Frequency: 00:10:00
• Maximum Retries: 2
• Discard Reason:
• Find Measurement Criteria:
• Field Read Option: Use on Service Date
• Prorate Fail Action: Use Field Read
• To Do Type:
• To Do Role:
• Search Within the Day: No
• Minimum Offset Days: 2
• Maximum Offset Days: 2
Task Type
You must create task types that correspond to the field task types defined in Service Order
Management.
For example, the "Turn On Item" field task type in Service Order Management could be mapped
to an "Electric Turn On Item" task type in Oracle Utilities Mobile Workforce Management.
Mappings between Service Order Management field task types and Oracle Utilities Mobile
Workforce Management task types are defined using the SOM_MWM_TaskType domain value
map (DVM). Refer to the Oracle Utilities Service Order Management Integration to Oracle Utilities Mobile
Workforce Management Implementation Guide for more information about this DVM.
Example: Task Type: E-ONITEM
• Activity Type: E-ONITEM
• Description: Electric Turn On Item
• Status: Active
• Average Duration: 00:10:00
• Auto Dispatch: Yes
• Acknowledgement Required: No
• Work Calendar: Default
• Eligible for Contracting: No
• Eligible for Assist: No
• Allow Breaks: No
• Allow Crew Time: No
• Activity Business Object: Activity
• Priority:
• Queue: Normal
• Preferred Time Factor: 1
• Ignore Sequence Locking: No
• Priority Profile: High
• Scheduling Priority: 1.00
• Procedures:
• Procedure Clearance Required: Yes
• Procedure Type: Meter Work Procedure
• Activities Creation:
• Create by Crew: Allowed
• Activity Expiration:
• Auto Extension: No
• Auto Cancel: No
• Capabilities:
• Crew Size: 1
• Worker Capability: Electric Meter Reading, Usage: Required, Count: 1
• Equipment: Basic Service Tools, Usage: Required
• Valid Remark Types:
• Remark Type: Mark for Review, Sort Sequence: 1
Note: The example above does not capture the complete list of fields and their corresponding
values.
Activity Type
You must create an Activity Type for the Disable Service process.
Example: Activity Type: Disable Service
• Activity Type: DISABLESERVICE
• Description: Disable Service Activity Type
• Activity Type Status: Active
• Activity Expiration Days: 10
• Override Device/Task Algorithm:
• Customer Device Compatibility Algorithm:
• Exception Handling:
• To Do Type: Activity To Do Type
• To Do Role: System Default Role
• Retry Frequency: 00:10:00
• Maximum Retries: 2
• Discard Reason:
• Find Measurement Criteria:
• Field Read Option: Use on Service Date
• Prorate Fail Action: Use Field Read
• To Do Type:
• To Do Role:
• Search Within the Day: No
• Minimum Offset Days: 2
• Maximum Offset Days: 2
Task Type
You must create task types that correspond to the field task types defined in Service Order
Management.
For example, the "Turn Off Meter" field task type in Service Order Management could be mapped
to an "Electric Turn Off Meter" task type in Oracle Utilities Mobile Workforce Management.
Mappings between Service Order Management field task types and Oracle Utilities Mobile
Workforce Management task types are defined using the SOM_MWM_TaskType domain value
map (DVM). Refer to the Oracle Utilities Service Order Management Integration to Oracle Utilities Mobile
Workforce Management Implementation Guide for more information about this DVM.
Example: Task Type: E-OFF
• Activity Type: E-OFF
• Description: Electric Turn Off Meter
• Status: Active
• Average Duration: 00:10:00
• Auto Dispatch: Yes
• Acknowledgement Required: No
• Work Calendar: Default
• Eligible for Contracting: No
• Eligible for Assist: No
• Allow Breaks: No
• Allow Crew Time: No
• Activity Business Object: Activity
• Priority:
• Queue: Normal
• Preferred Time Factor: 1
• Ignore Sequence Locking: No
• Priority Profile: High
• Scheduling Priority: 1.00
• Procedures:
• Procedure Clearance Required: Yes
• Procedure Type: Meter Work Procedure
• Activities Creation:
• Create by Crew: Allowed
• Activity Expiration:
• Auto Extension: No
• Auto Cancel: No
• Capabilities:
• Crew Size: 1
• Worker Capability: Electric Meter Reading, Usage: Required, Count: 1
• Equipment: Basic Service Tools, Usage: Required
• Valid Remark Types:
• Remark Type: Mark for Review, Sort Sequence: 1
Note: The example above does not capture the complete list of fields and their corresponding
values.
Activity Type
You must create an Activity Type for the Disable Service process.
Example: Activity Type: Disable Service
• Activity Type: DISABLESERVICE
• Description: Disable Service Activity Type
• Activity Type Status: Active
• Activity Expiration Days: 10
• Override Device/Task Algorithm:
• Customer Device Compatibility Algorithm:
• Exception Handling:
• To Do Type: Activity To Do Type
• To Do Role: System Default Role
• Retry Frequency: 00:10:00
• Maximum Retries: 2
• Discard Reason:
• Find Measurement Criteria:
• Field Read Option: Use on Service Date
• Prorate Fail Action: Use Field Read
• To Do Type:
• To Do Role:
• Search Within the Day: No
• Minimum Offset Days: 2
• Maximum Offset Days: 2
Task Type
You must create task types that correspond to the field task types defined in Service Order
Management.
For example, the "Turn Off Item" field task type in Service Order Management could be mapped
to an "Electric Turn Off Item" task type in Oracle Utilities Mobile Workforce Management.
Mappings between Service Order Management field task types and Oracle Utilities Mobile
Workforce Management task types are defined using the SOM_MWM_TaskType domain value
map (DVM). Refer to the Oracle Utilities Service Order Management Integration to Oracle Utilities Mobile
Workforce Management Implementation Guide for more information about this DVM.
Template Tab:
• Customer Event: Cut for Non-Payment
• SP Field Condition: External Fieldwork Orchestration
• Sequence: 10
• Not Activity:
• Disconnect Location:
• Activity Type: SOM-CUT
Type Tab:
• Field Activity Type: SOM-CUT
Note: The example above does not capture the complete list of fields and their corresponding
values.
Activity Type
You must create an Activity Type for the Cut Service for Non-Payment process.
Example: Activity Type: Cut Service for Non-Payment
• Activity Type: CUTNOPAY
• Description: Cut Service for Non-Payment
• Activity Type Status: Active
• Activity Expiration Days: 10
• Always Dispatch Field Activity: No
• Ensure Business Hours: Yes
• Work Calendar: US Work Calendar
• Start Hour: 10:00AM
• End Hour: 06:00PM
• Exception Handling:
• To Do Type: Activity To Do Type
• To Do Role: System Default Role
• Retry Frequency: 00:10:00
• Maximum Retries: 4
• Discard Reason:
• Find Measurement Criteria:
• Field Read Option: Use on Service Date
• Prorate Fail Action: Use Field Read
• To Do Type:
• To Do Role:
• Search Within the Day: No
• Minimum Offset Days: 0
• Maximum Offset Days: 5
Task Type
You must create task types that correspond to the field task types defined in Service Order
Management.
For example, the "Cut Service for Non-Payment" field task type in Service Order Management
could be mapped to an "Meter for Non-Payment" task type in Oracle Utilities Mobile Workforce
Management.
Mappings between Service Order Management field task types and Oracle Utilities Mobile
Workforce Management task types are defined using the SOM_MWM_TaskType domain value
map (DVM). Refer to the Oracle Utilities Service Order Management Integration to Oracle Utilities Mobile
Workforce Management Implementation Guide for more information about this DVM.
Example: Task Type: SOM-CUTFORNOPAY
• Activity Type: SOM-CUTFORNONPAY
• Description: SOM Cut Meter for Non-Payment
• Status: Active
• Average Duration: 00:40:00
• Auto Dispatch: Yes
• Acknowledgement Required: No
• Appointment Booking Group: Weekday All Day
• Work Calendar: US Work Calendar
• Eligible for Contracting: No
• Eligible for Assist: No
• Allow Breaks: No
• Allow Crew Time: No
• Activity Business Object: Cut For Non-Payment Meter Activity
• Host Reference: D1-CutForNonPayment
• Host System: Oracle Utilities Service Order Management
• Priority:
• Queue: Normal
• Preferred Time Factor: 1
• Ignore Sequence Locking: No
• Priority Profile: Mandatory
• Scheduling Priority: 1.00
• Procedures:
• Procedure Clearance Required: No
• Activity Expiration:
• Auto Extension: No
• Auto Cancel: No
• Capabilities:
• Crew Size: 1
• Worker Capability: Electric Meter Reading, Usage: Required, Count: 1
• Equipment: Basic Service Tools, Usage: Required
• Valid Remark Types:
• Remark Type: Mark for Review, Sort Sequence: 1
Note: The example above does not capture the complete list of fields and their corresponding
values.
Template Tab:
• Customer Event: Cut for Non-Payment
• SP Field Condition: External Fieldwork Orchestration
• Sequence: 10
• Not Activity:
• Disconnect Location:
• Activity Type: SOM-CUTIT
Type Tab:
• Field Activity Type: SOM-CUTIT
Note: The example above does not capture the complete list of fields and their corresponding
values.
Activity Type
You must create an Activity Type for the Cut Service for Non-Payment process.
Example: Activity Type: Cut Service for Non-Payment
• Activity Type: CUTNOPAY
• Description: Cut Service for Non-Payment
• Activity Type Status: Active
• Activity Expiration Days: 10
• Always Dispatch Field Activity: No
• Ensure Business Hours: Yes
• Work Calendar: US Work Calendar
• Start Hour: 10:00AM
• End Hour: 06:00PM
• Exception Handling:
• To Do Type: Activity To Do Type
• To Do Role: System Default Role
• Retry Frequency: 00:10:00
• Maximum Retries: 4
• Discard Reason:
• Find Measurement Criteria:
• Field Read Option: Use on Service Date
• Prorate Fail Action: Use Field Read
• To Do Type:
• To Do Role:
• Search Within the Day: No
• Minimum Offset Days: 0
• Maximum Offset Days: 5
Task Type
You must create task types that correspond to the field task types defined in Service Order
Management.
For example, the "Item - Cut for Non-Payment " field task type in Service Order Management
could be mapped to an "Cut Item for Non-Payment" task type in Oracle Utilities Mobile
Workforce Management.
Mappings between Service Order Management field task types and Oracle Utilities Mobile
Workforce Management task types are defined using the SOM_MWM_TaskType domain value
map (DVM). Refer to the Oracle Utilities Service Order Management Integration to Oracle Utilities Mobile
Workforce Management Implementation Guide for more information about this DVM.
Example: Task Type: SOM-CUTITEMNOPAY
• Activity Type: SOM-CUTITEMNOPAY
• Description: SOM Cut Item for Non-Payment
• Status: Active
• Average Duration: 00:40:00
• Auto Dispatch: Yes
• Acknowledgement Required: No
• Appointment Booking Group: Weekday All Day
• Work Calendar: US Work Calendar
• Eligible for Contracting: No
• Eligible for Assist: No
• Allow Breaks: No
• Allow Crew Time: No
• Activity Business Object: Cut For Non-Payment Item Activity
• Host Reference: D1-CutItemForNonPayment
• Host System: Oracle Utilities Service Order Management
• Priority:
• Queue: Normal
• Preferred Time Factor: 1
• Ignore Sequence Locking: No
• Priority Profile: Mandatory
• Scheduling Priority: 1.00
• Procedures:
• Procedure Clearance Required: No
• Activity Expiration:
• Auto Extension: No
• Auto Cancel: No
• Capabilities:
• Crew Size: 1
• Worker Capability: Electric Meter Reading, Usage: Required, Count: 1
• Equipment: Basic Service Tools, Usage: Required
• Valid Remark Types:
• Remark Type: Mark for Review, Sort Sequence: 1
Note: The example above does not capture the complete list of fields and their corresponding
values.
Template Tab:
• Customer Event: Reconnect for Payment
• SP Field Condition: External Fieldwork Orchestration
• Sequence: 10
• Not Activity:
• Disconnect Location:
• Activity Type: SOM-RECON
Type Tab:
• Field Activity Type: SOM-RECON
Note: The example above does not capture the complete list of fields and their corresponding
values.
Activity Type
You must create an Activity Type for the Reconnect Service for Payment process.
Example: Activity Type: Reconnect Service for Payment
• Activity Type: RECONNECTPAY
• Description: Reconnect Service for Payment
• Activity Type Status: Active
• Activity Expiration Days: 2
• Exception Handling:
• To Do Type: Activity To Do Type
• To Do Role: System Default Role
• Retry Frequency: 00:10:00
• Maximum Retries: 4
• Discard Reason:
• Find Measurement Criteria:
• Field Read Option: Use on Service Date
• Prorate Fail Action: Use Field Read
• To Do Type:
• To Do Role:
• Search Within the Day: No
• Minimum Offset Days: 2
• Maximum Offset Days: 2
Task Type
You must create task types that correspond to the field task types defined in Service Order
Management.
For example, the "Reconnect for Payment" field task type in Service Order Management could be
mapped to an "Reconnect for Payment" task type in Oracle Utilities Mobile Workforce
Management.
Mappings between Service Order Management field task types and Oracle Utilities Mobile
Workforce Management task types are defined using the SOM_MWM_TaskType domain value
map (DVM). Refer to the Oracle Utilities Service Order Management Integration to Oracle Utilities Mobile
Workforce Management Implementation Guide for more information about this DVM.
Example: Task Type: SOM-RECONPAY
• Activity Type: SOM-RECONPAY
• Description: SOM Reconnect for Payment
• Status: Active
• Average Duration: 00:40:00
• Auto Dispatch: Yes
• Acknowledgement Required: No
• Appointment Booking Group: Weekday All Day
• Work Calendar: US Work Calendar
• Eligible for Contracting: No
• Eligible for Assist: No
• Allow Breaks: No
• Allow Crew Time: No
• Activity Business Object: Reconnect For Payment Activity
• Host Reference: D1-ReonnectForPayment
• Host System: Oracle Utilities Service Order Management
• Priority:
• Queue: Normal
• Preferred Time Factor: 1
• Ignore Sequence Locking: No
• Priority Profile: Mandatory
• Scheduling Priority: 1.00
• Procedures:
• Procedure Clearance Required: No
• Activity Expiration:
• Auto Extension: No
• Auto Cancel: No
• Capabilities:
• Crew Size: 1
• Worker Capability: Electric Meter Reading, Usage: Required, Count: 1
• Equipment: Basic Service Tools, Usage: Required
• Valid Remark Types:
• Remark Type: Mark for Review, Sort Sequence: 1
Note: The example above does not capture the complete list of fields and their corresponding
values.
Activity Type
You must create an Activity Type for the Reconnect Service for Payment process.
Example: Activity Type: Reconnect Service for Payment
• Activity Type: RECONNECTPAY
• Description: Reconnect Service for Payment
• Activity Type Status: Active
• Activity Expiration Days: 2
• Exception Handling:
• To Do Type: Activity To Do Type
• To Do Role: System Default Role
• Retry Frequency: 00:10:00
• Maximum Retries: 2
• Discard Reason:
• Find Measurement Criteria:
• Field Read Option: Use on Service Date
• Prorate Fail Action: Use Field Read
• To Do Type:
• To Do Role:
• Search Within the Day: No
• Minimum Offset Days: 2
• Maximum Offset Days: 2
Task Type
You must create task types that correspond to the field task types defined in Service Order
Management.
For example, the "Item - Reconnect for Payment" field task type in Service Order Management
could be mapped to an "Reconnect Item for Payment" task type in Oracle Utilities Mobile
Workforce Management.
Mappings between Service Order Management field task types and Oracle Utilities Mobile
Workforce Management task types are defined using the SOM_MWM_TaskType domain value
map (DVM). Refer to the Oracle Utilities Service Order Management Integration to Oracle Utilities Mobile
Workforce Management Implementation Guide for more information about this DVM.
Example: Task Type: SOM-RECITPAY
• Activity Type: SOM-RECITPAY
• Description: SOM Reconnect Item for Payment
• Status: Active
• Average Duration: 00:40:00
• Auto Dispatch: Yes
• Acknowledgement Required: No
• Appointment Booking Group: Weekday All Day
• Work Calendar: US Work Calendar
• Eligible for Contracting: No
• Eligible for Assist: No
• Allow Breaks: No
• Allow Crew Time: No
• Activity Business Object: Reconnect Item For Payment Activity
• Host Reference: D1-ReonnectItemForPayment
• Host System: Oracle Utilities Service Order Management
• Priority:
• Queue: Normal
• Preferred Time Factor: 1
• Ignore Sequence Locking: No
• Priority Profile: Mandatory
• Scheduling Priority: 1.00
• Procedures:
• Procedure Clearance Required: No
• Activity Expiration:
• Auto Extension: No
• Auto Cancel: No
• Capabilities:
• Crew Size: 1
• Worker Capability: Electric Meter Reading, Usage: Required, Count: 1
• Equipment: Basic Service Tools, Usage: Required
• Valid Remark Types:
• Remark Type: Mark for Review, Sort Sequence: 1
Note: The example above does not capture the complete list of fields and their corresponding
values.
Meter Exchange
This section outlines the data setup required to support the Meter Exchange process. See Data
Setup for All Processes on page 3-2 for information about data setup used by all services.
Activity Type
You must create an Activity Type for the Meter Exchange process.
Example: Activity Type: Meter Exchange
• Activity Type: METER_EXCHANGE
• Description: Meter Exchange
• Activity Type Status: Active
• Decommission Removed Meter?: Decommission
• Exception Handling:
• To Do Type: Activity To Do Type
• To Do Role: System Default Role
• Retry Frequency: 00:10:00
• Maximum Retries: 2
• Discard Reason:
• Find Measurement Criteria:
• Field Read Option: Use on Service Date
• Prorate Fail Action: Use Field Read
• To Do Type:
• To Do Role:
• Search Within the Day: No
• Minimum Offset Days: 2
• Maximum Offset Days: 2
• Meter Exchange Role Configuration:
Task Type
You must create task types that correspond to the field task types defined in Service Order
Management.
For example, the "Meter Exchange" field task type in Service Order Management could be
mapped to an "Exchange Meter" task type in Oracle Utilities Mobile Workforce Management.
Mappings between Service Order Management field task types and Oracle Utilities Mobile
Workforce Management task types are defined using the SOM_MWM_TaskType domain value
map (DVM). Refer to the Oracle Utilities Service Order Management Integration to Oracle Utilities Mobile
Workforce Management Implementation Guide for more information about this DVM.
Example: Task Type: SOM-FD EXCHANGE_MM
• Activity Type: SOM-FD EXCHANGE_MM
• Description: SOM-FD Exchange MM
• Status: Active
Item Exchange
This section outlines the data setup required to support the Item Exchange process. See Data
Setup for All Processes on page 3-2 for information about data setup used by all services.
Activity Type
You must create an Activity Type for the Meter Exchange process.
Example: Activity Type: Meter Exchange
• Activity Type: METER_EXCHANGE
• Description: Meter Exchange
• Activity Type Status: Active
• Decommission Removed Meter?: Decommission
• Exception Handling:
• To Do Type: Activity To Do Type
• To Do Role: System Default Role
• Retry Frequency: 00:10:00
• Maximum Retries: 2
• Discard Reason:
• Meter Exchange Role Configuration:
Task Type
You must create task types that correspond to the field task types defined in Service Order
Management.
For example, the "Meter Exchange" field task type in Service Order Management could be
mapped to an "Exchange Meter" task type in Oracle Utilities Mobile Workforce Management.
Mappings between Service Order Management field task types and Oracle Utilities Mobile
Workforce Management task types are defined using the SOM_MWM_TaskType domain value
map (DVM). Refer to the Oracle Utilities Service Order Management Integration to Oracle Utilities Mobile
Workforce Management Implementation Guide for more information about this DVM.
Example: Task Type: SOM_EXCHANGE_ITEM
• Activity Type: SOM_EXCHANGE_ITEM
• Description: SOM-FD Exchange Item
• Status: Active
• Average Duration: 00:40:00
• Auto Dispatch: Yes
• Acknowledgement Required: No
• Appointment Booking Group: Weekday All Day
• Work Calendar: US Work Calendar
• Eligible for Contracting: No
• Eligible for Assist: No
• Allow Breaks: No
• Allow Crew Time: No
• Activity Business Object: Exchange Item Activity
• Host Reference: D1-ExchangeDevice
• Host System: Oracle Utilities Service Order Management
• Priority:
• Queue: Normal
• Preferred Time Factor: 1
• Ignore Sequence Locking: No
• Priority Profile: High
• Scheduling Priority: 1.00
• Procedures:
• Procedure Clearance Required: No
• Activities Creation:
• Create by Crew: Allowed
• Activity Expiration:
• Auto Extension: No
• Auto Cancel: No
• Capabilities:
• Crew Size: 1
• Worker Capability: Electric Meter Reading, Usage: Required, Count: 1
• Equipment: Basic Service Tools, Usage: Required
• Valid Remark Types:
• Remark Type: Mark for Review, Sort Sequence: 1
Note: The example above does not capture the complete list of fields and their corresponding
values.
Other task types can be created for individual role-based meter exchange field task types.
Examples include:
Algorithm
The "SA/SP Field Work Creation" (SASP FW CRE) algorithm type can be used to define details
for how field activities are created for pending start and pending stop service agreements shortly
before the pending start / stop date if field activities do not already exist (i.e., if a CSR hasn't
already created the field activities).
Algorithms of this type can be defined for the "Start Stop Field Work" SA Type system event (on
the Algorithms tab of the SA Type portal). Parameters (and sample values) used by algorithms of
this type include the following:
• Number of Days Lead Time: 3
• Back-to-Back Threshold Days: 7
• Wait Time for Meter Read: 5
• Field Activity Type for Meter Read: M-MR CYC
• SP's desired state for Meter Read: 30
• Immediate Field Activity Creation: Y
• Routing: SP Required
• Appointment Option: Not Applicable
• Duplicate Task Type Information:
• Allow Duplicates: Yes
• Conflicting Task Type Information:
• Allow Conflicts: Yes
• Processing Scripts:
• Criteria Script: Service Order - Retrieve Criteria Value
• Completion Events When Successful:
Activity Type
You must create an Activity Type for the Enable Service process.
Example: Activity Type: Back to Back
• Activity Type: BACKTOBACK
• Description: Back to Back Service
• Activity Type Status: Active
• Activity Expiration Days: 10
• Override Device/Task Algorithm:
• Customer Device Compatibility Algorithm:
• Exception Handling:
• To Do Type: Activity To Do Type
• To Do Role: System Default Role
• Retry Frequency: 00:10:00
• Maximum Retries: 2
• Discard Reason:
• Find Measurement Criteria:
• Field Read Option: Use on Service Date
• Prorate Fail Action: Use Field Read
• To Do Type:
• To Do Role:
Task Type
You must create task types that correspond to the field task types defined in Service Order
Management.
For example, the "Read Meter" field task type in Service Order Management could be mapped to
an "Electric Meter Read" task type in Oracle Utilities Mobile Workforce Management.
Mappings between Service Order Management field task types and Oracle Utilities Mobile
Workforce Management task types are defined using the SOM_MWM_TaskType domain value
map (DVM). Refer to the Oracle Utilities Service Order Management Integration to Oracle Utilities Mobile
Workforce Management Implementation Guide for more information about this DVM.
Example: Task Type: E-MREAD
• Activity Type: E-MREAD
• Description: Electric Meter Read
• Status: Active
• Average Duration: 00:40:00
• Auto Dispatch: Yes
• Acknowledgement Required: No
• Appointment Booking Group: Weekday All Day
• Work Calendar: US Work Calendar
• Complete Within Option: Days
• Complete Within Days: 2
• Eligible for Contracting: No
• Eligible for Assist: No
• Allow Breaks: No
• Allow Crew Time: No
• Activity Business Object: Meter Read Activity
• Host System: Oracle Utilities Service Order Management
• Priority:
• Queue: Normal
• Preferred Time Factor: 1
• Ignore Sequence Locking: No
• Priority Profile: High
Activity Type
You must create an Activity Type for canceling orchestration activities.
Example: Activity Type: Cancel Orchestration
• Activity Type: CANCELORCHESTRATION
• Description: Cancel Orchestration
• Activity Type Status: Active
• Activity Expiration Days: 2
• Exception Handling:
• To Do Type: Activity To Do Type
• To Do Role: System Default Role
• Retry Frequency: 00:10:00
• Maximum Retries: 2
• Discard Reason:
Activity Type
You must create an Activity Type for updating orchestration activities.
Example: Activity Type: Update Activity Orchestration
• Activity Type: UPDATEACTIVITY
• Description: Update Activity Orchestration
• Activity Type Status: Active
• Activity Expiration Days: 0
• Exception Handling:
• To Do Type: Activity To Do Type
• To Do Role: System Default Role
• Retry Frequency: 00:10:00
• Maximum Retries: 2
• Discard Reason: