PC-Regeneration User Guide

# $ K A + > Welcome Service Assistant Manager (SAM) consists of several PC-based applications designed to increase the efficiency of servicing MD110 systems while reducing service-related operating costs. SAM includes PC-Regen, an off-line, Windows-based application that automates database generation and conversion when upgrading within and between MD110 software releases. Additionally, PC-Regen can be used to create an emergency backup database.

# Welcome$WelcomeKMD110;PC-Regen;SAM;Service Assistant Manager;WelcomeAIntro+Group0000:0000 > main

# $ K A + > What you will find in HelpThis documentation describes PC-Regen functionality and provides step-by-step procedures for running PC-Regen. It also includes information on identifying and resolving error conditions.

Tips for using online Help: The Help window can be resized or maximized. Click Help Topics to show or hide the Contents, Index, and Search tabs. Click Print to print the current topic. Click >> to go to the next topic in the browse sequence. Click << to go to the previous topic

in the browse sequence. Click See Also to display a list of links to related topics. The Options menu provides additional display controls.

# What_You_Will_Find_in_Help$What you will find in HelpKHelp;How to Use Help;What You Will Find in HelpAIntro+Group0000:0007 > main

# $ K A + > Introduction to PC-RegenPC-Regen is a MD110 data regeneration application used to extract and convert data prior to upgrading MD110 software. PC-Regen can also be used to create a backup database.

Using PC-Regen, you can:

Generate a batch file to extract the MD110 system database. The extracted data can be saved and used as an emergency backup.

Convert and regenerate data into a new BC release format. Create batch files to send converted exchange data back to the MD110 to rebuild the

database after a software upgrade.PC-Regen consists of one executable file, data files, and several script files. The pre-written script files enable the regeneration process to generate the target database based on the specific source and target release versions.

PC-Regen allows you to regenerate the following MD110 system software releases:

Release Version

ASBU 501 01 R4/1

ASB 501 01 R3, R4

ASB 501 04 R1, R1/1, R1/2, R1/3, R1/4

R2, R2/1, R2/2, R2/3, R2/4, R2/4, R2/5, R2/6, R2/7, R2/8

R4, R4/1

R6

R7

R8

R11

# Introduction_to_PC_Regen$Introduction to PC-RegenKIntroduction;PC-Regen;What is PC-RegenAIntro+Group0000:0004 > main

# $ K UpgradeThe process of advancing from one level of functionality to a higher, more robust level. Moving from version BC10 to BC 12 is an example of a software upgrade.

# Upgrade$UpgradeKUpgrade

# $ K A + > System RequirementsYour PC must meet the following minimum requirements to run PC-Regen:

Windows 95/98, Windows 2000, or Windows NT 4.0 or higher 15 MB free disk space 16 MB RAM, Windows 95

32 MB RAM, Windows NT 4.0 WinFIOL or FIOL locally installed on the PC that will be connected to the MD110.

# System_Requirements$System RequirementsKFIOL;Minimum Requirements;PC Configuration;System Requirements;WinFIOLAIntro+Group0000:0005 > main

# $ K A + > Capacity and LimitationsPC-Regen does not support the following:

Downgrading the system database; however, regeneration from and to the same release version is supported.

Regenerating more than one MD110 database concurrently.PC-Regen regenerates the entire system database with the following exceptions:

Release From/ To Does Not Regenerate . . .

ASBU 501 01 to ASB 501 04 LA command group

NA command group (except NANSI)

RODDI, RODAI and ROCAI commands

PA command group

TR command group

IOPWC; CLTGI; ICUPI

ALREI; ALSII; ALAII; ALAOI; ALEII; ALEOI; ALIOI, ALIRI

ASB 501 01 to ASB 501 04 TR command group

IOCAC; IOPWC; CLTGI; ICUPI

ALREI; ALSII; ALAII; ALAOI; ALEII; ALEOI; ALIOI, ALIRI

ASB 501 04 to ASB 501 04 BL; CF; CT; DU; FC; FI; FT; HI; LA; LS; MH; OS; PC; PT; RF; SA; SD; SF; SG; SN; ST; SU; TM and TR command groups

CATII; CAPII

CNLDI; CNHUI; CNBRI

CLTGI; EDFTI; IOPWC; ICUPI; SCREI

ALREI; ALSII; ALAII; ALAOI; ALIRI

GSBLI; GSFTI; GSRFI

GJALI; GJBLI; GJOI; GJFTI; GJREI; GJRFI; GJSLI

NCCTI; NCGTI

BC9 to BC10 Systems using the Bellcore ISDN protocol and Dual Access extensions will have to manually set ACCTYP = 2 for command KSEXI.

BC5, BC6, BC7, BC8, BC9, or The parameter SUPER is defaulted in BC10 for

# Capacity_and_Limitations$Capacity and LimitationsKCapacity and Limitations;Command;Exception;Exclusions;Supported OptionsAIntro+Group0000:0006 > main

BC10 to BC10 command IOFDC due to a functionality change because of the NIU board.

BC9 or BC10 to BC10 NCTGI must be converted manually as NCGSP does not support printing of all ANCD groups.

BC10 to BC10 IOUAI will regenerate the user accounts, but passwords cannot be printed. As a result, passwords must be entered manually into the IOUAI file. IOUAI is not included in REGENCMD.BAT for this reason.

BC10 to BC10 PEALC is not supported. There is no command to print the users current active list. The users must reselect which list should be the active one.

BC 8 or BC9 to BC10 CSTA must be manually converted from BC8/9 to BC10. In BC8/9, TAU-D's were used with CSTA. In BC10, the NIU is used instead.

BC11 to BC12 DBC223 terminals (D4 family) in the BC11 exchange connected to ELU28/3 board will be regenerated correctly. Operator has to configure the terminals connected to other boards manually.

Note:

KSTSC is regenerated only when regenerating from and to the same release version, for example, from ASB 501 04 R2/4 to ASB 501 04 R2/4.

Optional parameters not included in the printout file will not be regenerated; however, mandatory parameters not included in the printout file will be regenerated using default values.

# $ K DowngradeThe process of moving from one level of functionality to a lower level of functionality.

Example: Moving from release ASB 501 04 R4 to ASB 501 04 02 is an example of a software downgrade.

Note: PC-Regen does not support software downgrades.

# Downgrade$DowngradeKDowngrade

# $ K A + > PC-Regen Main WindowThe main window consists of a menu bar, the System Configuration region and the Run region. {bmc pc-r0000.BMP} The System Configuration region contains the following controls:

Source Name – Catalogue folder for a MD110 switch. For every switch user can create a separate source name.

Source path – The directory to which the log files containing the MD110 source database are written during the data generation phase.

Target path – The directory to which PC-Regen writes the initiation files containing the converted MD110 database during the regeneration phase.

System type – The type of system; MD110 Standard Exchange or MD110 Centrex Version Source system – The software release currently installed on the MD110 system. Target system – The software upgrade being installed on the MD110 system.

The Run region contains the following buttons:

Data Gen – Click this button to start the generation of print commands Regeneration – Click this button to start the regeneration of the MD110 database Lic Calculation – Click this button to start license calculation. This is only applicable when

upgrading to the BC10 release or later.

# Using_PC_Regen$PC-Regen main windowKHow do I Use PC-Regen?;Main Window;MD110 Centrex Version;MD110 Standard Exchange;Operation Instructions;PC-Regen dialog box;PC-Regen Main Window;Source System;System Configuration;System Type;Target System;Using PC-RegenAIntro+Group0001:0000 > main

# $ K + > Configuring PC-RegenTo set the application configuration, perform the following steps:1 Click the … button adjacent to Source Name to select the source name from the Source

Name Dialog. All other controls on window, corresponding to this source name, will be filled in with the corresponding values. In case these are blank, user can fill the values as described below.

2 Enter the source directory or click the … button to browse existing directories. Click New Folder while browsing to create a new subdirectory within the selected directory.

3 Enter the target directory or click the … button to browse existing directories. Click New Folder while browsing to create a new subdirectory within the selected directory.

4 Select the system type from the pull down menu.5 Select the source system from the pull down menu. 6 Select the target system from the pull down menu. 7 Clicking on Data Gen or Regeneration or Lic Calculation button or selecting Data

Generation or Regeneration or License Calculation from Run Menu, will save the configuration of the source name.

Note: PC-Regen saves the configuration settings and the last source name worked with, and uses them as defaults the next time you run PC-Regen.

# Configuring_PC_Regen$Configuring PC-RegenKApplication configuration;Configuring PC-Regen;PC-Regen Setup;Set the Application Configuration;Setting Up PC-Regen+Group0001:0003 > second

# $ K FIOLFIOL is a command-handling tool used for communication with the MD110. If you select this option during configuration, PC-Regen generates initiation files with the /@EXECUTED/ batch command at the end of the first line, even for command lines that wrap to another line.

Example:

KSEXI:DIR=66603,EQU=3-3-20-05,ITYPE=12,TRAF=00040401,SERV=00021201,@/EXECUTED/

CDIV=0011510000,ROC=-23001,CALALT=1,TRM=0,ADC=00100013010,LAND=F;

# FIOL$FIOLKFIOL

# $ K WinFIOLWinFIOL, an updated version of FIOL, is a command-handling tool used for communication with the MD110. If you select this option during configuration, PC-Regen generates initiation files with the /@EXECUTED/ batch command at the end of the entire command. WinFIOL is selected by default.

Example:

KSEXI:DIR=66603,EQU=3-3-20-05,ITYPE=12,TRAF=00040401,SERV=00021201,

CDIV=0011510000,ROC=-23001,CALALT=1,TRM=0,ADC=00100013010,LAND=F;@/EXECUTED/

# WinFIOL$WinFIOLKWinFIOL

# $ K ASB FormatSome users prefer to view the MD110 software levels using ASB names, such as ASB 501 04 R2/4.

# ASB_Format$ASB FormatKASB format

# $ K BC FormatSome users prefer to view the MD110 software levels using BC names, such as BC 10 or BC 12.

# BC_Format$BC FormatKBC format

# $ K Source DirectoryThe source directory is where the log files containing the current MD110 database are written during the data generation phase.

# Source_Directory$Source DirectoryKSource Directory

# $ K Target DirectoryThe target directory is where PC-Regen writes the initiation files containing the converted MD110 database during the regeneration phase.

# Target_Directory$Target DirectoryKTarget Directory

# $ K Source SystemThe software release currently installed on the MD110 system.

# Source_System$Source SystemKSource System

# $ K Target SystemThe software upgrade being installed on the MD110 system.

# Target_System$Target SystemKTarget System

# $ K + > Creating a DATA.CMD batch fileTo create a DATA.CMD batch file, perform the following:1 Click the Data Gen button. The Generate Print Commands window opens.2 Click Start to begin generating the DATA.CMD batch file. The DATA.CMD region of the

window displays the application’s progress.3 Note any errors in the Error region of the window.

For information on resolving errors, see Troubleshooting. 4 Click Done to return to the PC-Regen main dialog box.

# How_to_perform_data_generation$Creating a DATA.CMD batch fileKBatch File;Create a DATA.CMD batch file;Creating;Creating:DATA.CMD batch file;Data generation;DATA.CMD batch file;Generating;Generating:DATA.CMD batch file;Perform data:generation+Group0001:0004 > second

# $ K + Analyzing script syntaxTo analyze the syntax of a script file, perform the following:1 From the Run menu, select Analyze Syntax.2 Click Start to begin the syntax analysis. The Analyze Syntax window displays the number of

lines checked and errors encountered. 3 For instructions on viewing the error log file, refer to Troubleshooting. 4 Click Done to return to the PC-Regen main dialog box.

# Analyze_script_syntax$Analyze script syntaxKAnalyze script syntax;Syntax+Group0002:0001

# $ K + Performing database regenerationTo regenerate the database, perform the following steps:1 Click the Regeneration button.2 Click Start to begin the regeneration process. 3 The Summary region of the window displays the application progress. 4 The regeneration program can be aborted at any time by clicking Stop. 5 Click Done to return to the PC-Regen main dialog box.

# How_to_perform_database_regeneration$Performing database regenerationKData regeneration;Perform data:regeneration;Regeneration+Group0001:0005

# $ K > Regeneration windowThe regeneration window contains the following information:

FileName of the output file being created by the regeneration process. PC-Regen creates one or more output files that can be transmitted to the MD110 using the REGENCMD.BAT batch file.

Elapsed timeLength of time it has taken to regenerate the MD110 system database.

Lines generatedRunning total of command lines being written to output files during the regeneration process.

LIMs in system Number of LIMs in the MD110 system.

Analog extensionsNumber of analog extensions regenerated.

Digital extensionsNumber of digital extensions regenerated.

Data extensionsNumber of data extensions regenerated.

Auxiliary extensionsNumber of auxiliary extensions regenerated.

ADNsThe number of additional directory numbers regenerated.

MDNsThe number of multiple directory numbers regenerated.

Trunk individualsNumber of individual trunks regenerated.

Syntax errorsNumber of syntax errors encountered while running the script file.

# Regeneration_window$Regeneration windowKADNs;LIMs;REGENCMD.BAT;Regeneration;Regeneration Window> main

# $ K + Regeneration did not create the expected commandsPC-Regen does not regenerate certain commands and command groups for given upgrades. See Capacity and Limitations for a complete list.

Open the error.log file in Notepad or another text editor to see a list of errors encountered during regeneration.

Note: The error.log file is located under the PC-Regen root directory.

# Commands_Not_Regenerated$Commands Not RegeneratedKCommand;Command groups;Commands Not Regenerated;Error Messages+Group0003:0003

# $ K + Init directory is not emptyError Message:The directory containing initiation commands is not empty. Matching command files will be overwritten.

A previous regeneration populated the target directory with initiation commands. To overwrite the previous regeneration commands, click OK. Otherwise, click Cancel and specify a different Target Path.

See Configuring PC-Regen.

# Init_Directory_Not_Empty$Init Directory Not EmptyKError Messages;Init Directory Not Empty;Target Directory+Group0003:0000

# $ K + The script contains errorsIf the syntax analysis revealed an error in a script file, refer to About Script Language for more information on the PC-Regen script language.

# Script_Has_Error$Script Has ErrorKError Messages;Script contains errors;Syntax+Group0003:0004

# $ K + The script file was not foundError Message:Script file xxxx not found.

Make sure that the SCRIPT directory is located directly beneath the PC-Regen application directory. If you continue to have this problem, your script files may be missing or corrupt. Re-install PC-Regen, accepting the default file locations when prompted.

# Script_Not_Found$Script Not FoundKError Messages;Script file;Script Not Found+Group0003:0005

# $ K + Invalid source pathError Message:The specified Source Path does not exist. Do you want to create a new directory?

The directory entered as the source path is invalid or does not exist. Click OK to create the specified directory. Click Cancel to exit the message box and enter a new directory.

# Source_Path_Not_Specified$Source Path Not SpecifiedKError Messages;Invalid source path;Source Path Not Specified+Group0003:0001

# $ K + Invalid target pathError Message:The specified Target Path does not exist.Do you want to create a new directory?

The directory entered as the target directory is invalid or does not exist. Click OK to create the specified directory. Click Cancel to exit the message box and enter a new directory.

# Target_Path_Not_Specified$Target Path Not SpecifiedKError Messages;Invalid target path;Target Directory;Target Path;Target Path Not Specified+Group0003:0002

# $ K > Glossary of Technical Terms{bmc pc-r0001.BMP} {bmc pc-r0002.BMP} {bmc pc-r0003.BMP} {bmc pc-r0004.BMP} {bmc pc-r0005.BMP} {bmc pc-r0006.BMP} {bmc pc-r0007.BMP} {bmc pc-r0008.BMP} {bmc pc-r0009.BMP} {bmc pc-r0010.BMP} {bmc pc-r0011.BMP} {bmc pc-r0012.BMP} {bmc pc-r0013.BMP} {bmc pc-r0014.BMP} {bmc pc-r0015.BMP} {bmc pc-r0016.BMP} {bmc pc-r0017.BMP} {bmc pc-r0018.BMP} {bmc pc-r0019.BMP} {bmc pc-r0020.BMP} {bmc pc-r0021.BMP} {bmc pc-r0022.BMP} {bmc pc-r0023.BMP} {bmc pc-r0024.BMP} {bmc pc-r0025.BMP} {bmc pc-r0026.BMP}

# A

ASB Format

# B

BC Format

# C

# D

Database Regeneration

DATA.CMD

Declaration Subsection

Downgrade

# Index$Glossary of Technical TermsKGlossary;Index;Technical Terms> main# A_INDEX# B_INDEX# YQ7PSV# BY76EB8

# E

End Subsection

Execution Subsection

# F

FIOL

G

H

I# # Identifiers

Initiation File

J

K# Keywords

L

M

# A0_1G0N# HMQS51# VDESHL# G1XTDW# EA4UTR

N#

O#

# P# # PC-Regen

Print File

Punctuators

Q

R# Regeneration

S# SAM

Script Analysis

Script Comments

Script File

Setup Subsection

Source Directory

# AC60KRZ# QFZWM_# B4BXIH# OV6Y28# B22TN45# D22TN45# E22TN45

Source System

Start Subsection

System Type

T# Target Directory

Target System

U# Upgrade

V

# W# Whitespace

WinFIOL

X

Y

# Z

# AYQ7PSV# JXL26T# A0W2RLA# AHMQS51# AVDESHL

# $ DATA.CMDThe DATA.CMD batch file is created during the Data Generation process and stored in the PC-Regen root directory, or in the directory specified in Default Paths in the Settings dialog. This file contains the print commands that are transmitted to the MD110 exchange to extract the data prior to a software upgrade.

# DATA.CMD$DATA.CMD

# $ K Database RegenerationDatabase regeneration is the process of converting and rebuilding an MD110 system database after upgrade software has been installed. When complete, this process yields a set of database files that contain the initiation command required to duplicate the original system.

# Database_Regeneration$Database RegenerationKData regeneration;Perform data:regeneration;Regeneration

# $ Initiation FileThe Initiation File created by the Regeneration process is called REGENCMD.BAT and is located in the target directory.

# Initiation_File$Initiation File

# $ Print FileThe Print File created by the Data Generation process is called DATA.CMD and is located in the application root directory or in the directory specified in Default Paths in the Settings dialog.

# Print_File$Print File

# $ RegenerationSee Database Regeneration.

# Regeneration$Regeneration

# $ SAMService Assistant Manager. SAM is a set of PC-based applications designed to facilitate and automate many of the maintenance activities required to provide service to MD110 customers.

# SAM$SAM

# $ PC-RegenPC-Regen is an off-line, Windows-based application that automates database generation and conversion when upgrading within and between MD110 software releases. Additionally, PC-Regen can be used to create an emergency backup database

# PC-Regen$PC-Regen

# $ Script FileThe pre-written script files shipped with PC-Regen enable the regeneration process to generate the target database based on the specified source and target release versions.

# Script_File$Script File

# $ Script AnalysisThe script analysis process checks the script for any errors that may cause the data generation or regeneration processes to terminate.

# Script_Analysis$Script Analysis

# $ Script CommentsComments are text added to the script file to explain or define the script functions. The number sign character (#) indicates the start of a comment. PC-Regen ignores the text from the comment character to the end of the line.

# Script_Comments_1$Script Comments

# $ WhitespacePC-Regen recognizes whitespace as blanks, tabs, and new line characters. Whitespace indicates the start and end of a token, which could be a keyword, an identifier, an operator, or a punctuator.

# Whitespace_1$Whitespace

# $ K A + > About script language

The PC-Regen regeneration program processes a script file and creates files to generate system commands with correct parameters. The script file is written according to predefined rules, syntax, and language. Script language consists of keywords, identifiers, and punctuators (or separators). For a defined list of punctuators, see Script Language Elements.

Writing a script file is similar to writing a program, but scripts are written at a higher level of detail than a traditional program. PC-Regen scripts indicate which commands and parameters need to be regenerated, the log files where the source database resides, and the methods to use to regenerate the commands.

Scripts include commands that enable parameter mapping and logic checking, which are required for some commands.

# About_Script_Language$About script languageKAbout Script Language;Punctuators;Script Language Overview;Syntax;What is Script Language?AScript files+Group0004:0000 > main

# $ KeywordsKeywords are reserved words that are used exclusively by PC-Regen. Keywords must not be used for other purposes, such as naming identifiers. Keywords are case-sensitive, which means that PC-Regen recognizes store as a keyword, while Store is recognized as an identifier.

# Keywords$Keywords

# $ K IdentifiersIdentifies are user-defined names for variables or pre-defined constant names used for certain commands. Identifiers can consist of letters, numbers, the underscore (_), forward slash (/), or the point (.) character.

# Identifiers$IdentifiersKConstant Names;Identifiers

# $ PunctuatorsSpecial characters used in conjunction with keywords and identifiers.

# Punctuators$Punctuators

# $ K A + > Script file structure

PC-Regen regenerates 80 or more commands for each particular source/destination release. The instructions the program uses to generate these commands are included in one script.

A script is divided into sections. Each section of a script begins with the keyword START and ends with the keyword END. A script contains five subsections, in which only specific script commands can be used.

The graphic below summarizes the valid transitions from one subsection to the next. Click within the graphic for more information on a specific subsection.

{bmc pc-r0027.SHG}

# Script_File_Structure$Script file structureKScript File StructureAScript files+Group0004:0001 > main

# $ K Start SubsectionIndicates the beginning of a new section. START is the only keyword allowed in this section.

# Start_Subsection$Start SubsectionKStart Subsection

# $ K Declaration SubsectionDescribes the printouts from which the source database can be retrieved, indicates the name of the command file to be created, which stores the regenerated commands, and includes the command name, the command parameters and their attributes (mandatory or optional), and the printout format (horizontal, vertical, mixed).

# Declaration_Subsection$Declaration SubsectionKDeclaration Subsection

# $ Setup SubsectionDepending on the printout format specified in the Declaration subsection, this subsection consists of commands that instruct PC-Regen to begin parsing the printout(s) to the point where valid data is located in the file.

# Setup_Subsection$Setup Subsection

# $ K Execution SubsectionThis is the subsection where the program obtains data and generates commands. Depending on the command type, the execution subsection may include the following:

Commands that map the data from the source system to the destination system Logic commands to determine the validity of the data.

# Execution_Subsection$Execution SubsectionKExecution Subsection

# $ K End SubsectionIndicates the end of a section. END is the only keyword allowed in this section.

# End_Subsection$End SubsectionKEnd Subsection

# $ K A + > Sample script fileThe following illustrates a sample script file. Click within the graphic for more information on a specific section.{bmc pc-r0028.SHG}

# Sample_Script_File$Sample script fileKExample Script;Sample Script File;Script ExampleAScript files+Group0004:0004 > main

# $ > startThe START keyword indicates the beginning of the command.

# start_keyword$start> second

# $ K declare commandfile: The name of the command file that contains the regenerated initiation

commands. source: Printout from which the source database can be retrieved. printformat: Printout will be formatted in a vertical page orientation. printfile: This command is employed only when selecting ‘Print Commands’ options to

generate print commands. command: Indicates the name of the generated command, ROVNI in this example. mand_parameter: Command ROVNI has mandatory parameters ROU and VAC.

# declare$declareKDeclare

# $ setup getlineuntil_else_exit: This command causes the program to continue reading in lines from

the file printout until a stringpattern is found. If one is not found, the program moves to the next section of the script file.

rewind: This command causes the program to set the file position of the file printout to the beginning.

key: Printout ROVNP has a header that includes ROU and VAC parameters. The program searches for this header from printout ROVNP based on the key string pattern "ROU". Using this header, the program needs to calculate the column positions from which data related to ROU and VAC can be retrieved. The program stores this information in its internal data structure.

# setup$setup

# $ K > execute getline: Read a line from the printout ROVNP checkprintline: If the line just obtained is empty or contains "WAIT", "<" or "/*", continue

getting the next line from the printout ROVNP until a valid line is found. getparmvalue: with a valid data line, the program retrieves data for ROU and VAC. sendcommand: Build the command ROVNI with its parameters and write it to command file

ROVNI.

# execute$executeKExecute> second

# $ > endThe END keyword indicates the end of the command.

# end$end> second

# $ K A + > Script language elementsThe script language consists of several elements.

Notation conventions Script keywords Whitespace Script comments Script identifiers Script operators Script punctuators

# Script_Language_Elements$Script language elementsKScript Language ElementsAScript files+Group0004:0002 > main

# $ K A > Notation conventions

The following table defines script notation conventions:

Convention Definition

Bold text Bold face type indicates text that must be entered exactly as shown in the script. Keywords, punctuators, and operators are printed in bold.

Italic text Italic type indicates identifiers.

[Brackets] Single square brackets enclose optional items.

# Notation_conventions$Notation conventionsKIdentifiers;Keywords;Notation Conventions;PunctuatorsAScript language> second

# $ K A > Whitespace

PC-Regen recognizes whitespace as blanks, tabs, and new line characters. Whitespace indicates the start and end of a token, which could be a keyword, an identifier, an operator, or a punctuator.

# Whitespace$WhitespaceKWhitespaceAScript language> second

# $ K A > Script comments

Comments are text added to the script file to explain or define the script functions. The number sign character (#) indicates the start of a comment. PC-Regen ignores the text from the comment character to the end of the line.

# Script_comments$Script commentsKScript CommentsAScript language> second

# $ K A > Script identifiers

Identifies are user-defined names for variables or pre-defined constant names used for certain commands. Identifiers can consist of letters, numbers, the underscore (_), forward slash (/), or the point (.) character. Identifiers are case-sensitive, so VAR1 is different than var1.

# Script_identifiers$Script identifiersKConstant Names;Identifiers;Script IdentifiersAScript language> second

# $ K A > Script operators

Operators are used in computational comparison. The following table defines script operators:

Operator Definition

>= Greater than or equal to

<= Less than or equal to

> Greater than

< Less than

= Equal to

!= Not Equal to

and Logical and (used only with if commands)

or Logical or (used only with if commands)

# Script_operators$Script operatorsKScript OperatorsAScript language> second

# $ K A > Script punctuators

Punctuators are special characters that are used with keywords or identifiers. The following table defines script punctuators:

Punctuator Definition

( ) Parentheses group expresses in the if/elseif/else statements. They are also used to group common items in commands. Example:

if (CON_TEMP = "CON")

printfile NADAP(NADAP)

[ ] Single square brackets indicate character array subscripts. Example:

store CDIV_TEMP[1] in @CDIV[1]

, The comma separates the list items after some commands. Example:

source KSMDP, KSCAP

- The hyphen is used specifically for the command range. Example:

range 0-&TEMP2

& The ampersand is used specifically for commands range and printfile. Example:

range 0-&TEMP2

printfile GDNDP(GDNDP;GRP=1&&99)

" Double quotes enclose character strings. Example:

key "SQU" ROEDP

: The colon is used specifically for commands printfile, mand_parameter and opt_parameter. Example:

printfile GDNDP(GDNDP;GRP=1&&99)

mand_parameter ROU:ROEDP, TRU:ROEDP, EQU:ROEDP

@ The at-sign character is used to distinguish between a parameter and an identifier, which could be a variable name. If the atsign character (@) is placed in front of an identifier, the program interprets that identifier as a parameter. Example:

@DIR

# Script_punctuators$Script punctuatorsKPunctuators;Script PunctuatorsAScript language> second

# $ K A + > Script keywords reference{bmc pc-r0001.BMP} {bmc pc-r0002.BMP} {bmc pc-r0003.BMP} {bmc pc-r0004.BMP} {bmc pc-r0005.BMP} {bmc pc-r0006.BMP} {bmc pc-r0007.BMP} {bmc pc-r0008.BMP} {bmc pc-r0009.BMP} {bmc pc-r0010.BMP} {bmc pc-r0011.BMP} {bmc pc-r0012.BMP} {bmc pc-r0013.BMP} {bmc pc-r0014.BMP} {bmc pc-r0015.BMP} {bmc pc-r0016.BMP} {bmc pc-r0017.BMP} {bmc pc-r0018.BMP} {bmc pc-r0019.BMP} {bmc pc-r0020.BMP} {bmc pc-r0021.BMP} {bmc pc-r0022.BMP} {bmc pc-r0023.BMP} {bmc pc-r0024.BMP} {bmc pc-r0025.BMP} {bmc pc-r0026.BMP}

# A

add_value

appendafter_each_char

alter_param

# B

build_dntr_table

build_fileoffset_tbl

# C

checkprintline

clear

clearall

combinefile

combinefromtoken

command

commandbatch

commandfile

convert_hex

convert_to cclval

# Script_Keywords_Reference$Script keywords referenceKScript Keywords ReferenceAScript files+Group0004:0003 > main# SGTJHV# A4IYHCU# C559OX1

convert_to_date

convert_to_min

count

counter

# D

deletefile

# E

else

elseif

END

endif

exception

F# fileoffset_tbl

filter_ADN

filter_FCN

find_sendcommand

findall_sendcommand

format_equ

format_key

format_trunk

G# get_lastchar

get_length

get_tcd_entry

getbpos_from_equ

# P75041# O1GBX3# MML9P# CMS8GSI

getcoltokenumber

getfrom

getlim_from_equ

getline

getline_else_logerr

getlineuntil

getlineuntil_else_exit

getmag_from_equ

getname

getokenumber

getparmvalue

getprintline

getprintline_else_logerr

getstring

getstringtoend

gotoloop

# H

I# if if_stringpattern

ignore

ignore_if_empty

in

incrementcounter

J

K

# KKS2C9# AIW8ZUH

# key

L# loop

M# mand_parameter

merge

mergefromtoken

mergewithspaces

N

O# opt_parameter

P# printfile

printformat

Q

R# range

remove_char

remove_leading_spaces

# AGL2AGL# G5EURA# EZX3KC# COQE_G# BJ8N6I# BO7HSEO

remove_trailing_spaces

replace

replace_char

rewind

S# search_for_param_in_file

seek_filpos

send_aftercmd

send_aftercmd_internal

sendcommand

sendcommand_comment

sendcommand_exit

send_command_sortby

sendcomment

set_printfile_pos_to_char

setdigit

setlimnumber

source

START

stop

stop_not_number

store

stringpattern

set_echo

T# token

U

# DOMSZYV# AZN60KC

V

W# # with

X

Y

# Z#

# Z7INV8# A045UJ9# AV7T2ZK# C9DS0WB

# $ K + add_value

Synopsis: The following cases are supported:

add_value @parameter NumbertoAdd Base add_value variable NumbertoAdd Base

Context: This keyword is used in the Declaration subsection.

Description:

This command adds the number to be added to the parameter or variable depending on the base and then stores the result in the same parameter or variable.

Example: add_value @KEY "5" "10"add_value @KEY "5" "16"add_value KEY_TEMP "5" "10"add_value KEY_TEMP "5" "16"

# add_value$add_valueKadd_value+Group0005:0000

# $ K > appendafter_each_char


appendafter_each_char @parameter "character" appendafter_each_char variable "character"

Context: This keyword is used in the Execution subsection.

Description:

This command appends the specified character after each character in the parameter or variable.

Example: appendafter_each_char @CLASS "&"

# appendafter_each_char$appendafter_each_charKAppendafter_each_char;Execution Subsection> second

# $ K > build_dntr_table

Synopsis: Build_dntr_table tablefile printfile @parameter


Description:

This command is used only when the source system is ASBU R4/1. Printouts EXCCP and DTCCP from ASBU R4/1 have parameters DTR and NTR, which need to be translated to TRAF parameter in ASB 501 04. The tablefile file is constructed using data from printout printfile. Data can be obtained under the header parameter.

Example: The following command constructs the file DNTR.TAB from printout EXCCP with data under the header DTR:

build_dntr_table DNTR.TAB EXCCP @DTR

# build_dntr_table$build_dntr_tableKBuild_dntr_table> second

# $ K > build_fileoffset_tbl

Synopsis: Build_fileoffset_tbl printout tablefile


Description:

This command constructs a fileoffset tablefile from the file printout. This table is a binary tree on a disk with each node having a directory number from files KSCAP or KSDDP as keys and the directory’s file position in KSCAP or KSDDP as the other field. With this information available on disk, print lines from KSCAP or KSDDP can be retrieved quickly.

Example: The following command constructs the file KSCAP.TBL from printout KSCAP:

build_fileoffset_tbl KSCAP KSCAP.TBL

# build_fileoffset_tbl$build_fileoffset_tblKBuild_fileoffset_tbl> second

# $ K > checkprintline


checkprintline USELESSLINE checkprintline TIMETOQUIT


Description:

USELESSLINE and TIMETOQUIT are constant names used after this keyword. Any other names are recognized as syntax errors.

If USELESSLINE is used, the program reads the printout line to check if it is empty or contains "WAIT", "<", or </"". If it does, the program reads the next line.

If TIMETOQUIT is used, the program reads the printout line to check if it contains "END", "NOT", "PARTLY", "COMMAND" or "FAULT INTERRUPT". If it does, the program stops generating commands for the current section and moves to the next section of the script.

Example: .loopcheckprintline USELESSLINEcheckprintline TIMETOQUIT. .

# checkprintline$checkprintlineKCheckprintline> second

# $ K > clear


clear @parameter clear variable


Description:

This command clears the content of parameter or variable.

Example: If the contents of the parameter CLASS is "1234", the following command makes the contents of CLASS to an empty string "":

clear @CLASS

# clear$clearKClear> second

# $ K > clearall

Synopsis: clearall [OPT_PARAMETER]Context: This keyword is used in the Execution subsection.

Description:

OPT_PARAMETER is the optional constant name used after this keyword. The program recognizes any other names as syntax errors.

If OPT_PARAMETER is used, all the contents of the optional parameters in the current section are set to an empty string. Otherwise, the contents of both mandatory and optional parameters are cleared.

Example: clearall OPT_PARAMETER

# clearall$clearallKClearall> second

# $ K > combinefile

Synopsis: combinefile file1 [file2,...]


Description:

The following command combines files NANSI1 and NANSI2 into one file named NUMANAL:

Example: START

commandfile NUMANAL

combinefile NANSI1,NANSI2

END

# combinefile$combinefileKCombinefile> second

# $ K > combinefromtoken


combinefromtoken printout startpos to endpos in variable combinefromtoken printout startpos combinefromtoken printout startpos to end in variable combinefromtoken printout startpos to end in @parameter


Description:

This command concatenates all tokens from token startpos to token endpos from the line obtained in printout. If the keyword end is specified, the program concatenates all tokens from token startpos until the end of the line. The result is stored in variable or parameter.

Example: Concatenate all tokens starting from token number 2 and store in parameter POS. The tokens are from the current line obtained from file NADAP:

combinefromtoken NADAP 2 to end in @POS

# combinefromtoken$combinefromtokenKCombinefromtoken> second

# $ K > command

Synopsis: command commandname


Description:

This command specifies the command name as part of the initiation command to be generated.

Example: The following command generate the command KSEXI:

command KSEXI

# command$commandKCommand> second

# $ K > commandbatch

Synopsis: commandbatchContext: This keyword is used in the Declaration subsection.

Description:

This command indicates that if valid commands have been generated, then the program should insert the line "commandfile" in the file REGENCMD.BAT. The commandfile stores generated initiation commands.

The purpose of REGENCMD.BAT is to record the order in which the initiation commands have been generated. When upgrading the destination system, the user can examine the contents of REGENCMD.BAT to find out the order initiation command files were send to the system.

Note: The commandfile must be specified for every section by using the command commandfile.

Example: commandbatch

# commandbatch$commandbatchKCommandbatch> second

# $ K > commandfile

Synopsis: commandfile commandfilename


Description:

This command specifies the command file that stores generated initiation commands.

Example: commandfile KSEXI

# commandfile$commandfileKCommandfile> second

# $ K > convert_hex


convert_hex @parameter1 in @parameter2[index] convert_hex @parameter in variable[index] convert_hex variable1 in variable2[index] convert_hex variable in @parameter[index]


Description:

This command converts the value stored in a variable or parameter to a hex value, and then stores the result to another variable or parameter at an index value.

Example: The following command converts the value stored in TEMP to hex and then stores the result in the fourth character position of parameter ICAT:

convert_hex TEMP in @ICAT4

# convert_hex$convert_hexKConvert_hex> second

# $ K > convert_to cclval


convert_to_cclval @parameter convert_to_cclval variable


Description:

This command converts the value stored in a variable or parameter to a synchronization control value, and then stores the result back to the same variable or parameter.

Example: .gettokennumber GSMULT.PRT 11 in TEMPconvert_to_cclval TEMP

if (TEMP[1]!="F") store TEMP in @MCCLendif.

# convert_to_cclval$convert_to cclvalKConvert_to cclval> second

# $ K > convert_to_date


convert_to_date @parameter convert_to_date variable


Description:

This command converts a string value stored in variable or parameter to string format yy-mm-dd. The string must have the following format: 21DEC90.

Example: If @DATE originally stored 21DEC90, the converted @ DATE will store 1990-12-21 using this command:

convert_to_date @DATE

# convert_to_date$convert_to_dateKConvert_to_date> second

# $ K > convert_to_min


convert_to_min @parameter convert_to_min variable


Description:

This command converts the string value stored in variable or parameter to minutes. The string must have the format HH:MM (e.g., 01:00), where HH represents hours and MM represents minutes. The result is stored back to the same variable or parameter.

Example: If @INT originally stores the value 01:00, the converted value stored in @INT will be 60 using this command:

convert_to_min @INT

# convert_to_min$convert_to_minKConvert_to_min> second

# $ K > count

Synopsis: count constname

where constname is one of the following constant identifiers:

ANA_EXT DATA_EXT TRUNK AUX_EXT ADN OPI DIG_EXT MDN


Description:

This command requests the program to count data, such as analog extensions and digital extensions. The constant names indicate what kind of data to count.

Constant Name System Data

ANA_EXT Analog extension

AUX_EXT Auxiliary extension

DIG_EXT Digital extension

ADN Additional Directory Number

MDN Multiple Directory Number

TRUNK Trunk individual

OPI PABX operator

Example: count AUX_EXT

# count$countKCount> second

# $ K > counter

Synopsis: counter startingcountervalue


Description:

The program maintains an internal variable that stores a counter value. The counter command sets the internal counter to a value equal to startingcountervalue. Counter has a valid range of 0 to 32767.

Example: ..counter 1loop

ignore IOEQP "1-0-23-01"gettokenumber IOEQP in TEMPstore TEMP in @EQU

merge "SYSTEMINAL" counter in @IODEVincrementcounter..

# counter$counterKCounter> second

# $ K > deletefile

Synopsis: deletefile file1[,file2,…]


Description:

This command deletes file(s).

Example: The following commands delete files NANSI1 and NANSI2 after they have been combined into one file named NUMANAL.

STARTcommandfile NUMANALcombinefile NANSI1, NANSI2deletefile NANSI1,NANSI2END

# deletefile$deletefileKDeletefile> second

# $ K > elsePlease refer to the if command.

# else$elseKElse> second

# $ K > elseifPlease refer to the if command.

# elseif$elseifKElseif> second

# $ K > END

Synopsis: ENDContext: This keyword is used in the END subsection.

Description:

The END keyword indicates the end of a section that includes the commands to generate the destination database. If the loop keyword is used in this section, the program returns to the line that contains loop to read the next line from the printout. Otherwise, the program goes to the next section.

Example: START... END

# END_2$ENDKEND keyword> second

# $ K > endifPlease refer to the if command.

# endif$endifKEndif> second

# $ K > exception

Synopsis: exception command


Description:

Since the format of the printout for command OPCGP is too difficult for the interpreter to handle, the command OPCGS is hard-coded with this command. The program recognizes only the command name OPCGS after the keyword exception. Any other name results in a syntax error.

Example: exception OPCGS

# exception$exceptionKException> second

# $ K > fileoffset_tbl

Synopsis: fileoffset_tbl tablefile1[,tablefile2…]


Description:

This command declares a list of binary tree on disk files where the directory numbers and their corresponding file positions from file KSCAP and KSDDP are stored. If more than one file is specified, use the comma (,) as the separator.

Example: fileoffset_tbl KSCAP.TBL, KSDDP.TBL

# fileoffset_tbl$fileoffset_tblKFileoffset_tbl> second

# $ K > filter_ADN

Synopsis: filter_ADN sourcefile destinationfile


Description:

In generating the command KSANI, the program needs information from the printout obtained via print command KSFKP. However, much of the information in this printout is not related to ADN. This command filters ADN information to speed up regeneration. The filtered information is stored in destinationfile.

Example: The following command filters ADN information from printout KSFKP and stores the result in ADN.DAT:

filter_ADN KSFKP ADN.DAT

# filter_ADN$filter_ADNKFilter_ADN> second

# $ K > filter_FCN

Synopsis: filter_FCN sourcefile destinationfile


Description:

In generating the command KSFKC, the program needs information from the printout obtained from the print command KSFKP. However, much of the information in this printout is not related to FCN. This command filters the necessary information to speed up regeneration. The filtered information is stored in destinationfile.

Example: The following command filters FCN information from printout KSFKP and stores the result in KSFKP.DAT:

filter_FCN KSFKP KSFKP.DAT

# filter_FCN$filter_FCNKFilter_FCN> second

# $ K > find_sendcommand

Synopsis: find_sendcommand sourcefile "stringpattern" "command"


Description:

This command searches the current line obtained from the printout sourcefile for the string pattern stringpattern. If the program finds a matching string pattern, the command command is written to the command file.

Note: stringpattern and command must be enclosed by double quotes.

Example: The following command searches the current line from printout GSMULT.PRT for pattern "SIDE 1". If "SIDE 1" is found, the program writes command "GSDUI:GSSIDE=0,DUP=DOUBLE" to command file:

find_sendcommand GSMULT.PRT "SIDE 1""GSDUI:GSSIDE=0,DUP=DOUBLE;"

# find_sendcommand$find_sendcommandKFind_sendcommand> second

# $ K > findall_sendcommand

Synopsis: findall_sendcommand sourcefile "stringpattern" "command"


Description:

This command is similar to find_sendcommand except that the program searches the entire printout file for the string pattern. If the string pattern is not found, the program moves to the next section of the script.

Example: The following command searches all lines from printout GSMULT.PRT for pattern "SIDE 1". If "SIDE 1" is found, it writes command "GSDUI:GSSIDE=0,DUP=DOUBLE" to command file:

findall_sendcommand GSMULT.PRT "SIDE 1""GSDUI:GSSIDE=0,DUP=DOUBLE;"

# findall_sendcommand$findall_sendcommandKFindall_sendcommand> second

# $ K > format_equ


format_equ @parameter format_equ variable


Description:

This command removes unnecessary characters stored in parameter or variable, which stores equipment position values.

Example: If EQU originally stores "001-1-10-1", the following command converts it to "1-1-10-1":

format_equ @EQU

# format_equ$format_equKFormat_equ> second

# $ K > format_key


format_key @parameter format_key variable


Description:

This command removes unnecessary characters stored in parameter or variable, which stores digital extensions’ key values.

Example: If KEY originally stores "A01, the following command converts the value to "A1":

format_key @KEY

# format_key$format_keyKFormat_key> second

# $ K > format_trunk


format_trunk @parameter format_trunk variable


Description:

The command removes unnecessary characters stored in parameter or variable, which stores trunk individuals’ values.

Example: If TRU originally stores "001-1", the following command converts the value to "1-1":

format_trunk @TRU

# format_trunk$format_trunkKFormat_trunk> second

# $ K > get_lastchar


get_lastchar @parameter in variable get_lastchar variable1 in variable2


Description:

This command retrieves the last character of the string stored in parameter or variable and then stores the result in another variable or the same variable.

Example: If variable EQU_TEMP stores "1-1-30-0", LCHAR will store "0" following this command:

get_lastchar EQU_TEMP in LCHAR

# get_lastchar$get_lastcharKGet_lastchar> second

# $ K > get_length


get_length @parameter in variable get_length variable1 in variable2


Description:

This command calculates the string length of the contents stored in parameter or variable and stores the result in another variable or the same variable.

Example: If variable QUE_TEMP stores "15", QUE_LEN will store "2" following this command:

get_length QUE_TEMP in QUE_LEN

# get_length$get_lengthKGet_length> second

# $ K > get_tcd_entry


get_tcd_entry tablefile @parameter in variable get_tcd_entry tablefile variable in variable2


Description:

This command is used only for the source system, ASBU R4/1. The program searches the file tablefile for the matching value stored in parameter or variable. The result is stored in another variable, which is used in the translation of the TRAF parameter in ASB 501 04.

Example: The following command searches the file DNTR.TAB for the matching value stored in NTR_TEMP and then assigns a value based on the result to the variable TCD_NIGHT:

get_tcd_entry DNTR.TAB NTR_TEMP in TCD_NIGHT

# get_tcd_entry$get_tcd_entryKGet_tcd_entry> second

# $ K > getbpos_from_equ


getbpos_from _equ @parameter in variable getbpos_from_equ variable in variable


Description:

This command extracts the board position from the equipment and stores the result in a variable.

Example: If the contents of EQU are "1-1-20-2", BOARD_POS will store "20" after the following command is executed:

get_bpos_from_equ EQU in BOARD_POS

# getbpos_from_equ$getbpos_from_equKGetbpos_from_equ> second

# $ K > getcoltokenumber

Synopsis: getcoltokenumber printout tokenumber in variable


Description:

This command reads the position of the first character of the specified tokenumber from the line obtained from the printout and stores the result in variable.

Example: The following command gets the column position of token number 1 from the current line obtained from printout CBDAP, and then stores the result in variable TEMP:

getcoltokenumber CBDAP 1 in TEMP

# getcoltokenumber$getcoltokenumberKGetcoltokenumber> second

# $ K > getfrom


getfrom startposition to endposition in variable getfrom startposition to endposition in @parameter getfrom startposition to end in variable getfrom startposition to end in @parameter


Description:

The program maintains an internal global variable. This command is used with the command get_parmvalue, which retrieves data from the printout and stores the result in this internal global variable, starting from startposition to endposition. If the keyword end is specified, all the data will be retrieved starting from startposition. The result is then stored in parameter.

Example: If the contents stored in the internal global variable are "H’00000006", the parameter VAR will store "00000006" after the following command is executed:

getfrom 3 to end @ VAR

# getfrom$getfromKGetfrom> second

# $ K > getlim_from_equ


getlim_from_equ @parameter in variable getlim_from_equ variable in variable2


Description:

This command extracts the LIM number from the equipment and stores the result in variable.

Example: If the contents of EQU are "5-1-20-2", then LIM_TEMP will store "5" after the following command is executed:

getlim_from_equ EQU in LIM_TEMP

# getlim_from_equ$getlim_from_equKGetlim_from_equ> second

# $ K > getline

Synopsis: getline printout


Description:

This command causes the program to read in a line from the file printout.

Example: getline NADAP

# getline$getlineKGetline> second

# $ K > getlineuntil

Synopsis: getlineuntil printout "stringpattern"


Description:

This command causes the program to continue reading lines from the file printout until a stringpattern is found.

Note: stringpattern must be enclosed in double quotes.

Example: getlineuntil DCSSP "CSSIDE"

# getlineuntil$getlineuntilKGetlineuntil> second

# $ K > getlineuntil_else_exit

Synopsis: getlineuntil_else_exit printout "stringpattern"

Context: This keyword is used in the Setup and Execution subsections.

Description:

This command causes the program to continue reading lines from the file printout until a stringpattern is found. If it does not find a matching stringpattern, the program moves to the next section of the script file.

Note: stringpattern must be enclosed between double quotes.

Example: getlineuntil_else_exit DCSSP "CSSIDE"

# getlineuntil_else_exit$getlineuntil_else_exitKGetlineuntil_else_exit> second

# $ K > getmag_from_equ


getmag_from_equ @parameter in variable getmag_from_equ variable in variable2


Description:

This command extracts the magazine number from the equipment and then stores the result in a variable.

Example: If the contents of EQU are "5-1-20-2", then MAG_TEMP will store "1" after the following command is executed:

getmag_from_equ EQU in MAG_TEMP

# getmag_from_equ$getmag_from_equKGetmag_from_equ> second

# $ K > getname

Synopsis: getname printout @parameter [in variable]


Description:

This command is used to retrieve the name identity assigned to the extension. The user can optionally specify the variable that stores the data. If the variable is omitted, the data is stored into the program’s internal global variable. Normally, the user specifies the variable so that data can be examined. In some cases it needs to be mapped to a different value.

Note: This command should be used for printouts with vertical formats only.

Example: The following is part of the printout NIINP:

.

.DIR NAME1 NAME21000 JOHN JR. DO..After the following command is executed, the variable TEMP stores "JOHN JR."

getname NIINP @NAME1 in TEMP

# getname$getnameKGetname> second

# $ K > getokenumber


getokenumber printout tokenumber in @parameter getokenumber printout tokenumber in variable


Description:

This command retrieves the specified tokenumber in the current line obtained from the file printout and stores the result in either a variable or parameter.

Example: If the current line in the printout GSMULT.PRT is as follows:

"EQU=1-0-00-0 GS-MULT 0-0 MCCL"Then the parameter GSMULT will store "0-0" after the following command is executed:

getokenumber GSMULT.PRT 5 in @GSMULT

# getokenumber$getokenumberKGetokenumber> second

# $ K > getparmvalue

Synopsis: getparmvalue printout @parameter [in variable]


Description:

This command causes the program to get the value of the specified parameter from the file printout. The user can optionally specify the variable that stores the data. If the variable is omitted, the data is stored in the program’s internal global variable. Normally the user specifies the variable so that data can be examined. In some cases, it needs to be mapped to a different value.


Example: The following is part of the printout ALULP:

.

.CLASS NOF1 20..

The variable TEMP stores "20" after the following command is executed:

getparmvalue ALULP @NOF in TEMP

# getparmvalue$getparmvalueKGetparmvalue> second

# $ K > getprintline


getprintline printout tokenumber @parameter getprintline printout tokenumber variable getprintline printout tokenumber "string"


Description:

This command causes the program to continue reading a line from the file printout and retrieve the token that corresponds to the tokenumber.

If, at the end of the printout, the program has not found a token equal to the content stored in parameter or variable or string, the program moves to the next section of the script file.

Example: The following is part of the printout KSCAP:

DIR TRAF SERV CDIV ROC ITYPE TRM ADC5008 00040401 00021107 00015 0230 1 0 0010000005011 00040401 00021107 00015 0230 1 0 001000000

If the current content of DIR is 5011, the following command will cause the program to search the KSCAP printout until it comes to the line that contains the token 5011 in parameter DIR:

getprintline KSCAP 1 @DIR

# getprintline$getprintlineKGetprintline> second

# $ K > getprintline_else_logerr


getprintline_else_logerr printout tokenumber @parameter in variable2 getprintline_else_logerr printout tokenumber variable in variable2 getprintline_else_logerr printout tokenumber "string" in variable2


Description:

This command causes the program to continue reading a line from the file printout and to get the token corresponding to the tokenumber.

If, at the end of the printout, the program has not found a token equal to the content stored in parameter or variable or string, the program writes an error message to the error log file and copies "0" to variable 2. If a match is found, "1" is copied to variable2.

Example: The following is part of printout KSCAP

DIR TRAF SERV CDIV ROC ITYPE TRM ADC5008 00040401 00021107 00015 0230 1 0 0010000005011 00040401 00021107 00015 0230 1 0 001000000

If the current content of DIR is 5011, the following command will cause the program to search the KSCAP printout until it comes to the line that contains the token 5011 in parameter DIR:

getprintline_else_logerr KSCAP 1 @DIR in FINDDIRif (FINDDIR!="1") rewind KSCAP gotoloopendif

# getprintline_else_logerr$getprintline_else_logerrKGetprintline_else_logerr> second

# $ K > getstring

Synopsis: getstring printout @parameter [in variable]


Description:

This command retrieves the value of the specified parameter enclosed between double quotes from the file printout. The user can optionally specify the variable that stores the data. If the variable is omitted, the data is stored in the program’s global internal variable. Normally, the user specifies the variable so that data can be examined. In some cases, it needs to be mapped to a different value.


Example: The following is part of the printout KSTSP:

.

STRNO STRING TIMFMT CHRVAL POSBSY1 "CALLBACK=6"..

After the following command is executed, the parameter STRING stores"CALLBACK=6"

getstring KSTSP @STRINGstore in @STRING

# getstring$getstringKGetstring> second

# $ K > gotoloop

Synopsis: gotoloopContext: This keyword is used in the Execution subsection.

Description:

This command returns to the line in the current section of the script file that contains the keyword loop.This command forces the program to skip the rest of the commands and read the next line from the printout.

Example: gotoloop

# gotoloop$gotoloopKGotoloop> second

# $ > if

Synopsis: if (statement)elseif (statement).else (statement).endif

Context: This keyword block is used in the Execution subsection.

Description:

The if/elseif/else/endif block is used to perform logical comparisons. The statement enclosed between parentheses is logical statement. If the statement is evaluated to a true condition, the commands immediately below the if are executed. Otherwise, the program searches for the next available elseif or else statements within the block. The endif command must terminate the block.

Nested if is supported. That means that within the if/elseif/else/endif block, there can be at least one other if/elseif/else/endif block.

Operators can be used in the statements.

Example: . if (USAGE != "-" and IODEV != "SYSTERMINAL")store IODEV in @IP/IODEV/SUBFSgetparmvalue IODDP @BPOS/EQUstore in @BPOS/EQUformat_equ @BPOS/EQUif (USAGE = "MML" or USAGE = "OUT")

store USAGE in @TYPE/USAGEif (USAGE = "MML") # AUTH is only used with MML ports

getparmvalue IODDP @AUTHstore in @AUTH

endifsendcommand

elseif (USAGE = "NETWORK/MML" or USAGE = "NETWORK/OUT")store "NETWORK" in @TYPEif (USAGE = "NETWORK/MML") # AUTH is only used with MML ports

store "MML" in @TYPE/USAGEgetparmvalue IODDP @AUTHstore in @AUTH

elsestore "OUT" in @TYPE/USAGE

endifsendcommand

# IF$if> second

endifendif

# $ K > if_stringpattern


if_stringpattern @parameter "stringpattern" in variable

if_stringpattern variable1 "stringpattern" in variable2


Description:

This command causes the program to check if there is a stringpattern in the parameter or variable. If there is a matching stringpattern, store "1" in variable (or variable2); otherwise, store "0".

Depending on the application, the user can then examine the value stored in variable (or variable2).

Example: ..getokenumber CLINP 1 IN ORIG_FROM

if (ORIG_FROM !="ALL")

if_stringpattern ORIG_FROM "-" in GOT_MULTI_ROU

if (GOT_MULTI_ROU = "0") gettokenumber CLINP 2 in ORIG_TO

if (ORIG_TO1="-")

remove_char ORIG_TO "-"..

# if_stringpattern$if_stringpatternKIf_stringpattern> second

# $ K > ignore

Synopsis: ignore printout "stringpattern"


Description:

This command checks if there is a stringpattern in the current line obtained from the file printout. If a matching stringpattern is found, the program returns to the line in the current section of the script file that contains the word loop. In other words, this command skips lines from the printout that contain the specified stringpattern.

Example: If the current line from the printout IOCAP has a string COMMAND, the program ignores that line and reads the next line when the following command is executed:

ignore IOCAP "COMMAND"

# ignore$ignoreKIgnore> second

# $ K > ignore_if_empty


ignore_if_empty @parameter ignore_if_empty variable


Description:

This command checks if the current content stored in parameter or variable is empty. If it is, the program returns to the line in the current section of the script that contains the keyword loop.

Example: ..getparmvalue KSDDP @EQUstore in @EQUignore_if_empty @EQUformat_equ @EQU..

# ignore_if_empty$ignore_if_emptyKIgnore_if_empty> second

# $ > in

Synopsis: store "string" in @parameter


Description:

The in keyword is used in conjunction with the keyword store .

Example: Store "32" in @GSM

# IN$in> second

# $ K > incrementcounter

Synopsis: incrementcounter [value]


Description:

If value is specified, this command causes the program to increment the value stored in the program’s internal counter variable by value. Otherwise, it increments by one (1).

Example: incrementcounter 2

# incrementcounter$incrementcounterKIncrementcounter> second

# $ K > key

Synopsis: key "stringpattern" printfile

Context: This keyword is used in the Setup subsection.

Description:

This command works differently depending on the printout format:

For horizontal print formats, the stringpattern indicates which line in the printfile contains the parameter value.

For vertical printout formats, the program searches the printfile for a line with the matching stringpattern. This line contains the parameter names.

The program parses this line to get the column positions of the parameters.

Note: Only one stringpattern per printfile per line is allowed. If required, use additional lines to specify remaining stringpatterns.

Example: key "EQU" GSMULT.PRT

# key$keyKKey> second

# $ K > loop

Synopsis: loopContext: This keyword is used in the Execution subsection.

Description:

This command causes the program to read lines from the printout(s). For printouts with horizontal format, the program continues reading lines until it reaches the string pattern specified in the key command.

Example: loop

# loop$loopKLoop> second

# $ K > mand_parameter


mand_parameter parameter1: printout [,parameter2:printout,…] mand_parameter parameter1: printout(,parameter2:printout,…),


Description:

This command lists the mandatory parameters required by the initiation commands. It is necessary to indicate the printout where the parameter values can be retrieved.

Syntax notes: Use the colon after the parameter name. While the first supported syntax case is most common, there are some instances where the parameter can be replaced by a number of other parameters. For example, the KSEXI command requires the CAT parameter from the KSDDP print file. If the CAT value is not found, parameters TRAF, SERV, CDIV, and ROC from the KSCAP print file can be used instead.

Example: mand_parameter DIR:KSDDP, EQU:KSDDP, ITYPE:KSCAPmand_parameter CAT:KSDDP(TRAF:KSCAP,SERV:KSCAP,CDIV:KSCAP, ROC:KSCAP)

# mand_parameter$mand_parameterKMand_parameter> second

# $ K > merge


merge "string1" [@parameter variable counter "string2"] in @parameter merge "string1" [@parameter variable counter "string2"] in variable


Description:

This command concatenates the contents from the source to the destination, which can be a variable or parameter. The source can be a combination of "strings", parameters, variables, and counter.

Example: If the counter stores "1", the parameter IODEV stores "SYSTERMINAL1" after the following command is executed:

merge "SYSTERMINAL" counter in @IODEV

# merge$mergeKMerge> second

# $ K > mergefromtoken


mergefromtoken printout startpos to endpos in variable mergefromtoken printout startpos to endpos in @parameter mergefromtoken printout startpos to end in variable mergefromtoken printout startpos to end in @parameter


Description:

This command is similar to command combinefromtoken except that the "&" character is appended to each token but the last one.

Example: The following is part of printout NADAP:

EXTERNAL/INTERNAL NUMBER CAT.0 14 13 12 11 10 9 8 7.After the following command is executed, the parameter CDCAT stores "14&13&12&11&10&9&8&7":

mergefromtoken NADAP 2 to end in @CDCAT

# mergefromtoken$mergefromtokenKMergefromtoken> second

# $ K > opt_parameter

Synopsis: opt_parameter parameter1: printout[,parameter2:printout,….]


Description:

This command lists the optional parameters, those parameters that do not have to be included in the initiation commands, but if data is found, should be included. Indicate the printout where the parameter values can be retrieved. Use this command with the colon after the parameter name.

Example: opt_parameter STPBIT:IOIFP,PROC:IOIFP

# opt_parameter$opt_parameterKOpt_parameter> second

# $ K > printfile


printfile logfile(@ I includefile) printfile logfile(printcommand1[+ printcommand2]…)


Description:

This command generates the DATA.CMD file. This file contains print commands, which when sent to the source system via FIOL or WinFIOL, open log files and send the print commands to obtain the source database.

For both cases, the logfile must be included. For the first case, the includefile groups the same kind of print commands. Use the second case when there are only a few print commands of the same group.

Example: printfile GJTSP(@ I GJTSP.BAT).printfile ISEPP(ISEPP:TERM=ALL+ISEPP:GRP=ALL)

When the above command is executed, the program generates the following commands in the DATA.CMD file:

@L GJTSP@I GJTSP.BAT.@L ISEPPISEPP:TERM+ALL:ISEPP:GRP=ALL:.

# printfile$printfileKPrintfile> second

# $ K > printformat


printformat HORIZONTAL printformat VERTICAL printformat DONTCARE


Description:

This command indicates the type of print format the program is going to work with. Three constant names are used to indicate the print format:

HORIZONTAL

VERTICAL

DONTCARE (a mixture of both horizontal and vertical formats)

Example: printformat VERTICAL

# printformat$printformatKPrintformat> second

# $ K > range


range startingvalue-& @parameter range startingvalue-& variable


Description:

This command is designed to work with the command GSCNI. The program builds the string, starting from startingvalue to the value stored in parameter or variable. The result is stored in the program’s global variable, which later can be stored in a parameter using the store command.

Example: If TEMP stores "3", the global variable will store "0&1&2&3" and then the program will assign result to parameter GSM after the following command range has been executed:

.range 0-& TEMPstore in @GSM.

# range$rangeKRange> second

# $ K > remove_char


remove_char @parameter "character" remove_char variable "character"


Description:

This command removes the character from the parameter or variable and then stores the result in the same parameter or variable.

Example: If DIAL Stores "-7000", then DIAL will store "0007" after the following command is executed:

remove_char DIAL "-"

# remove_char$remove_charKRemove_char> second

# $ K + remove_leading_spaces


remove_leading_spaces @parameter remove_leading_spaces variable


Description:

This command removes the leading blankspace characters from the parameter or variable and then stores the result in the same parameter or variable.

Example: remove_leading_spaces STRING_TEMPremove_leading_spaces @STRING

# remove_leading_spaces$remove_leading_spacesKremove_leading_spaces+Group0005:0001

# $ K + remove_trailing_spacesSynopsis: The following cases are supported:

remove_trailing_spaces @parameter remove_trailing_spaces variable


Description:

This command removes the trailing blankspace characters from the parameter or variable and then stores the result in the same parameter or variable.

Example: remove_trailing_spaces STRING_TEMPremove_trailing_spaces @STRING

# remove_trailing_spaces$remove_trailing_spacesKremove_trailing_spaces+Group0005:0002

# $ K > replace

Synopsis: replace @oldparam with "newparam"


Description:

For some commands, the parameter name in the source system changes to a different parameter in the destination system. This command indicates if a newparam is replacing the oldparam.

Example: In the destination system, the "CLASS" parameter becomes "CLA". Use the following command to replace the parameter:

Replace @CLASS with "CLA"

# replace$replaceKReplace> second

# $ K > replace_char


replace_char @parameter "replacedchar" with "replacingstring" replace_char variable "replacedchar" with "replacingstring"


Description:

This command causes the program to search for the content stored in parameter or variable for replacedchar and then replace every occurrence of replacedchar with replacingstring. The result is stored in the same parameter or variable.

Example: If parameter OPT stores "A,M", then OPT will store "A&M" after the following command is executed:

Replace_char @OPT "," with "&"

# replace_char$replace_charKReplace_char> second

# $ K > rewind

Synopsis: rewind printout


Description:

This command sets the file position of the file printout to the beginning.

Example: rewind EXCCP

# rewind$rewindKRewind> second

# $ K > seek_filpos


seek_filepos printfile tablefile @parameter seek_filepos printfile tablefile variable


Description:

This command changes the file position in printfile (e.g., KSCAP or KSDDP) based on the directory number. A binary tree on disk that contains the file position and the directory number as the key is used to perform this operation. This allows the program to quickly retrieve directory information.

Example: If the parameter DIR stores "5011", the following command obtains the file position from the table KSCAP.TBL using the key "5011, then performs a seek file operation on KSCAP based on the file position obtained:

seek_filepos KSCAP KSCAP.TBL @DIR

# seek_filpos$seek_filposKSeek_filpos> second

# $ K > send_aftercmd

Synopsis: send_aftercmd “YES”


Description:

For some initiation commands, a confirmation (e.g., "YES") needs to be sent to the system. This command stores the command in the program's internal variable. After each initiation command is created, this program writes the command to the command file.

send_aftercmd serves the same purpose but executes differently when target system is chosen as MX-ONE3.0.

In case of target system MX-ONE3.0 commands provides "-f" option in the REGENCMD.txt.This option directs shell to execute command without confirmation.

Example: This command inserts "-f" in the REGENCMD.TXT in the following way:echo ASPAC EXECUTION BEGINSmdsh -f -c "source ASPAC"echo ASPAC EXECUTION ENDS

# send_aftercmd$send_aftercmdKSend_aftercmd> second

# $ K > sendcommand


sendcommand sendcommand "command" sendcommand variable


Description:

After data is obtained for the command parameters, this command builds the initiation commands and writes them to the command file. However, if command is specified, the program writes it to the command file. If variable is specified, the program writes the content stored in variable to the command file.

Example: Sendcommandsendcommand "SCSCI:CONFIG=0,EQU=1-0-00-0,IOCCL=0-00,GSM=0,GSSIDE=0;"

# sendcommand$sendcommandKSendcommand> second

# $ K > sendcommand_comment


sendcommand_comment sendcommand_comment "command" sendcommand_comment variable


Description:

This command is the same as sendcommand except that the command is commented out before being written to the command line.

Example: sendcommand_comment "SCSCI:CONFIG=0,EQU=1-0-00-0,IOCCL=0-00,GSM=0,GSSIDE=0;"

# sendcommand_comment$sendcommand_commentKSendcommand_comment> second

# $ K > sendcommand_exit


sendcommand_exit sendcommand_exit "command" sendcommand_exit variable


Description:

This command is the same as sendcommand except that after the command is written to the command file, the program moves to the next section of the script file.

Example: sendcommand_exit"SCSCI:CONFIG=0,EQU=1-0-00-0,IOCCL=0-00,GSM=0,GSSIDE=0;"

# sendcommand_exit$sendcommand_exitKSendcommand_exit> second

# $ K > send_command_sortbySynopsis: The following cases are supported:

send_command_sortby @parameter "ascending"·send_command_sortby @parameter "descending"·


Description:

After data is obtained for the command parameters, this command builds the initiation commands and writes them to the command file in particular position of the initiation file so that the commands are sorted by the specified parameter in the specified way(ascending or descending).

Example: send_command_sortby @ENTRY "ascending"

# send_command_sortby$send_command_sortbyKSendcomment> second

# $ K > sendcomment

Synopsis: sendcomment "string"

Context: This keyword can be used in the Declaration, Setup, or Execution subsection.

Description:

This command writes comments to initiation command files. The strings are enclosed between comment strings "/*" and "*/".

Example: sendcomment "This is a comment"

# sendcomment$sendcommentKSendcomment> second

# $ K > set_printfile_pos_to_char

Synopsis: set_printfile_pos_to_char printfile index "character"


Description:

This command is used specifically for parsing printfile NADAP. The program parses data based on blank spaces between tokens. However, for abbreviated individual number series with five digits, there is no blank space between valid and invalid data. This command assigns a blank space so that the valid data can be obtained.

Example: If the printline from NADAP stores this string: "ABBREVIATED INDIV. NUMBER SERIES12345", then the string will become "ABBREVIATED INDIV. NUMBER SERIS 12345" after the following command is executed:

Set_printfile_pos_to_char NADAP 32 " "

# set_printfile_pos_to_char$set_printfile_pos_to_charKSet_printfile_pos_to_char> second

# $ K > setdigit


setdigit numberofdigit @parameter setdigit numberofdigit variable


Description:

The number of digits for some parameters in the destination system differs from that in the source system. This command sets the number of digits for parameters in the destination system. In the second case, the number of digits in variable is set instead.

Example: Using the following command, the parameter CDIV is set to nine (9) digits.

setdigit 9 @CDIV

# setdigit$setdigitKSetdigit> second

# $ K > setlimnumber


setlimnumber @parameter setlimnumber variable


Description:

This command is used to calculate the system’s total LIM number by using the content stored in parameter or variable, which should have this format: LIM-MAG-BRDPOS-IND (e.g., 3-0-10-0). The program retrieves the first digit, in this case, "3". This information, with other system information, is written to the file SWITCH.FIL after command generation completes.

Example: setlimnumber LIM

# setlimnumber$setlimnumberKSetlimnumber> second

# $ K > source

Synopsis: source printout1[,printout2…]


Description:

This command lists the printout(s) where the source database can be retrieved. If more than one printout is specified, use the command (,) as separator.

Example: source KSDDP,KSCAP

# source$sourceKSource> second

# $ K START

Synopsis: STARTContext: This keyword is used in the Start subsection.

Description:

The START keyword indicates the beginning of a section that includes the commands to generate the destination database.


# START$STARTKSTART

# $ K > stop

Synopsis: stop printout "stringpattern"


Description:

This command checks if there is a matching stringpattern in the current line obtained from the printout. If the program finds a match, it moves to the next section of the script file.

Example: stop CLINP "ORIG"

# stop$stopKStop> second

# $ K > stop_not_number


stop_not_number @parameter stop_not_number variable


Description:

This command checks if the content stored in parameter or variable is numeric. If it is, the program moves to the next section of the script file.

Example: stop_not_number TEMP

# stop_not_number$stop_not_numberKStop_not_number> second

# $ K > store


store "string" in variable store "string" in @parameter store in variable store in @parameter store variable in @parameter store variable[index] in variable2 store variable1[index] in variable2 store "character" in @parameter[index] store variable1 in variable2


Description:

This command allows the user to assign a string, or the contents stored in the variable, parameter, or the program’s internal global variable, to another variable or parameter. The user can also assign a single character to an index position or another parameter. For cases 3 and 4, the contents stored in the program’s global variable are assigned to parameter and variable respectively.

Example: store in @GSM

store "32" in @CHLstore TEMP in @NODEstore NODE_TEMP in @NODEstore CDIV_TEMP[5] in @CDIV[5]

store "1" in @CDIV[6]

# store$storeKStore> second

# $ K > stringpattern


stringpattern printout "stringpattern" "string" @parameter stringpattern printout "stringpattern" "string" variable stringpattern printout "stringpattern" token tokenumber @parameter stringpattern printout ‘stringpattern" token tokenumber variable


Description:

In cases 1 and 2, the program searches the current line obtained from the printout for the stringpattern. If it finds a matching stringpattern, string is assigned to parameter and variable respectively. Similarly, for cases 3 and 4, the token identified by the tokenumber obtained from the current line of the printout is stored to the parameter and variable respectively.

Example: If the program finds the string "ONE MISSION" in the current line of the SYDAP printout, then it assigns "1" to the PGJOB parameter when the following command is executed:

stringpattern SYDAP "ONE MISSION" "1" @PGJOBIf the program finds the string "NUMBER OF TRUNKS IN CO" in the printout SYDAP, then the program assigns token number 7 from the same print line to the NTC parameter when the following command is executed:

stringpattern SYDAP "NUMBER OF TRUNKS IN CO" token 7 @NTC

# stringpattern$stringpatternKStringpattern> second

# $ K > token


stringpattern printout "stringpattern" token tokenumber @parameter stringpattern printout "stringpattern" token tokenumber variable


Description:

This keyword is used in conjunction with the stringpattern keyword.

Example: If the program finds the string "NUMBER OF TRUNKS IN CO" in the printout SYDAP, then the program assigns token number 7 from the same print line to the NTC parameter when the following command is executed:

stringpattern SYDAP "NUMBER OF TRUNKS IN CO" token 7 @NTC

# token$tokenKToken> second

# $ K > with

Synopsis: replace @oldparam with "newparam"


Description:

This keyword is used in conjunction with the replace keyword.

Example: replace @CLASS with "CLA"

# with$withKWith> second

# $ K > START

Synopsis: STARTContext: This keyword is used in the Start subsection.

Description:

The START keyword indicates the beginning of a section that includes the commands to generate the destination database.


# START_3$STARTKSTART> second

# $ K A + Basic steps for using PC-RegenThis is an overview of the basic steps for using PC-Regen:Step 1 Set the application configurationStep 2 Perform data generation Step 3 Transmit the generated batch file to the MD110 Step 4 Run regenerationStep 5 Calculate licenses (when upgrading to BC10 or later)Step 6 Install the upgrade software on the MD110Step 7 Transmit the REGENCMD.BAT batch file from the PC to the MD110 using WinFIOL or FIOL

# Basic_Steps_for_Using_PC_Regen$Basic steps for using PC-RegenKBasic Steps;Basic Steps for Using PC-Regen;Overview;Using PC-RegenABasic steps;Intro+Group0006:0000

# $ K A + Set the application configurationThe application configuration includes information on how to generate and process the batch files, and identifies the source and target locations of input/output files.

How to: Enter configuration information

# Set_the_Application_Configuration$Set the application configurationKApplication configuration;Set the Application ConfigurationABasic steps+Group0006:0001

# $ K A + About syntax analysisPC-Regen scripts contain one or more script commands or keywords that perform various functions. The script file must be written according to script file language rules. If the script breaks these rules, a syntax error occurs. If PC-Regen encounters a syntax error during regeneration, the program may stop without completing successfully. To avoid this, it is recommended that you check for syntax errors prior to running either the data generation or regeneration processes.The Script Analysis function loads the appropriate script file based on the current configuration and checks it for errors. The program then writes any syntax errors to the error.log file in the application directory. The error log file contains the following information:

Script file name Line number of the error Description of the error

Refer to About Script Language for more information on PC-Regen script file language rules.

How to: Analyze script syntax

# About_Syntax_Analysis$About syntax analysisKAbout Syntax Analysis;Run Syntax Analysis;Script Analysis;SyntaxABasic steps+Group0002:0000

# $ K A + Perform data generationPC-Regen comes with several script files, which are used for converting data from one release level to another. A script may contain one or more keywords, which are used to generate MD110 print commands. The Data Generation process involves processing the script file and extracting all of the print commands to a single batch file named DATA.CMD. PC-Regen saves the DATA.CMD file in the default PC-Regen application directory. The DATA.CMD batch file can then be transmitted to the MD110 source system using FIOL or WinFIOL and the results stored as log files in the source directory.

How to: Create a DATA.CMD batch file

# Perform_data_generation$Perform data generationKData generation;DATA.CMD;Perform data;Perform data:generationABasic steps+Group0006:0002

# $ K A + Transmit the generated batch file to the MD110Load WinFIOL or FIOL to transmit the DATA.CMD file from the PC to the MD110. The commands are executed line by line. The output of each command is saved in a log file in the directory specified as the source directory during configuration. The result of this data generation process is a set of data files located in the source directory in a format consistent with the current MD110 software.

# Transmit_the_generated_batch_file_to_the_MD110$Transmit the generated batch file to the MD110KFIOL;Transmit the generated batch file to the MD110;WinFIOLABasic steps+Group0006:0003

# $ K A + Run regenerationThe System Database Regeneration process involves creating initiation files by running a script against the source system log files created during Data Generation. The initiation files are stored in the target directory specified during configuration. After the MD110 has been upgraded to the new software release, the initiation files can then be transmitted to the upgraded MD110 system using FIOL or WinFIOL to rebuild the database.

How to: Perform database regeneration

# Run_Regeneration$Run regenerationKData regeneration;Perform data:regeneration;Regeneration;Run Regeneration;System Database RegenerationABasic steps+Group0006:0004

# $ K A KeywordsKeywords are reserved words that are used exclusively by PC-Regen. Keywords must not be used for other purposes, such as naming identifiers. Keywords are case-sensitive, which means that PC-Regen recognizes store as a keyword, while Store is recognized as an identifier.

# Keywords_2$KeywordsKKeywordsAScript language

# $ K A + About license calculationThe BC10 version of the MD110 introduced the concept of license objects. BC10 and later versions of the MD110 have a print command giving the number of currently used licenses. When a site is upgraded to the BC10 release or later, the number of licenses corresponding to the customer’s site must be calculated. E.g. if the customer has an ELU28 board with 32 individuals used for digital extensions, he is granted 32 digital extension licenses after the upgrade.There are two types of licenses: individual licenses and system licenses. Individual licenses are used for software or hardware objects, e.g. analogue extensions. Each individual license is defined with a maximum number of licenses allowed.System licenses are used for operational facilities, e.g. network services. A system license can have two values: Object is available or Object is not available.The license information is used in SolveIT, which by others is used as a price management application.

How to: Calculate licenses

# About_License_Calculation$About license calculationKAbout License Calculation;Calculating Licenses;Individual licenses;Licenses;Object;SolveIT;System licensesAlicense+Group0007:0000

# $ K A + Calculating licensesTo calculate licenses, perform the following:1 Click the Lic Calculation button.2 Set the Initiating Command path. This is where the files used for the calculation are stored,

i.e. a directory containing all the initiation command files created by PC-Regen.3 Select whether the calculation should stop at errors or not.4 Click Calculate to begin the calculation.5 You can select whether to view the license file or the log file by clicking the appropriate

radio button in the View Settings region. You can also choose to view the input file for SolveIT.

6 Click Export to export the displayed information (the log file, the license file or the SolveIT file) to a text file.

7 Click Close to return to the PC-Regen main window

# Calculating_Licenses$Calculating licensesKCalculating Licenses;License;Licenses;SolveITAlicense+Group0007:0001

# $ K A + Calculate licensesWhen a site is upgraded to the BC10 release or later, the number of licenses corresponding to the customer’s site must be calculated.

How to: Calculate Licenses

# Calculate_Licenses$Calculate licensesKLicenseABasic steps+Group0006:0005

# $ K + Changing PC-Regen SettingsTo change the settings for PC-Regen, perform the following:1 From the Options menu, click Settings. The Settings dialog appears. 2 Click the General tab.3 Select whether FIOL or WinFIOL will be used for communicating with the MD110. 4 Select whether ASB or BC release names should be displayed.5 Select whether or not the @Executed command should be added.

# Changing_PC_Regen_Settings$Changing PC-Regen SettingsKChanging PC-Regen Settings;General;Settings+Group0001:0001

# $ K + Setting default pathsTo set default paths for the DATA.CMD, ERROR.LOG, License log and License file, perform the following:1 From the Options menu, click Settings. The Settings dialog appears. 2 Click the Default paths tab.3 Select default paths for the directories listed.4 Click OK when you have entered information in the Settings dialog.

# Setting_default_paths$Setting default pathsKDefault;Setting default paths;Settings+Group0001:0002

# $ K System TypeMD110 Standard Exchange or MD110 Centrex Version. There are two types of scripts, one for each type of system.

# System_Type$System TypeKMD110 Centrex Version;MD110 Standard Exchange;System Type

# $ K A License objectsThe calculation of licenses in PC-Regen is performed according to a certain set of rules. Some of the rules apply only to BC11 and BC12, but the main part of the rules applies to BC10, BC11 and BC12.This is a list of the rules that are used for calculating licenses in PC-Regen:

FAL104451, Analogue Extension portsAdd all values for NUMIND in command CNBOI where BRDID=2, 43, 44, 87 or 104.

FAL104452, Digital Extension portsAdd all values for NUMIND in command CNBOI where BRDID=31, 59 or 77. Also check OPERI and deduct one from the above total for every OPERI command found.

FAL104453, ISDN-TERMINAL-INTERFACEAdd all values for NUMIND in command CNBOI where BRDID=70.

FAL104455, CAS Extension portsAdd one for each command EXTEI where TYPE=EL7.

FAL104456, OPERATOR-EXTENSIONAdd one for each command OPERI.

FAL104461, EXTERNAL-LINE-CAS-ANAAdd all values for NUMIND in command CNBOI where BRDID=7, 8, 10, 11, 12, 26, 28,30,32,33, 39, 41, 51, 56, 75, 76, 79 or 99.

FAL104462, EXTERNAL-LINE-CAS-DIGAdd one for each route which is used in command ROEQI:ROU=xx and is also defined in RODAI with TYPE=TL20, TL30, TL31, TL33, TL37, TL38, TL45, TL51, or TL95.

FAL104463, EXTERNAL-LINE-DASS2Add one for each route which is used in command ROEQI:ROU=xx and is also defined in ROCAI with SIG(D11) = 2 and SERV(D3) = 0

FAL104464, EXTERNAL-LINE-ISDN-USRAdd one for each route which is used in command ROEQI: ROU=xx and is also defined in ROCAI with SIG (D11) = 3 and also defined inRODAI with VARI (D4) = 0, 2, 4, 6, 8 or A and VARO (D4) = 1. Add one for each route which is used in command ROEQI: ROU=xx and is also defined in ROCAI with TYPE=SL63 and RODAI.

FAL104465, EXTERNAL-LINE-DPNSSAdd one for each route which is used in command ROEQI:ROU=xx and is also defined in ROCAI with SIG(D11) = 1 and SERV(D3) = 1.

FAL104466, EXTERNAL-LINE-Q-SIGAdd one for each route which is used in command ROEQI: ROU=xx and is also defined in ROCAI with SIG (D11) = 3 and also defined in

RODAI with VARI (D4) = 0, 2, 4, 6, 8 or A and VARO (D4) = 0.

# License_objects$License objectsKCalculating Licenses;License objects;LicensesAlicense

For TYPE SL63, no Q-SIG license is seized.

FAL104467, EXTERNAL-LINE-APNSSAdd one for each route which is used in command ROEQI:ROU=xx and is also defined in ROCAI with SIG(D11) = 4 and SERV(D3) = 1.

FAL104525, ACD-AGENTAdd one for each member in an ACD group, in command ACGMI, after having removed all but one occurrence of agents who are members of more than one group, and who also is defined in KSANI.

FAL104526, ANCD-V24-INTERFACEAdd one for each command NCICI.

FAL104530, CCM-V24-INTERFACESet to one if command ACFUI is found.

FAL104532, IS-V24-INTERFACEAdd one for each command ICFUI.

FAL104521, Interception Service User (Nordic Countries only)If command ISFUI is present, add up the result from FAL104 451, 452, 453, 455 and 456 (total number of extension ports).

FAL104534, VM-V24-INTERFACEAdd one for each command VMFUI.

FAL104522, Voice Mail User (Nordic Countries only)If command VMFUI is present, add up the result from FAL104 451, 452, 453, 455 and 456 (total number of extension ports).

FAL104537, EM-V24-INTERFACEAdd one for each command EMFUI.

FAL104475, Authorization CodeIf command AUCOI is present, add up the result from FAL104 451, 452, 453, 455 and 456 (total number of extension ports).

FAL104502, MFC EquipmentAdd all values for NUMIND in command CNBOI where BRDID=24, 25 or 95.

FAL104501, Failure Through TransferAdd all values for NUMIND in command CNBOI where BRDID=20.

FAL104503, Call Metering on Analogue Trunk linesAdd one for each command ROECI.

FAL104505, NET-SERVICESAdd one for each route which is used in command ROEQI:ROU=xx and is also defined in ROCAI with SIG(D12) = 1 and SIG(D11) = 1 and SERV(D3) = 1.

FAL10456, Networking functionality QSIGAdd one for each route which is used in command ROEQI:ROU=xx and is also defined in ROCAI with SIG(D12) = 1 and SIG(D11) = 3 and SERV(D3) = 1.

FAL104507, EXTERNAL-LINE-ISDN-NET

Add one for each route which is used in command ROEQI:ROU=xx and is also defined in RODAI with VARI(D4) = 1, 3, 5, 7, 9 or B and VARO(D3) = 1, 2, 5, 6, 9, A, D or E and VARO(D4) = 1, 3 or 5.

And also defined in ROCAI with SIG (D11)=3.

FAL104508, Virtual Private NetworkAdd one for each route which is used in command ROEQI:ROU=xx and is also defined in ROCAI with SIG(D12) = 1 and SIG(D11) = 3 and SERV(D3) = 0.

FAL104509, Least Cost RoutingSet to one if command LCLDI is present.

FAL104510, Voice CompressionFor each VCCOI command add up licenses based on CONFIG parameter and the table below:

CONFIG 1 2 3 4 5 6 7 8Licenses 5 5 4 4 10 10 8 9

FAL104480, Music on HoldSet to one if command ASPAC with PARNUM=154 and PARVAL != 0 is found.

FAL104482, Message Diversion, Simplified Interception ServiceIf program unit IDP in CNPUP file is found add up the result from FAL104 451, 452, 453, 455 and 456 (total number of extension ports).

FAL104484, DISA-NUMBERSet to one if command NANSI with NUMTYP=DI is found.

FAL104485, TRAFFIC-MEASUREMENTSet to one if program unit TMM is found in file CNPUP.

FAL104486, RVA-INTERNALAdd all values for NUMIND in command CNBOI where BRDID=85.

FAL104487, RVA-EXTERNALAdd one for each command RAEQI found.

FAL104478, RVA Users (Nordic countries only)If command RAEQI is present, add up the result from FAL104 451, 452, 453, 455 and 456 (total number of extension ports).

FAL104488, SMDR-V24-INTERFACEAdd one for each command EDEQI found.

FAL104479, SMDR/CIL Users (Nordic countries only)If command EDEQI is present, add up the result from FAL104 451, 452, 453, 455 and 456 (total number of extension ports).

FAL104517, PAGING-SERIALAdd one for each occurrence of parameter TYPE=PG1 in command PASAI and corresponding search area SAR also defined in PACHI command.

FAL104518, PAGING-LOOPAdd one for each occurrence of parameter TYPE=PG2 in command PASAI and corresponding search area SAR also defined in PACHI command.

FAL104519, PAGING-PARALLELAdd one for each occurrence of parameter TYPE=PG3 in command PASAI and corresponding search area SAR also defined in PACHI command.

FAL104539, OM-V24-INTERFACEAdd one for each occurrence of parameter USAGE=MML in command IOEQI.

FAL104491, DUPLICATED-CSSet to one if command DCSYI is found.

FAL104492, GROUP-SWITCH-LINKAdd one for each GJLII found.

FAL104493, LINE-INTERFACE-MODULEExtract EQU from all GJLII commands, and save only the LIM number of EQU. Remove duplicate numbers and count the remaining LIMs. If counting result in zero the number of LIMs is set to one.

Remaining licenses in BC10Remaining BC10 license objects are set to 0 when upgrading to BC10. When upgrading from BC10 to BC11 or BC12, licenses are collected from LIDAP and IVBOP file. New license objects in BC10 are:

CORDLESS-EXTENSION FAL104454REPEAT-IND-DIV-USER FAL104471PERSONAL-NUMBER-USER FAL104472SMDR-ETH-INTERFACE FAL104489VC—FAX-III-PORT FAL104512Centralized Voice Mail FAL104515BASE-STATION-DECT FAL104520DUPLICATED-GS FAL104524CCM-ETH-INTERFACE FAL104531Interception Ethernet session FAL104533Voice mail Ethernet session FAL104535APP-LINK-INTERFACE FAL104536EM-ETH-INTERFACE FAL104538OM-ETH-INTERFACE FAL104540ANCD-FEATURE FAL104545VOICE-SYSTEM FAL104546VOICE-PORT FAL104547VOICE-MAILBOX FAL104470ORIGINAL-A-NUMBER FAL1040278

The license FAL104470 is calculated by counting number of items in file IVBOP because of no license tag in LIDAP.

Remaining licenses in BC11 and BC12Remaining BC11 and BC12 license objects to are set to 0 when upgrading to BC11 or BC12. They are collected from LIDAP. These objects are:

CIL-HDU-INTERFACE FAL104710EXTERNAL-LINE-CCSS7 FAL104705GENERIC-EXT-SMS FAL104708HOSPITALITY-APPLICATION FAL104709IP-EXTENSION FAL104706VOIP-ETH-INTERFACE FAL104707FREESEATING FAL1040050

New licenses in MX-ONE TSW

FAL104 6191, Analogue-Extension-ClipAdd one for each command EXTEI where ICAT(D1) = 8 , 9, C or D

Remaining MX-ONE TSW license objects are set to 0 when upgrading to MX-ONE TSW. These objects are:

Routing-Server-Server FAL1046192Routing-Server-Client FAL1046193

FAL1046192 and FAL1046193 are System licenses and are collected from LIDAP.They are set to 1 if allowed.

# $ K A + > Edit Source Name Dialog{bmc pc-r0029.BMP} Edit Source Name dialog is used for editing a source name. Change the source name in edit box and click OK. If the source name already exists, error message is prompted.

# Edit_Source_Name_Dialog$Edit Source Name DialogKEdit Source Name DialogAIntro+Group0000:0001 > main

# $ K getstringtoend

Synopsis: getstringtoend printout variable1 variable2 variable3


Description:

This command has been designed to support CLCCP new command printouts. It extracts three strings from three parameter values, just as they are, including spaces and double quotes. The names of the variables should be the same as the parameters they refer, and they are mandatory.

Note: This command should be used for printouts with vertical formats only, which have at least three string parameters. The syntax of this command takes variables instead of parameters to make possible to work with the strings captured if it is needed, before the real storage is done.

Example: The following is part of the printout CLCCP:

.

SEG POS CC1 CC2 CC30 1 "A" " A" " A". 2 "" " " " "

After the command ‘getstrintoend CLCCP CC1 CC2 CC3‘ is executed, while reading the first line, CC1 stores "A"; CC2 stores " A" and CC3 stores " A" if it is executed while reading second line, then CC1 stores "", CC2 stores " " and CC3 stores " ".

# getstringtoend$getstringtoendKgetstringtoend

# {ewl RoboEx32.dll, WinHelp2000, }

# CCQPHF

# $ K A + > Add Source Name Dialog{bmc pc-r0030.BMP} Add Source Name dialog is used for adding a source name. Enter the source name in edit box and click OK. If the source name already exists, error message is prompted.

# Add_Source_Name_Dialog$Add Source Name DialogKAdd Source NameAIntro+Group0000:0002 > main

# $ K A + > Source Name Dialog{bmc pc-r0031.BMP} Source Name dialog is used for selecting the source name with which user wants to work. Select a source name and click OK. The selected source name appears on the main window in the source name edit box.To add a new source name, click ‘Add’ button. Add Source Name Dialog is launched.To edit a source name, select it and click ‘Edit’ button. Edit Source Name Dialog is launched.To delete a source name, select it and click ‘Delete’ button.

# Source_Name_Dialog$Source Name DialogKSource Name DialogAIntro+Group0000:0003 > main


# ATSLTXG

# $ K sendcmd

send command

# sendcmd$sendcmdKNewTopic 1

# $ K NewTopic 1

guyguyhgk

# NewTopic_1$NewTopic 1KNewTopic 2

# $ NewTopic 2

add_value

bnmbijuihi

# NewTopic_2$NewTopic 2

# $ type popup caption here

type popup definition text here

# type_popup_caption_here$type popup caption here


# TFNP3B

{ewl RoboEx32.dll, WinHelp2000, }

# $ + K > @set_echo

Synopsis: set_echo set_echo 1

combinefile file1 [file2,...]

Context: This keyword is used in the Setup subsection. Also,This keyword is designed for the purpose of upgrading MD release to MX-ONE3.0 release. Implementation of this keyword holds good only when Target system is higher than MX-ONE3.0

Description: The command causes the program to write "set _ECHO = 1" in commandfile as the first line of the commandfile set _ECHO = 1 in the commandfile directs the shell to show command execution result preceded by command initiated on prompt during the execution of batch file REGENCMD.

Combination of set_echo 1 and combinefile solves a particular purpose. set_echo 1 directs program to first write set _ECHO = 1 in the commandfile and then combinefile appends all the files in the commandfile.

.

Example: STARTcommandfile ROEQI set_echo 1combinefile ROEQI1, ROEQI2END

Command file ROEQI1 regenerated as:ROEQI:ROU=1,TRU=1-1,EQU=1-1-01,INDDAT=000000000000;Command file ROEQI2 regenerated as:ROEQI:ROU=1,TRU=1-2,EQU=1-1-00-02,INDDAT=000000000000;ROEQI1 and ROEQI2 are combined in command file ROEQI as:set _ECHO = 1 ROEQI:ROU=1,TRU=1-1,EQU=1-1-00-01,INDDAT=000000000000;ROEQI:ROU=1,TRU=1-2,EQU=1-1-00-02,INDDAT=000000000000;

# set_echo$ set_echo+ PC-REGEN:0K set_echo> second@ Status|0|||0||||||

# $ K getline_else_log_error

Synopsis: getline_else_logerr printout tokenumber1 tokenumber2 tokenumber3 variable1/"string1" variable2/"string2" variable3/"string3"/@parameter in variable4


Description: This command causes the program to continue reading a line from the file printout and to get the tokens corresponding to the token numbers. If, at the end of the printout, the program has not found a token equal to the content stored in parameter or variable or string, the program writes an error message to the error log file and copies "0" to variable 4. If a match is found, "1" is copied to variable4.

Example: The following is part of printout IONCP:NODE/IODEV LIM USER TYPE/CON IP PORT PROCSYSN 1 CSTA CSTA SERVER/1 192.168.23.15 4003 TCP CSTA GICI-1 CLIENT 10.12.1.13 2400 TCP If the current content of IODEV_TEMP and USER_TEMP is CSTA, GICI-1 respectively, the following command will cause the program to search the IONCP printout until it comes to the line that contains the respective tokens CSTA, GICI-1 and CLIENT. getline_else_logerr IONCP 1 2 3 IODEV_TEMP USER_TEMP "CLIENT" in IODEV_CHECK2if( IODEV_CHECK2 = "1" ) getokenumber IONCP 4 in @IPendif

# getline_else_logerr$ getline_else_logerrK getline_else_logerr

# $ + K @ alter_param

Synopsis: The following cases are supported: alter_param @parameter "new_length" "append" "character" alter_param @parameter "new_length" "prepend" "character" alter_param variable "new_length" "append" "character" alter_param variable "new_length" "prepend" "character"


Description:

This command alters the length of the parameter or variable. The length of the parameter or variable is increased to "new_length" and the newly added bits will have the value that is mentioned in "character”. The new bits will be added at the beginning if "prepend" is specified and added at the end if "append" is specified.

Example: If the value of @ADC is "06061000000002500060001" then, after the execution of the below command the value of @ADC will be "06061000000002500060001000"

alter_param @ADC "26" "append" "0"

If the value of @ADC is "06061000000002500060001" then, after the execution of the below command the value of @ADC will be "00006061000000002500060001"

alter_param @ADC "26" "prepend" "0"

# alter_param$ alter_param+ PC-REGEN:0K alter_param@ Status|0|||0||||||

# $ + K search_for_param_in_fileSynopsis: search_for_param_in_file printout @parameter varaible1 in variable2


Description:

This command causes the program to continue reading a line from the file printout and searches untill it finds the value stored in the variable1 under the parameter in the printout. If it finds the value under parameter then it will store "1" in the variable2 or "0" in variable2.

Example: The following is part of printoutACPAPACDNUM ACDVAL 1 0 2 0 3 0 5 0 If the current content of ACDNUM_TEMP is 2, the following command will cause the program to search the ACPAP printout until it finds the value "2" in the parameter ACDNUM. If it finds the value "2" then it stores "1" in the variable ACPAP_TEMP or "0" in ACPAP_TEMP.search_for_param_in_file ACPAP @ACDNUM ACDNUM_TEMP in ACPAP_TEMP

# search_for_param_in_file$ search_for_param_in_file + PC-REGEN:0K search_for_param_in_file

# $ + K send_aftercmd_internal

Synopsis: send_aftercmd_internal command


Description: For some initiation commands, a delay (e.g., "@T 60") needs to be introduced to the system after each instance. This command stores the command in the program’s internal variable. After each initiation command is created, this program writes the command to the command file.

Example: send_aftercmd_internal "@T 60"

# send_aftercmd_internal$ send_aftercmd_internal + PC-REGEN:0K send_aftercmd_internal

# Missing topic found during conversion. 1

# GKZ4VJ

# $ + K @ mergewithspacesSynopsis: The following cases are supported:

mergewithspaces printout startpos to endpos in variable mergewithspaces printout startpos to endpos in @parameter mergewithspaces printout startpos to end in variable mergewithspaces printout startpos to end in @parameter


Description: This command concatenates all the tokens by including spaces from token startpos to token endpos from the line obtained in printout.

If the keyword end is specified, the program concatenates all the tokens by including spaces from token startpos to until the end of the line. The result is stored in variable or parameter.

Note: This command is especially implemented to retrieve the spaces in the parameter “-format” from the command “callinfo_status_print”

Example: The following is part of printout callinfo_status_print:Call information output configuration print Recording in Lim : 1 is active and is not forwarding to central log. QoS reporting from endpoints: off

+----------------------------------------------------------------------------+Lim 1 Output 0 connected. Recording enabled Type : tcp Subtype : general Records/calls queued : 0 Infotype : call Data base server:port : 10.12.30.99:1752 Data base server host : 10.12.30.99 Format string : {currentTime day 0R 2 2}{currentTime month 0R 2 2} {newline} Newline handling : CRNL Output for all (global) data

Heartbeat

In the below example all tokens starting from token number 4 to end are concatenated and the result is stored in parameter “-format”.

mergewithspaces callinfo_status_print 4 to end in @format

# mergewithspaces$ mergewithspaces+ PC-REGEN:0K mergewithspaces@ Status|0|||0||||||

PC-Regeneration User Guide

Documents

Transcript of PC-Regeneration User Guide