Contents

Licensing Guide

- Transaction Based Usage Costs

- Transactions - Categories and Units

- Base Platform TUPS

- Platform Services

- Application-Initiated - Subscriber Profile

- Network-Triggered

- Custom Modules

- Application-Initiated

- Network-Triggered

- Enabler Module TUPS

- Messaging

- Application-Initiated

- Network-Triggered

- Mobility

- Application-Initiated

- Network-Triggered

- Call Control

- Application-Initiated

- Network-Triggered

- Presence

- Application-Initiated - Watcher

- Network-Triggered - Watcher

- Application-Initiated - Presentity

- Payment

- Application-Initiated

- Named User Plus License

- Documentation Accessibility

Oracle® Communications Services Gatekeeper

Licensing Guide

Release 6.0

E50773-01

January 2015

The usage cost model for Oracle Communications Services Gatekeeper (Services Gatekeeper) is based on the idea of the transaction unit. This book describes how transaction categories are monitored and how transaction units are calculated.

The license for Services Gatekeeper Analytics is a Named User Plus model. The section "Named User Plus License" describes the model in detail.

Note:
To use the Services Gatekeeper Analytics, you must have an installation and a license for Business Intelligence Suite Enterprise Edition Plus for Oracle Applications 11.1.1.6.0.

Transaction Based Usage Costs

Usage costs for Services Gatekeeper are based on the rate (measured in transaction units per second or TUPS) during a specific time period per 24-hour interval. As Services Gatekeeper runs, it continuously counts the number of transactions it processes. Every 5 minutes that count is stored. After 24 hours of use, the busiest 60 minute window (the busy hour) is identified and the total number of transaction units processed in that period is divided by 3600. This computed busy hour forms the basis of the cost of using Services Gatekeeper.

Note:
Transaction units are based on statistics collected by the statistics service. By default, the system simply keeps track of usage for auditing purposes, but if an operator wishes to monitor usage more closely, it is possible to use OAM to set thresholds to raise alarms if certain usage levels are reached. For more information on setting alarms, see the discussion on managing and configuring transaction licenses in Services Gatekeeper System Administrator's Guide.

What specifically constitutes a transaction unit is based on the type of functionality being measured. Sending an SMS is not the same as setting up a call between two parties. In general, the Services Gatekeeper model is arranged in a tiered manner, using two large transaction categories, Base Platform and Enabler Module. Usage monitoring is based on the TUPS rates associated with these two transaction categories. See "Transactions - Categories and Units" for more information.

Note:
In application-initiated scenarios, transaction units are logged only if Services Gatekeeper returns an OK to the application. If there is an exception, no transaction unit is recorded. In network-triggered scenarios, transaction units are logged only if Services Gatekeeper returns an OK to the network. If there is an exception, no transaction unit is recorded.

Transactions - Categories and Units

Services Gatekeeper keeps track of transaction units at two basic levels:

- "Base Platform TUPS", the larger and more general level, which tracks:

- "Platform Services", which covers services such as subscriber profile that can be used by multiple capabilities

- "Custom Modules", which covers custom communication services

- And also includes, Enabler Module TUPS, which covers individual communication services.

- "Enabler Module TUPS", which tracks transaction units in Services Gatekeeper supplied communication services, which fall into the following groups:

- Call Control

- Messaging

- Mobility

- Presence

- Payment

Base Platform TUPS

The larger and more general rate category is Base Platform TUPS. The Base Platform TUPS rate is the sum of the TUPS limits for Platform Services and Custom Modules plus that for Enabler Modules.

Platform Services

Platform Services covers general services that can be used by multiple capabilities.

These services include:

- Subscriber Profile (based on Extended Web Services Subscriber Profile Interface)

Application-Initiated - Subscriber Profile

A Subscriber Profile transaction unit is recorded in the following situations:

- Getting one or more attributes from a subscriber profile.

- Getting either a whole or a subset of a profile identified by a profile ID.

Network-Triggered

Network-triggered scenarios are not applicable for subscriber profile.

Custom Modules

Custom Modules covers communication services or custom modules created using the Services Gatekeeper Platform Development Studio.

In general there are two main types of custom module transactions:

- Application-Initiated

- Network-Triggered

Application-Initiated

A transaction unit for a custom module application-initiated scenario:

Services Gatekeeper processes a request that is submitted by the application and passes it to the underlying network node and then Services Gatekeeper processes the response that is submitted by the underlying network node and passes it to the application.

Note:
The exact sequence of request and response is defined during the custom module development process.

Figure 1 illustrates when a generic custom module application-initiated transaction unit is logged. The illustrated operations are generic and abstract and would depend on which application-facing interface and/or network protocol the communication service is using.

Figure 1 TU Definition for a Custom Module Application-Initiated Scenario

Network-Triggered

A transaction unit for a custom module network-triggered scenario:

Services Gatekeeper processes a request that is submitted by the telecom network node and passes it on to the application, which processes it and returns a response to Services Gatekeeper, which passes it on to the telecom network node.

Figure 2 illustrates when a generic custom module network-triggered transaction unit is logged. The illustrated operations are generic and abstract and would depend on which application-facing interface and/or network protocol the communication service is using.

Figure 2 TU Definition for a Custom Module Network-Triggered Scenario

Enabler Module TUPS

The second rate category is Enabler Module TUPS. The Enabler Module TUPS rate measures the total transaction rate for communication services delivered as a part of Services Gatekeeper.

For definitional purposes, Enabler Module-based communication services are divided into the following transaction groups:

- Messaging

- Mobility

- Call Control

- Presence

- Payment

Messaging

The Messaging transaction group covers transactions for the following Parlay X 2.1 and RESTful communication services:

- Short Messaging

- Multimedia Messaging

It also covers transactions for all OneAPI, Extended Web Services, RESTful WAP Push communication services, the Binary SMS communication service, the native MM7 communication service, and the native UCP service.

There are two main types of transaction units in the Messaging group:

- Application-Initiated

- Network-Triggered

Application-Initiated

In an application-initiated scenario, a transaction unit consists of the following sequence:

Services Gatekeeper receives a request from an application and passes it on to the underlying network node. If notifications have been set up, Services Gatekeeper also receives the delivery notification from the network and passes it back to the application. Even if the message is distributed to a group of destination addresses, only one transaction unit is logged per message.

Note:
If the application is not registered for delivery notifications, the transaction unit is not affected.

Network-Triggered

In a network-triggered scenario, a transaction unit consists of one of the following two sequences:

- Services Gatekeeper receives a message from the network node and passes it on to the application.

- Services Gatekeeper receives a message from the network node and consumes the message itself. In this case, Services Gatekeeper itself acts as the application.

Mobility

The Mobility transaction group covers transactions for the following OneAPI, Parlay X 2.1, and RESTful communication services:

- Terminal Location

There are two main types of transaction units in the Mobility group:

- Application-Initiated

- Network-Triggered

Application-Initiated

In an application-initiated scenario, a transaction unit consists of one of the two following sequences:

- Services Gatekeeper receives a polling request for location from an application and passes it to the underlying network node. Services Gatekeeper then receives the immediate response that the underlying network node returns and passes it back to the application. Group requests are treated the same as single requests.

- Network receives a notification setup request from an application that also requests an immediate location check.

Note:
An immediate check followed by a status notification is considered two transaction units.

A transaction unit is not recorded in the following situation:

- Services Gatekeeper receives a notification setup request that does not include an immediate status or location check

Network-Triggered

In a network-triggered scenario, a transaction unit consists of the following sequence:

Services Gatekeeper receives a notification request that is submitted by the network node and then passes it on to the application.

Note:
For the purposes of logging transaction units, all notification triggers are equivalent: periodic, geographical, or state-change based are logged in the same manner.

Call Control

The Call Control transaction group includes transactions for the following Parlay X 2.1/3.0 and RESTful communication services:

- Third Party Call

- Call Notification

- Audio Call

There are two main types of transaction units in the Call Control group:

- Application-Initiated

- Network-Triggered

Application-Initiated

In an application-initiated scenario, a transaction unit consists of one of the following:

- An application requests that Services Gatekeeper setup a third party call. For the purposes of logging transaction units, no distinction is made based on who eventually terminates the call: the application, the caller or the callee.

- An application requests that Services Gatekeeper add or transfer a participant in a call (PX 3.0 only).

- An application requests that Services Gatekeeper either play an Audio Call message of any type or play a message and collect digits (PX 3.0 only).

Network-Triggered

In a network-triggered scenario, a transaction unit consists of one of the two following sequences:

- Services Gatekeeper receives a notification request from the network node and passes it on to the application. The request contains status information about the call, such as the callee is busy or not answering. No distinction is made between a notification that arrives in notify mode (for information only) and one that arrives in interrupt mode (where the call can be manipulated in the return message from the application).

- Services Gatekeeper receives a notification request from the network node and processes the call itself, based on rules that have been provisioned by the application at an earlier time.

Presence

The Presence transaction group covers transactions for the following Parlay X 2.1 and RESTful communication services:

- Presence

There are three main types of transaction units in the Presence group:

- Application-Initiated - Watcher

- Network-Triggered - Watcher

- Application-Initiated - Presentity

Application-Initiated - Watcher

In an application-initiated scenario, a transaction unit consists of the following:

Services Gatekeeper receives a polling request for user presence information from an application and passes it to the underlying network node. Services Gatekeeper then receives the immediate response that the underlying network node returns and passes it back to the application.

Network-Triggered - Watcher

In a network-triggered scenario, a transaction unit consists of the following:

Services Gatekeeper receives a status change notification request from the network node and passes it on to the application.

Application-Initiated - Presentity

In an application-initiated scenario, a transaction unit consists of the following:

A presentity publishes its presence information to Services Gatekeeper, which passes it on to the Presence Server.

Payment

The Payment transaction group covers transactions for the following OneAPI, Parlay X 3. 0, and RESTful communication services:

- Payment

The Payment transaction group includes only application-initiated requests.

Application-Initiated

A Payment transaction unit is recorded in the following situations

- Charging or refunding an amount

- Charging a split amount

- Reserving an initial amount and releasing it

- Reserving an initial amount and charging it

- Reserving an additional amount

A payment transaction unit is not recorded in the following situation:

- Releasing a previously held amount

Named User Plus License

Named User Plus is the licensing model used for both Services Gatekeeper Portals and Reporting. This section describes the terms of that license model.

Named User Plus is defined as an individual authorized by you to use the programs which are installed on a single server or multiple servers, regardless of whether the individual is actively using the programs at any given time. A non-human operated device will be counted as a named user plus in addition to all individuals authorized to use the programs, if such devices can access the programs. If multiplexing hardware or software (for example, a TP monitor or a web server product) is used, this number must be measured at the multiplexing front end. Automated batching of data from computer to computer is permitted. You are responsible for ensuring that the named user plus per processor minimums are maintained for the programs contained in the user minimum table in the licensing rules section; the minimums table provides for the minimum number of named users plus required and all actual users must be licensed.

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 that have purchased support 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.

Copyright © 2007, 2015, Oracle and/or its affiliates. All rights reserved.

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.

Oracle Legal Notices

Copyright Notice

Copyright © 1994-2015, Oracle and/or its affiliates. All rights reserved.

Trademark Notice

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.

License Restrictions Warranty/Consequential Damages Disclaimer

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.

Warranty Disclaimer

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.

Restricted Rights Notice

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.

Hazardous Applications Notice

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.

Third-Party Content, Products, and Services Disclaimer

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.

Alpha and Beta Draft Documentation Notice

If this document is in preproduction status:

This documentation is in preproduction status and is intended for demonstration and preliminary use only. It may not be specific to the hardware on which you are using the software. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to this documentation and will not be responsible for any loss, costs, or damages incurred due to the use of this documentation.