6 Base Rulesets and Extension Points

This chapter contains information about the rulesets in the Oracle Communications Unified Inventory Management (UIM) Base Rulesets cartridge and the base extension points in the Base Extensionpoints cartridge.

Base Rulesets

The Base Rulesets cartridge contains several rulesets that provide fundamental capabilities required to provision an inventory solution for specific domains, such as VoIP or POTS.

For example, the Base Rulesets cartridge provides a ruleset that identifies geographic place formats for service points. There are rulesets to validate resource availability and service configurations based on service parameters.

Use the base rulesets for reference or modify or substitute them to create custom rulesets. For example, the default telephone number format may not match the telephone number format used by the country in which you are implementing UIM. To reformat the telephone number, reuse or modify the base ruleset used to format telephone numbers.

Alternatively, you can write your own ruleset, assign it the same name as the base ruleset, and replace the base ruleset with it. See UIM Developer's Guide for more information on how to create your own rulesets.

Base Ruleset Descriptions

Table 6-1 lists and describes the basic rulesets in the Base Rulesets cartridge.

Table 6-1 Rulesets in the Base Rulesets Cartridge

Ruleset/Ruleset Extension Points Functionality

ADDRESS_RANGE_VALIDATION

Validates address ranges for geographic addresses in China.

CONVERT_LD_SR1_TO_SR2

Converts logical device entities from the format used in the SR1 release of UIM to the format used in SR2.

CREATE_ADDRESS_CHARACTERISTIC_MAP

Returns values for address associated with characteristic names.

EncryptText

Encrypts passwords in data federation scenarios.

FIND_ADDRESS_RANGE

Distinguishes between address formats for a city or town based on incoming geographic address and retrieves associated characteristic values.

IMPORT_INVENTORY

Imports inventory data from external systems using a CSV file. You should customize the ruleset based on your business requirements before you deploy it. For example, you can customize this rulesets to import inventory data in bulk using a CSV file.

PLACE_FORMAT_IDENTIFIER

Identifies country-specific telephone number formats.

RECALL_DISCONNECTED_TN

Transitions telephone numbers with a Disconnected status to the Transitional status. The disconnected numbers are transitioned if the expiry period is reached. For example, for a telephone number that was disconnected on January 1, 2009, and for which the expiry period is set for 10 days later, the transition can occur only on January 10, 2009. The expiry period is configured by the service provider.

This is a global ruleset and will apply to all telephone numbers regardless of the specifications used to create them.

RESERVATION_CHECK_REDEEMER

Can be configured to either of the two values: True or False. The default value is True. Setting the value to True indicates that when a reserved resource is assigned to a service configuration item, the user needs to provide the values of the Reserved For Type and Reserved For fields. The resource cannot be redeemed if the user provides incorrect values.

Setting the value to False indicates that no validation occurs to check for incorrect values of the Reserved For Type and Reserved For fields, and the resource is automatically assigned to the configuration item.

This is a global ruleset.

RESERVATION_EXPIRATION

Indicates the expiration periods for Long term and Short Term reservations. The default are 10 minutes and 40 days respectively.

This is a global ruleset.

SYSTEM_EXPORT

Exports database entities into other systems in XML format. This downloadable file is available in a binary ZIP file that may be imported using the SYSTEM_IMPORT ruleset.

SYSTEM_IMPORT

Imports data in XML format into UIM. This ruleset accepts a input in a binary ZIP file, which the SYSTEM_EXPORT ruleset generates.

TELEPHONE_NUMBER_FORMATTING

Changes the default telephone number length and format specified in a telephone number specification. The default length and format is NNNNNNNN. You may change the length and format to suit the requirements of your country. Use the NNN-NNN-NNNN format for US telephone numbers and NNN NN NNNN for telephone numbers in Spain.

TELEPHONE_NUMBER_GRADING

Enables you to define specific telephone number patterns. For example, you can define telephone numbers that users consider lucky or can memorize easily.

TN_SELECTION

Allows you to select telephone numbers that are placed into an inventory group that has a service association.

For example, consider a scenario where the telephone number 214-529-0001 is assigned to inventory group A, which references the service specification Pots Service. In this case, a Pots Service instance will select the telephone number assigned to that service using the inventory group A.

TRAIL_PIPE_TOPOLOGY_EDGE

Prevents the topology from storing the service trails of pipes and thereby ensures that they are not reflected in path analysis results. The default topology behavior requires that each individual pipe be terminated on a resource. This information is stored in a topology.

VALIDATE_ADDRESS_FOR_RANGE

Validates that a given address lies within a specified address range based on the values of the address range and address parameters.

VALIDATE_RELATE_PLACES

Validates whether the parameters for a parent place and the associated child place relate to specifications.


Base Extension Points

The Base Extensionpoints cartridge contains a set of basic extension points that may be associated with rulesets.

A ruleset is associated with an extension point that identifies the point where the ruleset is run. The extension point triggers the ruleset to run whenever the extension point is called.

Extension points are identified in the corresponding ruleset extension point specifications. Each extension point specification contains a signature of a method that calls the extension point. Whenever a service calls the method, the extension point is called and the associated ruleset is run.

For example, the ruleset extension point MPLSL3VPN_ALLOCATE_ALL_EXT instructs the system to run the ruleset MPLSL3VPN_ALLOCATE_ALL at the extension point ServiceConfigurationManager_autoAllocateServiceConfig.

In the Base Extension points cartridge, that extension point identifies the following point name and method signature:

ServiceConfigurationManager.autoAllocateServiceConfig
public abstract interface void
oracle.communications.inventory.api.service.ServiceConfigurationManager.
autoAllocateServiceConfig
(oracle.communications.inventory.api.entity.ServiceConfigurationVersion)

As a result, any time the ServiceConfigurationManager.autoAllocateServiceConfig method is called for an MPLS VPN service, the extension point in the Base Extension points cartridge is called and the MPLSL3VPN_ALLOCATE_ALL ruleset is run. See UIM Developer's Guide for more information on extension points.

Base Extension Point Descriptions

Table 6-2 lists and describes the extension points in the Base Extensionpoints cartridge.

Table 6-2 Ruleset Extension Points in the Base Extensionpoints Cartridge

Extension Point Functionality

ActivityManager.createActivity

Triggered when an activity is created.

ActivityManager.updateActivity

Triggered when an activity is updated.

AddressRangeManager_findAddressRange

Determines whether a particular address format pertains to a city or town based on the incoming geographic address and retrieves the corresponding characteristic values.

AddressRangeManager_validateAddressForRange

Validates whether a specific address can be associated to a particular address range.

AssignmentManager.assignResourceToTerminationPoint

Assigns a resource to a pipe termination point. Redeems the resource reservation, if any. Refers to the following method:

AssignmentManager.assignResourceToTerminationPoint(oracle.communications.inventory.api.entity.PipeTerminationPoint, java.util.Collection, java.lang.String, java.lang.String)

AssignmentManager_unassignResource

Enables you to unassign a resource from a service configuration when disconnecting a service.

AttachmentManager_createAttachment

Creates custom involvements between inventory items. Refers to the following method:

AttachmentManager.createCustomInvolvement(java.util.Collection)

AttachmentManager_createAttachment_Global

Global extension point to create custom involvements between inventory items. Refers to the following method:

AttachmentManager.createCustomInvolvement(java.util.Collection)

AttachmentManager_deleteAttachment

Deletes existing custom involvements between business entities. Refers to the following method:

AttachmentManager.deleteCustomInvolvement(java.util.Collection)

AttachmentManager_deleteAttachment_Global

Global extension point to delete existing custom involvements between business entities. Refers to the following method:

AttachmentManager.deleteCustomInvolvement(java.util.Collection)

AttachmentManager_updateAttachment

Modifies existing custom involvements between business entities. Refers to the following method:

AttachmentManager.updateCustomInvolvement(java.util.Collection)

AttachmentManager_updateAttachment_Global

Global extension point to modify existing custom involvements between business entities. Refers to the following method:

AttachmentManager.updateCustomInvolvement(java.util.Collection)

BaseConfigurationManager_approveConfigurationVersion

Changes a configuration version status to Issued status. Refers to the following method:

BaseConfigurationManager.approveConfigurationVersion(oracle.communications.inventory.api.entity.common.InventoryConfigurationVersion)

BaseConfigurationManager_assignResource

Assigns a resource to an entity configuration, redeeming the resource reservation if any. Refers to the following method.

BaseConfigurationManager.assignResource(oracle.communications.inventory.api.entity.common.InventoryConfigurationItem, oracle.communications.inventory.api.entity.common.ConsumableResource, java.lang.String, java.lang.String)

BaseConfigurationManager_autoAllocate

Assigns resources to entityConfigurationItems based on rules. This method is called when the specOption is selected from the specification options associated with a configuration item. You can extend this to automatically assign a resource on a particular configuration item after selecting a specification option. You can extend this method for any of the three configurations: Pipe, Logical Device, and Network.

BaseConfigurationManager_autoAllocateInvConfiguration

Assigns resources automatically to the configuration items for the specified configuration version, based on rules. This method is called when the Auto assign option is selected from the Related Pages menu. You can extend this method to perform automatic assignment for an entire configuration version. You can extend this method for any of the three configuration items: Pipe, Logical Device, and Network.

BaseConfigurationManager_autoAssignResource

Assigns resources to the configuration item based on rules. You can extend this method to perform automatic assignment for the newly-created configuration items. You can extend this method for any of the three configuration items: Pipe, Logical Device, and Network.

BaseConfigurationManager_automateConfiguration

Provides an extension point for custom rulesets that automate configuration. The default implementation does nothing.

BaseConfigurationManager_cancelConfigurationVersion

Cancels a configuration version. The status to which the configuration version is transitioned varies based on the starting status:

  • In Progress, Designed—Canceled

  • Designed—Canceled

  • Issued—Pending Cancel

  • Pending Cancel—Issued

BaseConfigurationManager_completeConfigurationVersion

Completes a configuration version. The status to which the configuration version is transitioned varies based on the starting status:

  • Issued—Completed

  • Pending Cancel—Canceled

BaseConfigurationManager_issueConfigurationVersion

Changes a configuration version status to Issued.

BaseConfigurationManager_unallocateInventoryConfigurationItems

Unassigns resources from configuration items. The configuration version cannot be in a Completed or Canceled status.

BaseConfigurationManager_populateCustomProperties

Populates custom properties for consumable resources.

BaseConfigurationManager_populateCustomProperties2

Populates custom properties for reference-enabled configurations.

BaseConfigurationManager_validateInventoryConfiguration

Validates the configuration versions. This method contains a set of basic validation procedures for date validations. You can extend this method using a ruleset. This method is called when you select Validate from the Actions list. You can extend this method to add more validations for a configuration version. You can extend this method for any of the three configuration items: Pipe, Logical Device, and Network.

BaseInvManager_completeCreate

Provides an extension point for validating entity creation during the completion of a business interaction.

BaseInvManager_completeDelete

Provides an extension point for validating entity deletion as part of a business interaction completion.

BaseInvManager_completeUpdate

Provides an extension point for validating entity modification as part of a business interaction completion.

BaseInvManager_validateDisassociation

Provides an extension point for validating the disassociation of items from business interactions.

BaseInvManager_validateTransfer

Provides an extension point for validation during the transfer of items from one business interaction to another.

BOMManager.populateAdditionInfoOnResource

Captures additional information about a resource while calculating a Bill of Materials (BOM).

BOMManager.populateAdditionInfoOnActivity

Captures additional information about an activity while calculating a BOM.

BusinessInteractionManager_addChildBusinessInteraction

Adds an additional child business interaction to the parent business interaction. This method is called when you associate one or more child business interactions in the Business Interaction Tree hierarchy. You can extend this method to include additional validations or business logic.

BusinessInteractionManager_cancelBusinessInteraction

Cancels one or more business interactions and restores the inventory status of the business interaction items accordingly. The context is set to Current. This method is called when you try to cancel the business interaction. You can extend this method to add more validations or business logic while canceling the business interaction. The context reverts to Current after the method has run.

BusinessInteractionManager_completeBusinessInteraction

Completes one or more business interactions and updates the inventory status of the business interaction items accordingly. This method is called when you try to complete the business interactions. You can extend this to add more validations or business logic while completing the business interactions. The context reverts to Current after the business interactions are completed.

BusinessInteractionManager_createBusinessInteractionAttachment

Creates an attachment to a business interaction.

BusinessInteractionManager_deleteBusinessInteractions

Deletes one or more business interaction. Sets the business interaction context to Current.

BusinessInteractionManager_getEntityAction

Gets the entity action during a Web service request to create a business interaction for service fulfillment.

BusinessInteractionManager_preProcessInteractionItems

Provides an extension point for sorting items during the execution of the Process Interaction Web service. You can create rulesets that ensure that items are processed in the proper order to account for dependencies among items.

BusinessInteractionManager_removeChildBusinessInteraction

Removes one or more child business interactions from a parent business interaction. This method is called when you try to disassociate one or more child business interactions within the Business Interaction Tree hierarchy. You can extend this method to include additional validations or business logic.

BusinessInteractionManager_sendRequest

Provides an extension point for developing logic for construction for constructing an interaction exchange or request with a third party system.

BusinessInteractionManager_switchContext

Changes the current business interaction context to another business interaction context or reverts it to Current context. If a versioned entity is passed, it is refreshed from the datastore. The context of the version object is changed to the target business interaction context or set to null if it is the Current context. The method returns a null value if the refreshed entity does not exist in the target business interaction or the Current context. You should call this method within the transaction scope.

BusinessInteractionManager_transferItems

Transfers business interaction items to the target business interaction. This method is called when you transfer items from one business interaction to another. You can extend this method to include additional validations or business logic.

BusinessInteractionManager_updateBusinessInteraction

Updates one or more business interactions.

BusinessInteractionUtils_associateWithBusinessInteraction

Associates the versioned object to a business interaction. It creates a new business interaction item if there is none available; otherwise, it returns the existing business interaction item. This method is called when you modify a business-interaction-enabled object in the context of a business interaction. You can extend this method to include additional validations or business logic.

ConditionManager_createConditions

Allows you to modify the way conditions are created in UIM. The API call associated with this extension point creates conditions for the resources in the set of Condition entities sent to the API call. The API call also creates conditions for the resources that are preconfigured with the resources sent as part of the call. Conditions are not currently supported for the configuration items Service and Geographic Place. The UIM base implementation requires that the reason, type, and resource be provided in the condition; otherwise, it will throw an error. This extension point may be used to add more entities that can have conditions attached or to notify that a condition has been created.

ConditionManager_deleteConditions

Enables you to alter the way conditions are deleted. The API call associated with this extension point scans the collection of resources supplied and deletes the conditions associated with the resources. The API call also removes the conditions from the resources that are preconfigured with the resources specified in the collection.

ConditionManager_updateConditions

Allows you to modify the way conditions are inventoried in UIM. The API call associated with this extension point updates the conditions inventoried in UIM with the resources in the set of Condition entities sent to the API call. The API call also updates conditions for the resources that are preconfigured with the resources sent as part of the call. Conditions are not currently supported for the configuration items Service and Geographic Place. The UIM base implementation requires that the reason, type, and resource be provided in the condition; otherwise, it will throw an error.

ConsumerManager_checkAvailability

Determines whether a resource has already been consumed or is available for consumption.

CustomNetworkAddressManager_createCustomNetworkAddress

Creates custom network address entities. It allows you to create custom network addresses with or without specifications.

If you create a custom network address with a valid specification, the API associated with the extension point assigns default values to all data elements and characteristics. The API only performs mandatory checks if you create a custom network address without specifications.

The operation to create custom network addresses is atomic. Either all of the input custom network addresses are created or none. The API also runs the federation manager to fetch the federated data and validates that the custom network addresses are unique.

This extension point may be used to perform preliminary checks to ensure that the data supplied has mandatory data elements. The extension point also enables you to add custom network addresses to inventory groups.

EntityIdGenerator_getId_1

Returns an automatically-generated ID for an entity.

The automatically-generated ID is a numeric sequential value, which may optionally contain a prefix and suffix. The prefix and suffix may be defined in the Entity Identification specification.

For the extension point to run correctly, the entity specification should not be configured for a manual ID, and the ID field should be empty.

You may override this extension point with your extension point to generate a custom ID for the entity.

EntityIdGenerator_getId_2

Returns an automatically-generated ID for a child entity.

The automatically-generated ID is a numeric sequential value, which may optionally contain a prefix and suffix. The prefix and suffix may be defined in the Entity Identification specification.

For the extension point to run correctly, the entity specification should not be configured for a manual ID, and the ID field should be empty.

You may override this extension point with your extension point to generate a custom ID for the child entity.

EquipmentManager_copyPhysicalDevices

Copies physical devices, including other physical devices in their hierarchies. Ports and connectors provided by the devices are also copied. Associations, mappings, and preconfigurations are not copied.

EquipmentManager_createEquipment

Creates equipment entities and the designated ports, connectors, and equipment holders based on specifications.

EquipmentManager_createPhysicalDevices

Creates physical devices along with provided ports and connectors defined in the specification.

EquipmentManager_createPhysicalPorts

Creates physical ports provided by other entities.

EquipmentManager_updateEquipment

Updates equipment entities and the designated ports, connectors and equipment holders in UIM.

EquipmentManager_updatePhysicalDevices

Updates data elements and characteristics in a physical device.

FederationManager_assignFederationData

Assigns federated data.

FederationManager_associateFederationData

Associates federated data.

FederationManager_createFederationData

Creates federated data.

FederationManager_deleteFederationData

Deletes federated data.

FederationManager_findFederationData

Finds federated data.

FederationManager_referFederationData

References federated data.

FederationManager_reserveFederationData

Reserves federated data.

FederationManager_updateFederationData

Updates federated data.

FederationManager_validatePreUpdateFederationData

Validates federated data before update.

InventoryEntityLifeCycleEventListener_postLoad

Listens to the postLoad life cycle event. Occurs when a persistent instance is loaded from the data store.

InventoryEntityLifeCycleEventListener_postPersist

Listens to the postPersist event. Occurs after persisting an instance into the database.

InventoryEntityLifeCycleEventListener_postRemove

Listens to the postRemove event. Occurs after removing a persistent instance from the database.

InventoryEntityLifeCycleEventListener_postUpdate

Listens to the postUpdate event. Occurs after updating a persistent instance in the database.

InventoryEntityLifeCycleEventListener_prePersist

Listens to the prePersist event. Occurs before persisting an instance in the database.

InventoryEntityLifeCycleEventListener_preRemove

Listens to the preRemove event. Occurs before removing a persistent instance in the database.

InventoryEntityLifeCycleEventListener_preUpdate

Listens to the preUpdate event. Occurs before updating a persistent instance in the database.

InventoryGroupManager_associateInventoryGroupsToPersistent

Allows you to customize UIM behavior when associating an inventory group to a persistent entity, such as party.

InventoryGroupManager_associatePersistentToInventoryGroup

Allows you to customize UIM behavior when associating multiple persistent entities to an inventory group.

InventoryGroupManager_createInventoryGroup

Allows you to customize UIM behavior when you create an inventory group.

InventoryGroupManager_deleteInventoryGroup

Allows you to customize UIM behavior when you delete an inventory group.

InventoryGroupManager_deleteInvGroupRef

Allows you to customize UIM behavior when you delete an inventory group reference row.

InventoryGroupManager_updateInventoryGroup

Allows you to customize UIM behavior when you update an inventory group.

IPAddressManager_createIPAddress_Global

Extension point on IP address creation.

IPAddressManager_deleteIPAddress_Global

Extension point on IP address deletion.

IPAddressManager_updateIPAddress_Global

Extension point IP address update.

IPNetworkManager_createIPNetworks_Global

Extension point on IP network creation.

IPNetworkManager_deleteIPNetworks_Global

Extension point on IP network deletion.

IPNetworkManager_updateIPNetworks_Global

Extension point on IPv4 address creation.

IPv4AddressManager_createIPAddresses_Global

Extension point on IPv4 address creation.

IPv4AddressManager_deleteIPAddresses_Global

Extension point on IPv4 address deletion.

IPv6AddressManager_createIPAddresses_Global

Extension point on IPv6 address creation.

IPv6AddressManager_deleteIPAddresses_Global

Extension point on IPv6 address deletion.

IPv6AddressManager_updateIPAddresses_Global

Extension point on IPv6 address update.

LogicalDeviceAccountManager_createLogicalDeviceAccounts

Creates logical device accounts in UIM.

LogicalDeviceAccountManager_deleteLogicalDeviceAccounts

Deletes logical device accounts in UIM.

LogicalDeviceAccountManager_updateLogicalDeviceAccounts

Modifies logical device accounts in UIM.

LogicalDeviceManager_copyLogicalDevices

Copies logical devices, including logical devices in the hierarchies. Provided logical devices are also copied. Associations, relationships, and mappings are not copied.

LogicalDeviceManager_createLogicalDevice

Creates logical device entities and their designated device interfaces and sub device interfaces based on the specification. Device interfaces can also provide other device interfaces. The number of device interfaces to be created is determined by the minimum value defined in the specification relationships.

LogicalDeviceManager_deleteLogicalDevice

Delete logical devices, designated device interfaces, and sub device interfaces. Also deletes associations between designated device interfaces and physical ports/connectors. The extension point does not delete entities with active assignments or reservations.

LogicalDeviceManager_updateLogicalDevice

Modifies the data elements and characteristics of a logical device in UIM. If logical device is deactivated, all designated device interfaces and sub device interfaces are also deactivated. A logical device cannot be deactivated if the designated device interfaces have an active assignment or reservation. If a logical device is activated, all designated device interfaces and sub device interfaces are also activated.

MediaResourceManager_createMediaStreams

Creates a media stream entity based on the input specification and data.

MediaResource_updateMediaStreams

Updates characteristics and data elements in a media stream entity.

NetworkManager_createNetwork

Creates a network entity.

NetworkManager_createNetworkEdge

Creates a network edge.

NetworkManager_createNetworkNode

Creates a network node.

NetworkManager_deleteNetworkEdges

Deletes network edges.

NetworkManager_deleteNetworkNodes

Deletes network nodes.

NetworkManager_updateNetwork

Updates characteristics and data elements in a network entity.

NetworkManager_updateNetworkEdges

Updates characteristics and data elements in a network edge.

NetworkManager_updateNetworkNodes

Updates characteristics and data elements in a network node.

PartyManager_createParty

Allows you to customize UIM behavior when creating parties.

PartyManager_deleteParty

Allows you to customize UIM behavior when deleting parties.

PartyManager_updateParty

Allows you to customize UIM behavior when modifying parties.

PathAnalysisManager_findPaths

Initiates a path analysis using enabled pipe and custom filtering criteria or analysis mode as parameters.

PathAnalysisManager_findSecondaryPaths

Finds secondary paths for a given primary path. Process the list of primary pipes and identifies available secondary path based associated network properties.

PathAnalysisManager_postProcessFindSecondaryPaths

Provides an extension point for customizing the secondary path logic. Occurs after secondary paths are determined but before results are returned.

PathAnalysisManager_preProcessFindSecondaryPaths

Provides an extension point for customizing the secondary path logics. Occurs before secondary paths are determined.

PipeConfigurationManager_addTrailPipeSegments

Creates pipe configuration items for the pipe segments return by path analysis.

PipeConfigurationManager_addTransportItems

Creates configuration item for each pipe in a given path in the transport group.

PipeConfigurationManager_deleteEnablementConfigItems

Deletes the configuration items from the first transport group for pipes that no longer enable the service trail.

PipeConfigurationManager_reassignEnablementConfigItems

Reassigns enablement configuration items from a previous configuration version.

PipeConfigurationManager_unassignEnablementConfigItems

Unassigns enablement configuration items from a previous configuration version.

PipeConfigurationManager_updatePipeConfiguration

Updates a pipe configuration for the first path. Creates gap pipes and makes pipe assignments.

PipeManager_autoConfigure

Provides an extension point for automating enablement of a trail pipe with no pipe configuration.

PipeManager_createDefaultPipes

Creates pipe entities based on the input specification.

PipeManager_createTrailPipe

Creates a trail pipe and its two provided termination points.

PipeManager_deletePipeEnablement

Deletes the enablements for the trail for the first path.

PipeManager_deletePipes

Deletes pipe entities. If the pipe is part of a trail, it cannot be deleted until the trail is updated to remove this pipe from the enablement The two pipe termination points are also deleted if no other pipes are sharing them.

PipeManager_updatePipes

Updates the characteristics and data elements in a pipe entity.

PipeManager_updateTrailPipe

Updates a trail pipe.

PipeManager_updateTrailPipeSegments

Updates a pipe configuration for a given path (transport group). Creates gap pipes and makes pipe assignments.

PlaceConfigurationManager_autoAssignResource

Allows you to customize automatic assignment logic for inventory resources.

PlaceConfigurationManager_validatePlaceConfiguration

Validates the list of place configurations and returns a list of valid place configurations.

PlaceManager_createGeographicPlace

Creates one or more entities based on GeographicPlace specifications.

PlaceManager_deleteGeographicPlace

Deletes one or more Geographic Place entities from the database.

PlaceManager_formatGeocodingAddress

Converts a UIM address into a string of address lines in a specific format, similar to a postal address, required by the Oracle Spatial GeoCoder.

PlaceManager_relatePlaces

Creates a relationship between two GeographicPlace entities, which creates a PlaceRel entity. The PlaceRel entity represents a relationship between two Geographic Place instances.

PlaceManager_relatePlaces2

Additional extension point on place relationship.

PlaceManager_updateGeographicPlace

Updates the data elements of one or more Geographic Place entities.

ReservationManager_checkRedeemer

Allows you to check whether a resource is redeemable. If the associated API returns a true value to indicate that a particular reserved resource is redeemable, you must provide values for Reserved For and Reserved For Type fields to redeem the resource.

This extension point is used in Redeem Reservation work flows.

ReservationManager_deleteReservation

Allows you to delete resource reservations created in UIM.

ReservationManager_expireReservation

Allows you to expire reservations that have an expiry date prior to the current date.

ReservationManager_extendReservation

Allows you to extend the expiry dates for reservations based on the expiration rules.

ReservationManager_reserveResource

Allows you to create reservations for a group of resources. The API associated with the extension point is used in work flows where reservations are created for resources. The API is used in both UI and work flows for Web services.

ReservationManager_setReservationExpiry

Allows you to configure the expiry dates for reservations based on the expiration rules. You can configure the reservation rules using the RESERVATION_EXPIRATION ruleset.

ReservationManager_unreserveResource

Allows you to delete the reservations for resources you previously reserved.

ReservationManager_updateReservation

Allows you to update the input collection of reservations.

ReservationManager_updateReservation2

Updates the collection of reservations with modified values.

ServiceConfigurationManager_createServiceConfiguration

Create a new configuration version for a service.

ServiceConfigurationManager_refreshTopology

Refreshes the topology for the specified version based on rules.

ServiceConfigurationVersionWorker_validateCompleteConfigurationForCustomState

Validates the Service configuration on completion for a custom state.

ServiceConfigurationVersionWorker_validateCreateConfigurationForCustomState

Validates the Service configuration on creation for a custom state.

ServiceManager_cancelService

Starts the cancel operation for a service. The status to which the service is transitioned depends on the starting status.

ServiceManager_completeService

Starts the complete operation for a service. The status to which the service is transitioned depends on the starting status.

ServiceManager_createService

Create one or more service entities.

ServiceManager_disconnectService

Transitions the service to Pending Disconnect status. Creates a new configuration version and unassigns or dereferences current assignments and references. The configuration version that is created must be completed to transition the service to Disconnected status.

ServiceManager_resumeService

Resumes a service by transitioning it from Suspended status to In Service status. Does not change the status of assignments or references on the active configuration.

ServiceManager_suspendService

Transitions the service to Suspended status. Does not change assignments or references in the active configuration version.

ServiceManager_updateService

Changes service characteristics and data elements.

SpecManager_getEditMask

Enables you to customize code to retrieve the edit mask specified in the Telephone Number specification.

The default edit mask for a telephone number is '##########'.

TelephoneNumberManager_createTelephoneNumbers

Creates telephone numbers in UIM.

TelephoneNumberManager_deleteTelephoneNumbers

Deletes telephone numbers from UIM.

TelephoneNumberManager_recallDisconnectedTelephoneNumber

Manages the transition of the telephone number assignment status from Disconnected to Transitional, and subsequently to Unassigned. This extension point is called by the TN_AGING ruleset.

TelePhoneNumberManager_transitionOnSnapBack

Transitions the telephone number status from Ported to Unassigned for telephone numbers that were previously ported out.

TelephoneNumberManager_updateTelephoneNumbers

Updates telephone numbers in UIM.

TimeoutEventListener_timerExpired

Notifies timer expiry events in UIM.

TopologyMapper_createEnabledByPipesTopologyEdge

Enables you to track pipe topology in non-optimal cases. The default topology behavior requires that each individual pipe be terminated on a resource to be stored in topology. This mechanism is used so Service Trails are not stored in topology and path analysis will not find those paths. There are two situations where this default behavior is not optimal. A T1 is riding a T3 and the T1 is not terminated, because it is terminated on the T3, and a Local Loop scenario where the provisioner wishes to assign to the local loop and not the individual cable pairs. For these cases, extend this method using either an 'INSTEAD' ruleset extension point for the specification you wish to track in topology. If this method returns 'TRUE' topology will use the termination points of the parent connection as the termination points of the child.

TopologyProfileMapper_createTopologyProfile

Enables you to create nodes for logical devices, physical devices, device interfaces, equipment, networks, network nodes, geographic sites, locations, edges for pipes and networks. You must assign the nodes and edges to a service configuration for them to appear in the service topology. This extension point is called when you select View Topology on the Service Topology work area for the first time. This extension point also calls the extension point TopologyProfileMapper_processTopologyProfileExtension after it runs.

TopologyProfileMapper_processTopologyProfileExtension

Enables you to access the TopologyProfile TopologyEdgeProfile and TopologyProfile TopologyNodeProfile lists to add, modify, and delete edges and nodes respectively. You should associate this extension point to the ServiceConfigurationVersion specification that needs to be extended. You should run this extension point after the refreshServiceTopology and createTopologyProfile extension points have run.

TopologyProfileMapper_refreshServiceTopology

Refreshes the topology for a service topology profile. By default, this extension point deletes the current service topology profile and then recreates it. This extension point calls the extension point 'TopologyProfileMapper_processTopologyProfileExtension to run custom implementations.

TransitionManager_validateBusinessStateTransitions

Lets you overwrite existing validation rules for business state transitions or perform additional tasks before or after a validation. This extension point is called before an entity transitions to a new business state.

TransitionManager_validateObjectStateTransition

Lets you overwrite existing validation rules for object state transitions or perform additional tasks before or after a validation. This extension point is called before an entity transitions to a new object state.

WorkflowManager.assignActivity

Used to assign activities to users or resources.

WorkflowManager.canActivityStartNow

Checks whether an activity can be started.

WorkflowManager.canActivityCompleteNow

Checks whether an activity can be completed now.

WorkflowManager.completeActivity

Triggered when an activity is completed.

WorkflowManager.createActivities

Triggered when multiple activities are created.

WorkflowManager.insertActivity

Triggered when an activity is inserted into an existing workflow.

WorkflowManager.isAllowedToWorkOnActivity

Checks whether an activity can be assigned to a particular user.

WorkflowManager.startActivity

Triggered when an activity starts.