This chapter defines the attributes of the data returned when the Activation API makes a call to Oracle Communications MetaSolv Solution to retrieve activation data.
The element returned by the Activation XML API is metaSolvServiceActivationValue, which is defined in the schema XmlMetaSolvServiceEntities.xsd. The element is defined as type MetaSolvServiceActivationType. The following list is a hierarchical representation of the attributes contained within MetaSolvServiceActivationType. See "Schema Type and Attribute Descriptions" for the descriptions of the types and attributes within MetaSolvServiceActivationType.
orderDetails (OrderDetailsType) companyName firstName lastName orderKey (OrderKeyType) primaryKey serviceCategory purchaseOrderNumber desiredDueDate suppType orderType switchActivation (Array of SwitchActivationType) switchLocationNetworkCode lineServices (Array of LineServiceType)
Note:
See "ServiceType" for more information.
lineEquipmentNumber
networkElementIdentifier
networkElementName
originatingEquipmentType
isHuntGroupMember
telephoneNumber (TelephoneNumberType)
telephoneNumber
activityCd
relatedTelephoneNumbers
fromTelephoneNumber
toTelephoneNumber
associationType
intercept
interceptId
option
name
endDate
picInformation
pic
picTypeCd
freezePic
partyName
activityCd
lineFeatures (Array of ServiceType)
Note:
See "ActivationCustomAttributeType" for more information.
systemOptions (Array of ServiceType)
Note:
See "ServiceType" for more information.
huntGroups (Array of HuntGroupType)
Note:
See "ServiceType" for more information.
groupName
groupNumber
groupType
huntGroupMember (Array of HuntGroupMemberType)
memberNumber
memberHuntTo
activityCd
networkElements (Array of NetworkElementType)
Note:
See "ServiceType" for more information.
status
networkElementIdentifier
networkElementName
networkElementType
managementIPAddress
elementCustomAttributes (Array of ActivationCustomAttributeType)
Note:
See "ActivationCustomAttributeType" for more information.
individualConnections (Array of IndividualConnectionType)
connectionType
connectionAssignments (Array of ConnectionAssignmentType)
Note:
See "ServiceType" for more information.
connectionDesignKey (connectionDesignKey)
designKey
connectionIdentifier
connectionStatus
ipAddress
macAddress
physicalNodeAddress
logicalPort
shelfEquipmentName
shelfSlotNumber
shelfEquipmentKey
portEquipmentKey
portAddressSequenceNumber
channels (Array of int)
portAddressStatus
connectionCustomAttributes (Array of ActivationCustomAttributeType)
Note:
See "ActivationCustomAttributeType" for more information.
connectionType
dueDate
locationName
connectionAllocations (Array of ConnectionAllocationType)
Note:
See "ServiceType" for more information.
connectionDesignKey (connectionDesignKey)
designKey
connectionIdentifier
connectionStatus
ipAddress
macAddress
physicalNodeAddress
logicalPort
shelfEquipmentName
shelfSlotNumber
shelfEquipmentKey
portEquipmentKey
portAddressSequenceNumber
channels (Array of int)
portAddressStatus
connectionCustomAttributes (Array of ActivationCustomAttributeType)
Note:
See "ActivationCustomAttributeType" for more information.
connectionType
relationshipCustomAttributes (Array of ActivationCustomAttributeType)
Note:
See "ActivationCustomAttributeType" for more information.
networkSystems (Array of NetworkSystemType)
networkSystemKey (NetworkSystemKey)
networkSystemKey
networkNameShort
networkNameLong
networkDescription
status
dateCreated
dateInService
providerSystemId
customerSystemId
hardSoftAssignment
systemCustomAttributes (Array of ActivationCustomAttributeType)
Note:
See "ActivationCustomAttributeType" for more information.
sameChannelAssignmentIndicator
inherentlyProtIndicator
networkElements (Array of NetworkElementType)
Note:
Attributes are the same as networkElements presented previously.ServiceType serviceKey primaryKey itemType itemAlias provisioningName activityCD valueLabels (Array of ValueLabelType) label value activityCD ActivationCustomAttributeType caUsageKey label customAttributeValues (Array of ActivationCustomAttributeValueType) value unitOfMeasure
This section describes the types and attributes contained in MetaSolvServiceActivationType. The following containers are described:
This container represents information used to activate POTS service, a network system, or a connection within a network system. This structure supports multiple technologies such as DSL, DSL with POTS, VoDSL (Voice over DSL), ATM (Asynchronous Transfer Mode) and Frame Relay, VoATM (Voice over ATM), and MPLS (Multiple Protocol Label Switching).
Table 3-1 describes the attributes or types in the MetaSolvActivationType container.
Table 3-1 MetaSolvServiceActivationType
| Attribute or Type | Description |
|---|---|
|
orderDetails |
Type: OrderInformationType This information represents information about the order that the activation applies to. |
|
switchActivations |
Array of type SwitchActivationType. Represents a collection of switch-related services on an order, such as POTS. The collection will contain a SwitchActivationType instance for every switch location associated with the ordered services. |
|
networkElements |
Array of type NetworkElementType. Represents a collection of network elements which meet any of the following criteria:
For example, for a DSL service order that includes a physical connection and one virtual connection, this collection would include a NetworkElementType instance for the DSLAM that the physical connection is assigned to. In addition, it would include an instance for every network element in the path of the virtual connection, such as an ATM Switch and an IP Router. Network elements are included in this collection only if the network element or related connection is ordered separately from a network system. For ordered network systems, such as a VPN network, the network system is represented as a NetworkSystemType (see the networkSystems attribute) that contains network elements and connections. |
|
networkSystems |
Array of type NetworkSystemType. Represents a collection of ordered network systems such as a virtual private network (VPN). The data includes information about the network system and all network elements and connections contained within the network system. |
This container represents information about the activation order.
Table 3-2 describes the attributes or types in the OrderDetailsType container.
| Attribute or Type | Description |
|---|---|
|
companyName |
Company name of the customer. |
|
firstName |
First name of the customer. |
|
lastName |
Last name of the customer. |
|
orderKey |
Type.attribute: OrderKeyType.primaryKey Identifier of the specific order that resulted in the activation. |
|
serviceCategory |
A code that categorizes bill cycles, customer accounts, and products for PSRs. When placing a service request for a customer account, you can order only those products that have the same service category. Service categories are maintained by each organization. Examples of service categories include business, residential, and government. Valid values: User defined. |
|
purchaseOrderNumber |
Customer's purchase order number. |
|
desiredDueDate |
The date by which an order is to be completed. This is represented as a string with the format: yyyy-MM-dd'T'HH:mm:ss. |
|
supplementType |
Reason an order is being supplemented, or changed. Only applicable for supplemented orders. Valid values: Cancel, New Due Date, Correction. |
|
orderType |
Identifies the type of order. Currently, the only order type supported for activation is SO (a PSR order). |
This container represents information about a switch and services to be activated on the switch such as a line service.
Table 3-3 describes the attributes or types in the SwitchActivationType container.
Table 3-3 SwitchActivationType
| Attribute or Type | Description |
|---|---|
|
switchLocationNetworkCode |
The network location code of the switch. |
|
lineServices |
Array of Type: LineServiceType Represents a collection of line service data for a switch. |
|
systemOptions |
Array of Type: ServiceType Represents a collection of system options for a switch ordered at the same level as the line service items. |
|
huntGroups |
Array of Type: HuntGroupType Represents a collection of hunting groups to be configured on the switch. A hunting group determines how an incoming call may hunt (search) for an available line when the one dialed is not available. |
This container represents information about a line service.
Table 3-4 describes the attributes or types in the LineServiceActivationType container.
| Attribute or Type | Description |
|---|---|
|
lineEquipmentNumber |
The port activated on the switch. This value maps to the node address of the port in MetaSolv Solution. The node address is populated on the equipment specification for the equipment containing the assigned port. This value must be present to enable activation. |
|
networkElementIdentifier |
The identifier of the network element. This value is entered in the NEID field on the properties window for the network element. |
|
networkElementName |
The name of the network element. |
|
originatingEquipmentType |
Identifies the format of the line equipment number (LEN). This value is entered in the Mounting Type field on the equipment specification for the shelf equipment. |
|
isHuntGroupMember |
Identifies whether or not the line is a member of a hunt group on the order. |
|
telephoneNumber |
Type: TelephoneNumberType Represents data for the telephone number of the line service. |
|
relatedTelephoneNumbers |
Array of RelatedTelephoneNumberType Represents a collection of telephone numbers related to the telephone number of the line service. |
|
picInformation |
Array of PicInfoType Represents a collection of Primary Interexchange Carrier (PIC) information for the line service. The PIC is a customer's preferred provider for long distance. Customers can choose PICs for different types of calls, such as interlata/boundary calls and intralata/boundary calls. The PICs you can select are entered through Access Customer in Order Management on the navigation bar. They are referred to as CICs instead of PICs in Order Management. |
|
lineFeatures |
Array of ServiceType. Represents a collection of features on the line, such as call waiting. |
|
elementCustomAttributes |
Array of ActivationCustomAttributeType Represents a collection of custom attributes for the switch network element. Custom attributes can be defined to capture any activation data associated with a network element not otherwise available through the application. For a switch network element this might include the manufacturer, technology and software version of the switch. This collection includes an instance for all custom attributes defined for the element regardless of whether or not the custom attribute is populated with a value. Populated values represent the current value of the custom attribute. The custom attribute information does not include an activity code and will not include both the old and the new value in the event of a change. |
This container represents information about the telephone number for a line service.
Table 3-5 describes the attributes or types in the TelephoneNumberType container.
| Attribute or Type | Description |
|---|---|
|
telephoneNumber |
The telephone number for the line service including any special characters used for formatting. The special characters can be used to delimit the components of telephone number. For example, the dashes of a North American telephone number could be used to separate the number into NPA, NXX and Line Range. |
|
activityCd |
The activity to be performed on this telephone number as specified by the order. Valid values: iactn = New iactc = Change iactd = Disconnect iacti = In Service iacts = Suspend iactr = Restore iacta = Cancel |
This container represents information about telephone numbers related to the telephone number of a line service.
Table 3-6 describes the attributes or types in the RelatedTelephoneNumberType container.
Table 3-6 RelatedTelephoneNumberType
| Attribute or Type | Description |
|---|---|
|
fromTelephoneNumber |
The telephone number of the line service. |
|
toTelephoneNumber |
The telephone number to which the line service telephone number is related. |
|
associationType |
Identifies the type of association between the telephone numbers. Valid values: LT = Alternate RFC = Remote Call Forward |
|
intercept |
Type: InterceptType Represents information about an intercept message, which is set up following a line's removal from service to alert incoming callers of the change. |
This container represents information about an intercept message, which is set up following a line's removal from service to alert incoming callers of the change.
Table 3-7 describes the attributes or types in the InterceptType container.
| Attribute or Type | Description |
|---|---|
|
interceptId |
Identifier for the intercept. |
|
option |
The type of transfer requested by the end user. Valid values: plit = The new telephone number is given. Standard = More than one telephone number is given. None = |
|
name |
Name associated with the telephone number to which calls are to be referred. |
|
endDate |
The date at which the intercept is no longer effective. This is represented as a string with the format: yyyy-MM-dd'T'HH:mm:ss. |
This structure represents information on the Primary Interexchange Carrier (PIC) for a given voice service.
Table 3-8 describes the attributes or types in the PicInfoType container.
| Attribute or Type | Description |
|---|---|
|
pic |
A Carrier Identification Code (CIC) that represents an end user's toll provider. When designated for this purpose, these codes are call primary interexchange codes (PICs). |
|
picTypeCd |
The type of PIC. Valid values: LPIC = IntraLATA PIC = InterLATA INTNL = International |
|
freezePic |
Indicates the customer requested the freeze option on the PIC, meaning the end user is specifying that the PIC can only be changed when authorized by the end user. This attribute will not be populated by the Activation API. |
|
partyName |
The provider who is responsible to the customer using the PIC for toll calling. |
|
activityCd |
The activity to be performed on this PIC as specified by the order. Valid values: iactn = New iactc = Change iactd = Disconnect iacti = In Service |
This structure represents information about a hunting group, which determines how an incoming call may search for an available line when the one dialed is not available.
Table 3-9 describes the attributes or types in the HuntGroupType structure.
| Attribute or Type | Description |
|---|---|
|
Include ServiceType Section |
Include the ServiceType section below. |
|
groupName |
Descriptive name for the hunting group. |
|
groupNumber |
A numeric identifier for the hunting group. |
|
groupType |
Describes the type of hunting group, indicating its behavior. Valid values: User defined. |
|
huntGroupMember |
Array of HuntGroupMemberType Represents a collection of hunting group members that belong to the hunting group. The telephone number for each member will be included as a line service in the lineServices collection under SwitchActivationType. |
This structure represents information about a member of a Hunting group used to route incoming calls when the original number dial is not available to pick up.
Table 3-10 describes the attributes or types in the HuntGroupMemberType structure.
Table 3-10 HuntGroupMemberType
| Attribute or Type | Description |
|---|---|
|
memberNumber |
The member number that is the original or from number. |
|
memberHuntTo |
The member the call will be routed to if this member cannot be reached. |
|
activity |
The activity to be performed on this hunt group member as specified by the order. Valid values: iactn = New iactc = Change iactd = Disconnect iacti = In Service |
This container represents information about a network element, any connections assigned to a port(s) on the network element, and any virtual connections allocated to those connection assignments.
Table 3-11 describes the attributes or types in the NetworkElementType container.
| Attribute or Type | Description |
|---|---|
|
Include ServiceType Section |
Include the ServiceType section below. The ServiceType attributes are populated only if the network element is an ordered item. For example, in the case of an ordered virtual connection, the network elements that make up the path of the virtual connection will be included because they are associated to the ordered connection, but the ServiceKey attributes for those network elements will not be populated. |
|
networkElementIdentifier |
The identifier of the network element. To enable activation, this identifier must match the identifier in the Network Element Manager. |
|
status |
The status of the network element. Valid values: Pending In Service Pending Disconnect Disconnected Cancelled |
|
networkElementName |
Descriptive name for the network element. |
|
networkElementType |
Indicates the type of network element such as DSL Multiplexer or ATM Switch. Valid values: User defined. |
|
managementIPAddress |
The IP address of the network element host box. |
|
individualConnections |
Array of IndividualConnectionType Represents a collection of connections connected to the network element. Each instance represents information about an individual connection assigned to a port(s) on the network element and any virtual connections allocated to that connection assignment. |
|
elementCustomAttributes |
Array of ActivationCustomAttributeType Represents a collection of custom data about the network element. Custom attributes can be defined to capture any activation data associated with a network element not otherwise available through the application. For a network element this might include a profile name or the manufacturer, technology and software version. This collection will include an instance for all custom attributes defined for the element regardless of whether or not the custom attribute is populated with a value. Populated values represent the current value of the custom attribute. The custom attribute information does not include an activity code and will not include both the old and the new value in the event of a change. |
This container represents information about an individual connection assigned to a port(s) on a network element and any virtual connections allocated to that connection assignment.
Table 3-12 describes the attributes of types in the IndividualConnectionType container.
Table 3-12 IndividualConnectionType
| Attribute or Type | Description |
|---|---|
|
connectionType |
The connection type of the physical connection represented by connectionAssignments. Valid values: User defined. |
|
connectionAssignments |
Array of ConnectionAssignmentType Represents a collection of connection assignments to ports on a network element. Each connectionAssignment instance represents information about a different port assignment on the same physical connection. If the order involves the change of a connection from one port to another, a connectionAssignment occurrence will be included for both the port to be disconnected and the new port. The old port can be identified by a portAddressStatus = Pending Disconnect, while the new port will have a portAddressStatus = Pending. |
|
connectionAllocations |
Array of ConnectionAllocationType Represents a collection of virtual connections that are allocated to the physical connection represented by the collection of connectionAssignments. |
This container represents information about the assignment of a physical connection to a particular port on a network element.
Table 3-13 describes the attributes or types in the ConnectionAssignmentType container.
Table 3-13 ConnectionAssignmentType
| Attribute or Type | Description |
|---|---|
|
ServiceType |
Include the ServiceType attributes (See Table 3-16). The attributes are populated only if the connection is an item on the order. |
|
connectionDesignKey |
The MetaSolv Solution internal numeric identifier for the connection. |
|
connectionIdentifier |
Identifier for the connection defined by the service provider. |
|
connectionStatus |
Current status of the connection. Valid values: Pending Assigned In Progress CLR Issued DLR Issued In Service Pending Disconnect Disconnected Problem Cancelled |
|
ipAddress |
IP address for the port to which the assignment is made. |
|
macAddress |
MAC address for the port to which the assignment is made. |
|
physicalNodeAddress |
This represents the port address to which the connection has been assigned. If populated for a virtual connection (ConnectionAllocationType), this represents a virtual port. |
|
logicalPort |
A user-defined identifier for a group of channel positions. |
|
shelfSlotNumber |
Describes the slot number for the network element. This data is captured in the Mounting Position field of the Equipment Specification for the shelf equipment. |
|
shelfEquipmentKey |
The MetaSolv Solution internal numeric identifier for the shelf equipment that contains the equipment that contains the port. |
|
portEquipmentKey |
The MetaSolv Solution internal numeric identifier for the card that contains the port. |
|
portAddressSequenceNumber |
The MetaSolv Solution internal sequence number used in conjunction with the portEquipmentKey to identify the port. |
|
shelfEquipmentName |
The Equipment Name of the shelf equipment. If a shelf number is required for activation, it is recommended that it is stored in this field. |
|
channels (Array) |
Represents a group of channel positions that comprise a logical port to which a physical connection is allocated. |
|
portAddressStatus |
The status of the port. Valid values: Pending In Service Pending Disconnect |
|
connectionCustomAttributes |
Array of ActivationCustomAttributeType Represents a collection of custom data about the connection. Custom attributes can be defined to capture any activation data associated with the connection not otherwise available through the application. MetaSolv Solution provides some custom attributes that are attributes of a connection, such as Broadband Service Category, In Service Upstream Bitrate and In Service Downstream Bitrate. Note that this collection includes an instance for all custom attributes defined for the connection regardless of whether or not the custom attribute is populated with a value. Populated values represent the current value of the custom attribute. The custom attribute information does not include an activity code and will not include both the old and the new value in the event of a change. |
|
connectionType |
The type of connection such as DSL Link or Assignable Bandwidth Link. Valid values: User defined. |
|
dueDate |
The date the connection is due to be activated. This is represented as a string with the format: yyyy-MM-dd'T'HH:mm:ss. |
|
locationName |
The name of the location where the equipment is located. This is expressed as a Common Language Location Identifier (CLLI) or Coded Location. |
Represents information about a connection that is allocated to a connection assignment. For example, this could represent a virtual connection allocated to a physical connection to provide DSL service.
Table 3-14 describes the attributes or types in ConnectionAllocationType.
Table 3-14 ConnectionAllocationType
| Attribute or Type | Description |
|---|---|
|
ServiceType |
Include the ServiceType attributes. See Table 3-16 for more information. |
|
connectionIdentifier |
The identifier for the connection used by an Exchange Carrier. |
|
connectionStatus |
The current status of the connection. Valid values: Pending Assigned In Progress CLR Issued DLR Issued In Service Pending Disconnect Disconnected Problem Cancelled |
|
ipAddress |
The IP address for the port to which the assignment is made. |
|
macAddress |
The MAC address for the port to which the assignment is made. |
|
physicalNodeAddress |
This represents the Port address to which the connection has been assign. |
|
logicalPort |
A user-defined identifier for a group of channel positions. |
|
shelfSlotNumber |
Describes the slot number for the network element. This data is captured in the Mounting Position field of the Equipment Specification for the shelf equipment. |
|
shelfEquipmentKey |
The MetaSolv Solution internal numeric identifier for the shelf equipment that contains the equipment that contains the port. |
|
portEquipmentKey |
The MetaSolv Solution internal numeric identifier for the equipment that contains the port. |
|
portAddressSequenceNumber |
The MetaSolv Solution internal sequence number used in conjunction with the portEquipmentKey to identify the port. |
|
shelfEquipmentName |
The equipment name of the shelf equipment. If shelf number is required for activation, it is recommended that it is stored in this field. |
|
channels |
Array of ints Represents a collection of assigned enabled port addresses (EPAs) on the logical port. |
|
portAddressStatus |
Status of the port address. Valid values: Unassigned ending In Service Pending Disconnect Reserved Reserved Capacity |
|
connectionCustomAttributes |
Array of ActivationCustomAttributeType Represents a collection of custom data about the virtual connection. Custom attributes can be defined to capture any activation data associated with the connection not otherwise available through the application. MetaSolv Solution provides some custom attributes that are attributes of a connection, such as Broadband Service Category, In Service Upstream Bitrate and In Service Downstream Bitrate. Note that this collection will include an instance for all custom attributes defined for the connection regardless of whether or not the custom attribute is populated with a value. Populated values represent the current value of the custom attribute. The custom attribute information does not include an activity code and will not include both the old and the new value in the event of a change. |
|
connectionType |
The type of connection such as DSL Link or Assignable Bandwidth Link. Valid values: User defined. |
|
relationshipCustomAttributes |
Array of ActivationCustomAttributeType Represents a collection of custom data about the relationship between the connection represented by the ConnectionAssignment and the connection represented by this ConnectionAllocation. For example, this could include the Virtual Path Identifier (VPI) and Virtual Channel Identifier (VCI) for a virtual connection allocated to a DSL Link connection. Note that this collection will include an instance for all custom attributes defined for the relationship regardless of whether or not the custom attribute is populated with a value. Populated values represent the current value of the custom attribute. The custom attribute information does not include an activity code and will not include both the old and the new value in the event of a change. |
Represents information about a network system.
Table 3-15 describes the attributes or types in NetworkSystemType.
| Attribute or Type | Description |
|---|---|
|
ServiceType |
Include the ServiceType attributes. See Table 3-16 for more information. |
|
networkSystemKey |
Type.attribute: NetworkSystemKey.networkSystemKey Represents the unique numeric identifier for the network system. |
|
networkNameShort |
Short descriptive name for the network system |
|
networkNameLong |
Longer descriptive name for the network system |
|
networkDescription |
Description of the network system |
|
status |
The current status of the network system. Valid values: Pending Assigned In Progress CLR Issued DLR Issued In Service Pending Disconnect Disconnected Problem Cancelled |
|
dateCreated |
Date when the network system was created. This is represented as a string with the format yyyy-MM-dd'T'HH:mm:ss. |
|
dateInService |
Date on which the network system was placed in service. This is represented as a string with the format yyyy-MM-dd'T'HH:mm:ss. |
|
providerSystemId |
A number or text string used by the service provider to identify the network system |
|
customerSystemId |
A number or text string used by a customer to identify the network system |
|
hardSoftAssignment |
Specifies whether assignments are made to core components within a network system or not. Valid values: 1 = H (hard) - Assignments are made to core components. 2 = S (soft) - Assignments are not made to core components, but to edge components that provide entry and exit from the network. |
|
networkElements |
Array of NetworkElementType Represents a collection of network elements contained within the network system. Information about the connections between the network elements is contained in each network element the connection is assigned to. |
|
systemCustomAttributes |
Array of ActivationCustomAttributeType Represents a collection of custom data about the network system. Custom attributes can be defined to capture any activation data associated with the network system not otherwise available through the application. Note that this collection includes an instance for all custom attributes defined for the network system regardless of whether or not the custom attribute is populated with a value. Populated values represent the current value of the custom attribute. The custom attribute information does not include an activity code and will not include both the old and the new value in the event of a change. |
|
sameChannelAssignmentIndicator |
Indicates if the network requires the same channel assignment (for example, wavelength) on each facility segment when assigning to multiple segments through a network. The indicator will be applicable only to networks based on the Optical template. It will be used by the OPA - Optical Provisioning Assistant and auto-assignment to enforce equivalent channel assignments along a given assignment route. Valid values: Y = Use the same channel assignment (for example, wavelength) for a connection through the system. N = Do not use the same channel assignment (for example, wavelength) for a connection through the system. The circuit/connection may be assigned to different channels (for example, wavelengths) on each segment. NULL = Applies only to Optical Network Systems. Value will be Null when the Network System type is not Optical. |
|
inherentlyProtIndicator |
Indicates if a second set of assignments is necessary to protect a circuit when provisioning a connection to an optical network. |
This container represents generic information about the service. This type is currently only used in MetaSolvServiceActivationType. It is included as part of other activation types representing services that may be activated including NetworkSystemType, NetworkElementType, ConnectionAssignment, ConnectionAllocation, LineServiceType and HuntGroupType. It is also used to represent system options and line features for switch activation. The attributes in this type are populated only if the service item is included on the order.
Table 3-16 describes the attributes or types in the ServiceType container.
| Attribute or Type | Description |
|---|---|
|
serviceKey |
Type.attribute: MetaSolvServiceKey.servicePrimaryKey The unique numeric identifier for the service item. |
|
itemType |
The MetaSolv Solution defined code for the type of the service. Item types are combined in building product specifications. These specifications serve as templates for creating a service provider's product catalog. For example, the item type code for the virtual connection in a DSL service would be CONNECTOR. Under the virtual connection in the product catalog could be an IP Address service, which would have the item type code IPADDR. |
|
itemAlias |
The name used by the service provider to describe the service item as it applies to a product catalog item. |
|
provisioningName |
This name is required in MetaSolv Solution when the Switch Provisioning Indicator or the Server Provisioning Indicator is set on a product specification item or product specification value label. The provisioning name can be used to differentiate between services items that have the same item type. For example, a line service can contain multiple features such as call waiting or call forwarding. The features are represented as a collection of ServiceTypes under the LineServiceType, each with item type = OPTION. To differentiate between the call waiting and call forwarding features, the provisioning name on the two product specifications could be populated with different values such as CCW an CFW. ItemAlias is not recommended to be used for this purpose because it is defined for each product catalog item rather than at the product specification level. |
|
activityCD |
The activity to be performed on the service item as specified by the order. Valid values: iactn - New iactc - Change iactd - Disconnect iacts - Suspend iactr - Restore iacta - Cancel If a service item that is In Service is placed on an order and is not disconnected, suspended, restored or cancelled, the activity code will be iactc (Change) even if the properties or design of the service item were not modified. |
|
valueLabels |
Array of ValueLabelType This represents a collection of value and label combinations for attributes defined by the service provider in the product specification. |
This container represents information about a value and label combination for an attribute defined by the service provider in a product specification.
Table 3-17 describes the attributes or types in the ValueLabelType container.
| Attribute or Type | Description |
|---|---|
|
label |
The label of the service attribute |
|
value |
The value of the service attribute |
|
activityCD |
The activity to be performed on the attribute as specified by the order. Valid values: actn - New iactc - Change iactd - Disconnect iacti - In Service iacta - Cancel |
This container represents information about a value and label combination for a custom attribute. Custom attributes can be defined by the service provider and associated with network systems, network elements, physical connections, virtual connections and the relationship between physical and virtual connections. Custom attributes can be used to capture activation data for these items not otherwise available through the application.
Table 3-18 describes the attributes or types in the ActivationCustomAttributeType container.
Table 3-18 ActivationCustomAttributeType
| Attribute or Type | Description |
|---|---|
|
caUsageId |
The MetaSolv Solution internal numeric key that identifies a custom attribute usage. As a part of defining custom attributes, a custom attribute is first defined generically and then associated with a building block, such as a type of network system, network element, connection or connection relationship. When that association is made, a custom attribute usage is created with a caUsageId. For example, Broadband Service Category is generically defined as a custom attribute. When Broadband Service Category is associated to the connection type DSL Link, a CA usage is created for that association. |
|
label |
The label of the custom attribute. A label is assigned to CA in its generic definition. That label can be overridden when the generic CA is associated to a building block and a process point (such as Activation). This is the label value defined for the building block and Activation process point. |
|
customAttributeValues |
Array of ActivationCustomAttributeValueType This represents a collection of values for a custom attribute. A custom attribute can be defined to allow either a single value or multiple values. |
This container represents information about a value for a custom attribute.
Table 3-19 describes the attributes or types in the ActivationCustomAttributeValueType container.