B Communications Orders Dictionary
This appendix provides a snapshot of the Communications Orders Dictionary. Communications Orders include enterprise business objects (EBOs) for sales orders, fulfillment orders, and provisioning orders.
Table B-1 defines the terms used in this appendix.
Table B-1 Communications Orders Dictionary Terminology
| Term | Definition |
|---|---|
|
Asset-able |
Indicates if an attribute value is saved to the corresponding asset in Siebel CRM. An asset here refers to purchased product offering instance by a customer. |
|
Prior Value |
Indicates if, when the attribute changes, a prior value is also sent on the order message. Prior values can be used to determine if a change has occurred and to roll back changes. |
|
OM |
Order Management |
|
CRM |
Siebel Customer Relationship Management |
|
CommsOrder |
A variable signifying one of the following:
|
Caution:
Oracle Application Integration Architecture (Oracle AIA) EBOs may present more attributes than used by one business process or application because they cross industries and are built as part of the Foundation Pack. Therefore, the listing of an attribute in a following table does not mean that the attribute is used and the corresponding feature is available. The supported features are listed in the Oracle AIA pre-built integrations and in documentation and collateral for the participating applications. Although the remarks against some attributes indicate lack of support for some attributes, they are not a complete account of uptake of these attribute across different applications.
Order Header Component Attributes
Table B-2 lists the attributes for order headers in communications orders.
Table B-2 Order Header Component Attributes
| Functional Attribute Name | Attribute Usage Semantics | Seeded Values | Asset-able | Prior Value Available | Comments | EBO Structure XPath |
|---|---|---|---|---|---|---|
|
Order ID |
Uniquely identifies each order. |
NA |
No |
None |
Produces a unique identifier for all orders, including revision orders. Unlike Order Number, Order ID is different for revisions of the same base order. Used by Oracle AIA for cross-reference. |
SaleOrderEBO/Identification/BusinessComponentID |
|
Order Number |
Identifies an order across revisions. |
NA |
No |
None |
A revision number >1 does not necessarily mean that this is a revision order from OM Fulfillment. You can create an order in Siebel CRM and revise it several times before submitting it. If an Order Number matches an in-flight order, then the order is treated as a revision order. When an order is revised, this number stays the same. OM uses this number to identify the base order. If the same order number with the same revision is submitted, then OM rejects the revision order and places it in fallout. |
CommsOrderEBO/Identification/ID |
|
Revision |
A revision sequence number that, with the order number, represents the user key to an order. |
NA |
No |
None |
If an order is received with an Order Number equal to that of an in-flight order and the newly received order has a higher revision number, then OM assumes the order is a revision order and proceeds to analyze the Order Lines. If the revision number is equal or lower than that of the base order, the revision is rejected. |
CommsOrderEBO/Identification/Revision/Number |
|
Success Dependency |
Declares if all order lines must fulfill successfully or else the whole order fails (all or none). When the order level Success Dependency is set to All or None, it takes precedence over Order Line Success Dependency designations because it is more restrictive. |
DEFAULT ALL OR NONE |
No |
None |
None |
CommsOrderEBO/PartialFulfillmentAllowedIndicator |
|
Fulfillment Mode |
Qualifies the nature of fulfillment request. |
Deliver, Qualify, Cancel, Initiate billing, Fulfill billing |
No |
None |
Communications service providers (CSPs) may extend support to other modes, such as Design, Schedule and Cost. CRM can cancel an order through a revision order with no order lines or by resending the order with Fulfillment Mode = Cancel. OM is expected to honor the two alternatives for canceling an order, providing no order lines reaches the point of no return. When used on billing EBS, Fulfillment Mode has a different meaning. It determines the type of Billing request: Initiate or Fulfill. |
CommsOrderEBO/FulfillmentModeCode |
|
Customer Class |
Identifies type of customer: Residential, Business, and so on |
Residential Business |
No |
None |
None |
CommsOrderEBO/CustomerPartyReference/CustomerPartyAccountTypeCode |
|
Organization ID |
Identifies the organization/LOB generating the order. No cross-reference exists. |
NA |
No |
None |
No cross-reference. OM should use the application-specific ID if required in any of the rules; if Organization IDs are unique and synchronized across all order capture systems. |
CommsOrderEBO/BusinessUnitReference/BusinessUnitIdentification/ID |
|
Sales Channel |
Identifies the sales channel. |
NA |
No |
None |
None |
CommsOrderEBO/SalesChannelCode |
|
Job ID |
A string or number that uniquely identifies the job to orchestration. |
NA |
No |
None |
Track orders that belong to a bulk or batch job. |
CommsOrderEBO/ProcessingNumber |
|
Sequence in Job |
A number that identifies the order sequence within the job. |
NA |
No |
None |
None |
CommsOrderEBO/ProcessingSequenceNumber |
|
Job Type |
Identifies the type of job. This information identifies the threshold for creating a consolidated SR for Bulk or Batch Orders. This value is optional for orders whose Job Cardinality is 1. By default, this value is HETROGENEOUS. |
Heterogeneous,homogeneous, third-party homogeneous, third-party heterogeneous, correlated |
No |
None |
None |
CommsOrderEBO/ProcessingTypeCode |
|
Job Cardinality |
Indicates the total number of orders within the job. |
NA |
No |
None |
None |
CommsOrderEBO/ProcessingQuantity |
|
Parent Order ID |
Order ID of another order that indicates the fulfillment for this order does not start before the parent order fulfillment completes. |
NA |
No |
None |
This attribute applies to explicit order-to-order dependencies and is not limited to follow-on orders. For example, in a B2B scenario, a large order can be divided into some smaller orders, with one order acting as the root order for all other orders and the remainder of the orders chained using the parent order ID attribute. |
CommsOrderEBO/ParentCommsOrderReference/CommsOrderIdentification/BusinessComponentID |
|
Fulfillment Priority |
Indicates relevant priority of order fulfillment across orders. A lower value indicates a higher priority. Accepts values 0 to 9 in accordance with JMS Queue support. |
9,7,5,3 |
No |
None |
EBM value: Siebel value 9: Urgent. Used for expedited orders. 7: High. CSP determines its use. 5: Medium. CSP determines its use. 3: Low. Recommended for job orders. Notice that Oracle Advanced Queuing (AQ) and JSM priority values have the inverse order of precedence. |
CommsOrderEBO/FulfillmentPriorityCode |
|
Order Type |
Sometimes indirectly determines sales channel to drive compensation process. |
Sales Order |
No |
None |
None |
CommsOrderEBO/TypeCode |
|
Requested Delivery Date Time |
Overall order level due date that provides the default due date at each line level. Can be overridden at each line. |
NA |
Yes |
None |
None |
CommsOrderEBO/RequestedDeliveryDateTime |
|
Fulfillment Status |
Reports aggregate order fulfillment status. |
In Progress, Failed, Canceled, Complete |
Yes |
None |
This is different from the Status attribute tracked within Siebel CRM. |
CommsOrderEBO/Status/Code |
|
Status Context |
Provides details about the current status. The implementer configures this value. |
NA |
Yes |
None |
OM can use this to track the milestone causing the status change, along with context details such as error message, cause for cancel. One primary scenario that the Order Header / Status Context is populated: with revision orders that cancels Order Lines by dropping them from the revision and if the revision is rejected. In that case the orchestration system does not have a line on the revision order to provide fallout status and context. In such a case the header level status context is used to identify the base line the cause for the fallout. |
CommsOrderEBO/Status/Description |
|
Owner Account ID |
Identifies the owner account. |
NA |
Yes |
None |
Cross-referenced. |
CommsOrderEBO/CustomerPartyReference/CustomerPartyAccountIdentification/BusinessComponentID |
|
Owner Account Name |
Identifies the Account Name. You can enter or derive this value from contact first name + last name of primary contact associated with the account. |
NA |
Yes |
None |
Required for network inventory tracking of service owner. |
CommsOrderEBO/CustomerPartyReference/CustomerPartyAccountName |
|
Owner Account Number |
Identifies account number to customer. |
NA |
Yes |
None |
None |
CommsOrderEBO/CustomerPartyReference/CustomerPartyAccountIdentification/ID |
|
Account Contact ID |
Foreign key to contact record that holds personal and contact details of the customer/company representative who is placing the order and is the contact person for anything related to the order process. |
NA |
Yes |
None |
None |
CommsOrderEBO/CustomerPartyReference/CustomerPartyAccountContactIdentification/BusinessComponentID |
|
Account Contact Address (component) |
Identifies the address used to communicate with the Contact ID. |
NA |
Yes |
None |
-- |
CommsOrderEBO/CustomerPartyReference/CustomerPartyAccountContactAddressCommunication/AddressCommunication/Address |
|
Project ID |
Identifies project record if the order to be delivered is part of a project that contains related orders. Foreign key reference. No cross-reference. |
NA |
Yes |
None |
No cross-reference for 2.4. |
CommsOrderEBO/ProjectReference/ProjectIdentfication/ID |
|
Fulfillment System Type |
For the Get Target Fulfillment Provider utility service, determines the logical identifier for appropriate target system instance among those serving this Fulfillment System Type. |
NA |
No |
None |
None |
FulfillmentOrderEBO/FulfillmentSystemTypeCode |
|
Target Instance |
For the Get Target Fulfillment Provider utility service returns the logical identifier for appropriate target system instance among those serving this Fulfillment System Type. |
NA |
No |
None |
None |
FulfillmentOrderEBO/FulfillmentTargetSystemID |
|
Order Changed Indicator |
OM sets this attribute to Yes if the order changed significantly such that CRM should make a copy of the customer order to preserve the customer intent before updating the working version of the order. |
True, False |
No |
None |
Allows Siebel to make a copy of the order if the order changes to the extent that the customer's intent is compromised. |
CommsOrderEBO/OrderChangedIndicator |
|
Sales Representative ID |
CRM User ID that identifies the sales representative who entered the order. |
NA |
No |
None |
No cross-reference. Use the application ID. |
CommsOrderEBO/SalespersonPartyReference/PartyIdentification/ID |
|
Owner Account Contact (multiple fields) |
Identifies if the address is used to communicate with the contact ID. Includes these fields: First Name, Last Name, Phone Number, and Email. |
NA |
NA |
NA |
NA |
CommsOrderEBO/CustomerPartyReference/CustomerPartyAccountContact/FirstName CommsOrderEBO/CustomerPartyReference/CustomerPartyAccountContact/LastName CommsOrderEBO/CustomerPartyReference/CustomerPartyAccountContactPhoneCommunication/PhoneCommunication/CompleteNumber CommsOrderEBO/CustomerPartyReference/CustomerPartyAccountContactEmailCommunication/EmailCommunication/ |
|
Price List |
Indicates default price list on order. |
NA |
No |
No |
If no price list value is supplied for order lines for products synchronized with rate plan selectors, the price list on the order header is used. If products on order lines were not synchronized with rate plan selectors, the default price list from the AIAConfigurationProperties.xml file is used. |
CommsOrderEBM/DataArea/CommsOrder/PriceListReference/PriceListIdentification/ID |
|
Order Subject |
Indicates the type of fulfillment system to which the order is sent. |
CUSTOMER |
No |
No |
Used by OSM SOM to determine whether to transform an order from a customer order to a service order. |
CommsOrderEBO/OrderSubject |
Order Line Component Attributes
Table B-3 lists the attributes for order lines in communications orders.
Table B-3 Order Line Component Attributes
| Functional Attribute Name | Attribute Usage Semantics | Seeded Values and Value Type | Asset-able | Prior Value Available | Remarks | EBO Structure XPath |
|---|---|---|---|---|---|---|
|
Line ID |
Uniquely identifies the order line item across orders and order revisions. Automatically generated. |
NA |
No |
None |
Cross-referenced. Produces a unique identifier for all Order Lines, including revision Order Lines. |
CommsOrderEBO/CommsOrderLine/Identification/BusinessComponentID |
|
Base Line ID |
References base order line revised by this order line. |
NA |
No |
None |
Uses a cross-reference. |
CommsOrderEBO/CommsOrderLine/OriginalCommsOrderLineReference/CommsOrderLineIdentification/BusinessComponentID |
|
Asset Integration ID |
Uniquely identifies an instance of a product that was or is being purchased. |
NA |
Yes |
AIA2.0 |
Cross-referenced CRM populates the Asset Integration ID on all Order Lines, regardless of the Assetable state on the subject of the Order Line or whether the Order Line is for a new or existing service. A revision should never change the Asset Integration ID. When a product is dropped as part of one product hierarchy (CP or Promotion) and then added through another product hierarchy (CP or Promotion), the Asset Integration ID for the two line items are different, although for the same product. |
CommsOrderLine/InstalledProductReference/InstalledProductIdentification/BusinessComponentID |
|
Line Number |
Identifies the line regarding its position in the line item tree. |
NA |
No |
None |
Line number establishes the parent child relationship between Order Lines of the same order, but it may vary across revisions. Therefore, do not rely on it for matching Order Lines across revisions. |
CommsOrderEBO/CommsOrderLine/Identification/ID |
|
Parent Line |
References parent order line in the line items tree instantiated according to the product model definition. Points to itself if the item does not have an associated parent item. |
NA |
No |
None |
None |
CommsOrderEBO/CommsOrderLine/ParentCommsOrderLineIdentification/BusinessComponentID |
|
Root Line |
References the root order line in the line item tree instantiated according to the product model definition. Points to itself if the item is a root item itself. |
NA |
No |
None |
None |
CommsOrderEBO/CommsOrderLine/RootParentCommsOrderLineIdentification/BusinessComponentID |
|
Related Line ID |
BRM adaptors use to relate one-time charges to base line ID. |
NA |
No |
None |
None |
CommsOrderEBO/CommsOrderLine/ChargeParentLineIdentification/BusinessComponentID |
|
Related Asset Integration ID |
Links Move-Add to Move-Delete line items. |
NA |
No |
None |
None |
CommsOrderEBO/CommsOrderLine/InstalledProductReference/PriorInstalledProductIdentification/BusinessComponentID |
|
Depends On Line ID |
Indicates order line item ID of a previous order line item that is changed by this order. Follow-on orders use this value to capture dependencies of the order line items in the follow-on order-to-order line items of original orders. |
NA |
No |
None |
Cross-referenced. |
CommsOrderEBO/CommsOrderLine/DependingCommsOrderLineReference/CommsOrderLineIdentification/BusinessComponentID |
|
Depends On Order ID |
Identifies order ID of an in-flight order, which is the basis for this follow-on order line item. |
NA |
No |
None |
Cross-referenced. |
CommsOrderEBO/CommsOrderLine/DependingCommsOrderReference/CommsOrderIdentification/BusinessComponentID |
|
Promotion Line ID |
References an order line that represents the promotion/marketing offer under which the order line is being purchased. |
NA |
No |
Yes |
None |
CommsOrderEBO/CommsOrderLine/PromotionCommsOrderLineReference/PromotionCommsOrderLineIdentification/Identification/BusinessComponentID |
|
Promotion Asset Integration ID |
References an asset that represents the promotion/marketing offer under which the order line is being purchased. |
NA |
Yes |
Yes |
None |
CommsOrderEBO/CommsOrderLine/PromotionCommsOrderLineReference/InstalledProductReference/InstalledProductIdentification/BusinessComponentID |
|
Product ID |
References product record based on which order line is instantiated. Foreign key reference. |
NA |
Yes |
None |
None |
CommsOrderEBO/CommsOrderLine/ItemReference/Identification/BusinessComponentID |
|
Quantity |
Identifies the quantity of the item requested by a customer. Default is 1. |
NA |
Yes |
Yes |
None |
CommsOrderEBO/CommsOrderLine/OrderQuantity |
|
Action Code |
Specify action required to meet customer request. |
None, Add, Update,Suspend Resume,Delete,Move-Add, Move-Delete |
No |
None |
None |
CommsOrderEBO/CommsOrderLine/ServiceActionCode |
|
Deliver To Address |
Address record that represents the delivery/service installation address. |
NA |
Yes |
Yes |
None |
CommsOrderEBO/CommsOrderLine/ServiceAddress/Address |
|
Requested Delivery Date Time |
When Null, the requested date for delivery of the goods or service is ASAP; otherwise, it is the specified date. This date is not guaranteed. Typically, it is a future date; if it is a past date, then the default behavior equals a Null value. |
NA |
Yes |
Yes |
None |
CommsOrderEBO/CommsOrderLine/CommsOrderSchedule/RequestedDeliveryDateTime |
|
Usage Start Date |
Determines the date when usage events should start being rated. The value for this attribute is populated by CRM, OM Fulfillment flows, or kept to Null for BRM default to the current date. |
NA |
Yes |
Yes |
None |
CommsOrderEBO/CommsOrderLine/CommsOrderSchedule/ServiceUsageStartDate |
|
Cycle State Date |
Determines the date when cycle charges should start being billed. The value for this attribute is populated by CRM, OM Fulfillment flows, or kept to Null for BRM default to the current date according to previous patterns. |
NA |
Yes |
Yes |
None |
CommsOrderEBO/CommsOrderLine/CommsOrderSchedule/CycleStartDate |
|
Purchase Date |
Determines the date when one-time purchase charges should be billed. The value for this attribute is populated by CRM, OM Fulfillment flows, or kept to Null for BRM default to current date according to previously mentioned patterns. |
NA |
Yes |
Yes |
None |
CommsOrderEBO/CommsOrderLine/CommsOrderSchedule/PurchaseDate |
|
Service Start Date |
Indicates effective start date of service. |
NA |
Yes |
None |
Initially computed by Siebel based on Due Date and then updated by Order Management based on Actual Delivery Date |
CommsOrderEBO/CommsOrderLine/EffectiveTimePeriod/StartDateTime |
|
Earliest Delivery Date |
Identifies the date when the work associated to the order can start. Typically used for fulfillment actions that require customer presence such as in cases customer must be available to install service or deliver shipment. |
NA |
No |
None |
None |
CommsOrderEBO/CommsOrderLine/CommsOrderSchedule/EarliestDeliveryDateTime |
|
Service End Date |
Indicates the effective end date of service. Applies to services with a specified duration. |
NA |
Yes |
None |
Initially computed in Siebel and then updated by Order Management. Update is sent to Siebel. |
CommsOrderEBO/CommsOrderLine/EffectiveTimePeriod/EndDateTime |
|
Actual Delivery Date Time |
Determines the date when the purchased product or service is considered available to the customer by the CSP. This date may be when physical goods are shipped, delivered, or their receipt is acknowledged. For service-based products, the service is activated on this date. This date is computed in the OM Fulfillment flow according to previous patterns. |
NA |
Yes |
None |
Oracle BRM does not allow for starting any charges before the Purchase Date; therefore, the ABCS for Oracle BRM always overrides the Purchase Date if it is later than any of the Cycle or Usage start dates. OM should facilitate calculation of Order Line level Actual Delivery Date and Order Line attributes for billing Usage Start Date, Cycle Start Date, and Purchase Date. |
CommsOrderEBO/CommsOrderLine/CommsOrderSchedule/ActualDeliveryDateTime |
|
Expected Delivery Date Time |
Indicates the due date expected by the system because of Design and Assign. The default is the Order Due Date when the order is created by CRM. |
NA |
No |
None |
Computed by OM based on preconfigured time estimates on fulfillment actions. Used by OM to communicate to CRM changes to expected delivery date of specific Order Lines. |
CommsOrderEBO/CommsOrderLine/CommsOrderSchedule/ExpectedDeliveryDateTime |
|
Fulfillment Status |
Updates orchestration and CRM regarding the current status of order line fulfillment at a high level. |
In Progress, Failed,Canceled Complete |
Yes |
None |
Additional values can be added as an extension |
CommsOrderEBO/CommsOrderLine/Status/Code |
|
Milestone |
Fulfillment passes the last reached milestone into this field. |
NA |
No |
None |
None |
CommsOrder/CommsOrderLine/MilestoneCode |
|
Status Context |
Provides details about the current status of the order line. The implementer configures this value. |
NA |
Yes |
None |
OM can include the reached milestone (from the fulfillment system, the cause for the status update that is necessary because of dynamic nature of fulfillment plan) and a textual string for context per current status as follows (canonical Status / status context): Submitted / NA In Progress / <milestone>: context text Failed / <milestone>: reason text Canceled / <milestone>: reason text Complete / NA In Progress: Context Text could be used to indicate any of the following among others: o Requires customer interaction o Delivery is expected to be delayed |
CommsOrderEBO/CommsOrderLine/Status/Description |
|
Point-of-no-return |
Determines if Siebel should allow order line revisions to be submitted. |
Not yet, Hard |
No |
None |
OM Fulfillment flows allow configuration of setting a hard PONR when a condition is met for a particular service. When a hard PONR is reached for an Order Line in OM, a status update is issued to reflect the same in CRM. Additional values such as SOFT can be added as an extension. |
CommsOrderEBO/CommsOrderLine/RevisionPermissibleCode |
|
Billing Account |
References an account record that represents the bill payer or the branch of a company responsible for bill payment. This value may be a customer account or an account from the account hierarchy. |
NA |
Yes |
Yes |
None |
CommsOrderEBO/CommsOrderLine/CommsOrderSchedule/BillToPartyReference/CustomerPartyAccountIdentification/BusinessComponentID |
|
Billing Profile |
References the billing profile record that holds the customer's billing/payment preferences. This value may be associated to the customer account or to a separate billing account. |
NA |
Yes |
Yes |
None |
CommsOrderEBO/CommsOrderLine/CommsOrderSchedule/BillToPartyReference/BillingProfileReference/BillingProfileIdentification/BusinessComponentID |
|
Payment Profile |
Identifies the Payment Profile. |
NA |
No |
None |
None |
CommsOrderEBO/CommsOrderLine/CommsOrderSchedule/BillToPartyReference/BillingProfileReference/PaymentProfileReference/PaymentProfileIdentification/BusinessComponentID |
|
Service Account |
References an account record that represents a service user or the branch of the company where service is installed. This value may be customer account or an account from the account hierarchy. |
NA |
Yes |
Yes |
None |
CommsOrderEBO/CommsOrderLine/CommsOrderSchedule/OwnerPartyReference/CustomerPartyAccountIdentification/BusinessComponentID |
|
Owner Account |
References an account record that represents the legal owner of a service, against which collections actions can be taken. The value must be the parent account in the hierarchy of the service account. |
NA |
Yes |
Yes |
Only considered when the Oracle AIA configuration property O2C.LegalGroup is set to TRUE. |
New value: ProcessSalesOrderFulfillmentEBM/DataArea/ProcessSalesOrderFulfillment/SalesOrderLine/OwnerAccountId Prior value: ProcessSalesOrderFulfillmentEBM/DataArea/ProcessSalesOrderFulfillment/PriorSalesOrderLine/OwnerAccountId |
|
Owner Contact |
Represents a contact of the customer account or service account who should be contacted during fulfillment of the line if required. |
NA |
Yes |
None |
None |
CommsOrderEBO/CommsOrderLine/CommsOrderSchedule/OwnerPartyReference/CustomerPartyAccountContactIdentification/BusinessComponentID |
|
Shipping Contact |
Represents a contact of the customer account or service account who should be contacted for shipping purposes. |
NA |
Yes |
None |
None |
CommsOrderEBO/CommsOrderLine/CommsOrderSchedule/ShipToPartyReference/CustomerPartyAccountContactIdentification/BusinessComponentID |
|
Node |
Alphanumerically references the root order line that corresponds to access at site A of a connection. This value is relevant for network ordering only. |
NA |
Yes |
Yes |
None |
CommsOrderEBO/CommsOrderLine/CommsOrderLineSpecificationGroup/SpecificationGroup[./name="ExtensibleAttributes"]/Specification[./name="Node"]/ValueText |
|
To Node |
Alphanumerically references the root order line that corresponds to access at site B of a connection. This value is relevant for network ordering only. |
NA |
Yes |
Yes |
None |
CommsOrderEBO/CommsOrderLine/CommsOrderLineSpecificationGroup/SpecificationGroup[./name="ExtensibleAttributes"]/Specification[./name="ToNode"]/ValueText |
|
Network ID |
Unique compound product number that represents the virtual network ID. Relevant for network orders. Provided by default from the order number and cascaded to network connection items. |
NA |
Yes |
Yes |
Identifies which Access and Nodes belong to the same network. This information may be of value to decomposition. |
CommsOrderEBO/CommsOrderLine/CommsOrderLineSpecificationGroup/SpecificationGroup[./name="ExtensibleAttributes"]/Specification[./name="NetworkID"]/ValueText |
|
Port Number |
Identifies the port number allocated to the access circuit connected to provide (starting) edge router during the fulfillment process. |
NA |
Yes |
Yes |
For new services, port number comes back from Network Inventory through provisioning. |
CommsOrderEBO/CommsOrderLine/CommsOrderLineSpecificationGroup/SpecificationGroup[./name="ExtensibleAttributes"]/Specification[./name="PortNumber"]/ValueText |
|
To Port Number |
Identifies the port number allocated to the access circuit connected to provide (ending) edge router during the fulfillment process. |
NA |
Yes |
Yes |
None |
CommsOrderEBO/CommsOrderLine/CommsOrderLineSpecificationGroup/SpecificationGroup[./name="ExtensibleAttributes"]/Specification[./name="ToPortNumber"]/ValueText |
|
Service Address Prefix |
Identifies the area code/NPA for the access circuits on starting or two ends of the connection. |
NA |
Yes |
Yes |
None |
CommsOrderEBO/CommsOrderLine/CommsOrderLineSpecificationGroup/SpecificationGroup[./name="ExtensibleAttributes"]/Specification[./name="ServiceAddressPrefix"]/ValueText |
|
To Service Address Prefix |
Identifies the area code/NPA for the access circuits on the end of the connection. |
NA |
Yes |
Yes |
None |
CommsOrderEBO/CommsOrderLine/CommsOrderLineSpecificationGroup/SpecificationGroup[./name="ExtensibleAttributes"]/Specification[./name="ToServiceAddressPrefix"]/ValueText |
|
Access Circuit |
Provides the Common Language Location Identification (CLLI) for the access circuit on two sides or starting side of the connection. |
NA |
Yes |
Yes |
None |
CommsOrderEBO/CommsOrderLine/CommsOrderLineSpecificationGroup/SpecificationGroup[./name="ExtensibleAttributes"]/Specification[./name="AccessCircuit"]/ValueText |
|
To Access Circuit |
Provides the CLLI for the access circuit on ending side of the connection. |
NA |
Yes |
Yes |
None |
CommsOrderEBO/CommsOrderLine/CommsOrderLineSpecificationGroup/SpecificationGroup[./name="ExtensibleAttributes"]/Specification[./name="ToAccessCircuit"]/ValueText |
|
To Service Account ID |
Identifies the Service Account ID associated with the end side of a network. |
NA |
Yes |
Yes |
None |
CommsOrderEBO/CommsOrderLine/CommsOrderLineSpecificationGroup/SpecificationGroup[./name="ExtensibleAttributes"]/Specification[./name="ToServiceAccountID"]/ValueText |
|
From Service Address ID |
Identifies the Service Address ID for the starting point of a network. |
NA |
Yes |
Yes |
None |
CommsOrderEBO/CommsOrderLine/CommsOrderLineSpecificationGroup/SpecificationGroup[./name="ExtensibleAttributes"]/Specification[./name="FromServiceAddressID"]/ValueText |
|
To Service Address ID |
Identifies the Service Address ID for the ending point of a network. |
NA |
Yes |
Yes |
None |
CommsOrderEBO/CommsOrderLine/CommsOrderLineSpecificationGroup/SpecificationGroup[./name="ExtensibleAttributes"]/Specification[./name="ToServiceAddressID"]/ValueText |
|
To Service Point ID |
References a dummy asset record that represents the access point to which the starting side of a network service is connected on the customer's premises. |
NA |
Yes |
Yes |
None |
CommsOrderEBO/CommsOrderLine/CommsOrderLineSpecificationGroup/SpecificationGroup[./name="ExtensibleAttributes"]/Specification[./name="ToServicePointID"]/ValueText |
|
Service Point |
References a dummy asset record that represents the access point to which this service is connected on the customer's premises. For example, NTE for PSTN, Set top box for Broadband/Cable service. |
NA |
Yes |
Yes |
Expected to be mastered in network inventory and loaded in Siebel in batch. |
CommsOrderEBO/CommsOrderLine/ServicePointCode |
|
Promotion Description |
Provides short description that appears on the invoice. |
NA |
Yes |
Yes |
None |
CommsOrderEBO/CommsOrderLine/ItemReference/Description This is Promotion Description used for display purposes on customer invoice |
|
Service ID |
Identifies the product/service instance as recognized across BSS and OSS applications. Most significantly this is the ID used to correlate rating records to customer accounts. |
NA |
Yes |
Yes |
Can be populated as part of order capture process or during fulfillment, but before interface an order to billing. |
CommsOrderEBO/CommsOrderLine/CommsOrderSchedule/CommsOrderItemInstance/Identification/ID |
|
Balance Bundle Identification |
Identifies the Balance Bundle to which a service instance belongs. |
NA |
NA |
None |
Not Used by Oracle AIA for Communications |
CommsOrderEBO/CommsOrderLine/CommsOrderSchedule/BalanceBundleIdentification/BusinessComponentID |
|
Line Description |
Provides additional description for an order line. For example, to indicate that a charge is being applied for a penalty. |
NA |
No |
None |
Not used by Oracle AIA for Communications |
CommsOrderEBO/CommsOrderLine/Description |
|
Service Length |
Indicates requested service length in Service Length Unit of Measure. |
NA |
Yes |
Yes |
None |
CommsOrderEBO/CommsOrderLine/CommsOrderSchedule/ServiceTimePeriod/Duration |
|
Service Length Unit of Measure |
Indicates the service length unit of measure. |
NA |
Yes |
Yes |
None |
CommsOrderEBO/CommsOrderLine/CommsOrderSchedule/ServiceTimePeriod/Duration |
|
Fulfillment Mode |
Designates compensation operations for Initiate Billing. May be used in the future to provide explicit revision operations at the line level. |
DO, NOOP,REDO,UNDO |
No |
None |
None |
CommsOrderEBO/CommsOrderLine/FulfillmentModeCode |
|
Product Name |
Provides the name of the product. |
NA |
NA |
NA |
None |
CommsOrderEBO/CommsOrderLine/ItemReference/Name |
|
Composition Type |
Determines product composition granularity. PartialItem is an order line that constitutes an indivisible element of another order line. This type typically denotes a piece of a product. WholeItem is an order line that represents a self-contained subject. A WholeItem may be represented by a single line item or some PartialItem order lines. May also assume no value signified by a Null value or absence of value. |
<no value> for NULL, PARTIAL ITEM, WHOLE ITEM |
No |
None |
Consult Oracle on usage. |
CommsOrderEBO/CommsOrderLine/ItemReference/FulfillmentCompositionTypeCode |
|
Product Type |
Classifies products into Products, Discounts, Bundles, Promotion (Offer), and so on. |
Product, Offer, Bundle |
No |
None |
Used part of fulfillment to determine the order lines Subject Type, which drives the mapping to Product Specifications. |
CommsOrderEBO/CommsOrderLine/ItemReference/TypeCode |
|
Billing Type |
Classifies products for Billing into Service Bundles, Subscriptions, Items, Discounts, and Special Ratings. |
Service Bundle, Subscription, Item, Discount, Special Rating |
No |
None |
Used with Product Type. |
CommsOrderEBO/CommsOrderLine/ItemReference/ClassificationCode [listID="BillingProductTypeCode"] |
|
Billing Service Type |
Specifies the service type so that when a corresponding product is created in Billing, it is associated to the specified service. |
NA |
No |
None |
None |
CommsOrderEBO/CommsOrderLine/ItemReference/ClassificationCode [listID="PermittedTypeCode"] |
|
Service Flag |
Indicates the product of a service or non-service, for example, physical goods. |
TRUE, FALSE |
No |
None |
Used with Product Type and may be used to parameterize fulfillment flows. |
CommsOrderEBO/CommsOrderLine/ItemReference/ServiceIndicator |
|
Vendor |
Identifies the vendor supplying the product when the product is supplied by a third-party. |
NA |
Yes |
Yes |
None |
CommsOrderEBO/CommsOrderLine/ItemReference/SupplierPartyReference/PartyIdentification/ID |
|
Vendor Part Number |
Identifies the product part number to the vendor. |
NA |
Yes |
Yes |
None |
CommsOrderEBO/CommsOrderLine/ItemReference/ItemIdentification/SupplierItemID |
|
Fulfillment Item Code |
Uniquely identifies the mapping of an Order Line Subject to a Product Specification. |
1) Null 2) A unique code that identifies the Product Spec to OM |
No |
None |
None |
CommsOrderEBO/CommsOrderLine/ItemReference/ClassificationCode [listID = "FulfillmentItemCode"] |
|
Item Class Name |
Determines business classification of a product. |
NA |
No |
None |
None |
CommsOrderEBO/CommsOrderLine/ItemReference/PrimaryClassificationCode |
|
Success Dependency |
Declares if all order lines of a bundle or offer must fulfill successfully or else the whole bundle or offer fails (all or none). |
Default,All Or None |
No |
None |
None |
CommsOrderEBO/CommsOrderLine/ItemReference/FulfillmentSuccessCode |
|
Start Billing on First Usage |
When set to Yes by CRM or OSM, passes the request along to BRM. In this case, Usage Start Date, Cycle Start Date, and Purchase Date should have no effect. |
True, False |
No |
None |
Not yet supported by integration. |
CommsOrderEBO/CommsOrderLine/StartBillingOnFirstServiceUsageIndicator. We have added BillingStartCode to ItemReference, if this requirement is at the item/itemReference level and not line level then BillingStartCode from ItemReference is necessary. |
|
Smart Part Number |
Automatically generated based on a predefined scheme. Mainly, drives dynamic product configuration/pricing rules in CRM. The billing system may use it to dynamically derive a price/discount value. |
NA |
Yes |
None |
None |
CommsOrderEBO/CommsOrderLine/ItemReference/AlternateObjectKey [ContextID=SmartPartNumber] |
|
Network Product Flag |
Indicates if this is a network product, which helps determine which user-defined attributes to expect. |
True, False |
No |
None |
None |
CommsOrderEBO/CommsOrderLine/ItemReference/NetworkIndicator |
|
Network Element Type |
Indicates if this network product represents a node, a connection, or a network. |
NA |
No |
None |
None |
CommsOrderEBO/CommsOrderLine/ItemReference/NetworkItemTypeCode |
|
Charge Frequency Code |
Indicates charge frequency unit of measure, for example, monthly, quarterly, yearly. |
NA |
NA |
NA |
None |
CommsOrderEBO/CommsOrder>Line/CommsOrderSchedule/CommsOrderScheduleCharge/Charge/ChargeFrequencyCode |
|
List Price Type |
Identifies price type. |
One-Time, Recurring, Usage |
No |
None |
None |
CommsOrderEBO/CommsOrderLine/CommsOrderSchedule/CommsOrderScheduleCharge/Charge/TypeCode |
|
List Price |
Identifies base price of the item. |
NA |
Yes |
None |
None |
CommsOrderEBO/CommsOrderLine/CommsOrderSchedule/CommsOrderScheduleCharge/Charge/UnitListPrice/Amount |
|
Sale Price Type |
Identifies price type. |
One-Time, Recurring, Usage |
No |
None |
None |
CommsOrderEBO/CommsOrderLine/CommsOrderSchedule/CommsOrderScheduleCharge/Charge/TypeCode |
|
Sale Price |
Identifies net price of the item. |
NA |
Yes |
Yes |
None |
CommsOrderEBO/CommsOrderLine/CommsOrderSchedule/CommsOrderScheduleCharge/Charge/UnitSalePrice/Amount |
|
Pricing Commit Type |
Indicates whether the pricing is Committed or Dynamic. |
Common/Siebel values are true/Dynamic, false/Committed. |
Yes |
Yes |
None |
CommsOrder/CommsOrderLine/CommsOrderSchedule/CommsOrderScheduleCharge/Charge/DynamicPricingIndicator |
|
Dynamic Discount Method |
Indicates whether the discount is of type amount or percent. |
Amount, Percent |
Yes |
Yes |
N A |
CommsOrder/CommsOrderLine/CommsOrderSchedule/CommsOrderScheduleCharge/Charge/DiscountMethodCode |
|
Discount Percent |
Indicates the percent by which the list price is discounted. |
NA |
Yes |
Yes |
N A |
CommsOrder/CommsOrderLine/CommsOrderSchedule/CommsOrderScheduleCharge/Charge/DiscountPercent |
|
Discount Amount |
Indicates the amount by which the list price is discounted. |
NA |
Yes |
Yes |
NA |
CommsOrder/CommsOrderLine/CommsOrderSchedule/CommsOrderScheduleCharge/Charge/DiscountAmount |
|
Member [0.N] |
Represents a member of a list by their phone number. |
NA |
No |
None |
Used for capturing membership to friends and family plans. |
CommsOrderEBO/CommsOrderLine/CommsOrderLineSpecificationGroup/SpecificationGroup[./name="ExtensibleAttributes"]/Specification[./name="SpecialRating"]/ValueText [0.N] |
|
Price List |
For products synchronized with a rate plan selector. Indicates which price list a purchased product should use. |
NA |
No |
No |
Service bundle components automatically receive same price list as service bundle line. If no value is supplied, the price list on the order header is used. If products on order lines were not synchronized with rate plan selectors, the default price list from the AIAConfigurationProperties.xml file is used regardless of values specified for this attribute. |
CommsOrderEBM/DataArea/CommsOrderLine/CommsOrderSchedule/PriceListReference/PriceListIdentification/ID |
|
Service Family |
Indicates the category of a service, such as broadband or wireless. |
NA |
No |
No |
Set by order management, used to determine actions of fulfillment systems. |
CommsOrderEBO/CommsOrderLine/ServiceFamily |
|
Technical Inventory ID |
Correlates assets across technical inventory systems. |
NA |
No |
No |
Set by service and resource management system. |
CommsOrderEBO/CommsOrderLine/InstalledProductReference/TechnicalInventoryId |
|
User Defined Attributes |
Indicates attribute is common across all Specification components. |
NA |
Yes |
None |
UDA Name |
CommsOrder/CommsOrderLine/ItemReference/SpecificationGroup[name="ExtensibleAttributes"]/Specification/Name |
|
User Defined Attributes |
Indicates attribute is common across all Specification components. |
Add, Update, Delete |
Yes |
None |
UDA Action Code (Expected to change to a Service Action Code element to allow additional value NONE.) |
CommsOrder/CommsOrderLine/ItemReference/SpecificationGroup[name="ExtensibleAttributes"]/Specification[name="<OrderLine.XA.Attribute>"]/@actionCode |
|
User Defined Attributes |
Indicates attribute is common across all Specification components. |
NA |
Yes |
has Previous LIC Value |
UDA language-independent code Value |
CommsOrder/CommsOrderLine/ItemReference/SpecificationGroup[name="ExtensibleAttributes"]/Specification[name="<OrderLine.XA.Attribute>"]/Value |
|
User Defined Attributes |
Indicates attribute is common across all Specification components. |
String, Date, Number |
Yes |
None |
UDA Data Type |
CommsOrder/PriorCommsOrder/CommsOrderLine/ItemReference/SpecificationGroup[name="ExtensibleAttributes"]/Specification[name="<OrderLine.XA.Attribute"]/DataTypeCode |
|
User Defined Attributes |
Indicates attribute is common across all Specification components. |
NA |
Yes |
None |
UDA language-independent code Prior Value |
CommsOrder/PriorCommsOrder/CommsOrderLine/ItemReference/SpecificationGroup[name="ExtensibleAttributes"]/Specification[name="<OrderLine.XA.Attribute>"]/Value |