28/02/2005 http://garbowww.ericsson.se:80/tomax/mdocs/010-01013-021_E/mdoc.html #1
ERICSSON /// DOCUMENT INSTRUCTION
Uppgjord - Prepared Datum - Rev Dokumentnr - Document no
ETX/TX/DZ MYON Date E 10/1013-FCK 114 21 Uen
1996-01-01
Godkänd - Approved Kontr - Checked Tillhör/referens -
ETX/TX/DT (H. Westlund) File/reference
SOURCE PARAMETER LIST FOR CP SOFTWARE UNITS
Contents
1 REVISION INFORMATION
2 APPLICATION
3 PURPOSE OF THIS DI
4 SOURCE PARAMETER LIST FOR CP SOFTWARE UNITS
4.1 Purpose
4.2 Users
4.3 Identification
4.4 Contents
4.5 How to write an SPL
1 REVISION INFORMATION
This is a new document, which replaces the following documents:
Document Instruction for Source Parameter List for CP Software Units; TX/DZ-91:134 Uen
Document Instruction for Source Parameter List for CP Software Units; TX/UL-92:035 Uen
The following modifications have been made:
Major change to structure of matrix parameters.
Insertion of new chapter, Software Unit Description.
An example of a Forlopp parameter has been added.
Minor changes in chapter 4.5.
Minor corrections on syntax faults.
2 APPLICATION
This document applies to all new Source Parameter Lists (SPL) made in APS for CP Software Units (CAA
107...) in AXE.
The existing SPLs must be modified according to this document instruction (DI) when the factual contents of
the SPLs are changed the next time. Where an Application Information (AI) describing the parameters exists,
the information in the AI shall be included in the SPL when removing the AI.
3 PURPOSE OF THIS DI
This DI defines the structure and contents of an SPL for CP Software Units. It also tells you how to write an
SPL for CP Software Units. Because of computer processing of the SPL later on, it is of vital importance that
the structure is correct, that is, tabulator positions and syntax are in line with the DI.
4 SOURCE PARAMETER LIST FOR CP SOFTWARE UNITS
4.1 Purpose
An SPL is to be made for all CP Software Units in the AXE system. The purpose of an SPL for CP Software
Units is to define and give absolute values to the Global Number Symbols and Global String Symbols of the
Software Unit. The SPL is used so that a change in a function can be made with a changed parameter
instead of a change in the Source Program Information.
4.2 Users
Those who need information and guidelines from the SPL for CP Software Units are:
The program production people, as a basis for the Parameter List (190 59) for the application. The
program production section computer processes the SPL.
Craft personnel, for assigning application parameter values for the customer.
4.3 Identification
The SPL does not contain a document header. The top of the SPL specifies only the document name.
Syntax ExampleDOCUMENT
SPARAM; DOCUMENT ENQUSPARAM;
*END; *END;ID SPARAM TYPE DOCUMENT; ID
ENQUSPARAM TYPE DOCUMENT;CLA <19073>;
CLA 190 73;NUM CAA 107 <4567>; NUM CAA 107 4479;
REV ; REV A;DAT ;
DAT 1991-10-18;DES ; DES TX/UL ETXSVBE;
RES ; RES TX/UL;APP ;
APP TX/UL;END ID; END ID;
SPARAM is the AXE document name for the SPL where is the function designation of the CP
software unit. The function designation = block designation + 'U' for CP software units.
190 73 is the decimal class of the document.
CAA is the ABC-class.
123 4567 indicates the type and sequence number of the CP software unit. Z = Revision state of the SPL.
Letters I, O, P, Q, R and W must not be used.
4.4 Contents
All SPLs shall have a uniform structure and layout. You obtain this by using a skeleton in DELTA/METHODS.
1
BLOCK DESIGNATION
2
SOFTWARE UNIT DESCRIPTION
3
BLOCK TYPE STATEMENTS
4
SOURCE PROGRAM INFORMATION
5
SYSTEM DEFINED PARAMETERS
5.1
Global Number Symbols
5.2
Global String Symbols
6
SYSTEM DEFAULT PARAMETERS
6.1
Global Number Symbols
6.2
Global String Symbols
7
APPLICATION DEPENDENT PARAMETERS
7.1
Global Number Symbols
7.2
Global String Symbols
4.5 How to write an SPL
28/02/2005 http://garbowww.ericsson.se:80/tomax/mdocs/010-01013-021_E/mdoc.html #2
4.5.1 General Points
This section explains how to write an SPL for CP software units. It defines the headings to be used. Under
each heading there is an explanation of what the specific heading should comprise.
The COCA, PRCA, ALCAT and ALCLS symbol names in the SPL (on the left hand side of the "=" sign) are
defined by the MAXE committee, and their values (on the right hand side of the "=" sign) are set by the
designer.
Relative Start Phase Numbers (SPH...) are declared as local symbols in the source program, and shall not be
included in the SPL. File sizes are not to be set with a Global Parameter.
The following layout rules also apply when writing an SPL:
Do not write after column 72 (This will save time for the SPL user, as the information will not flow over
the screen width.
Write 'NSYMB' in column 1 (to enable computer processing).
Write parameter name in column 11.
Always use a blank space after the ":" character (avoids problems when using the SPL in dedicated
EDML application).
Each parameter shall have the same structure, that is be assigned a Value Range, a Guiding Value
and a description. Insert these directly after the parameter. Do not insert blank lines into the structure
if they are not within exclamation marks (to enable computer processing).
Be consistent when assigning Hex (#) values, that is, if it is used in Value Range it should also be
used in Guiding Value. Further details will be given below.
Parameters that belong together, for example for a certain function, should be written after each other
to facilitate for the parameter setters.
When setting VALUE RANGE the following should be considered:
Try not to just put the limit the system allows you, that is, according to the number of bits. The user is
more interested in what is possible for the specific function that the parameter controls. It is possible to
set the Value Range to separate values as well as intervals. The numbers and intervals should
however be separated by a space. For example, Value Range can be set to 0 4 7-9 18 40-43. This
means that the following numbers are allowed: 0, 4, 7, 8, 9, 18, 40, 41, 42 and 43.
For Global String Symbols the Value Range is from the minimum number to the maximum number of
alphanumeric characters that can be stored in the string symbol.
When setting GUIDING VALUE the following shall be considered:
Assign the most likely value.
For Global String Symbols the Guiding Value indicates the value of the string symbol for the English
language area.
Keep the complete Guiding Value as on line. Do not split it between rows (to enable computer
processing).
When writing the parameter description, the following shall be considered:
Explain the functional meaning of the parameter. Write several sentences if necessary. Remember
who is using the document. Explain each possible value of the parameter clearly and separately
when possible.
It is sometimes desirable to have a single description that covers several parameters, see for example
matrix parameters chapter 7.
Explain the possible relationship between parameters in the document.
Explain the parameter in telephony terms.
When describing the different values of parameters, give as alternatives only those values which are
realistic for the block. Remember also in applicable cases, to mention the 'unit' and the 'step' of the
parameter.
When describing time supervision parameters, state what the unit of time supervision is (seconds,
minutes), and in which steps the parameter value can be given. If the value range is from 0 (zero),
explain what '0' means. Explain also relationship to possible other time supervision parameters and
functions.
If it is necessary to give additional information to the designers, this could be made by using 'notes'
which are explained at the end of the document.
In some cases, for example, when describing time supervision parameters, reference to the
corresponding Function Specification (FS) and parameter in the FS (and/or GSM or CCITT or ETSI
specification) may clarify the function and the use of the parameter, as well as reference to the
corresponding 2/AI.
If the parameter is market-specific, that is, if it is introduced via the MIR process as market-specific
parameter, this should be explained in the description.
If the parameter is changeable by command, this should be explained in the description.
Supplementary documents:
The following Design Rules and manual must be used when writing the technical contents of the SPL:
Use of Block Types in AXE, X/UD 2523
Function Codes in AXE 10, XT/UD 82 300
Block Categories in AXE, TX/UR 88 089
Setting of Alarm Category and Alarm Class Value, XT/UD 82 078
Adaptation to Forlopp in AXE, ETX 102 60-1044
Specifying of Elements in Tone Message, X/UD 718
Software Reliability Handbook, EN LZG 205 603
4.5.2 1 BLOCK DESIGNATION
The Sector Header 'BLOCK' contains the Block designation of the CP Software Unit in the target machine.
Syntax ExampleBLOCK ;
BLOCK ENQ;
4.5.3 2 SOFTWARE UNIT DESCRIPTION
Make a short description of the functions of the software unit. The parameter setters often have not access to
the Source Program Information where this information can be found.
Syntax

Example
!
THE SUBSCRIBER SERVICE ENQUIRY, ADD-ON CONFERENCE
SERVICE AND TRANSFER SERVICES ARE HANDLED BY THE
BLOCK ENQ, IN THE SUBSCRIBER SWITCHING SUBSYSTEM, SUS.
THE FUNCTION BLOCK ENQ HANDLES THE CONNECTION OF
THE C-SUBSCRIBER, THE CONNECTION TO THE CONTROL-
LING SUBSCRIBER DURING DIGIT RECEPTION, A RETURN
TO A CALL BETWEEN THE CONTROLLING SUBSCRIBER (A OR
B) AND THE C-SUBSCRIBER, DISCONNECTION OF THE
C-SUBSCRIBER AND DISCONNECTION OF THE CONTROLLING
SUBSCRIBER AT TRANSFER CALL.
!
4.5.4 3 BLOCK TYPE STATEMENTS
For a description of the block type and block type extension concepts, see the AXE System Design Manual.
The TYPE and TYPEEXT statements are mandatory and must always be declared.
Syntax Example
TYPE BT; TYPE BTENQ;TYPEEXT BTEXT
; TYPEEXT BTEXTENQ;
where Z is the block designation.
4.5.5 4 SOURCE PROGRAM INFORMATION
The USE statement indicates the system defined name (AX document name) for the Source Program
Information of the CP Software Unit. X is the function designation for the CP software. The function
designation = block designation + 'U' for CP Software Units.
Syntax ExampleUSE PROGRAM;
USE ENQUPROGRAM;
4.5.6 5 SYSTEM-DEFINED PARAMETERS
Mandatory headline that helps the computer tool to sort the parameters.
!
------------------------------------------------------------
SYSTEM DEFINED PARAMETERS
------------------------------------------------------------
!
28/02/2005 http://garbowww.ericsson.se:80/tomax/mdocs/010-01013-021_E/mdoc.html #3
4.5.6.1 5.1 Global Number Symbols
SYSTEM DEFINED parameters represent system properties that remain unchanged irrespective of the
application. The SYSTEM DEFINED PARAMETERS are always assigned values (system values) in the SPL,
by the designer. Change of value shall only be made by the designer.
Block type with the associated mask and property symbol. Explain in the comment what types that are
included.
SyntaxNSYMB BT = ; !VALUE RANGE:
GUIDING VALUE:

!
ExampleNSYMB BTENQ = #8010; !VALUE RANGE: #0-#FFFF
GUIDING VALUE: #8010
BLOCK CHARACTERISTICS FOR
ENQ ON APT LEVEL
BTENQ=BCAPT (+) BCCATOWN
#8000 BCAPT
APT BLOCK
#8010 BCCATOWN
CATEGORY OWNING
BLOCK
!
SyntaxNSYMB BTEXT = ; !VALUE RANGE:
GUIDING VALUE:

!
ExampleNSYMB BTEXTENQ = #2400; !VALUE RANGE: #0-#FFFF
GUIDING VALUE: #2400
BLOCK CHARACTERISTICS FOR
ENQ ON AXE LEVEL
BTEXTENQ=
BCLOGDATA (+) BCEXTREC
#0400 BCLOGDATA
BLOCK WITH VARIABLES
IN DS DUMP
#2000 BCEXTREC
BLOCK WITH
EXTENSIBLE
FILES
!
SyntaxNSYMB BC = ; !VALUE RANGE:
GUIDING VALUE:

!
ExampleNSYMB BCSUBLI = #8402; !VALUE RANGE: #0-#FFFF
GUIDING VALUE: #8402
BLOCK TYPE CATEGORY
FOR SUBSCRIBER LINES
!
SyntaxNSYMB BM = ; !VALUE RANGE:
GUIDING VALUE:

!
ExampleNSYMB BMSUBLI = #860E; !VALUE RANGE: #0-#FFFF
GUIDING VALUE: #860E
BLOCK TYPE MASK FOR
SUBSCRIBER LINES
!
Function Codes (FC...)
SyntaxNSYMB FC = ; !VALUE RANGE:
GUIDING VALUE:

!
ExampleNSYMB FCSEMIPERMANENT = 38; !VALUE RANGE: 0-65535
GUIDING VALUE: 38
ASSIGNED VALUE FOR
SEMIPERMANENT CONNECTION
!
Block Category
SyntaxNSYMB = ; !VALUE RANGE:
GUIDING VALUE:

!
ExampleNSYMB BLOCAT = 2; !VALUE RANGE: 0-3
GUIDING VALUE: 2
THE BLOCK HAS A MAJOR
INFLUENCE ON THE CALL
HANDLING PROCESS.
!
If statistical counters are implemented in the Software Unit the Data Interface Descriptions (DID) must be
included and a reference to a Design rule made, TX/JE-88:214.
(For a full description of the above system concepts, see the AXE System Design Manual)
ISO character definition (COLON, ANDSIGN, AMPERSAND etc.)
SyntaxNSYMB = ; !VALUE RANGE:
GUIDING VALUE:

!
ExampleNSYMB SEMICOLON = #3B; !VALUE RANGE: #0-#FF
GUIDING VALUE: #3B
COMMAND END
!
4.5.6.2 5.2 Global String Symbols
Strings other than System Default and Application Dependent.
For example, Card Designations
SyntaxSTRING = ""; !VALUE RANGE:
GUIDING VALUE:

!
ExampleSTRING CARD3 = "EMC-6"; !VALUE RANGE: 1-5 CHARACTERS
GUIDING VALUE: "EMC-6"
NAME OF CARD
!
4.5.7 6 SYSTEM DEFAULT PARAMETERS
System Default parameters represent system properties that are normally not changed for an application.
The parameters are always assigned values (system default values) in the SPL by the designer.
Mandatory headline that helps the computer tool to sort the parameters.
!
------------------------------------------------------------
SYSTEM DEFAULT PARAMETERS
------------------------------------------------------------
!
4.5.7.1 6.1 Global Number Symbols
Alarm Categories and Alarm Classes
SyntaxNSYMB ALCAT = ; !VALUE RANGE:
28/02/2005 http://garbowww.ericsson.se:80/tomax/mdocs/010-01013-021_E/mdoc.html #4
GUIDING VALUE:

!
ExampleNSYMB ALCAT153 = #6; !VALUE RANGE: #0-#F
GUIDING VALUE: #6
SUBSCRIBER LINE TEST
BUFFER FAULT
!
SyntaxNSYMB ALCLS = ; !VALUE RANGE:
GUIDING VALUE:

!
ExampleNSYMB ALCLS166 = #1; !VALUE RANGE: #0-#4
GUIDING VALUE: #1
BELONGS TO ALCAT153
ALARM SENT WHEN FAULT
BUFFER, ROUTINE TEST
BUFFER OR INTERMITTENT
FAULT BUFFER IS 90%
FULL
!
Alarm Categories refer to the areas of the exchange affected by the alarm and are represented by "system
default" global number symbols ALCATn.
The alarm classes refer to the severity of the alarm and are represented by "system default" global number
symbols ALCLSn.
Command Categories
SyntaxNSYMB COCA = ; !VALUE RANGE:
GUIDING VALUE:

!
ExampleNSYMB COCA1086 = #4023; !VALUE RANGE: #0-#FFFF
GUIDING VALUE: #4023
COMMAND SLFB1
!
Printout Category Number (PRCA)
SyntaxNSYMB PRCA = ; !VALUE RANGE:
GUIDING VALUE:

!
ExampleNSYMB PRCA002 = 2; !VALUE RANGE: 0-127
GUIDING VALUE: 2
"CHARGING STATISTICS"
!
Tabulator Position for Printout Table
SyntaxNSYMB TABPOS = ; !VALUE RANGE:
GUIDING VALUE:

!
ExampleNSYMB TABPOS1 = 1; !VALUE RANGE: 1-72
GUIDING VALUE: 1
USED IN SLOCI ANSWER
PRINTOUT FOR PARAMETER
EMG
!
Forlopp information
SyntaxNSYMB FLINFO = ; !VALUE RANGE:
GUIDING VALUE:

!
ExampleNSYMB FLINFO = #A100; !VALUE RANGE: #0-#FFFF
GUIDING VALUE: #A100
FORLOPP INFORMATION
FOR THE BLOCK
!
4.5.7.2 6.2 Global String Symbols
Below follows some mandatory headlines that help the computer tool to assign the correct strings. (If the SPL
doesn't contain these types of parameters it is not mandatory).
Command Codes (Before called Keywords or Slogans)
!
COMMAND CODES
-------------
!
SyntaxSTRING = ""; !VALUE RANGE:
GUIDING VALUE:

!
ExampleSTRING CHSSI = "CHSSI"; !VALUE RANGE: 1-5 CHARACTERS
GUIDING VALUE: "CHSSI"
CHARGING ADMINISTRATION
OF SWITCHING CLASS,
SPECIFICATION INITIATE
!
Printout Keywords
!
PRINTOUT KEYWORDS
-----------------
!
SyntaxSTRING = ""; !VALUE RANGE:
GUIDING VALUE:

!
ExampleSTRING TRARE = "TRAFFIC RECORDING"; !VALUE RANGE: 1-31 CHARACTERS
GUIDING VALUE:
"TRAFFIC RECORDING"
USED IN PRINTOUT
COMMAND TRMPP
!
Printout slogans
!
PRINTOUT SLOGANS
----------------
!
SyntaxSTRING = ""; !VALUE RANGE:
GUIDING VALUE:

!
ExampleSTRING NONE = "NONE"; !VALUE RANGE: 1-7 CHARACTERS
GUIDING VALUE: "NONE"
NO DATA
!
Fault slogans
!
FAULT SLOGANS
-------------
!
SyntaxSTRING = ""; !VALUE RANGE:
GUIDING VALUE:

!
ExampleSTRING TEXT02 = "DATA IS NOT SPECIFIED";
!VALUE RANGE: 1-31 CHARACTERS
GUIDING VALUE:
"DATA IS NOT SPECIFIED"
THE DATA HAS TO BE
SPECIFIED FIRST
!
Parameters for commands and printouts
28/02/2005 http://garbowww.ericsson.se:80/tomax/mdocs/010-01013-021_E/mdoc.html #5
!
COMMAND AND PRINTOUT PARAMETERS
-------------------------------
!
SyntaxSTRING = ""; !VALUE RANGE:
GUIDING VALUE:

!
ExampleSTRING EAEBC = "EAE/BC"; !VALUE RANGE: 1-31 CHARACTERS
GUIDING VALUE: "EAE/BC"
USED IN PRINTOUT AFTER
COMMAND CHESP
!
Output file name references
!
OUTPUT FILE NAME REFERENCE
--------------------------
!
SyntaxSTRING = ""; !VALUE RANGE:
GUIDING VALUE:

!
ExampleSTRING FILENAME = "TRARFILE"; !VALUE RANGE: 1-15 CHARACTERS
GUIDING VALUE: "TRARFILE"
FILE ON WHICH OUTPUT
OCCURS
!
4.5.8 7 APPLICATION DEPENDENT PARAMETERS
Application Dependent parameters represent system properties that are normally changed for an application.
The parameters are given the most likely value in the SPL.
Mandatory headline that helps the computer tool to sort the parameters.
!
------------------------------------------------------------
APPLICATION DEPENDENT PARAMETERS
------------------------------------------------------------
!
4.5.8.1 7.1 Global Number Symbols
SyntaxNSYMB = ; !VALUE RANGE:
GUIDING VALUE:

!
ExampleNSYMB ALLOWED = 1; !VALUE RANGE: 0-1
GUIDING VALUE: 1
PARAMETER WHICH INDICATES
WHETHER THE CALL BACK SERVICE
IS AUTOMATICALLY AVAILABLE TO
ALL SUBSCRIBERS OR AVAILABLE
ON A SUBSCRIPTION BASIS
0 THE SERVICE IS AUTOMATICALLY
AVAILABLE
1 THE SERVICE IS ON A
SUBSCRIPTION BASIS
!
ExampleNSYMB STIME = 10; !VALUE RANGE: 0-126
GUIDING VALUE: 10
SUPERVISION TIME IN SECONDS
FOR INTERVAL BETWEEN DIGITS
!
For Matrix Parameters certain rules apply. A specification of the format shall be in the heading. How this is
done is best explained by a couple of examples. Start with the name of the matrix parameter, column and row
definition and end with "END MATRIX" (see examples below). The computer tool used by parameter setters
does not record any special description to a matrix parameter just a general description for all parameters.
Any specific values for a certain matrix parameter should be stated there. See a SC (Subscriber Category)
block in APT 210, on how to write a description to matrix parameters.
Example 1
! MATRIXPARAMETER CASE
VALUE RANGE: 0-1
GUIDING VALUE: 1
WHATEVER
!NSYMB CASE00 = 1;NSYMB CASE01 = 1;NSYMB CASE10 = 1;
NSYMB CASE11 = 1;NSYMB CASE20 = 1;NSYMB CASE21 = 1;
! END MATRIX !
This matrix has three rows (0-2) and two columns (0-1).
Example 2
! MATRIXPARAMETER BASEMM
VALUE RANGE: 0-1
GUIDING VALUE: 1
WHATEVER
!NSYMB BASE00MM00 = 1;NSYMB BASE00MM01 = 1;NSYMB BASE01MM00 = 1;
NSYMB BASE01MM01 = 1;
! END MATRIX !
This matrix has two rows (00-01) and two columns (00-01).
4.5.8.2 7.2 Global String Symbols
List the Global String Symbols used in the block for example:
Block Name references for blocks that can be duplicated or exist in more than one version in an
application system. These blocks are given application dependent block names other than the
product names. E.g. an ET block cooperating with BT and DIPST. In the application the names are
ET2D3, BT2D3 and DIP2D3. In ET2D3 the string symbol BTNAME will have value "BT2D3" and
symbol DIPSTNAME value "DIP2D3".
Other strings with direct application dependent values.
SyntaxSTRING = ""; !VALUE RANGE:
GUIDING VALUE:

!
ExampleSTRING DIPSTNAME = "DIPST"; !VALUE RANGE: 1-7 CHARACTERS
GUIDING VALUE: "DIPST"
DIPST BLOCK NAME AS GIVEN
IN THE APPLICATION
!