BLOCK DESCRIPTION

Contents

1

REVISION INFORMATION

2

APPLICATION

3

PURPOSE OF THIS DOCUMENT INSTRUCTION (DI)

4

BLOCK DESCRIPTION (BD)

4.1

Purpose of a Block Description

4.2

Users of a Block Description

4.3

Identification of a Block Description

4.4

Contents of a Block Description

4.5

Writing a Block Description

5

GLOSSARY

6

REFERENCES

1 REVISION INFORMATION

This is a new document instruction, which replaces the following document instructions:

Block Description; 3/1013-FCK 114 21 Uen and

Block Description Flow Chart; 4/1013-FCK 114 21 Uen.

Rev B

The document has been updated for the AM concept and the HLPLEX programming language.

2 APPLICATION

This document instruction applies to new descriptions of AXE (CNT, CNZ and CNA) blocks. When

descriptions are modified, the document should be adapted to the instruction as much as possible.

3 PURPOSE OF THIS DOCUMENT INSTRUCTION (DI)

This DI defines the structure and contents of a Block Description and gives instructions on how to

write a Block Description.

ERICSSON ///

DOCUMENT INSTRUCTION

Uppgjord - Prepared

EED/TM Anna Paintner

Faktaansvarig - Subject responsible

ETX/TX/DT MYON

Nr - No

14/1013-FCK 114 21 Uen

Dokansv/Godk - Doc respons/Approved

ETX/TX/DT (H. Westlund)

Kontr - Checked

Datum - Date

1996-01-01

Rev

B

File

Strona 1 z 15

BLOCK DESCRIPTION

2004-12-30

file://C:\Documents%20and%20Settings\wakr\Pulpit\wiedza\tomax\mdoc-309.html

4 BLOCK DESCRIPTION (BD)

4.1 Purpose of a Block Description

The BD describes functionality within a block, which may cover one or more functions, or a part of a

function, and shows how these functions are distributed on the block (hardware and software) unit.

The external interfaces to other blocks and the internal interfaces between the block units are

described in a verbal and graphical manner. The BD also describes the dynamic behaviour of a

block, for example, in terms of event sequences. An event sequence has a defined start-point, which

is the event, followed by a sequence of actions that ends in a defined end-point.

4.2 Users of a Block Description

Those who need information and guidelines from the BD are:

Unit Designers, as a basis for unit design and basic test

Management, administration and customers as a product description

Function Designers and Block Designers as an aid to understand the block structure during

block update

4.3 Identification of a Block Description

The document head should contain the following information:

Document name:

The corresponding tag is called docname.

Enter the document name DESCRIPTION in capital letters.

Prepared:

The corresponding tag is called prep.

Enter your company code and office code, separated by a stroke (/), and your registered

initials.

Example: ETX/TX/DZ ADS

Subject responsible:

The corresponding tag is called subresp.

Enter the company code and office code, separated by a stroke (/), and the registered initials of

the person to be consulted.

Example: ETX/TX/DZ BKN

This field is entered only when:

A person other than the document's author is to be consulted on the contents of the

document

The office providing the data is not subordinate to the approving office

No.:

The corresponding tag is called docno.

Enter the document number, which must have the format:

1551-<product number> Uen

Example: 1551-CNT 216 1234 Uen

Strona 2 z 15

BLOCK DESCRIPTION

2004-12-30

file://C:\Documents%20and%20Settings\wakr\Pulpit\wiedza\tomax\mdoc-309.html

Doc respons/Approved:

The corresponding tag is called appr.

Enter a dash (-) here until the document has been approved.

The company code and office code of the Final Documentation Office is entered here. The

manager of this office signs the hard copy of the document, to indicate that it is a valid

document.

On the computer-stored document, the name is given within brackets to indicate that the

document has been signed.

Example: ETX/TX/FO (B. Eriksson)

Checked:

The corresponding tag is called checked.

Enter the company signature of the person who technically approves the document. He or she

signs the hard copy of the document.

The registered signature is entered here to indicate that the document has been signed.

Example: EEDUFR

Date:

The corresponding tag is called date.

Enter the date in the order YYYY-MM-DD

Example: 1994-06-21

The date on the document is the date when the document was last revised.

Rev:

The corresponding tag is called rev.

The revision letter defines the revision state of the document. Begin with A for a new

document. Use capital letters A ... Z, AA ... ZZ, except I, O, P, Q, R, U and W. A document

change which affects the subject contents, must be indicated by a stepped revision letter. Other

changes, such as correction of spelling errors etc., do not alter the revision letter.

Example: C is stepped to D, AB is stepped to AC.

A preliminary document is denoted by a "P" before the revision letter, and a numeral,

indicating the sequence number, after the revision letter. If a preliminary document must be

revised, the sequence number is stepped.

Example: PA1 is stepped to PA2.

When approved, the document gets a full-letter revision.

Example: PB4 becomes B.

Title:

The corresponding tag is called title.

Enter the title of the BD. Use capital letters.

BLOCK <BLOCK NAME>

<BLOCK DESIGNATION>

Example:

BLOCK BASSC

DYNAMIC OUTGOING/INCOMING

B-CHANNEL ASSIGNMENT

4.4 Contents of a Block Description

Strona 3 z 15

BLOCK DESCRIPTION

2004-12-30

file://C:\Documents%20and%20Settings\wakr\Pulpit\wiedza\tomax\mdoc-309.html

All BDs should have a uniform structure and layout.

1

REVISION INFORMATION

2

GENERAL

3

IMPLEMENTATION

3.1 Block Structure

3.2 Data Structure

3.3 Program Structure

4

INTERWORK

4.1 External Interwork

4.2 Internal Interwork

4.3 Test Points and Operation Points

4.4 Commands

4.5 Printouts

5

FUNCTION

5.1 Object Classes

5.2 Start/Restart

5.3 File Size Alterations

5.4 Block Function

5.n Block Sub-Function n (if any)

5.n+1 Subroutines

6

REFERENCES

7

GLOSSARY (optional)

4.5 Writing a Block Description

This section explains how to write a BD. It defines the headings and numbering to be used. Under

each heading there is an explanation of what the specific heading should comprise. If a heading is

not applicable, then insert "-" under the heading.

To avoid duplication of information, give priority to flowcharts when describing program and data

structure. Use verbal description only if it helps understanding the flowchart.

4.5.1 1 REVISION INFORMATION

Give a brief description of the changes in the document if the revision is being stepped.

4.5.2 2 GENERAL

Give a short (3-6 lines) description of the main function(s) of the block.

4.5.3 3 IMPLEMENTATION

Implementation is divided into the following sections:

4.5.4 3.1 Block Structure

Give a brief description of the block's functional modules. Describe in which units (CP, RP, EMRP,

SP, and Hardware) the modules are implemented. If the block consists of more than one unit, then

draw a figure (block diagram) to show the units and their interfaces. For each unit briefly describe

the main purpose(s) of the unit. (Most blocks in AXE contain only one unit, that is, CP software.)

Strona 4 z 15

BLOCK DESCRIPTION

2004-12-30

file://C:\Documents%20and%20Settings\wakr\Pulpit\wiedza\tomax\mdoc-309.html

4.5.5 3.2 Data Structure

Briefly describe all the major data used in the block, specifying the block's common data, files, and

records. Describe data structures on external data media and in transferred buffers owned by the

block. Diagrams may be used in describing the data structure. For each Data Structure mentioned,

describe the main variables/individuals associated.

4.5.6 3.3 Program Structure

Describe how the code will be divided into different sub-programs (modules) within the block, when

implementing the block in PLEX. Give a brief description of each sub-program (module).

Describe how the block is divided into HLPLEX processes when implementing the block in

HLPLEX.

For a block containing Object Classes, describe each Object Class in a seperate sub-program (PLEX)

or process (HLPLEX).

For an SP block, show how each unit in the block is divided into Eripascal processes (SP) or

DEFAX modules. Give a description of the main functions for each process or DEFAX module.

4.5.7 4 INTERWORK

Interwork is divided into the following main sections:

External Interwork

Internal Interwork

Test Points and Operation Points

Commands

Printouts

4.5.7.1 4.1 External Interwork

External Interwork is divided into the following subchapters. If a subchapter does not contain

information then it should be ommitted:

4.1.1

Strona 5 z 15

BLOCK DESCRIPTION

2004-12-30

file://C:\Documents%20and%20Settings\wakr\Pulpit\wiedza\tomax\mdoc-309.html

PLEX External Interwork

4.1.2

HLPLEX External Interwork

4.1.3

Object Class Interface

4.1.4

Eripascal (SP) External Interwork

4.5.7.2 4.1.1 PLEX External Interwork

If the block is implemented in PLEX, the External Interwork with other blocks is implemented with

PLEX signals. The block can also use an Object Class Interface to communicate with other blocks.

See section Object Class Interface.

List all signals in the interface between the described block and other blocks. Indicate all software

signals, except those "hidden" in language statements (read/write signals), transited (a signal

received and then sent again by the same block) and "dummy" signals (signals specified in the Signal

Survey, but dummy marked in the code so that they will cause an exit from the code and not cause a

restart. These signals may then be used by the block in the future). Where blocks are linked together

to form a software relation, indicate only those transited signals which have a functional effect on the

block. Subdivide the signals into "received" and "sent" signals.

4.1.1.1 Received PLEX Signals

List the recieved signals in alphabetical order. For each received signal, give a short description (1-2

lines) of the signal function (as it is seen from this block). This should include the following

information:

Name of signal

Sender/Receiver

Purpose of signal

4.1.1.2 Sent PLEX Signals

As specified for Received PLEX Signals.

4.5.7.3 4.1.2 HLPLEX External Interwork

If the block is implemented in HLPLEX, the External Interwork with other blocks is implemented

with HLPLEX Events, Procedures, Functions and Seizurecases. The block can also use an Object

Class Interface to communicate with other blocks. See section Object Class Interface. Describe the

HLPLEX Interwork between the described block and other blocks, under the following headings:

4.1.2.1 Received HLPLEX Events

Example:Signal Name From

Purpose

ASEIZE

LI, IL, BL, SE Seizure of SEPRM individual. Originating call.

BANSWA

LI, OL, BL, SE B subscriber answer.

Example:Signal Name To

Purpose

CONTFSEND

DAF

Answer to question if the size alteration can take place.

DELSELINK

LI, IL, OL, BL, SE Delete SEPRM link from SE chain.

Strona 6 z 15

BLOCK DESCRIPTION

2004-12-30

file://C:\Documents%20and%20Settings\wakr\Pulpit\wiedza\tomax\mdoc-309.html

List the received events in alphabetical order. For each received event, give a short description (1-2

lines) of the event function (as it is seen from this block).The events should be listed according to

their protocols. This should include the following information:

Protocol Name

Event Name

Sender

Purpose of event

4.1.2.2 Sent HLPLEX Events

As specified for Received HLPLEX Events.

4.1.2.3 HLPLEX Procedures

List the HLPLEX Procedure names, the block owner and the purpose of the HLPLEX Procedure in

following format:

4.1.2.4 HLPLEX Functions

List the HLPLEX Function names, the block owner and the purpose of the HLPLEX Function in

following format:

4.1.2.5 HLPLEX Seizurecases

List the HLPLEX Seizurecase names, the block owner and the purpose of the HLPLEX Seizurecase

in following format:

4.5.7.4 4.1.3 Object Class Interface

Example:Protocol Name Event Name

From Purpose

ATCA_ATJA

ATTNEWDESTINFO ATCA Call diversion information

ATTL_ATJA

SERIALCALLINFO ATTL Mark call for Serial Call

Example:Protocol

Name

Event Name

To

Purpose

ATCC_ATJC

CHSUBSTATEINFO ATTL Inform that status of the subscriber has been

changed.

ATTB_ATJB

ATTSTARTINGREQ ATCA Asks ringing to be stated.

Procedure Module Owner Purpose
-

-

-

-

-

-

Function Module Owner Purpose
-

-

-

-

-

-

Seizurecase Module Owner Purpose
-

-

-

-

-

-

Strona 7 z 15

BLOCK DESCRIPTION

2004-12-30

file://C:\Documents%20and%20Settings\wakr\Pulpit\wiedza\tomax\mdoc-309.html

Note: This section is applicable to both HLPLEX and PLEX.

There are two types of blocks that use an Object Class Interface:

Blocks containing Management Function (MF) functionality

Object Owning Blocks

When an MF wants to communicate with an Object Class and vice versa, they must use the interface

(messages) described in the Object Class Description (OCD). The MF and Object Class use this

interface differently (see <O&M>).

Management Function

A Management Function only has to implement those parts (messages) of an OCD that it requires to

fulfill it's functionality. If this Block Description is for a block acting as a Management Function,

include the following information:

4.1.3.1 Messages sent by Management Function to Object Class

List the messages the MF can send in alphabetical order. For each message specified, give a short

description (1-2 lines) of the message function (as it is seen from this block). This should include the

following information:

Message Name

NOTE: It is possible that message names can be the same in different Object Class Protocols,

so specify the message name in the format <OC.M> where OC is the name of the Object Class

that defines the message and M is the message name,

Names of Object Classes that the MF may send the message to,

Purpose of message.

For each Object Class listed, refer to it's Object Class Description in Chapter 6, References.

4.1.3.2 Messages Received by Management Function from Object Class

As specified for Messages Sent by MF to Object Class in previous section.

Example:Messages

Object Classes

Purpose

TOP.close_association_c

PROPHAN,

SUBSCR, BSHAN

This message implements the sending of the

actionclose_association on C-level.

SUBCHECK.check

PROPHAN,

SUBSCR

Up to 16 instances of the subsription object

can be checked with this message.

PRVCHAR.get_restr_type_of_snb BSHAN

This message implements the sending of the

action get_RestrTypeOfSNB .

Example:Messages

Object Classes Purpose

SUBCHECK.check_resp

PROPHAN,

SUBSCR

This message is a reply to the check

message.

PRVCHAR.get_restr_type_of_snb_ack BSHAN

This message is sent in response to the

message get_restr_type_of_snb .

Strona 8 z 15

BLOCK DESCRIPTION

2004-12-30

file://C:\Documents%20and%20Settings\wakr\Pulpit\wiedza\tomax\mdoc-309.html

For each Object Class listed, refer to it's Object Class Description in Chapter 6, References.

4.1.3.3 Event Notifications received by Management Function

For each Event Notification that can be received by the MF, list the name of the Events in

alphabetical order and it's Purpose in the following format:

Object Owning Block

A Block containing an Object Class must implement all messages that can be received by the Object

Class. If this Block Description is for an Object Owning Block, include the following information

for each Object Class that the block owns:

4.1.3.4 Object Classes owned by the Block

List the Object Classes that the Block owns in alphabetical order, and include the following

information:

Object Class Name

Purpose of Object Class

Information on the messages that the Object Class can receive and send can be found in the OCD for

the Object Class. For each Object Class listed, refer to it's OCD in Chapter 6, References.

4.5.7.5 4.1.4 Eripascal (SP) External Interwork

If the block is implemented in Eripascal (SP Design only), describe the Interwork between the

described block and other blocks, under the following headings:

4.1.4.1 Received Signals

List the recieved signals in alphabetical order. For each received signal, give a short description (1-2

lines) of the signal function (as it is seen from this block). This should include the following

information:

Name of signal

Sender/Receiver

Purpose of signal

Example:Event Name Purpose
Pbx_subscr_admin

This event occurs after linking or unlinking of a GIN.

Example:Object

Class

Purpose

CAPTAM

Defines the structure and the means of obtaining Call Path Tracing Information

in an AM based system.

TRANSNB

Reads subscriber numbers from the IO Buffer for translation in addition to the

insertion of translated subscriber numbers into the IO Buffer.

Example:Signal Name From

Purpose

ASEIZE

LI, IL, BL, SE Seizure of SEPRM individual. Originating call.

BANSWA

LI, OL, BL, SE B subscriber answer.

Strona 9 z 15

BLOCK DESCRIPTION

2004-12-30

file://C:\Documents%20and%20Settings\wakr\Pulpit\wiedza\tomax\mdoc-309.html

4.1.4.2 Sent Signals

As specified for Received Signals.

4.1.4.3 Procedures and Functions

Show all imported subroutines (procedures and functions) for the SP block. In addition, list any

exported subroutines, besides those described in the open interface documents. List the subroutines

alphabetically and subdivide into the following headings:

4.1.4.4 Types

Show all Eripascal types imported by the block, and from where they are imported. In addition, list

any exported types, besides those described in open interface documents.

4.1.4.5 Constants

Show all Eripascal constants imported by the block, and where they are imported from. In addition,

list any exported constants, besides those described in the open interface documents. Use the same

headings as for exported types (see previous section).

4.5.7.6 4.2 Internal Interwork

Internal Interwork is divided into the following subchapters. If a subchapter does not contain

information, it should be ommitted:

4.2.1

PLEX Internal Interwork

4.2.2

HLPLEX Internal Interwork

4.2.3

Eripascal (SP) Internal Interwork

4.5.7.7 4.2.1 PLEX Internal Interwork

Example:Signal Name To

Purpose

CONTFSEND

DAF

Answer to question if the size alteration can take place.

DELSELINK

LI, IL, OL, BL, SE Delete SEPRM link from SE chain.

ImportedProcedure/Function Exporter Purpose
-

-

-

-

-

-

ExportedProcedure/Function Purpose
-

-

-

-

ImportedName Exporter Purpose
-

-

-

-

-

-

ExportedName Purpose
-

-

-

-

Strona 10 z 15

BLOCK DESCRIPTION

2004-12-30

file://C:\Documents%20and%20Settings\wakr\Pulpit\wiedza\tomax\mdoc-309.html

List all signals sent between the central and the regional Software Units and signals sent to own

Software Unit (not LOCAL). If a regional Software Unit exists, subdivide the chapter into "CP -

RP", "RP - CP" and "CP - CP" and list the signals in alphabetical order. For each signal, give a short

(1-2 lines) description of the signal function.

Also list the local signals of the block.

4.2.1.1 CP - RP Signals

List the CP - RP signals alphabetically. For each CP - RP signal, give a short (1-2 lines) description

of the signal function. Divide in incoming and outgoing signals.

4.2.1.2 RP - RP Signals

As for CP - RP signals, 4.2.1.1

4.2.1.3 CP - CP Signals

As for CP - RP signals, 4.2.1.1

4.2.1.4 SP - SP Signals

For SP blocks that interwork with other SP blocks, list, in alphabetical order, the signals used in the

interwork.

List also the Local signals of the block.

4.5.7.8 4.2.2 HLPLEX Internal Interwork

4.2.2.1 HLPLEX Block Internal Events

List all HLPLEX events between two processes within the block and give a short description (1-2

lines) of each event.

4.5.7.9 4.2.3 Eripascal (SP) Internal Interwork

4.2.3.1 Procedures and Functions (SP onlly)

Show any module level subroutines (procedures and functions) for an SP block. List the subroutines

alphabetically subdivide into the following headings:

4.5.7.10 4.3 Test Points and Operation Points

This section applies only to blocks that have associated hardware. List the different points. Give a

short description of the message which can be sent or received for each point.

4.5.7.11 4.4 Commands

List the commands which can be received by the module. Give a short description of the command

function for each command code.

Procedure/Function Purpose
-

-

-

-

Strona 11 z 15

BLOCK DESCRIPTION

2004-12-30

file://C:\Documents%20and%20Settings\wakr\Pulpit\wiedza\tomax\mdoc-309.html

4.5.7.12 4.5 Printouts

List the printouts which can be initiated by the module (not procedure printouts). Give a short

description of the printout.

4.5.8 5 FUNCTION

4.5.8.1 5.1 Object Classes

Specify all Object classes which the block owns.

4.5.8.2 5.2 Start/Restart

Describe all Start/Restart phases in which the block participates as well as the initializations made.

4.5.8.3 5.3 File Size Alterations

Describe, where applicable, the following Size Alterable entities:

Files,

HLPLEX Procedures,

HLPLEX Functions,

HLPLEX Processes.

.

4.5.8.4 5.4 Block Function

Give a graphical description of the block functions. Give a brief verbal description of each module.

Divide the chapter into subchapters, one subchapter for each block subfunction. Describe the block

function with all its normal and abnormal cases of events. If the abnormal cases are not complex,

they may be described with the normal cases.

External interwork (an interwork with a block outside the block in question) may be shown in either

of the ways outlined below. When naming external blocks, use the Free Text symbol followed by the

name of the block to indicate the external block name. This symbol will not appear in the printout.

The signal name should be given above the signal line.

Pseudo-code is recommended to describe SP-block functions instead of flowcharts.

Strona 12 z 15

BLOCK DESCRIPTION

2004-12-30

file://C:\Documents%20and%20Settings\wakr\Pulpit\wiedza\tomax\mdoc-309.html

The external blocks do not have to be shown in a separate column. The signal name is given beside

the signal, and the name of the block from which the signal is sent or received is written below the

signal using the Free Text symbol.

4.5.8.5 5.n Block Sub-Function n (if any)

Clearly describe together with a flowchart the course of events for all block subfunctions. The

description should show

when a specific signal is sent or received and how this signal is related to

other signals. When the external interwork is described, interworking blocks or subsystems may be

indicated by their designations. If there are no block subfunctions to describe, omit this chapter.

4.5.8.6 5.n+1 Subroutines

Give a verbal and graphical description in alphabetical order of the subroutines of the block.

4.5.9 6 REFERENCES

List references made to other documents.

List also Function DescriptionsFDs, Interwork DescriptionsIWDs (SP design only), and Design

RulesDR that are applicable for the function block.

Strona 13 z 15

BLOCK DESCRIPTION

2004-12-30

file://C:\Documents%20and%20Settings\wakr\Pulpit\wiedza\tomax\mdoc-309.html

Structure the list as you find appropriate, for example as below:

Document References

[1]

1551-CNT 216 1610 Uen, BLOCK CAPP

Function Description

1/155 16-CNT 216 1611 Uen

CALL PATH TRACING

Control System Design Rules

ETX 102 60-1026

Execution Time Limits

ETX 102 60-1207

Limitations in Signal/Event sending

ETX 102 60-1141

Command Routines in AXE

ETX 102 60-1114

System Start and Restart in AXE

ETX 102 60-1116

Selection of Signalling Level

XT/UD 81 022

Standardized Signals for Level Change

General Application Design Rules

X/UD 26 78 Ue

Global States in APT 210; Definitions

Function Specific Design Rules

X/U 159-75 104 Ue

Tracing of Switching Paths

4.5.10 7 GLOSSARY (optional)

5 GLOSSARY

BD

Block Description

Block Units

The function block could be split into 1 CP unit and 1 EMRP unit, or 2 CP units and 1 RP unit,

etc.

CP

Central Processor

DEFAX

Definition Module in AXE

Dummy signal

A dummy signal is specified in the Signal Survey, but dummy marked in the code so that it

will cause an exit from the code and not cause a restart. This type of signal may be used by the

Strona 14 z 15

BLOCK DESCRIPTION

2004-12-30

file://C:\Documents%20and%20Settings\wakr\Pulpit\wiedza\tomax\mdoc-309.html

block in the future.

EMRP

Extension Module RP

Functional Modules

A functional module is a part of the block in which a particular function is implemented.

HLPLEX

High Level PLEX

MF

Management Function

OCD

Object Class Description

RP

Regional Processor

SP

Support Processor

6 REFERENCES

<TERM>

AM Encyclopedia

EN/LZT 101 1859

<O&M>

Design Directive for MF's and OOB's

EEI/STB-94:0213 Uen

Strona 15 z 15

BLOCK DESCRIPTION

2004-12-30

file://C:\Documents%20and%20Settings\wakr\Pulpit\wiedza\tomax\mdoc-309.html