CLIMA - CLI Manipulation

The goal of AMO-CLIMA is to internalize an incoming number as long as it matches a predefined number/pattern. It is also responsible for Alpha tagging and Call barring. In case the incoming number matches a predefined number/pattern, it is changed to an internal number - as if the call came from an internal number. With AMO CLIMA configuration for SIP URI Domain mapping is possible. A domain can be mapped to a number, and it is supposed that the number is a preconfigured trunk access code.

Alpha tagging: If the incoming number matches a predefined number/pattern, the incoming party name is changed - so the incoming number can be recognized.
Call barring: If the incoming number matches a predefined number/pattern, one of the following actions is taken:

The call is rejected

The call is routed to a predefined number

The call is accepted (routed to the original called party)

In the system there is 1 table for checking the called (DDI) number and 19 tables for checking the calling (CLI) number. For both kind of tables number patterns can be specified (the digits 0-9, the letter X indicating any digit 0-9, the letter Z indicating any number of any digits 0-9). The patterns in these tables are not considered as devices configured in the system. They are just used to compare the calling or called number digits received from the incoming trunk.

CLI Table contains the following fields :

CLIDP - In case the incoming number matches this number/pattern, the corresponding action will be taken. CLIDP can contain digits 0-9 and letters X and Z.

NAME - If the external number matches, the name of the external party will be changed to this value.

NUMBER - If the external number matches, the number of the external party will be changed to this value.

DESTIDX - If ACTION is RESTRICT and the external number matches, the destination number will be changed to the value looked up in the Destination Table (configured with HOTLN:HOTDEST) based on this index value.

ACTION - If the external number matches, the action will be executed. Action can be any of the following:

REJECT - the call will be refused (Disconnect sent to caller).

RESTRICT - the call will be routed to a predefined extension based on the Destination Index field.

ACCEPT - the call will be accepted.

DDI Table contains the following fields :

DDIDP - The called number is checked against this number/pattern. DDIDP can contain digits 0-9 and letters X and Z.

PLAN - This parameter determines which CLI Table to use for checking the CLIDP.

DOMAIN Table contains the following fields:

DDOMAIN - SIP URI Domain. DOMAIN can have maximum 63 characters and can contain digits 0-9, letters A-Z and "_",".","-".

NUMBER - The number which identifies the route where calls are routed based on DOMAIN

TYPE - DOMAIN type:

ROUTE - routing for specific domains to specific trunks (incoming/outgoing calls).

IGNORE - ignore the domain and route the call to the number from call SIP URI (number@domain).

DEFAULT - DOMAIN is the default domain or not (only a single domain is the default domain)

Yes/No - default route for outgoing calls with domains not defined - e.g., calls routed to default trunk to ITSP.

The first domain added becomes the default domain.

A domain can be set as default using CHANGE-CLIMA.

With AMO-LDPLN the DPLN numbers 770 to 789 are reserved for CLI numbering and they are not used for any other purposes (like LCR). A certain dialing plan number is necessary to distinguish between the CLI number analysis and the original function LCR digit analysis.

With AMO-LDPLN the DPLN number 790 is reserved for domain mapping and it is not used for any other purposes (like LCR). A certain dialing plan number is necessary to distinguish between the domain mapping and the original function LCR digit analysis.

ADD-DIMSU: TYPE=NETWORK, LDPLN8=<number>;

ADD-DIMSU: TYPE=NETWORK, LDPLNC8=<number>;

ADD-LDPLN: LCRCONF=LCRADM, DIPLNUM=<number>, LWMPOOL=8, DIALPLN=<number>, INFO="CLI/DDI/DOMAIN)/NUMBERING PLAN";

ADD-DIMSU: TYPE=USER, HOTDEST=<number>;

ADD-HOTLN: TYPE=HOTDEST, HTLNIDX=<number>, DEST=<key-num>;

Cross Reference to Other AMOs:

AMO DIMSU	Dimensioning of features, switching unit
AMO LDPLN	Administration lcr dialplan
AMO HOTLN	Hotline/offhook intercept

Generation sequence:

 DIMSU --> LDPLN --> CLIMA 
 DIMSU --> LDPLN --> HOTLN --> CLIMA (When ACTION is chosen as REDIRECT)

Destination Processor: BP (Switching Unit)

Functions

ADD	Add Entry to CLI, DDI or DOMAIN Table	password class 2
CHANGE	Change CLI, DDI or DOMAIN Table Entry	password class 2
DELETE	Delete CLI, DDI or DOMAIN Table Entry	password class 2
OPTIMIZE	Optimize CLI, DDI or DOMAIN Table	password class 2
DISPLAY	Display CLI, DDI or DOMAIN Table	password class 2
REGENERATE	Regenerate CLI, DDI or DOMAIN Table	password class 2

Procedure Overview

ADD-CLIMA

ADD-CLIMA
		TABLE=DOMAIN,DOMAIN=<string>, NUMBER=<number>, [TYPE=<param>];
		TABLE=CLI,PLAN=<number>, CLIDP=<string>, [NAME=<string>], [NUMBER=<number>], [DESTIDX=<number>], [ACTION=<param>];
		TABLE=DDI,DDIDP=<string>, PLAN=<number>;

Example

Input:

  ADD-CLIMA:TABLE=CLI,PLAN=1,CLIDP="1234567",NAME="NAME1",ACTION=ACCEPT;

Output:

  H04: CLIDP HAS BEEN ADDED FOR CLIDPNO 1.

Example

Input:

  ADD-CLIMA:TABLE=CLI,PLAN=1,CLIDP="134567",NAME="NAME2",ACTION=REJECT;

Output:

  H04: CLIDP HAS BEEN ADDED FOR CLIDPNO 2.

Example

Input:

  ADD-CLIMA:TABLE=CLI,PLAN=1,CLIDP="11111",NAME="NAME3",DESTIDX=3,AKTION=RESTRICT;

Output:

  H04: CLIDP HAS BEEN ADDED FOR CLIDPNO 3.

Example

Input:

  ADD-CLIMA:TABLE=DDI,DDIDP="1234",PLAN=1

Output:

  H04: DDIDP HAS BEEN ADDED FOR DDIDPNO 4.

Example

Input:

 ADD-CLIMA:TABLE=DOMAIN,DOMAIN="UNIFY.COM",NUMBER=12100,TYPE=ROUTE;

Output:

  H04: DOMAIN HAS BEEN ADDED FOR DOMAINNO 3.

CHANGE-CLIMA

CHANGE-CLIMA
		TABLE=DOMAIN, {(min 1) DOMAIN=<string>, DOMAINNO=<number>}, [NUMBER=<number>], [TYPE=<param>], [DFLT=<param>];
		TABLE=CLI,PLAN=<number>, {(min 1) CLIDP=<string>, CLIDPNO=<number>}, {(min 1) NAME=<string>, NUMBER=<number>, DESTIDX=<number>, ACTION=<param>};
		TABLE=DDI, {(min 1) DDIDP=<string>, DDIDPNO=<number>}, PLAN=<number>;

A DOMAIN can be set as default only via CHANGE-CLIMA.

Example

Input:

 CHANGE-CLIMA:TABLE=DOMAIN,DOMAIN="UNIFY.COM",DFLT=Y;

DELETE-CLIMA

DELETE-CLIMA
		TABLE=DOMAIN, {(min 1) DOMAIN=<string>, DOMAINNO=<number>};
		TABLE=CLI,PLAN=<number>, {(min 1) CLIDP=<string>, CLIDPNO=<number>};
		TABLE=DDI, {(min 1) DDIDP=<string>, DDIDPNO=<number>};

OPTIMIZE-CLIMA

OPTIMIZE-CLIMA

TABLE=DOMAIN,

ACTOPT=REBUILD,[LIMIT=<number>];

ACTOPT=DELETE;

TABLE=CLI,PLAN=<number>,

ACTOPT=REBUILD,[LIMIT=<number>];

ACTOPT=DELETE;

TABLE=DDI,

ACTOPT=REBUILD,[LIMIT=<number>];

ACTOPT=DELETE;

DISPLAY-CLIMA

DISPLAY-CLIMA
		TABLE=DOMAIN, {(max 1) DOMAIN=<string>, DOMAINNO=<number>};
		TABLE=CLI,[PLAN=<number>], {(max 1) CLIDP=<string>, CLIDPNO=<number>, NUMBER=<number>};
		TABLE=DDI, {(max 1) DDIDP=<string>, DDIDPNO=<number>};

Example

Input:

  DISP-CLIMA:CLI,1,1234567;

Output:

  
 CLI TABLE :
 +------------------------------------+
 |            CLI TABLE               |
 +------------------------------------+
 +------------------------------------+
 | PLAN 1                             |
 +------------------------------------+
 |  IDX     : 1                       |
 |  CLIDP   : 1234567                 |
 |  NAME    : NAME1                   |
 |  NUMBER  :                         |
 |  DESTIDX :                         |
 |  ACTION  : ACCEPT                  |
 +------------------------------------+

Example

Input:

  DISP-CLIMA:DDI,,;

Output:

  
 DDI TABLE :
 +------------------------------------+
 |            DDI TABLE               |
 +------------------------------------+
 |  DDIDPNO : 4                       |
 |  CLIDP   : 1234                    |
 |  PLAN    : 1                       |
 +------------------------------------+

Example

Input:

  DIS-CLIMA:DOMAIN,UNIFY.COM;  or   DIS-CLIMA:DOMAIN,,3;

Output:

  
 +----------------------------------------------------------------------------+
 |              DOMAIN TABLE                                                  |
 +----------------------------------------------------------------------------+
 | DOMAINNR : 3                                                               |
 | DOMAIN   : UNIFY.COM                                                       |
 | NUMBER   : 12100                                                           |
 | TYPE     : ROUTE                                                           |
 | DEFAULT  : YES                                                             |
 +----------------------------------------------------------------------------+

REGENERATE-CLIMA

REGENERATE-CLIMA
		[TABLE=DOMAIN], {(max 1) DOMAIN=<string>, DOMAINNO=<number>};
		[TABLE=CLI],[PLAN=<number>], {(max 1) CLIDP=<string>, CLIDPNO=<number>, NUMBER=<number>};
		[TABLE=DDI], {(max 1) DDIDP=<string>, DDIDPNO=<number>};

Example

Input:

  REG-CLIMA:CLI,1,;

Output:

  ADD-CLIMA:TABLE=CLI,PLAN=1,CLIDP="1234567",NAME="NAME1",ACTION=ACCEPT;
  ADD-CLIMA:TABLE=CLI,PLAN=1,CLIDP="134567",NAME="NAME2",ACTION=REJECT;
  ADD-CLIMA:TABLE=CLI,PLAN=1,CLIDP="11111",NAME="NAME3",DESTIDX=3,AKTION=RESTRICT;

Example

Input:

  REG-CLIMA:DDI,;

Output:

  ADD-CLIMA:TABLE=DDI,DDIDP="1234",PLAN=1;

Example

Input:

  REG-CLIMA:DOMAIN;

Output:

  ADD-CLIMA:TABLE=DOMAIN,DOMAIN="ATOS.NET",NUMBER=12100,TYPE=IGNORE;
  ADD-CLIMA:TABLE=DOMAIN,DOMAIN="SIEMENS.COM",NUMBER=12101,TYPE=IGNORE;
  ADD-CLIMA:TABLE=DOMAIN,DOMAIN="UNIFY.COM",NUMBER=12100,TYPE=ROUTE;
  CHANGE-CLIMA:TABLE=DOMAIN,DOMAIN="UNIFY.COM",DFLT=Y;
  ADD-CLIMA:TABLE=DOMAIN,DOMAIN="VODAFONE.RO",NUMBER=12201,TYPE=IGNORE;

Parameter description

ACTION	Action to be executed
	Type of Input:	single value, 4. parameter of a min-1-group			(CHANGE,TABLE=CLI-CLI Table)
		single value, optional			(ADD,TABLE=CLI-CLI Table)
	Possible Values:	ACCEPT	The call will be accepted	DB_LDPLN_CLI_ACT_ACCEPT
		REJECT	The call will be refused	DB_LDPLN_CLI_ACT_REJECT
		RESTRICT	The call will be routed	DB_LDPLN_CLI_ACT_RESTRICT
	Default Value:	ACCEPT-The call will be accepted
ACTOPT	Cache action
	Type of Input:	single value, mandatory
	Possible Values:	DELETE	Delete cache
		REBUILD	Refine cache
CLIDP	CLI digit pattern; allowed: 0..9,X,Z
	Type of Input:	single value, 1. parameter of a max-1-group			(DISPLAY,TABLE=CLI-CLI Table / REGENERATE,TABLE=CLI-CLI Table)
		single value, 1. parameter of a min-1-group			(CHANGE,TABLE=CLI-CLI Table / DELETE,TABLE=CLI-CLI Table)
		single value, mandatory			(ADD,TABLE=CLI-CLI Table)
	Possible Values:	text, up to 22 characters
CLIDPNO	CLI digit pattern number
	Type of Input:	1 to 10 single values, concatenated with & or &&, 2. parameter of a min-1-group			(DELETE,TABLE=CLI-CLI Table)
		1 to 10 single values, concatenated with &, 2. parameter of a max-1-group			(DISPLAY,TABLE=CLI-CLI Table / REGENERATE,TABLE=CLI-CLI Table)
		single value, 2. parameter of a min-1-group			(CHANGE,TABLE=CLI-CLI Table)
	Possible Values:	numeric, 1-9999
DDIDP	DDI digit pattern; allowed: 0..9,X,Z
	Type of Input:	single value, 1. parameter of a max-1-group			(DISPLAY,TABLE=DDI-DDI Table / REGENERATE,TABLE=DDI-DDI Table)
		single value, 1. parameter of a min-1-group			(CHANGE,TABLE=DDI-DDI Table / DELETE,TABLE=DDI-DDI Table)
		single value, mandatory			(ADD,TABLE=DDI-DDI Table)
	Possible Values:	text, up to 22 characters
DDIDPNO	DDI digit pattern number
	Type of Input:	1 to 10 single values, concatenated with &, 2. parameter of a max-1-group			(DISPLAY,TABLE=DDI-DDI Table / REGENERATE,TABLE=DDI-DDI Table)
		1 to 10 single values, concatenated with &, 2. parameter of a min-1-group			(DELETE,TABLE=DDI-DDI Table)
		single value, 2. parameter of a min-1-group			(CHANGE,TABLE=DDI-DDI Table)
	Possible Values:	numeric, 1-9999
DESTIDX	Index of Destination Table
	Type of Input:	single value, 3. parameter of a min-1-group			(CHANGE,TABLE=CLI-CLI Table)
		single value, optional			(ADD,TABLE=CLI-CLI Table)
	Possible Values:	numeric, 1-2512
DFLT	Default Domain
	Type of Input:	single value, optional
	Possible Values:	Y	Yes	TRUE
DOMAIN	domain; allowed: 0..9,A-Z,_,.,-
	Type of Input:	single value, 1. parameter of a max-1-group			(DISPLAY,TABLE=DOMAIN-DOMAIN TABLE / REGENERATE,TABLE=DOMAIN-DOMAIN TABLE)
		single value, 1. parameter of a min-1-group			(CHANGE,TABLE=DOMAIN-DOMAIN Table / DELETE,TABLE=DOMAIN-DOMAIN Table)
		single value, mandatory			(ADD,TABLE=DOMAIN-Domain Table)
	Possible Values:	text (case sensitive), up to 63 characters
DOMAINNO	DOMAIN digit pattern number
	Type of Input:	1 to 10 single values, concatenated with &, 2. parameter of a max-1-group			(DISPLAY,TABLE=DOMAIN-DOMAIN TABLE / REGENERATE,TABLE=DOMAIN-DOMAIN TABLE)
		1 to 10 single values, concatenated with &, 2. parameter of a min-1-group			(DELETE,TABLE=DOMAIN-DOMAIN Table)
		single value, 2. parameter of a min-1-group			(CHANGE,TABLE=DOMAIN-DOMAIN Table)
	Possible Values:	numeric, 1-9999
LIMIT	Limit for linear search
	Type of Input:	single value, optional
	Possible Values:	numeric, 1-2048
NAME	Name representing the CLI digit pattern
	Type of Input:	single value, 1. parameter of a min-1-group			(CHANGE,TABLE=CLI-CLI Table)
		single value, optional			(ADD,TABLE=CLI-CLI Table)
	Possible Values:	text (case sensitive), up to 22 characters
NUMBER	Trunk access code
	Type of Input:	single value, 2. parameter of a min-1-group			(CHANGE,TABLE=CLI-CLI Table)
		single value, 3. parameter of a max-1-group			(DISPLAY,TABLE=CLI-CLI Table / REGENERATE,TABLE=CLI-CLI Table)
		single value, mandatory			(ADD,TABLE=DOMAIN-Domain Table)
		single value, optional			(ADD,TABLE=CLI-CLI Table / CHANGE,TABLE=DOMAIN-DOMAIN Table)
	Possible Values:	numeric, up to 22 characters
PLAN	CLI plan number
	Type of Input:	single value, mandatory			(ADD,TABLE=CLI-CLI Table / ADD,TABLE=DDI-DDI Table / CHANGE,TABLE=CLI-CLI Table / CHANGE,TABLE=DDI-DDI Table / DELETE,TABLE=CLI-CLI Table / OPTIMIZE,TABLE=CLI-CLI Table)
		single value, optional			(DISPLAY,TABLE=CLI-CLI Table / REGENERATE,TABLE=CLI-CLI Table)
	Possible Values:	numeric, 1-19
TABLE	Table type
	Type of Input:	single value, mandatory			(ADD / CHANGE / DELETE / DISPLAY / OPTIMIZE)
		single value, optional			(REGENERATE)
	Possible Values:	CLI	CLI Table
		DDI	DDI Table
		DOMAIN	DOMAIN TABLE		(DISPLAY / REGENERATE)
		DOMAIN	DOMAIN Table		(CHANGE / DELETE / OPTIMIZE)
		DOMAIN	Domain Table		(ADD)
TYPE	Domain Type
	Type of Input:	single value, optional
	Possible Values:	IGNORE	Ignore the domain	DOM_TYPE_IGNORE
		ROUTE	Domain routing to specific trunk routes	DOM_TYPE_ROUTE
	Default Value:	ROUTE - Domain routing to specific trunk routes			(ADD,TABLE=DOMAIN-Domain Table)

Error Messages

F01	F01: ILLEGAL CHARACTER IN NUMBER PATTERN: NUMBER PATTERN MAY ONLY CONTAIN THE CHARACTERS 0 TO 9, AND THE WILDCARDS X AND Z.
F02	F02: THERE IS NO MORE LCR DIALPLAN CACHE MEMORY AVAILABLE. PLEASE TRY TO INCREASE THIS MEMORY USING AMO DIMSU, PARAMETER LDPLNC8 OR TRY TO REORGANIZE THE CACHE BY MEANS OF DELETE AND REBUILD.
F03	F03: PATTERN NUMBER @@@@ NOT YET EXISTING.
F04	F04: NO DESTINATIONS ARE CREATED AT HOTDEST FOR THE SPECIFIED HOTLN INDEX.
F05	F05: @@@@@@ CANNOT BE ADDED/CHANGED - THERE IS NO FREE @@@@@@-MEMORY (ADD-DIMSU:LDPLN8=<NUMBER>;)
F05	F05: @@@DP CANNOT BE ADDED/CHANGED - THERE IS NO FREE @@@DP-MEMORY (ADD-DIMSU:LDPLN8=<NUMBER>;)
F06	F06: ENTERED @@@@@@ ALREADY EXISTS AT @@@@@@NO @@@@.
F06	F06: ENTERED @@@DP ALREADY EXISTS AT @@@DPNO @@@@.
F07	F07: FOR ACTION RESTRICT A DESTIDX HAS TO BE ENTERED.
F08	F08: @@@@@@ AND @@@@@@NO CANNOT BE ENTERED AT THE SAME TIME.
F08	F08: @@@DP AND @@@DPNO CANNOT BE ENTERED AT THE SAME TIME.
F09	F09: @@@@@@ NOT YET ADDED.
F09	F09: @@@DP @@@@@@@@@@@@@@@@@@@@@@ NOT YET ADDED.
F10	F10: @@@@@@ NUMBERING PLAN IS NOT CONFIGURED. PLEASE CONFIGURE IT USING: ADD-LDPLN:LCRADM,@@@,8,@@@,"@@@@@@ PATTERN PLAN";
F10	F10: @@@ NUMBERING PLAN IS NOT CONFIGURED. PLEASE CONFIGURE IT USING: ADD-LDPLN:LCRADM,@@@,8,@@@,"@@@ PATTERN PLAN #@@@";
F11	F11: WHEN ACTION IS CHANGED TO RESTRICT, DESTIDX HAS TO BE ENTERED.
F12	F12: @@@@@@ NUMBERING PLAN @@@ IS NOT CONFIGURED.
F12	F12: @@@ NUMBERING PLAN @@@ IS NOT CONFIGURED.
F13	F13: DOMAIN @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ COULD NOT BE DELETED SINCE IT IS THE DEFAULT DOMAIN

Advisory Messages

H01	H01: @@@@@@DP @@@@@@@@@@@@@@@@@@@@@@ NOT YET ADDED.
H02	H02: ENTERED @@@@@@DPNO NOT YET ADDED.
H03	H03: @@@@@@ TABLE IS EMPTY.
H04	H04: @@@@@@ HAS BEEN ADDED FOR @@@@@@NO @@@@.
H04	H04: @@@@@@DP HAS BEEN ADDED FOR @@@@@@DPNO @@@@.
H05	H05: THE ACTUAL MAXIMAL LINEAR SEARCH LENGTH IS @@@@@.
H06	H06: THE LCR DIALPLAN CACHE HAS BEEN DELETED.
H07	H07: WHEN CLIDP OR CLIDPNO IS ENTERED, PLAN HAS TO BE SPECIFIED.
H08	H08: ENTERED NUMBER @@@@@@@@@@@@@@@@@@@@@@ NOT YET ADDED.