API Overview Release 7 - Oracle

[1Oracle?

]

Communications

Unified Inventory Management

API Overview

Release 7.4

E88057-01

December 2017

Oracle Communications Unified Inventory Management API Overview, Release 7.4

E88057-01

Copyright ? 2013, 2017, 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.

Contents

Preface ................................................................................................................................................................. v

Audience.......................................................................................................................................................

Related Documentation ..............................................................................................................................

Documentation Accessibility .....................................................................................................................

v

v

vi

1 Overview

2 Working with Transactions, Exceptions, and Logging

Working with Transactions ....................................................................................................................

Working with Exceptions .......................................................................................................................

Working with Logging ............................................................................................................................

Configuring the Logging Level........................................................................................................

Working with the Log Interface .......................................................................................................

About UIM Log Messages ................................................................................................................

Defining Custom Log Messages ......................................................................................................

Working with the FeedbackProvider Interface..............................................................................

3

2-1

2-2

2-3

2-3

2-3

2-4

2-5

2-5

Implementing a Generic Service Fulfillment Scenario

About the Generic Service Fulfillment Scenario ............................................................................... 3-1

Querying for the Specification .............................................................................................................. 3-4

Creating the Service and Service Configuration................................................................................ 3-4

Creating the Service ........................................................................................................................... 3-5

Retrieving the Service Configuration Specification ...................................................................... 3-6

Creating the Service Configuration ................................................................................................. 3-7

About Alternate Flows ...................................................................................................................... 3-8

Changing the Service.................................................................................................................. 3-8

Disconnecting the Service .......................................................................................................... 3-9

Creating and Associating the Party....................................................................................................... 3-9

Creating the Party .............................................................................................................................. 3-9

Creating the Party Role .................................................................................................................. 3-10

Associating the Party and Party Role with the Service ............................................................. 3-11

About Alternate Flows ................................................................................................................... 3-12

Disassociating the Party and Party Role from the Service................................................. 3-12

Deleting the Party .................................................................................................................... 3-13

Deleting the Party Role ........................................................................................................... 3-13

iii

Creating and Associating the Geographic Address with the Service .........................................

Creating the Geographic Place......................................................................................................

Creating the Place Role...................................................................................................................

Associating the Geographic Place and Place Role with the Service ........................................

About Alternate Flows ...................................................................................................................

Disassociating the Geographic Place and Place Role from the Service............................

Deleting the Geographic Place ...............................................................................................

Deleting the Place Role............................................................................................................

Configuring the Resources for the Service Configuration............................................................

Finding the Service..........................................................................................................................

Finding the Current Service Configuration Version..................................................................

Finding the Service Configuration Item ......................................................................................

Finding the Custom Object to Assign ..........................................................................................

Creating the Custom Object to Assign.........................................................................................

Assigning the Resource to a Configuration Item .......................................................................

About Alternate Flows ...................................................................................................................

Unassigning Resources from a Configuration Item............................................................

Reserving a Custom Object ....................................................................................................

Unreserving a Custom Object ................................................................................................

Creating a Blocked Condition for a Custom Object............................................................

Deleting a Blocked Condition for a Custom Object ............................................................

Setting Characteristic Values for the Service Configuration Item ..............................................

About Alternate Flows ...................................................................................................................

Unsetting Characteristic Values for the Service Configuration Item ...............................

Transitioning the Lifecycle Status .....................................................................................................

3-14

3-14

3-15

3-16

3-16

3-17

3-17

3-18

3-18

3-19

3-20

3-20

3-20

3-21

3-22

3-23

3-24

3-25

3-27

3-28

3-30

3-31

3-33

3-33

3-33

4 Implementing a Channelized Connectivity Enablement Scenario

About the Channelized Connectivity Enablement Scenario ........................................................... 4-1

Creating a Property Location and Associating Network Entity Codes.......................................... 4-2

Creating a Logical Device and Associating LD Interfaces with Network Entity Codes ............ 4-4

Creating Channelized Connectivity ..................................................................................................... 4-6

Create Channelized Connectivity .................................................................................................... 4-6

Configure Capacity on the Channelized Connectivity................................................................. 4-8

Configure Auto Termination on the Channelized Connectivity ................................................ 4-9

Enabling Channelized Connectivity .................................................................................................... 4-9

Manually Enabling Channelized Connectivity........................................................................... 4-10

Performing Gap Analysis............................................................................................................... 4-11

Adding Segments To Connectivity Path Based on the Gap Analysis Results ....................... 4-12

A UIM Entity Managers

B NFV Orchestration Java Managers

C Common Utility Code Examples

iv

Preface

This guide explains how to extend Oracle Communications Unified Inventory

Management (UIM) through standard Java practices using Oracle Communications

Design Studio, which is an Eclipse-based integrated development environment. This

guide includes references to both applications, and often directs the reader to see the

Design Studio Help and the UIM Help for instructions on how to perform specific

tasks.

This guide includes information about the UIM entity managers. This guide also

includes the list of Java managers which provide UIM's NFV Orchestration

functionality. Similar to extending UIM and using the UIM APIs, the information in

this guide applies to extending the NFV Orchestration functionality as well.

This guide should be read after reading UIM Concepts, because this guide assumes that

the reader has a working knowledge of UIM architecture and concepts. This guide

should be read from start to finish because the information presented in a chapter

often builds upon information presented in a preceding chapter.

This guide includes examples of typical development code used in given situations.

The guidelines and examples may not be applicable in every situation.

Audience

This guide is intended for developers who implement code to extend UIM. The

developers should have a good working knowledge of XML and Java development

and, in particular, JPA, standard Java practices, and J2EE principles. In working with

the NFV Orchestration functionality, this guide assumes you have a working

knowledge of NFV concepts.

Related Documentation

For more information, see the following documents in the Oracle Communications

Unified Inventory Management documentation set:

¡ö

¡ö

¡ö

¡ö

UIM Installation Guide: Describes the requirements for installing UIM, installation

procedures, and postinstallation tasks.

UIM System Administrator¡¯s Guide: Describes administrative tasks such as working

with cartridges and cartridge packs, maintaining security, managing the database,

configuring Oracle Map Viewer, and troubleshooting.

UIM Security Guide: Provides guidelines and recommendations for setting up UIM

in a secure configuration.

UIM Concepts: Provides an overview of important concepts and an introduction to

using both UIM and Design Studio.

v

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download