Building IN-Based Applications¶

This chapter provides information about using the SCE to build IN-based applications.

Signaling Transport (SIGTRAN) protocol is an IETF standard signaling protocol used to provide intelligent services in SS7 networks.

XTML IN Data Types¶

The SCE provides XTML data types that are strongly-typed objects, which differ from other XTML data types because they have a well-defined set of properties.

The SCE JavaScript Editor window displays these properties, as shown in the following image.

Strongly-typed objects make it easier to work with complex, well-structured sets of data that are commonly used across many applications. Application maintenance is easier when using these strongly-typed objects because all developers are storing and accessing information in similar, well-understood patterns.

The following XTML strongly-typed objects represent all the information related to these specific IN messages that are either sent or received by the application server.

Analyze_Route
Authorize_Termination
Close
Connect
Continue
Disconnect
Forward_Call
INMessage
INParameter
Info_Analyzed
Info_Collected
ParameterProvideValue
ProvideInstructions/Start
Resource_Clear
Send_To_Resource
SCCP_Address
Termination_Attempt
Termination_Notification
Update
Update_Data
Update_Request

Many of the PACs listed under IN Calling Name Delivery, IN Service Control Point Interface, and IN Toll Free on the Actions tab in the workspace pane operate on these data types or return one of these objects as a result of their action. Grouping all of the information associated with the object makes it easier for an application to construct and manage IN messages.

Common Properties¶

All IN objects include the following properties.

Property	Description
sccp_src	SCCP address of the message source.
sccp_dest	SCCP address of the message destination.
tcap_op_code	Code that describes the type of message.

Analyze_Route Properties¶

Property	Description
AlternateBillingIndicator	Indicates the Automatic Message Accounting (AMA) call type and service feature identifier for the alternate trunk group.
AlternateCarrier	Provides the carrier selection information and the identification of the alternate carrier that a call is routed to.
AlternateTrunkGroup	Provides an alternate trunk group route index and is sent, along with SecondAlternateTrunkGroup and PrimaryTrunkGroup, when a call is to be routed to a trunk group.
AMAAlternateBillingNumber	Identifies an alternate billing number to which the Automatic Number Identification (ANI) number should be billed.
AMABusinessCustomerID	Identifies the business customer and the type of customer ID.
AMADigitsDialedWC	Provides any digit string that the customer dialed along with the context ID to indicate the name of the digit string.
AMAslpID	Indicates that the Service Switching Point (SSP) should override normal switch-based recording and invoke Advanced Intelligent Network (AIN) Automatic Message Accounting (AMA) record generation.
AMASequenceNumber	Indicates the order in which Advanced Intelligent Network (AIN) triggers are invoked within the context of an originating or termination call portion.
AMAServiceProviderID	Provides the identifier of a service provider when the service logic resides on a Service Control Point (SCP) and the provider is not the LEC whose equipment is generating the Automatic Message Accounting (AMA).
AMP1	This AIN Maintenance Parameter marks and traces test calls/signals and activates logging on selected calls through the network. This parameter contains the first subset of the information needed for the AIN Network Test functionality.
AMP2	This AIN Maintenance Parameter marks and traces test calls/signals and activates logging on selected calls through the network. This parameter contains the second subset of the information needed for the AIN Network Test functionality.
ApplyRestrictions	Indicates whether to override existing toll and code restrictions.
CallingPartyBGID	The business group identifier either identifies a Basic Business Group (BBG) or a Multi-Switch Business Group (MBG).
CallingPartyID	Provides the Directory Number (DN) associated with the calling party.
Carrier	Provides the carrier selection information and the identification of the primary carrier that a call was routed to.
CarrierUsage	Indicates to the Service Switching Point (SSP) how and when to use the carrier information contained in the Carrier, AlternateCarrier, and SecondAlternateCarrier parameters.
ChargeNumber	Provides the Automatic Number Identification (ANI) of the calling party.
ChargePartyStationType	Indicates the calling station type (based on the Originating Line Information Integrated Services Digital Network User Part (ISDNUP) parameter).
DisplayText	Provides the display data that is to be sent to the user.
ExtensionParameter	Provides service provider-specific information.
ForwardCallIndicator	Indicates whether a call needs to be routed over SS7 supported facilities.
GenericAddressList	Provides a list of generic addresses.
GenericDigitsList	Provides a list of generic digits.
GenericName	Based on the ISDNUP Generic Name (GN) parameter.
NetworkSpecificFacilities	Identifies the specific service being delivered to the Primary Rate Interface (PRI).
OutpulseNumber	Provides the outpulse number for routing over private facilities.
OverflowBillingIndicator	Provides the Automatic Message Accounting (AMA) call type and service feature identifier for the carrier that is used to route the call.
PassiveLegTreatment	Requests that a specific type of alerting treatment to a passive leg be provided.
Prefix	Indicates that a 1+ prefix was dialed by the user with or without other prefixes.
PrimaryBillingIndicator	Provides the Automatic Message Accounting (AMA) call type and service feature identifier for the primary trunk group and for services when the primary trunk group is not provided. This object can also be used for the OverflowBillingIndicator.
PrimaryTrunkGroup	Provides a primary trunk group route index and is sent, along with AlternateTrunkGroup and SecondAlternateTrunkGroup, when a call is to be routed to a trunk group.
RedirectingPartyID	Provides the Directory Number (DN) of the last redirecting party.
RedirectionInformation	Indicates the reason for forwarding the call from the Directory Number (DN) of the first and last redirecting party and indicates the number of forwards that have occurred.
SecondAlternateBillingIndicator	Provides the Automatic Message Accounting (AMA) call type and service feature identifier for the second alternate trunk group.
SecondAlternateCarrier	Provides the second alternate carrier selection information and that carrier’s identification code.
SecondAlternateTrunkGroup	Provides a second alternate trunk group route index and is sent, along with AlternateTrunkGroup and PrimaryTrunkGroup, when a call is to be routed to a trunk group.
ServiceContext	Provides the identification of the context of a service.
ServiceProviderID	There are two parameters associated with the ServiceProviderID placeholder. The Ocn parameter is sent to support surveillance functionality. The MsrID parameter is sent to identify the Message Storage and Retrieval (MSR) system to the Service Switching Point (SSP) when the Service Control Point (SCP)/Adjunct requests the SSP to update Message Waiting Indicator (MWI) information.
Tcm	Provides the Traveling Class Mark (TCM) for the user. Traveling Class Marks allow users in a private network to access features and services based on their Class of Service (COS), Class of Restriction (COR), and Interconnect Number rather than on the features of the incoming trunk.

Authorize_Termination Properties¶

Property	Description
AMAAlternateBillingNumber	Identifies an alternate billing number to which the Automatic Number Identification (ANI) number should be billed.
AMABusinessCustomerID	Identifies the business customer and the type of customer ID.
AMADigitsDialedWC	Provides any digit string that the customer dialed along with the context ID to indicate the name of the digit string.
AMALineNumber	Field including information such as the calling party ID, incoming terminating number, or Automatic Number Identification (ANI).
AMAslpID	Indicates that the Service Switching Point (SSP) should override normal switch-based recording and invoke Advanced Intelligent Network (AIN) Automatic Message Accounting (AMA) record generation.
AMASequenceNumber	Indicates the order in which Advanced Intelligent Network (AIN) triggers are invoked within the context of an originating or termination call portion.
AMAServiceProviderID	Provides the identifier of a service provider when the service logic resides on a Service Control Point (SCP) and the provider is not the LEC whose equipment is generating the Automatic Message Accounting (AMA).
AMP1	This AIN Maintenance Parameter marks and traces test calls/signals and activates logging on selected calls through the network. This parameter contains the first subset of the information needed for the AIN Network Test functionality.
AMP2	This AIN Maintenance Parameter marks and traces test calls/signals and activates logging on selected calls through the network. This parameter contains the second subset of the information needed for the AIN Network Test functionality.
CallingPartyID	Provides the Directory Number (DN) associated with the calling party.
ControllingLegTreatment	Requests the Service Switching Point (SSP) to provide a specific type of alerting treatment to the controlling leg.
DisplayText	Provides the display data that is to be sent to the user.
ExtensionParameter	Provides service provider-specific information.
PrimaryBillingIndicator	Provides the Automatic Message Accounting (AMA) call type and service feature identifier for the primary trunk group and for services when the primary trunk group is not provided. This object can also be used for the OverflowBillingIndicator.
SEQ_AMADigitsDialedWC	An array of AMADigitsDialedWC.
SEQ_AMALineNumber	An array of AMALineNumber.
ServiceContext	Provides the identification of the context of a service.
ServiceProviderID	There are two parameters associated with the ServiceProviderID placeholder. The Ocn parameter is sent to support surveillance functionality. The MsrID parameter is sent to identify the Message Storage and Retrieval (MSR) system to the Service Switching Point (SSP) when the Service Control Point (SCP)/Adjunct requests the SSP to update Message Waiting Indicator (MWI) information.
Tcm	Provides the Traveling Class Mark (TCM) for the user. Traveling Class Marks allow users in a private network to access features and services based on their Class of Service (COS), Class of Restriction (COR), and Interconnect Number rather than on the features of the incoming trunk.

Forward_Call Properties¶

Property	Description
AlternateBillingIndicator	Indicates the Automatic Message Accounting (AMA) call type and service feature identifier for the alternate trunk group.
AlternateCarrier	Provides the carrier selection information and the identification of the alternate carrier that a call is routed to.
AlternateTrunkGroup	Provides an alternate trunk group route index and is sent, along with SecondAlternateTrunkGroup and PrimaryTrunkGroup, when a call is to be routed to a trunk group.
AMAAlternateBillingNumber	Identifies an alternate billing number to which the Automatic Number Identification (ANI) number should be billed.
AMADigitsDialedWC	Provides any digit string that the customer dialed along with the context ID to indicate the name of the digit string.
AMALineNumber	Field including information such as the calling party ID, incoming terminating number, or Automatic Number Identification (ANI).
AMASequenceNumber	Indicates the order in which Advanced Intelligent Network (AIN) triggers are invoked within the context of an originating or termination call portion.
AMP1	This AIN Maintenance Parameter marks and traces test calls/signals and activates logging on selected calls through the network. This parameter contains the first subset of the information needed for the AIN Network Test functionality.
AMP2	This AIN Maintenance Parameter marks and traces test calls/signals and activates logging on selected calls through the network. This parameter contains the second subset of the information needed for the AIN Network Test functionality.
ApplyRestrictions	Indicates whether to override existing toll and code restrictions.
CallingPartyID	Provides the Directory Number (DN) associated with the calling party.
CalledPartyID	Provides the Directory Number (DN) associated with the called party.
Carrier	Provides the carrier selection information and the identification of the primary carrier that a call was routed to.
CarrierID	Supports sending a 10-digit “calling directory number” in a query and/or sending a 6-digit controlled code for Automatic Call Gap (ACG) in a response message. In both instances, the format of the object is the same.
ChargeNumber	Provides the Automatic Number Identification (ANI) of the calling party.
ChargePartyStationType	Indicates the calling station type (based on the Originating Line Information Integrated Services Digital Network User Part (ISDNUP) parameter).
DisplayText	Provides the display data that is to be sent to the user.
ExtensionParameter	Provides service provider-specific information.
GenericName	Based on the ISDNUP Generic Name (GN) parameter.
OutpulseNumber	Provides the outpulse number for routing over private facilities.
OverflowBillingIndicator	Provides the Automatic Message Accounting (AMA) call type and service feature identifier for the carrier that is used to route the call.
Prefix	Indicates that a 1+ prefix was dialed by the user with or without other prefixes.
PrimaryBillingIndicator	Provides the Automatic Message Accounting (AMA) call type and service feature identifier for the primary trunk group and for services when the primary trunk group is not provided. This object can also be used for the OverflowBillingIndicator.
PrimaryTrunkGroup	Provides a primary trunk group route index and is sent, along with AlternateTrunkGroup and SecondAlternateTrunkGroup, when a call is to be routed to a trunk group.
RedirectingPartyID	Provides the Directory Number (DN) of the last redirecting party.
RedirectionInformation	Indicates the reason for forwarding the call from the Directory Number (DN) of the first and last redirecting party and indicates the number of forwards that have occurred.
SecondAlternateBillingIndicator	Provides the Automatic Message Accounting (AMA) call type and service feature identifier for the second alternate trunk group.
SecondAlternateTrunkGroup	Provides a second alternate trunk group route index and is sent, along with AlternateTrunkGroup and PrimaryTrunkGroup, when a call is to be routed to a trunk group.
ServiceContext	Provides the identification of the context of a service.
ServiceProviderID	There are two parameters associated with the ServiceProviderID placeholder. The Ocn parameter is sent to support surveillance functionality. The MsrID parameter is sent to identify the Message Storage and Retrieval (MSR) system to the Service Switching Point (SSP) when the Service Control Point (SCP)/Adjunct requests the SSP to update Message Waiting Indicator (MWI) information.
Tcm	Provides the Traveling Class Mark (TCM) for the user. Traveling Class Marks allow users in a private network to access features and services based on their Class of Service (COS), Class of Restriction (COR), and Interconnect Number rather than on the features of the incoming trunk.

Info_Analyzed Properties¶

Property	Description
AccessCode	Identifies the access code of a business group dialing plan. This could be an attendant access code, an access code to the public network, or a feature access code.
ACGEncountered	Indicates that an Automatic Call Gap (ACG) control has been encountered.
AMAServiceProviderID	Provides the identifier of a service provider when the service logic resides on a Service Control Point (SCP) and the provider is not the LEC whose equipment is generating the Automatic Message Accounting (AMA).
AMP1	This AIN Maintenance Parameter marks and traces test calls/signals and activates logging on selected calls through the network. This parameter contains the first subset of the information needed for the AIN Network Test functionality.
AMP2	This AIN Maintenance Parameter marks and traces test calls/signals and activates logging on selected calls through the network. This parameter contains the second subset of the information needed for the AIN Network Test functionality.
ApplyRestrictions	Indicates whether to override existing toll and code restrictions.
CallingPartyBGID	The business group identifier either identifies a Basic Business Group (BBG) or a Multi-Switch Business Group (MBG).
CallingPartyID	Provides the Directory Number (DN) associated with the calling party.
CalledPartyID	Provides the Directory Number (DN) associated with the called party.
CallingGeodeticLocation	Provides the location, in terms of latitude, longitude, and possibly altitude, of a calling user.
Carrier	Provides the carrier selection information and the identification of the primary carrier that a call was routed to.
ChargeNumber	Provides the Automatic Number Identification (ANI) of the calling party.
ChargePartyStationType	Indicates the calling station type (based on the Originating Line Information Integrated Services Digital Network User Part (ISDNUP) parameter).
CollectedAddressInfo	Provides the address information collected from the user.
CollectedDigits	Provides the digits collected from the user, which do not necessarily correspond to an address.
CTRConnection	Indicates whether the event being reported resulted from a Connect_To_Resource message.
GenericAddressList	Provides a list of generic addresses.
GenericDigitsList	Provides a list of generic digits.
JuristictionInformation	Has an NPA-NXX format and indicates the geographic location of the originating caller or switch.
Lata	Identifies the Local Access and Transport Area (LATA).
NetworkSpecificFacilities	Identifies the specific service being delivered to the Primary Rate Interface (PRI).
OriginalCalledPartyID	Provides the Directory Number (DN) of the original called, or first redirecting, party.
Prefix	Indicates that a 1+ prefix was dialed by the user with or without other prefixes.
RedirectingPartyID	Provides the Directory Number (DN) of the last redirecting party.
RedirectionInformation	Indicates the reason for forwarding the call from the Directory Number (DN) of the first and last redirecting party and indicates the number of forwards that have occurred.
Sap	Informs the Service Control Point (SCP)/Adjunct about operator services involved in a call.
STRConnection	Indicates whether the event being reported resulted from a Send_To_Resource message.
TriggerCriteriaType	Indicates the type of event that caused a trigger to occur.
TriggerInformation	Indicates additional information to the Service Control Point (SCP) in query messages identifying particular instances of a trigger.
Tcm	Provides the Traveling Class Mark (TCM) for the user. Traveling Class Marks allow users in a private network to access features and services based on their Class of Service (COS), Class of Restriction (COR), and Interconnect Number rather than on the features of the incoming trunk.
VerticalServiceCode	Provides the vertical service code for the information collected from the user.

Info_Collected Properties¶

Property	Description
AccessCode	Identifies the access code of a business group dialing plan. This could be an attendant access code, an access code to the public network, or a feature access code.
ACGEncountered	Indicates that an Automatic Call Gap (ACG) control has been encountered.
AMASequenceNumber	Indicates the order in which Advanced Intelligent Network (AIN) triggers are invoked within the context of an originating or termination call portion.
AMP1	This AIN Maintenance Parameter marks and traces test calls/signals and activates logging on selected calls through the network. This parameter contains the first subset of the information needed for the AIN Network Test functionality.
AMP2	This AIN Maintenance Parameter marks and traces test calls/signals and activates logging on selected calls through the network. This parameter contains the second subset of the information needed for the AIN Network Test functionality.
BearerCapability	Identifies the bearer capability of the user, which may be the calling or called party.
CallingGeodeticLocation	Provides the location, in terms of latitude, longitude, and possibly altitude, of a calling user.
CallingPartyID	Provides the Directory Number (DN) associated with the calling party.
Carrier	Provides the carrier selection information and the identification of the primary carrier that a call was routed to.
ChargeNumber	Provides the Automatic Number Identification (ANI) of the calling party.
ChargePartyStationType	Indicates the calling station type (based on the Originating Line Information Integrated Services Digital Network User Part (ISDNUP) parameter).
CollectedAddressInfo	Provides the address information collected from the user.
CollectedDigits	Provides the digits collected from the user, which do not necessarily correspond to an address.
GenericAddressList	Provides a list of generic addresses.
GenericDigitsList	Provides a list of generic digits.
Lata	Identifies the Local Access and Transport Area (LATA).
OriginalCalledParty	Provides the Directory Number (DN) of the original called, or first redirecting, party.
Prefix	Indicates that a 1+ prefix was dialed by the user with or without other prefixes.
RedirectingPartyID	Provides the Directory Number (DN) of the last redirecting party.
RedirectionInformation	Indicates the reason for forwarding the call from the Directory Number (DN) of the first and last redirecting party and indicates the number of forwards that have occurred.
Sap	Informs the Service Control Point (SCP)/Adjunct about operator services involved in a call.
Tcm	Provides the Traveling Class Mark (TCM) for the user. Traveling Class Marks allow users in a private network to access features and services based on their Class of Service (COS), Class of Restriction (COR), and Interconnect Number rather than on the features of the incoming trunk.
TriggerCriteriaType	Indicates the type of event that caused a trigger to occur.
TriggerInformation	Indicates additional information to the Service Control Point (SCP) in query messages identifying particular instances of a trigger.
UserID	Provides an identifier of a user.
VerticalServiceCode	Provides the vertical service code for the information collected from the user.

Resource_Clear Properties¶

Property	Description
AMAMeasurement	Indicates the start date, start time, and the total connect time of an interaction between a user and a resource.
AMP1	This AIN Maintenance Parameter marks and traces test calls/signals and activates logging on selected calls through the network. This parameter contains the first subset of the information needed for the AIN Network Test functionality.
AMP2	This AIN Maintenance Parameter marks and traces test calls/signals and activates logging on selected calls through the network. This parameter contains the second subset of the information needed for the AIN Network Test functionality.
Carrier	Provides the carrier selection information and the identification of the primary carrier that a call was routed to.
ClearCause	Indicates why a connection between a user and a resource was terminated.
ClearCauseData	Provides information that can be returned from an IP in cases where the IP terminates a connection with an ISDN Return Error Component.
CollectedDigits	Provides the digits collected from the user, which do not necessarily correspond to an address.
CollectedAddressInfo	Provides the address information collected from the user.
ExtensionParameter	Provides service provider-specific information.
FailureCause	Indicates that the received operation could not be performed due to the unavailability of a hardware or software resource, causing a failure to occur.
IPReturnBlock	Returns the result of any user interaction with the IP to the Service Control Point (SCP)/Adjunct in a Resource_Clear or Call_Info_From_Resource message.

Send_To_Resource Properties¶

Property	Description
AlternateCarrier	Provides the carrier selection information and the identification of the alternate carrier that a call is routed to.
AMAAlternateBillingNumber	Identifies an alternate billing number to which the Automatic Number Identification (ANI) number should be billed.
AMABusinessCustomerID	Identifies the business customer and the type of customer ID.
AMAMeasure	Indicates whether a duration time measurement should be made.
AMASequenceNumber	Indicates the order in which Advanced Intelligent Network (AIN) triggers are invoked within the context of an originating or termination call portion.
AMAServiceProviderID	Provides the identifier of a service provider when the service logic resides on a Service Control Point (SCP) and the provider is not the LEC whose equipment is generating the Automatic Message Accounting (AMA).
AMP1	This AIN Maintenance Parameter marks and traces test calls/signals and activates logging on selected calls through the network. This parameter contains the first subset of the information needed for the AIN Network Test functionality.
AMP2	This AIN Maintenance Parameter marks and traces test calls/signals and activates logging on selected calls through the network. This parameter contains the second subset of the information needed for the AIN Network Test functionality.
AnswerIndicator	Indicates whether the Service Switching Point (SSP) should return answer supervision to the caller when the caller is connected to the announcement during the Send_To_Resource procedures.
CalledPartyID	Provides the Directory Number (DN) associated with the called party.
Carrier	Provides the carrier selection information and the identification of the primary carrier that a call was routed to.
CarrierUsage	Indicates to the Service Switching Point (SSP) how and when to use the carrier information contained in the Carrier, AlternateCarrier, and SecondAlternateCarrier parameters.
ChargeNumber	Provides the Automatic Number Identification (ANI) of the calling party.
ChargePartyStationType	Indicates the calling station type (based on the Originating Line Information Integrated Services Digital Network User Part (ISDNUP) parameter).
DestinationAddress	Provides the Directory Number (DN) of an intelligent peripheral.
DisconnectFlag	Indicates whether the Service Switching Point (SSP) must disconnect a leg after a Send_To_Resource interaction is completed.
DPConverter	Indicates whether conversion from Dial Pulse to dual-tone multi-frequency (DTMF) is requested.
ExtendedRinging	Indicates whether the Service Switching Point (SSP) should continue to alert the called party in a manner appropriate to the terminating interface when the caller is connected to the announcement during the Send_To_Resource procedures.
ExtensionParameter	Provides service provider-specific information.
PrimaryBillingIndicator	Provides the Automatic Message Accounting (AMA) call type and service feature identifier for the primary trunk group and for services when the primary trunk group is not provided. This object can also be used for the OverflowBillingIndicator.
PartyID	Provides an indication of which party a Send_To_Resource is directed toward.
PartyOnHold	Indicates that a party is to be placed on hold when a Send_To_Resource is received by the switch. The calling or called party is placed on hold based on the value of the PartyID in the same Send_To_Resource message.
ResourceType	Indicates the type of resource to which a user is to be connected.
SecondAlternateCarrier	Provides the second alternate carrier selection information and that carrier’s identification code.
SecondAlternateTrunkGroup	Provides a second alternate trunk group route index and is sent, along with AlternateTrunkGroup and PrimaryTrunkGroup, when a call is to be routed to a trunk group.
ServiceContext	Provides the identification of the context of a service.
ServiceProviderID	There are two parameters associated with the ServiceProviderID placeholder. The Ocn parameter is sent to support surveillance functionality. The MsrID parameter is sent to identify the Message Storage and Retrieval (MSR) system to the Service Switching Point (SSP) when the Service Control Point (SCP)/Adjunct requests the SSP to update Message Waiting Indicator (MWI) information.
StrParameterBlock	Provides the information that a Service Switching Point (SSP) or IP needs for the capability specified.
TSTRCTimer	Indicates the value, in minutes, of the duration for a Send_To_Resource connection.

Termination_Attempt Properties¶

Property	Description
ACGEncountered	Indicates that an Automatic Call Gap (ACG) control has been encountered.
AMASequenceNumber	Indicates the order in which Advanced Intelligent Network (AIN) triggers are invoked within the context of an originating or termination call portion.
AMP1	This AIN Maintenance Parameter marks and traces test calls/signals and activates logging on selected calls through the network. This parameter contains the first subset of the information needed for the AIN Network Test functionality.
AMP2	This AIN Maintenance Parameter marks and traces test calls/signals and activates logging on selected calls through the network. This parameter contains the second subset of the information needed for the AIN Network Test functionality.
BearerCapability	Identifies the bearer capability of the user, which may be the calling or called party.
CalledPartyID	Provides the Directory Number (DN) associated with the called party.
CalledPartyStationType	Provides the station type of the called party.
CallingPartyID	Provides the Directory Number (DN) associated with the calling party.
CallingGeodeticLocation	Provides the location, in terms of latitude, longitude, and possibly altitude, of a calling user.
ChargeNumber	Provides the Automatic Number Identification (ANI) of the calling party.
ChargePartyStationType	Indicates the calling station type (based on the Originating Line Information Integrated Services Digital Network User Part (ISDNUP) parameter).
CTRConnection	Indicates whether the event being reported resulted from a Connect_To_Resource message.
GenericAddressList	Provides a list of generic addresses.
GenericDigitsList	Provides a list of generic digits.
GenericName	Based on the ISDNUP Generic Name (GN) parameter.
Lata	Identifies the Local Access and Transport Area (LATA).
OriginalCalledPartyID	Provides the Directory Number (DN) of the original called, or first redirecting, party.
RedirectingPartyID	Provides the Directory Number (DN) of the last redirecting party.
RedirectionInformation	Indicates the reason for forwarding the call from the Directory Number (DN) of the first and last redirecting party and indicates the number of forwards that have occurred.
RTPServiceIndicator	Indicates that this call can go through the Release to Pivot (RTP) process if required.
Sap	Informs the Service Control Point (SCP)/Adjunct about operator services involved in a call.
STRConnection	Indicates whether the event being reported resulted from a Send_To_Resource message.
Tcm	Provides the Traveling Class Mark (TCM) for the user. Traveling Class Marks allow users in a private network to access features and services based on their Class of Service (COS), Class of Restriction (COR), and Interconnect Number rather than on the features of the incoming trunk.
TriggerInformation	Indicates additional information to the Service Control Point (SCP) in query messages identifying particular instances of a trigger.
UserID	Provides an identifier of a user.

Termination_Notification Properties¶

Property	Description
AMP1	This AIN Maintenance Parameter marks and traces test calls/signals and activates logging on selected calls through the network. This parameter contains the first subset of the information needed for the AIN Network Test functionality.
AMP2	This AIN Maintenance Parameter marks and traces test calls/signals and activates logging on selected calls through the network. This parameter contains the second subset of the information needed for the AIN Network Test functionality.
BusyCause	Indicates the reason the call could not be presented to the terminating party.
ConnectTime	Indicates the time elapsed between the answer and disconnect.
ExtensionParameter	Provides service provider-specific information.

Update Properties¶

Property	Description
AdministrableObject	There are five parameters associated with the AdministrableObject placeholder: TriggerItemAssignment SSPUserResource SrhrGroup NetworkTestDesignator OperationsMonitoringAssignment
AMAslpID	Indicates that the Service Switching Point (SSP) should override normal switch-based recording and invoke Advanced Intelligent Network (AIN) Automatic Message Accounting (AMA) record generation.
AMP1	This AIN Maintenance Parameter marks and traces test calls/signals and activates logging on selected calls through the network. This parameter contains the first subset of the information needed for the AIN Network Test functionality.
AMP2	This AIN Maintenance Parameter marks and traces test calls/signals and activates logging on selected calls through the network. This parameter contains the second subset of the information needed for the AIN Network Test functionality.
ControlEncountered	Provides a congestion level indicator.
EditListType	Adds or deletes a list element to or from a list in the Service Switching Point (SSP).

Update_Data Properties¶

Property	Description
FailureCause	Indicates that the received operation could not be performed due to the unavailability of a hardware or software resource, causing a failure to occur.

Update_Request Properties¶

Property	Description
BearerCapability	Identifies the bearer capability of the user, which may be the calling or called party.
ControlEncountered	Provides a congestion level indicator.
TriggerCriteriaFlag	Indicates whether a trigger should be active or inactive.

XTML IN Events¶

XTML IN events are listed on the Events tab in the workspace pane.

These IN events are triggered when the corresponding messages are received by the SIGTRAN agent:

Application

SigTranNotification

IN Calling Name Delivery Events (GR-1188)

ParameterProvideValue

IN Toll Free Events (GR-533)

Connect
NS800PlayAnnouncment
ProvideInstructionsStart

IN Service Control Point Events (GR-1299)

Analyze_Route
Close
Continue
Disconnect
Info_Analyzed
Info_Collected
Resource_Clear
Termination_Attempt
Termination_Notification
Update_Data

XTML IN PACs¶

The function of each IN PAC is to create and send the specific message with the same name. For example, the Analyze_Route PAC sends an analyze_route message, and the Authorize_Termination PAC sends an authorize_termination message.

This section defines the unique tabs included in the Properties window and the standard results available for each PAC listed under IN Calling Name Delivery, IN Service Control Point Interface, and IN Toll Free on the Actions tab in the workspace pane.

For more information about the common Description tab and Custom tab, see Build Functions and Custom Results.

Analyze_Route¶

The Analyze_Route PAC requests that call origination processing be resumed.

Properties¶

The Analyze_Route PAC includes the General and Optional tabs.

General¶

*General Fields*¶
Field Name	Description
IN Message	The variable used to hold the IN message to be sent.
Send Notification	If selected, the switch will send a notification back to the application when the call is complete.
Returns	Contains information when errors occur. Can be in the following formats: scope - string that describes the scope in which the error took place code - integer that provides the error code message - string that describes the error txid - integer that provides the ID of the transaction in which the error took place

Optional¶

The Optional tab allows you to add applicable parameters to the Analyze_Route PAC.

Add Parameters

Click Add.
In the Parameter field, select an optional property to apply to the PAC.
In the Value field, type the value for the selected parameter.

Note

Click Insert to add a parameter below the parameter currently selected. Click Delete to remove a parameter from the PAC.

Exit Paths¶

In addition to the default result exit path, the Analyze_Route PAC also includes the result exit paths listed in the following table.

Exit Path	Description
Success	Points to the next PAC to be executed in the event that the connection is successful.
Error	Points to the next PAC to be executed in the event that the operation returned an error.
Timeout	Points to the next PAC to be executed in the event that the operation times out.

Authorize_Termination¶

The Authorize_Termination PAC requests that processing continue.

Properties¶

The Authorize_Termination PAC includes the General and Optional tabs.

General¶

*General Fields*¶
Field Name	Description
IN Message	The variable used to hold the IN message to be sent.
Send Notification	If selected, the switch will send a notification back to the application when the call is complete.
Returns	Contains information when errors occur. Can be in the following formats: scope - string that describes the scope in which the error took place code - integer that provides the error code message - string that describes the error txid - integer that provides the ID of the transaction in which the error took place

Optional¶

The Optional tab allows you to add applicable parameters to the Authorize_Termination PAC.

Add Parameters

Click Add.
In the Parameter field, select an optional property to apply to the PAC.
In the Value field, type the value for the selected parameter.

Note

Click Insert to add a parameter below the parameter currently selected. Click Delete to remove a parameter from the PAC.

Exit Paths¶

In addition to the default result exit path, the Authorize_Termination PAC also includes the result exit paths listed in the following table.

Exit Path	Description
Success	Points to the next PAC to be executed in the event that the connection is successful.
Error	Points to the next PAC to be executed in the event that the operation returned an error.
Timeout	Points to the next PAC to be executed in the event that the operation times out.

Connect¶

The Connect PAC sends a Connect response message.

Properties¶

The Connect PAC includes the General tab.

General¶

*General Fields*¶
Field Name	Description
IN Message	The variable used to hold the IN message to be sent.
Billing Indicator	Provides customer billing information.
Carrier	Provides the carrier selection information and the identification of the primary carrier that a call was routed to.
Routing Number	Supports sending a 10-digit “calling directory number” in a query and/or sending a 6-digit controlled code for Automatic Call Gap (ACG) in a response message.
Returns	Contains information when errors occur. Can be in the following formats: scope - string that describes the scope in which the error took place code - integer that provides the error code message - string that describes the error txid - integer that provides the ID of the transaction in which the error took place

Exit Paths¶

In addition to the default result exit path, the Connect PAC also includes the result exit paths listed in the following table.

Exit Path	Description
Success	Points to the next PAC to be executed in the event that the connection is successful.
Error	Points to the next PAC to be executed in the event that the operation returned an error.
Timeout	Points to the next PAC to be executed in the event that the operation times out.

Continue¶

The Continue PAC requests that trigger processing be continued in the same Trigger Detection Point (TDP) to allow an event to hit more that one trigger in a single TDP.

Properties¶

The Continue PAC includes the General and Optional tabs.

General¶

*General Fields*¶
Field Name	Description
IN Message	The variable used to hold the IN message to be sent.
Send Notification	If selected, the switch will send a notification back to the application when the call is complete.
Returns	Contains information when errors occur. Can be in the following formats: scope - string that describes the scope in which the error took place code - integer that provides the error code message - string that describes the error txid - integer that provides the ID of the transaction in which the error took place

Optional¶

The Optional tab allows you to add applicable parameters to the Continue PAC.

Add Parameters

Click Add.
In the Parameter field, select an optional property to apply to the PAC.
In the Value field, type the value for the selected parameter.

Note

Click Insert to add a parameter below the parameter currently selected. Click Delete to remove a parameter from the PAC.

Exit Paths¶

In addition to the default result exit path, the Continue PAC also includes the result exit paths listed in the following table.

Exit Path	Description
Success	Points to the next PAC to be executed in the event that the connection is successful.
Error	Points to the next PAC to be executed in the event that the operation returned an error.
Timeout	Points to the next PAC to be executed in the event that the operation times out.

Disconnect¶

The Disconnect PAC sends a request to disconnect the call.

Properties¶

The Disconnect PAC includes the General and Optional tabs.

General¶

*General Fields*¶
Field Name	Description
IN Message	The variable used to hold the IN message to be sent.
Returns	Contains information when errors occur. Can be in the following formats: scope - string that describes the scope in which the error took place code - integer that provides the error code message - string that describes the error txid - integer that provides the ID of the transaction in which the error took place

Optional¶

The Optional tab allows you to add applicable parameters to the Disconnect PAC.

Add Parameters

Click Add.
In the Parameter field, select an optional property to apply to the PAC.
In the Value field, type the value for the selected parameter.

Note

Click Insert to add a parameter below the parameter currently selected. Click Delete to remove a parameter from the PAC.

Exit Paths¶

In addition to the default result exit path, the Disconnect PAC also includes the result exit paths listed in the following table.

Exit Path	Description
Success	Points to the next PAC to be executed in the event that the connection is successful.
Error	Points to the next PAC to be executed in the event that the operation returned an error.
Timeout	Points to the next PAC to be executed in the event that the operation times out.

Forward_Call¶

The Forward_Call PAC requests that the call be forwarded.

Properties¶

The Forward_Call PAC includes the General and Optional tabs.

General¶

*General Fields*¶
Field Name	Description
IN Message	The variable used to hold the IN message to be sent.
Send Notification	If selected, the switch will send a notification back to the application when the call is complete.
Returns	Contains information when errors occur. Can be in the following formats: scope - string that describes the scope in which the error took place code - integer that provides the error code message - string that describes the error txid - integer that provides the ID of the transaction in which the error took place

Optional¶

The Optional tab allows you to add applicable parameters to the Forward_Call PAC.

Add Parameters

Click Add.
In the Parameter field, select an optional property to apply to the PAC.
In the Value field, type the value for the selected parameter.

Note

Click Insert to add a parameter below the parameter currently selected. Click Delete to remove a parameter from the PAC.

Exit Paths¶

In addition to the default result exit path, the Forward_Call PAC also includes the result exit paths listed in the following table.

Exit Path	Description
Success	Points to the next PAC to be executed in the event that the connection is successful.
Error	Points to the next PAC to be executed in the event that the operation returned an error.
Timeout	Points to the next PAC to be executed in the event that the operation times out.

Info_Analyzed¶

The Info_Analyzed PAC indicates that a trigger event was detected.

Properties¶

The Info_Analyzed PAC includes the General and Optional tabs.

General¶

*General Fields*¶
Field Name	Description
Bearer Capability	Identifies the bearer capability of the user, which may be the calling or called party.
User ID	Provides an identifier of a user.
SCCP Address	The SCCP address of where the message is to be sent. Can be in the following formats: global_title_indicator - global_title_indicator of the SCCP address natl_intl_bit - national/international bit of the SCCP address signaling_point_code_bit - point code bit of the SCCP address subsystem_bit - subsystem bit of the SCCP address routing_bit - routing bit of the SCCP address point_code - point code of the SCCP address (if present) subsystem_number - subsystem number of the SCCP address global_title - object containing the global title of the SCCP address (if present)
Returns	Contains information when errors occur. Can be in the following formats: scope - string that describes the scope in which the error took place code - integer that provides the error code message - string that describes the error txid - integer that provides the ID of the transaction in which the error took place

Optional¶

The Optional tab allows you to add applicable parameters to the Info_Analyzed PAC.

Add Parameters

Click Add.
In the Parameter field, select an optional property to apply to the PAC.
In the Value field, type the value for the selected parameter.

Note

Click Insert to add a parameter below the parameter currently selected. Click Delete to remove a parameter from the PAC.

Exit Paths¶

In addition to the default result exit path, the Info_Analyzed PAC also includes the result exit paths listed in the following table.

Exit Path	Description
Success	Points to the next PAC to be executed in the event that the connection is successful.
Error	Points to the next PAC to be executed in the event that the operation returned an error.
Timeout	Points to the next PAC to be executed in the event that the operation times out.

Info_Collected¶

The Info_Collected PAC indicates that a trigger event was detected.

Properties¶

The Info_Collected PAC includes the General and Optional tabs.

General¶

*General Fields*¶
Field Name	Description
Bearer Capability	Identifies the bearer capability of the user, which may be the calling or called party.
User ID	Provides an identifier of a user.
SCCP Address	The SCCP address of where the message is to be sent. Can be in the following formats: global_title_indicator - global_title_indicator of the SCCP address natl_intl_bit - national/international bit of the SCCP address signaling_point_code_bit - point code bit of the SCCP address subsystem_bit - subsystem bit of the SCCP address routing_bit - routing bit of the SCCP address point_code - point code of the SCCP address (if present) subsystem_number - subsystem number of the SCCP address global_title - object containing the global title of the SCCP address (if present)
Returns	Contains information when errors occur. Can be in the following formats: scope - string that describes the scope in which the error took place code - integer that provides the error code message - string that describes the error txid - integer that provides the ID of the transaction in which the error took place

Optional¶

The Optional tab allows you to add applicable parameters to the Info_Collected PAC.

Add Parameters

Click Add.
In the Parameter field, select an optional property to apply to the PAC.
In the Value field, type the value for the selected parameter.

Note

Click Insert to add a parameter below the parameter currently selected. Click Delete to remove a parameter from the PAC.

Exit Paths¶

In addition to the default result exit path, the Info_Collected PAC also includes the result exit paths listed in the following table.

Exit Path	Description
Success	Points to the next PAC to be executed in the event that the connection is successful.
Error	Points to the next PAC to be executed in the event that the operation returned an error.
Timeout	Points to the next PAC to be executed in the event that the operation times out.

Provide Instructions/Start¶

The ProvideInstructions/Start PAC sends a request for the Start message.

Properties¶

The ProvideInstructions/Start PAC includes the General tab.

General¶

*General Fields*¶
Field Name	Description
SCCP Address	The SCCP address of where the message is to be sent. Can be in the following formats: global_title_indicator - global_title_indicator of the SCCP address natl_intl_bit - national/international bit of the SCCP address signaling_point_code_bit - point code bit of the SCCP address subsystem_bit - subsystem bit of the SCCP address routing_bit - routing bit of the SCCP address point_code - point code of the SCCP address (if present) subsystem_number - subsystem number of the SCCP address global_title - object containing the global title of the SCCP address (if present)
LATA	Identifies the Local Access and Transport Area (LATA).
Service Key	Supports sending a 10-digit “calling directory number” in a query and/or sending a 6-digit controlled code for Automatic Call Gap (ACG) in a response message.
Originating Station Type	Provides the binary equivalent of the ANI II digits and identifies characteristics of the calling line.
Calling Party Number	Provides the binary equivalent of the ANI II digits and identifies characteristics of the calling line.
Returns	Contains information when errors occur. Can be in the following formats: scope - string that describes the scope in which the error took place code - integer that provides the error code message - string that describes the error txid - integer that provides the ID of the transaction in which the error took place

Exit Paths¶

In addition to the default result exit path, the Provide Instructions/Start PAC also includes the result exit paths listed in the following table.

Exit Path	Description
Success	Points to the next PAC to be executed in the event that the connection is successful.
Error	Points to the next PAC to be executed in the event that the operation returned an error.
Timeout	Points to the next PAC to be executed in the event that the operation times out.

Return Error¶

The Return Error PAC sends an error message.

Properties¶

The Return Error PAC includes the General tab.

General¶

*General Fields*¶
Field Name	Description
IN Message	The variable used to hold the IN message to be sent.
Error Code	Indicates the reason why the requested operation failed.
Returns	Contains information when errors occur. Can be in the following formats: scope - string that describes the scope in which the error took place code - integer that provides the error code message - string that describes the error txid - integer that provides the ID of the transaction in which the error took place

Exit Paths¶

In addition to the default result exit path, the Return Error PAC also includes the result exit paths listed in the following table.

Exit Path	Description
Success	Points to the next PAC to be executed in the event that the connection is successful.
Error	Points to the next PAC to be executed in the event that the operation returned an error.
Timeout	Points to the next PAC to be executed in the event that the operation times out.

Return Result Last¶

The Return Result Last PAC indicates that this is the end of the query.

Properties¶

The Return Result Last PAC includes the General tab.

General¶

*General Fields*¶
Field Name	Description
IN Message	The variable used to hold the IN message to be sent.
Generic Name	Based on the Integrated Services Digital Network User Part (ISDNUP) Generic Name parameter.
Returns	Contains information when errors occur. Can be in the following formats: scope - string that describes the scope in which the error took place code - integer that provides the error code message - string that describes the error txid - integer that provides the ID of the transaction in which the error took place

Exit Paths¶

In addition to the default result exit path, the Return Result Last PAC also includes the result exit paths listed in the following table.

Exit Path	Description
Success	Points to the next PAC to be executed in the event that the connection is successful.
Error	Points to the next PAC to be executed in the event that the operation returned an error.
Timeout	Points to the next PAC to be executed in the event that the operation times out.

Send_To_Resource¶

The Send_To_Resource PAC indicates that an interaction with the calling party is required.

Properties¶

The Send_To_Resource PAC includes the General and Optional tabs.

General¶

*General Fields*¶
Field Name	Description
Resource Type	Type of resource to which a user is to be connected.
StrParameter Block	Provides the information that a Service Switching Point (SSP) or IP needs for the capability specified by the resource type.
IN Message	The variable used to hold the IN message to be sent.
Send Notification	If selected, the switch will send a notification back to the application when the call is complete.
Returns	Contains information when errors occur. Can be in the following formats: scope - string that describes the scope in which the error took place code - integer that provides the error code message - string that describes the error txid - integer that provides the ID of the transaction in which the error took place

Optional¶

The Optional tab allows you to add applicable parameters to the Send_To_Resource PAC.

Add Parameters

Click Add.
In the Parameter field, select an optional property to apply to the PAC.
In the Value field, type the value for the selected parameter.

Note

Click Insert to add a parameter below the parameter currently selected. Click Delete to remove a parameter from the PAC.

Exit Paths¶

In addition to the default result exit path, the Send_To_Resource PAC also includes the result exit paths listed in the following table.

Exit Path	Description
Success	Points to the next PAC to be executed in the event that the connection is successful.
Error	Points to the next PAC to be executed in the event that the operation returned an error.
Timeout	Points to the next PAC to be executed in the event that the operation times out.

TCAP Forward Message¶

The TCAP Forward Message PAC sends a Forward Message message.

Properties¶

The TCAP Forward Message PAC includes the General tab.

General¶

*General Fields*¶
Field Name	Description
IN or TCAP Message	The variable used to hold the IN or TCAP message to be forward.
SCCP Address	The SCCP address of where the message is to be sent. Can be in the following formats: global_title_indicator - global_title_indicator of the SCCP address natl_intl_bit - national/international bit of the SCCP address signaling_point_code_bit - point code bit of the SCCP address subsystem_bit - subsystem bit of the SCCP address routing_bit - routing bit of the SCCP address point_code - point code of the SCCP address (if present) subsystem_number - subsystem number of the SCCP address global_title - object containing the global title of the SCCP address (if present)
Returns	Contains information when errors occur. Can be in the following formats: scope - string that describes the scope in which the error took place code - integer that provides the error code message - string that describes the error txid - integer that provides the ID of the transaction in which the error took place

Exit Paths¶

In addition to the default result exit path, the TCAP Forward PAC also includes the result exit paths listed in the following table.

Exit Path	Description
Success	Points to the next PAC to be executed in the event that the connection is successful.
Error	Points to the next PAC to be executed in the event that the operation returned an error.
Timeout	Points to the next PAC to be executed in the event that the operation times out.

Termination_Notification¶

The Termination_Notification PAC indicates the outcome of a request for notification when the call exists.

Properties¶

The Termination_Notification PAC includes the General and Optional tabs.

General¶

*General Fields*¶
Field Name	Description
Echo Data	Correlates this termination notification with the appropriate call.
Termination Indicator	Provides either yes or no to indicate termination.
SCCP Address	The SCCP address of where the message is to be sent. Can be in the following formats: global_title_indicator - global_title_indicator of the SCCP address natl_intl_bit - national/international bit of the SCCP address signaling_point_code_bit - point code bit of the SCCP address subsystem_bit - subsystem bit of the SCCP address routing_bit - routing bit of the SCCP address point_code - point code of the SCCP address (if present) subsystem_number - subsystem number of the SCCP address global_title - object containing the global title of the SCCP address (if present)
Returns	Contains information when errors occur. Can be in the following formats: scope - string that describes the scope in which the error took place code - integer that provides the error code message - string that describes the error txid - integer that provides the ID of the transaction in which the error took place

Optional¶

The Optional tab allows you to add applicable parameters to the Termination_Notification PAC.

Add Parameters

Click Add.
In the Parameter field, select an optional property to apply to the PAC.
In the Value field, type the value for the selected parameter.

Note

Click Insert to add a parameter below the parameter currently selected. Click Delete to remove a parameter from the PAC.

Exit Paths¶

In addition to the default result exit path, the Termination_Notification PAC also includes the result exit paths listed in the following table.

Exit Path	Description
Success	Points to the next PAC to be executed in the event that the connection is successful.
Error	Points to the next PAC to be executed in the event that the operation returned an error.
Timeout	Points to the next PAC to be executed in the event that the operation times out.

Update¶

The Update PAC requests that certain information be changed.

Properties¶

The Update PAC includes the General and Optional tabs.

General¶

*General Fields*¶
Field Name	Description
Administrable Object	The object that contains the carrier-specific information to be updated.
SCCP Address	The SCCP address of where the message is to be sent. Can be in the following formats: global_title_indicator - global_title_indicator of the SCCP address natl_intl_bit - national/international bit of the SCCP address signaling_point_code_bit - point code bit of the SCCP address subsystem_bit - subsystem bit of the SCCP address routing_bit - routing bit of the SCCP address point_code - point code of the SCCP address (if present) subsystem_number - subsystem number of the SCCP address global_title - object containing the global title of the SCCP address (if present)
Returns	Contains information when errors occur. Can be in the following formats: scope - string that describes the scope in which the error took place code - integer that provides the error code message - string that describes the error txid - integer that provides the ID of the transaction in which the error took place

Optional¶

The Optional tab allows you to add applicable parameters to the Update PAC.

Add Parameters

Click Add.
In the Parameter field, select an optional property to apply to the PAC.
In the Value field, type the value for the selected parameter.

Note

Click Insert to add a parameter below the parameter currently selected. Click Delete to remove a parameter from the PAC.

Exit Paths¶

In addition to the default result exit path, the Update PAC also includes the result exit paths listed in the following table.

Exit Path	Description
Success	Points to the next PAC to be executed in the event that the connection is successful.
Error	Points to the next PAC to be executed in the event that the operation returned an error.
Timeout	Points to the next PAC to be executed in the event that the operation times out.

Update_Data¶

The Update_Data PAC indicates whether a request to change certain information was granted.

Properties¶

The Update_Data PAC includes the General and Optional tabs.

General¶

*General Fields*¶
Field Name	Description
IN Message	The variable used to hold the IN message to be sent.
Send Notification	If selected, the switch will send a notification back to the application when the call is complete.
Returns	Contains information when errors occur. Can be in the following formats: scope - string that describes the scope in which the error took place code - integer that provides the error code message - string that describes the error txid - integer that provides the ID of the transaction in which the error took place

Optional¶

The Optional tab allows you to add applicable parameters to the Update_Data PAC.

Add Parameters

Click Add.
In the Parameter field, select an optional property to apply to the PAC.
In the Value field, type the value for the selected parameter.

Note

Click Insert to add a parameter below the parameter currently selected. Click Delete to remove a parameter from the PAC.

Exit Paths¶

In addition to the default result exit path, the Update_Data PAC also includes the result exit paths listed in the following table.

Exit Path	Description
Success	Points to the next PAC to be executed in the event that the connection is successful.
Error	Points to the next PAC to be executed in the event that the operation returned an error.
Timeout	Points to the next PAC to be executed in the event that the operation times out.

Update_Request¶

The Update_Request PAC indicates whether a request to change certain information was granted.

Properties¶

The Update_Request PAC includes the General and Optional tabs.

General¶

*General Fields*¶
Field Name	Description
User ID	Provides an identifier of a user.
SCCP Address	The SCCP address of where the message is to be sent. Can be in the following formats: global_title_indicator - global_title_indicator of the SCCP address natl_intl_bit - national/international bit of the SCCP address signaling_point_code_bit - point code bit of the SCCP address subsystem_bit - subsystem bit of the SCCP address routing_bit - routing bit of the SCCP address point_code - point code of the SCCP address (if present) subsystem_number - subsystem number of the SCCP address global_title - object containing the global title of the SCCP address (if present)
Returns	Contains information when errors occur. Can be in the following formats: scope - string that describes the scope in which the error took place code - integer that provides the error code message - string that describes the error txid - integer that provides the ID of the transaction in which the error took place

Optional¶

The Optional tab allows you to add applicable parameters to the Update_Request PAC.

Add Parameters

Click Add.
In the Parameter field, select an optional property to apply to the PAC.
In the Value field, type the value for the selected parameter.

Note

Click Insert to add a parameter below the parameter currently selected. Click Delete to remove a parameter from the PAC.

Exit Paths¶

In addition to the default result exit path, the Update_Request PAC also includes the result exit paths listed in the following table.

Exit Path	Description
Success	Points to the next PAC to be executed in the event that the connection is successful.
Error	Points to the next PAC to be executed in the event that the operation returned an error.
Timeout	Points to the next PAC to be executed in the event that the operation times out.

Error Handling¶

Error handling is a critical component of IN application development. Sometimes an error is the only way that a transaction terminates, and if that error is not properly handled, the transaction will not terminate and a license can be locked.

Errors can occur locally within the application or remotely. Local errors are caused by a failure to send the message from the PAC. For example, attempting to send a message to an unavailable point code or subsystem number, not including the appropriate required parameters in a PAC, or network-related errors.

Local errors can be handled immediately by the application. Each PAC has a Returns field that accepts an object variable. When a local error occurs, the object specified in this field is populated with the error information and exits on its error path.

Remote errors are generated by a remote machine. In a remote error, the message is sent successfully, but an error notification is received back from a switch at a later point in the call flow.

Remote errors are more difficult to capture because they can happen at any point once the message has been sent. Remote errors are handled using the SigTranNotification event. This event has one parameter that is an error object with the same signature as the Returns object in the PAC. To handle a remote error, use either the Wait for PAC to wait for a response or the SigtranNotification to a message you sent or add an event handler for SigtranNotification in your application.

SigTranNotification Event¶

When an application sends a query from the application server, it is important to have a SigTranNotification to handle the remote error. In this situation the application is waiting for either a response or an error before the transaction ends. If neither the response nor the error are received, the transaction does not end and a transaction license is locked.

When an application responds to queries from the application server, handling the remote error case is not as important. In this case, the transaction ends once the application responds to a query with a final response and a transaction license is not locked.

Application Development Guidelines¶

The following are guidelines to follow when developing applications:

Use the Returns object to handle local errors for the application. This field is optional, but good development practices recommend that you use this field for all PACs in your application.
When available, select the Send Notification checkbox to instruct the switch to send a notification back to the application when the call is complete. This results in a Termination_Notification event.