Comptel Business Service Tool™: Reference Manual
Comptel Business Service Tool™: Reference Manual
Reference Manual
Joint Confidential
Trademarks
Comptel, Comptel logo, Nexterday, Data Fastermind, Comptel Monetizer, Data Monetizer, FlowOne, SoftBlades, VPR [vaɪpər], Comptel
Operational Intelligence, Comptel Operational Intelligence for Mediation, Comptel Social Links Business Intelligence API, Comptel Social
Links Analytics Development Kit,Comptel Social Links Reporting Development Kit Add-onSocial Advertising Intelligence, Xtract, Social
Links, Comptel Social Links, Universal Profiles, XSAI, Comptel Dynamic OSS, Comptel Control and Charge, Comptel Policy and
Charging Control, Comptel Policy Control, Comptel Online Charging System, Charging Policy Offer Designer, Comptel Convergent
Mediation, Comptel Charging, Comptel Interconnect Billing, Comptel Roaming Management, Comptel Dynamic SIM Management,
Comptel Fulfillment, Comptel Order Management, Comptel Provisioning and Activation, Comptel Service and Resource Inventory,
Comptel Catalog, Comptel Subscriber Profile Repository, Comptel Number Management, Comptel Number and Identifier Management,
Comptel Bandwidth Management, Comptel Roaming Cost Control, Comptel Dynamic Campaigning, Comptel Inventory, Comptel Service
Inventory, Comptel Service Repository, Comptel Subscriber Repository, Comptel Service Catalog, Comptel Fulfillment Solution, Comptel
Convergent Mediation Solution, Comptel Convergent Charging Solutions, Comptel Voice and Data Charging Solution, Comptel IP
Prepaid Solution, Comptel Online Cost Control Solution, Comptel Rating Solution, Comptel Offline Mediation Solution, Comptel Online
Mediation Solution, Comptel Provisioning and Activation Solution, Comptel Service Repository Solution, Comptel Service Catalog
Solution, Comptel Inventory Solution, Comptel Interconnect Billing Solution, Comptel Roaming Management Solution, Comptel Data
Retention Solution, Comptel Number and Identifier Management Solution, Comptel Order Management Solution, Comptel NIMS,
Comptel IPAM, Comptel TETRA Solution, Comptel EventLink, Comptel InstantLink, Comptel OnlineLink, Comptel PacketLink, Comptel
ServiceLink, Comptel SMSLink, Comptel Alarm Dispatcher, Comptel Balance Management, Comptel GTP Collector, Comptel Lookup
Server, Comptel Partner Account, Comptel Rater, Comptel Notifier, Comptel Reporter, Comptel Convergent Mediation SDK, Comptel
Provisioning Client, Comptel Workflow Client, EventLink Business Logic Tool, EventLink Correlator, EventLink Developer's License,
EventLink Encapsulated ARM-FR, EventLink FTP Collector, EventLink FTP Distributor, EventLink Java FTP Collector, EventLink Java
FTP Distributor, EventLink Java SFTP Collector, EventLink Java SFTP Distributor, EventLink Java Local Collector, EventLink Java Local
Distributor, EventLink Multi-format Encoder, EventLink Remote File Agent, EventLink Reporter, Comptel EventLink SDK, EventLink UDP
Collector, EventLink UDP Distributor, EventLink User Interface, EventLink Record Correction Tool, InstantLink Business Service Tool,
Comptel Business Service Tool, InstantLink Developer's License, InstantLink NE Interface SDK, InstantLink Provisioning Client,
InstantLink Workflow Client, FlowOne OrderHub, Fastermind for Customer Engagement Automation, Fastermind for CEA, OnlineLink
Business Service Tool and Comptel A.I.R are trademarks or registered trademarks of Comptel Corporation and its subsidiaries (Comptel
Group).
All other trademarks and registered trademarks are the property of their respective holders.
Information in this document is subject to change without notice and does not represent a commitment on the part of Comptel
Corporation. Comptel Corporation is not liable for errors contained in this document or for any incidental or consequential damages in
connection with furnishing or use of this material. This document is not part of a contract or license save insofar as may be expressly
agreed in writing.
Comptel’s software is protected by copyright laws. Comptel has also sought patent protection for its solutions. Comptel is continuously
keeping up with the patenting activities within its field of business. Comptel respects the intellectual property rights of third parties and
never wilfully infringes patents owned by third parties.
1.2.1 Abbreviations 1
1.2.2 Terminology 2
2 GRC Parameters 3
2.1 GRC Parameters in Detail 3
3 Request Parameters 11
3.1 REQUEST_TRACE Request Parameter 11
4 Directory Structure 13
6 File Cleaning 18
6.1 Cleaning Request Trace Data 18
7 Memory Configuration 19
7.1 Memory Consumption 20
9.7 Downloading and Uploading rules.properties for Provisioning Logics and Library Logics 33
9.8 Downloading Active Logic Set and Uploading New Working Set 34
11 Comparing Logics 37
16 Troubleshooting 51
16.1 All Output Parameters to Pool Check Box 51
1.1 Audience
This document is intended for Comptel Business Service Tool administrators.
The reader should be familiar with the Comptel Business Service Tool application
and user interface (UI) as well as Comptel InstantLink and its UI. In addition, it is
assumed that the reader has experience with UNIX administration and Oracle
database administration tools.
1.2.1 Abbreviations
BST Business Service Tool
GRC Global Resource Configuration
OSS/BSS Operations and Business Support System
UI User Interface
1.2.2 Terminology
Archive Database Archive Database is an add-on module of Comptel InstantLink that
allows storing request information over a longer period of time.
Business Service Tool Engine A configurable request processing tool, fully integrated to Comptel
InstantLink.
Business Service Tool Logic A web-based user interface of Comptel Business Service Tool for
Editor configuring provisioning logics.
Comptel InstantLink A system for subscriber provisioning and service activation.
Comptel InstantLink receives requests from the OSS/BSS systems,
translates the requests to network-element-specific commands and
executes these commands. After execution of a request, Comptel
InstantLink sends a response to the OSS/BSS.
GRC parameter A variable used to define configuration settings. GRC parameters are
located in a database.
GRC section A group of parameters for a particular application stored in a
database. Each section is identified by the unique name of the
application.
Operations and Business A program that helps an operator monitor, control, analyse and
Support System; OSS/BSS manage usage of a communications network.
OSS/BSS systems include, for example, systems for customer care,
order management, billing, relationship management, decision
support, market analysis, fraud detection, traffic engineering and
network planning.
The individual properties of each OSS/BSS system determine what
kind of requirements the customer sets for the Provisioning Systems,
such as what services the Provisioning System should activate for
subscribers.
provisioning logic A set of rules that define how provisioning is performed. A
provisioning logic is presented in the Business Service Tool user
interface by a flowchart, consisting of steps and methods. A
provisioning logic can, for example, manipulate parameter data,
execute a provisioning task, fetch information from lookup tables
and create a response.
For more information about Comptel InstantLink, see the Comptel InstantLink
documentation.
2 GRC Parameters
The global resource configuration (GRC) parameters are used to configure the
processing of Comptel Business Service Tool. The GRC parameter values are
automatically set during the Comptel Business Service Tool system installation and
they are rarely changed.
The GRC parameters are stored in the Comptel InstantLink database that is organised
into sections. The GRC parameters of Comptel Business Service Tool are located in
the Comptel Business Service Tool section. The parameters can be accessed and
modified through the Comptel InstantLink UI. For more information, see Comptel
InstantLink Online Help.
It is highly recommended to modify the provisioning logic to not use the overwrite or
all output parameters to pool definitions, because they slow down request processing
considerably. You can temporarily set these parameters to YES to open the
provisioning logic and make the necessary changes in the provisioning logic. After
the changes are implemented, set the parameters back to NO to ensure optimal
performance.
When the value of the parameter is NO, the task status values from Comptel
InstantLink are used. This is the default option. When the value of the parameter is
YES, the task status values from MDS/SAS 3 are used. This means that the task status
values are always mapped when Comptel Business Service Tool receives a task
response and when a request response is sent to Comptel InstantLink.
shows how task status values are mapped in a task response from Comptel
InstantLink to Comptel Business Service Tool when the parameter is set to YES.
Figure 2 shows how task status values are mapped in a request response from
Comptel Business Service Tool to Comptel InstantLink when the parameter is set to
YES.
You can view the previously and currently active logics on the Active Logics page on
the BST pages if the GRC parameter is set to YES.
Note This listing does not include library logics even though they have similar old
logic handling as main logics.
Example:
A request might be timed to be executed later and not immediately when it is received
by Comptel InstantLink. If provisioning logics are changed after the timed request
was received, Comptel Business Service Tool knows based on the request’s
received_time parameter which version of the active logic to use for running the
request.
Note If the old_logic_support parameter was set to NO when the request was
received, but is set to YES when the request is being processed, the request
fails.
The number of old logics kept in memory can be configured by setting the following
option in the <installdir>/sas/.customer.environment-variables file:
JAVA_OPTS="$JAVA_OPTS -Dbst_old_logic_max_count_in_memory=5"
The number of old logic sets read to memory in startup and refresh can be configured
by setting the following option in the <installdir>/sas/
.customer.environment-variables file:
JAVA_OPTS="$JAVA_OPTS -Dbst_old_logic_init_count_in_memory=1"
The default value is 1. This option is used even if the value is larger than
bst_old_logic_max_count_in_memory.
3 Request Parameters
There are two request parameters that affect logic execution in Comptel Business
Service Tool: REQUEST_TRACE and IL_BYPASS_BST_LOGIC. For more information
about request parameters in general, see Comptel InstantLink customer
documentation.
Note This parameter is only used when resending a request from the Archive
Database. It can be used only in request API messages, extended API does not
support this parameter.
4 Directory Structure
All directory names listed in this chapter are relative to the installation directory
<installdir> defined during the installation.
Table 2 shows the structure of the directories used by Comptel Business Service Tool.
The log files are stored in the same directory as Comptel InstantLink log files. The
location is defined in Comptel InstantLink by the GRC parameter log_dir in the
common section. The default location after the installation of Comptel InstantLink is
<installdir>/sas/logdir/logs.
Comptel InstantLink cleans Comptel Business Service Tool log files automatically.
For information about how to set cleaning scripts to crontab in UNIX to clean log
files, see Comptel InstantLink Operation and Maintenance Guide.
The log file names include the component about which the log information is written,
the date when the log file was created and the sequence number within that day
starting from 0. Some of the log information is also available in the Comptel
InstantLink UI.
Note In addition to the log files, browser Java Console provides log information
about Business Service Tool Logic Editor during the user’s browser session.
For more information, see your browser documentation.
A new log file is created at midnight every night. The sequence number increases
within one day; a new log file is also created every time the Comptel InstantLink
system is started, each time the configuration is refreshed or the file size reaches its
maximum limit.
No logging levels are used with the configuration audit log files. Configuration audit
log cannot be turned off.
Note Logging levels providing detailed information take a lot of disk space, which
affects the performance of Comptel Business Service Tool. Additionally, if the
disk in which the log files reside is full, Comptel Business Service Tool does
not start. Use logging level WARNING for normal production use and logging
level INFO if you have plenty of free disk space and you need more detailed
information. Use logging level ALL only temporarily for troubleshooting
purposes.
A logging level includes all lower logging levels. For example, the logging level
INFO also includes logging levels WARNING and SEVERE.
Note The Log step writes an entry to the Business Service Tool Engine log file only
if the value of the diag_level GRC parameter is INFO or ALL.
6 File Cleaning
Comptel InstantLink cleans Comptel Business Service Tool log files automatically.
However, by default, request trace data and backup provisioning logics are not
cleaned automatically. This chapter describes how to schedule files to be deleted
regularly to free disk space in a development environment. In addition, some files
must be deleted manually.
You can schedule automatic trace data cleaning by using UNIX crontab.
7 Memory Configuration
Comptel Business Service Tool runs in the same process as InstantLink Service
Module Engine. Therefore, if the provisioning logic is large or several provisioning
logics are active at the same time, you must increase the memory allocation for
InstantLink Service Module Engine. For information on changing the memory
allocation by editing the start_ServiceModuleEngine.ksh file, see Section
7.2 Configuring InstantLink Service Module Engine Memory Usage.
When working with large provisioning logics, saving or loading a logic may fail if the
workstation memory settings are not adequate. For information on changing the
workstation memory allocation using Java Control Panel, see Section 7.3 Configuring
Workstation Memory Usage.
If several users must access the Comptel Business Service Logic Editor at the same
time, for example in a training or development host, more memory has to be reserved
for the UI. For information on changing the UI memory allocation by editing the
tomcat_control file, see Section 7.5 Configuring UI Server Memory Usage.
When editing a large provisioning logic by standalone Logic Editor, you may have to
increase the heap size. For information on changing the MAX_HEAP parameter for
standalone Logic Editor by editing the bst_standalone.jnlp file, see Section
7.7 Configuring Standalone Logic Editor Memory Usage.
The maximum heap sizes for Request Processing Engine, Service Module Engine,
Task Engine and Network Model are configured using the MAX_HEAP parameter in
the beginning of startup scripts start_ServiceModuleEngine.ksh,
start_TaskEngine.ksh and start_NetworkModel.ksh. These files are
located in the <installdir>/sas/bin directory.
The MAX_HEAP parameter specifies that InstantLink Service Module Engine can use
up to 1024 MB of memory for heap. In practice, this means that the InstantLink
process can grow to be larger than 1 GB.
To change the maximum heap size of Service Module Engine, edit the
start_ServiceModuleEngine.ksh file
cd <installdir>/sas/bin
5. Change the maximum allowed heap size defined with the parameter
MAX_HEAP as follows:
#!/bin/ksh
SASBASE=/comptel/ilink/sas
. $SASBASE/.profile
MODULE_NAME=$1
JMX_PORT=$2
JMX_OPTS="-Djavax.net.ssl.trustStore=$SASBASE/config/
client.ts -Djavax.net.ssl.keyStore=$SASPATH/sas/
.keystore -Djavax.net.ssl.keyStorePasswor
d=instantlink -
Djavax.net.ssl.trustStorePassword=instantlink -
Dcom.sun.management.jmxremote.ssl=true -
Dcom.sun.management.jmxremote.authentica
te=false -Dcom.sun.management.jmxremote.port=$JMX_PORT"
By default, the Business Service Tool user interface is allowed to use max 64MB of
heap. If the provisioning logic is very large, this is not enough and the Business
Service Tool user interface becomes slow. To speed it up, increase the heap size in the
Java Control Panel.
2. Click Programs.
5. In the Java tab, click View... The Java Runtime Environment Settings
dialog box opens.
6. In the Java Runtime Environment Settings dialog box, set the maximum
heap to appropriate size by typing new values in the Runtime Parameters
column (User tab, Java 1.7 row), for example:
-Xmx512m -Djavaplugin.maxHeapSize=512m
By default, the Business Service Tool user interface uses the default connection
timeout value of 300 seconds (300000 milliseconds). A large provisioning logic may
require more time when it is opened or saved. To keep the connection open for a
longer period of time, define the timeout values in the Java Control Panel. These
settings apply also when viewing Business Service Tool traces.
2. In Control Panel, to open the Java Control Panel, double-click the Java icon.
When editing a large provisioning logic in your development or test environment, you
may have to increase the heap size. For example, if opening a large logic always fails,
the UI may be out of heap.
cd <installdir>/sas/bin
4. Change the following line at the top of the tomcat_control file and save
the file:
MAX_HEAP="256m"
. <installdir>/sas/.profile
ctl_control stop
ctl_control start
1. Go to <installdir>/sas/ui/webapps/bst.
4. Change the maximum read timeout and connection timeout values, for
example:
<resources>
<j2se version="1.8+" initial-heap-size="256m"
max-heap-size="512m" java-vm-args="
-Djnlp.read_timeout=300000
-Djnlp.connect_timeout=300000"/>
For the changes to take effect, you must uninstall standalone Logic Editor and then
reinstall the new version from the Comptel InstantLink UI pages. For instructions on
uninstallation and reinstallation, see Section 7.7 Configuring Standalone Logic Editor
Memory Usage.
For more information on standalone Logic Editor, see Comptel Business Service Tool
Online Help.
To change the maximum heap size of standalone Logic Editor, edit the
bst_standalone.jnlp file
cd <installdir>/sas/ui/webapps/bst
<resources>
For the changes to take effect, you must uninstall standalone Logic Editor and then
reinstall the new version from the Comptel InstantLink UI pages.
2. Click Programs.
5. On the General tab, in the Temporary Internet Files section, click View...
The Java Cache Viewer dialog box opens.
7. On the Title row, click the standalone version you want to delete. On top of
the dialog box, click the Remove selected items icon.
The standalone Logic Editor is now removed. The BST.properties file and
the online help are not removed, because all standalone BSTs use the same
BST.properties file and online help. In addition, the provisioning logics
are not removed.
2. In the Comptel InstantLink UI main menu, click the BST menu item. A
submenu opens on the left side of the working area.
3. On the submenu, click the Standalone submenu item. The Standalone page
opens.
4. On the Standalone page, click the Install button. The Create shortcut dialog
box opens.
After the installation is complete, your desktop has a new BST shortcut. You
can open the standalone version by double-clicking the shortcut.
For more information on standalone Logic Editor, see Comptel Business Service Tool
Online Help.
You can also transfer logics from one environment to another with the upload and
download tool in Business Service Tool Logic Editor. Provisioning logics and logic
rules can also be uploaded and downloaded in the Comptel InstantLink UI. For more
information, see Comptel Business Service Tool Online Help.
The provisioning logic is stored in a JAR file. The saved provisioning logics are
named as follows: <name>_<date_time>.jar, for example,
TestLogic_20141014_130040.jar.
a) when the two environments are on the same host by using the
following UNIX commands:
cd <installdir2>/sas
. .profile
bst_admin.ksh --insert-logic /tmp/
TestLogic_20141014_130040.jar
cd /tmp
ftp target_host_name
Name (target_host_name:user):<user_name>
Password:<password>
ftp> bin
ftp> cd /tmp
ftp> put TestLogic_20141014_130040.jar
ftp> bye
ssh target_host_name
cd <installdir2>/sas
. .profile
Comptel Business Service Tool comes with command line tool bst_admin.ksh
located in the <installdir>/sas/bin directory. It covers most of the
functionality available in the user interface.
The following sections define the usage and options of the bst_admin.ksh script.
All script options have a long (human readable) name and a shorter alias. Their
functionality is identical. The long options always start with two hyphens, for
example bst_admin.ksh --list-logic-versions, and the short version
always starts with one hyphen, for example, bst_admin.ksh -lv.
bst_admin.ksh --list-logic-versions
catalog_driven_generic_logic_20140707_145140.jar
default_logic_20141014_130407.jar
Provisioning_logic_example_20080603_150000.jar
Provisioning_logic_example_20140929_155922.jar
Provisioning_logic_template_20080603_150000.jar
Replace_Ericsson_EMA_20120203_125403.jar
bst_admin.ksh --get-logic
Provisioning_logic_example_20080603_150000.jar /tmp
bst_admin.ksh --delete-logic-version
Provisioning_logic_example_20080603_150000.jar
The current working set consists of current versions of logic rules, provisioning logics
and library logics. The current set is taken into use with Apply configuration
changes on the System Status page in the Comptel InstantLink user interface or with
the bst_admin.ksh and ctl_control scripts.
For listing the active set or current working set, the bst_admin.ksh script has the
following options:
bst_admin.ksh --list-active-set
Currently active rules:
Provisioning_logic_example_20140929_155922;equals "$NE_TYPE"
"BST";
Logic_library_example_20141014_130915;equals "$NE_TYPE" "HLR"
and substr "$IL_REQ_GROUP" "LIB";
default_logic_20141014_130407;;
Currently active libraries:
Check_mandatory_parameters_example_20141014_130751;;
bst_admin.ksh --activate-logic
Provisioning_logic_example_20140929_155922.jar
9.8 Downloading Active Logic Set and Uploading New Working Set
Downloading the whole active logic set is useful especially when transferring from
one environment to another. The logic set is packed as a .zip file for easy transfer.
Uploading to a target environment adds all the provisioning logics, library logics and
logic rules to the working set so that it is possible to make modifications before taking
the new working set into use.
bst_admin.ksh --activate-current-set
After the command has been run, the active set is replaced with working set. To make
the BST Engine read the new active set, activate the changes with the following
command:
ctl_control reconfig
The changed active set is read by the BST Engine and new requests start using the
new configuration.
The following table describes the export trace option for the bst_admin.ksh script:
bst_admin.ksh --export-trace 1
This command exports the trace for the request with request ID 1.
trace_1
trace_1_1
trace_1_2
You can also create provisioning logic report in Comptel InstantLink UI by selecting
the BST menu item and in the Logic Versions page selecting Report icon next to a
provisioning logic version. For more information, see Comptel InstantLink Online
Help.
cd <installdir>/sas/bst/bin
./create_logic_report.ksh
Example:
default_logic_20141014_130407.jar
11 Comparing Logics
You can compare differences between two Comptel Business Service Tool logics with
compare_logics.ksh script. The script is located in the <installdir>/sas/
bst/bin/ directory.
Before comparison, the logics must be downloaded from the database to the file
system with the bst_admin.ksh --get-logic command. For more information,
see Section 9.2 Downloading Provisioning Logics and Library Logics to File System.
The following table lists the command line parameters for the compare_logics
.ksh script.
cd comptel/ilink/sas/bst/bin/
Example:
compare_report_08102014_132502.log
compare_report_02102014_132621.html
For more information on how to compare logics, see Comptel InstantLink Online
Help.
This script handles only the NumberRange step and does not have an impact on other
parameters.
2. List the different number ranges in the logic, by entering the following
command:
The new logic is created with current time stamp to the same directory where
the original one resides and the number range file is imported to the number
range step.
Before the number range is imported to the step, a sanity check is performed. The
check includes the following:
NumberRange step type (numeric or alphanumeric) is read from the step. This affects
the sanity checks done to the ranges. The start and end value are compared using a
lexicographic algorithm when they are alphanumeric values. Otherwise a normal
numerical comparison is done. In numeric step type only numerical values are
allowed and in alphanumeric also alphabets and punctuation are relevant.
<range_min_value>|<range_max_value>|<network_element_type>|<pa
rameter_name>|<parameter_value>
The following table lists the Number Range text file parameters.
Example:
358501000000|358501009999|HLR|NE_ID|hlr1
358501010000|358501019999|HLR|NE_ID|hlr2
If more parameters are mapped against a number range, the format of the file is the
following:
<range_min_value>|<range_max_value>|<network_element_type>[|<parameter_name
_1>|<parameter_value_1>|<parameter_name_2>|<parameter_value_2>...|<parameter
_name_n>|<parameter_value_n>]
Example:
358501000000|358501009999|HLR|NE_ID|hlr1|BASIC1|T11
358501010000|358501019999|HLR|NE_ID|hlr2|SUPP_CODES|291001293001|BACKUP_NE|h
lr2_backup
The script can also be used to transfer lookup tables between two Comptel Business
Service Tool environments. The source and target Comptel Business Service Tool
software versions must be the same. Each task is logged into <installdir>/sas/
logdir/logs/lookup_table_converter_<timestamp>_<seq>.log file.
Check it before applying the configuration changes.
You can also transfer lookup tables from one environment to another using the
Download Lookup Tables and Upload Lookup Tables submenu links in the
Comptel InstantLink UI Maintenance page. For more information, see Comptel
InstantLink Online Help.
1. Log in to the UNIX host using the same UNIX group ID and user ID as in
Comptel InstantLink.
<installdir>/sas/bst/bin/store_lookup_files_to_db.ksh -
list
As a result all the lookup table names on the system are listed on the screen.
1. Log in to the UNIX host using the same UNIX group ID and user ID as in
Comptel InstantLink.
<installdir>/sas/bst/bin/store_lookup_files_to_db.ksh -
delete <table_list>
Example:
/comptel/ilink/sas/bst/bin/store_lookup_files_to_db.ksh
-delete table1,table2,table3
As a result the listed lookup tables are permanently deleted from the system.
If you want to delete all lookup tables at once, execute the following
command:
<installdir>/sas/bst/bin/store_lookup_files_to_db.ksh -
delete -all
As a result all lookup tables are permanently deleted from the system.
1. Log in to the UNIX host using the same UNIX group ID and user ID as in
Comptel InstantLink.
2. Download the lookup tables to the zip file with the following command:
<installdir>/sas/bst/bin/store_lookup_files_to_db.k
sh -download <file_name> <directory>
Example:
/comptel/ilink/sas/bst/store_lookup_files_to_db.k
sh -download lookup_tables_20150802.zip /comptel/ilink/
temp
As a result the zip file including all the lookup tables is created to the
temporary directory.
1. Log in to the UNIX host using the same UNIX group ID and user ID as in
Comptel InstantLink.
<installdir>/sas/bst/bin/store_lookup_files_to_db.ksh
[<option> <file_name>] <directory>
If <option> is omitted, all the files in the given directory are treated as
lookup table files and tried to be uploaded one by one.
Example:
/comptel/ilink/sas/bst/store_lookup_files_to_db.ksh
-upload lookup_tables_20150802.zip /comptel/ilink/temp
With the upload option, the following error messages are shown if the
uploaded lookup table already exists in the target system:
3. Perform Comptel InstantLink system refresh to activate the lookup table data
for the BST LookUp step.
Additionally, starting from InstantLink Business Service Tool version 3.1, the rules
for evaluating regular expression syntax have slightly changed and may require
manual changes to the RegEx steps, see Chapter 15 Regular Expression Syntax in the
EdifactParser and RegExp Steps.
If you want to upgrade provisioning logics created with releases 2.1.2, 3.0, 3.0.1, 3.1,
3.1.1 or 3.2 you need to upgrade them with the update_logics.ksh script.
Reporting options:
-report
Creates a report of the possible problem situations with the provisioning logic. An
InstantLink Business Service Tool 3.x logic will not be upgraded when this
option is used. An InstantLink Business Service Tool 2 logic is always converted to a
logic jar file and the Tracer IDs are given to the logic units even if this option is used.
The report is created in a file named logic_migration.log to the current
directory.
When upgrading a logic, it is recommended to first run the script with the -report
option to avoid breaking the provisioning logic. Make the changes manually if you
decide to perform the suggested changes to the provisioning logic.
Mandatory options:
-add_ids
Adds Tracer IDs to the provisioning logic's units. This option is needed when
upgrading from InstantLink Business Service Tool 3.0.x to InstantLink Business
Service Tool 3.1.x and newer. This is the only mandatory option needed when
upgrading version 3.0.x logics. When converting an InstantLink Business Service
Tool 2.1.2 logic to new format with the upgrade script, the IDs are added
automatically.
-combine_log_steps
Converts the LogValue, Print and Debug steps to the new Log step. The old steps
have been removed since InstantLink Business Service Tool 4 and all old logics have
to be updated using this option. (This option is not needed if the logic has no
LogValue, Print or Debug steps. You can use the -report option to check if there are
any of these steps in the logic.)
-edifact_update
If the Edifact step is used in the logic, the Edifact step's parameters are updated.
-check_element_names
Checks, that the method names and step names do not include other characters than
letters (a-z), numbers (0-9) and underscores. In case other characters exists, they are
changed to underscore. Checks and renames steps that cause problem when using
Standalone Logic Editor. If the logic has steps, for example, with names IfEqual
and ifequal, the script changes one of the step names to ifequal_renamed_n ,
where n is a number.
Optional options:
-mandatory_updates
-n new_logic_name
Gives a new name for the upgraded provisioning logic. This option can be used when
converting an InstantLink Business Service Tool 2.1.2 logic to version 4 format. If a
provisioning logic name is not given, the InstantLink Business Service Tool 2.1.2
logic will be named 'converted_logic' and the InstantLink Business Service Tool 3
logic will use the original logic name. The logic name must not contain any special
characters other than underscore.
-d "description"
Gives a new description for the logic. This can be used when converting InstantLink
Business Service Tool 2.1.2 logic which did not have description information. If a
logic name is not given, InstantLink Business Service Tool 2.1.2 logic will have the
description 'This logic has been converted from BST2 to BSTx.y.' whereas a
InstantLink Business Service Tool 3 logic will use the original logic description.
-add_brackets
-l log_dir
-remove_needless_params
-percent_to_dollar
Updates the old InstantLink Business Service Tool 2.1.2 and 3.0 percent notation
(%PARAM) to the dollar notation ($PARAM).
Background:
In the old versions of InstantLink Business Service Tool, the percent sign could be
used instead of the dollar denoting a parameter mapping. InstantLink Business
Service Tool 3.1 and newer versions do not support this notation. Therefore, a
provisioning logic using this notation style has to be upgraded to keep the
provisioning logic functional.
1. the MapParameters step has two parameters that use the percent sign as a wild
card. REMOVE_BEFORE_LIST and REMOVE_AFTER_LIST both use the
percent notation (%) to represent "any sequence of characters". The upgrade
script does not change this kind of usage of the percent sign.
2. Sometimes the user needs to be able to use the percent character in a value or
name of a parameter. The upgrade script does not change percent characters in
parameter names or values if they do not seem to be parameter mappings.
-all
-?
or alternatively
-help
Example 1:
This example shows how the user can check which changes the update_logic.ksh
script would make to the logic with the given options, without doing the actual
upgrade. The command produces a report on the suggested changes:
update_logic.ksh /comptel/ilink/backup/config-version-499
-report -add_ids
Example 2:
This example shows how a provisioning logic created with InstantLink Business
Service Tool 2 can be upgraded. The following creates a jar file with Tracer IDs, a
graphical logic flow presentation and upgraded step definitions:
update_logic.ksh /comptel/ilink/backup/config-version-123 -n
PHASE_34 -mandatory_updates
Example 3:
This is an example of a situation where the user has already run the script with the
-report option and has decided to make the changes to the provisioning logic. The
example shows how a provisioning logic created with InstantLink Business Service
Tool 2 can be upgraded. After the script is run, a jar file named
new_logic_name_<timestamp>.jar with Tracer ID is created, square brackets
are added and needless parameters deleted. In addition, the tooltip for the logic is My
new description on the Logic Versions page:
update_logic.ksh /comptel/ilink/sas/bst/xml/config-version-123
-n new_logic_name -d “My new description” -mandatory_updates
–add_brackets –remove_needless_params
Example 4:
This example shows how to upgrade a provisioning logic created with InstantLink
Business Service Tool 3.0 or 3.0.1:
The update creates a new jar file with a recent date information. The original jar file is
intact.
Example 5:
You can also use the upgrade script for renaming a provisioning logic. In the example,
a logic named AUTOSAVE_Administrator_MyLogic.jar is renamed to
MyNewLogic_<timestamp>.jar
update_logic.ksh /comptel/ilink/sas/bst/logics/versions/AUTOSA
VE_Administrator_MyLogic.jar -n MyNewLogic
The script lists the switch step information for Value and Default value fields that
contain incorrect values. The script checks the logics under the given input directory
and prints all the parameters in a switch step that have commas with specific rules.
The printing format is the following:
cd <installdir>/sas/bin
ameters_with_comma 2>/dev/null
The following example (with one parameter including commas) describes the
output of the script:
/tmp/test_logic_20141014_145544.jar:xml/
Switch_1.xml:DEFAULT__TEST=1,201
To make sure that the logic works properly, check the parameters listed in the output
from Business Service Tool Logic Editor.
The regular expression syntax used in the EdifactParser step and RegExp step has
been changed to follow the Java API specification. The new definition is more strict
and may require changes to the provisioning logic. In earlier Comptel Business
Service Tool versions it was possible to use the regular expression ^XSU to refer to a
string starting with XSU. Starting from InstantLink Business Service Tool 3.1, the
correct regular expression is ^XSU.*. Therefore, when upgrading provisioning logics
that were done with InstantLink Business Service Tool releases 3.0.1 or earlier, check
whether the provisioning logic contains RegExp steps.
1. In the Comptel InstantLink UI main menu, click the BST menu item. The
BST pages open.
2. In the Logic Versions page, locate the BST logic to be verified and click the
Edit icon.
The logic opens in a separate window in Business Service Tool Logic Editor.
3. In the Steps list identify steps with RegExp Icon (blue icon with symbol RE*).
4. Right click the step name and select step instance from the list. The RegExp
step details window opens.
5. In the RegExp parameters area check the Regular expressions. If the regular
expressions matches the beginning of the string consider adding ".*" to the
end of the expressions (* stands for any character occurring zero or more
times).
For a full description on the regular expression syntax, see Java documentation.
16 Troubleshooting
After upgrading to the latest release, you may experience problems with logic
loading.
The following sections present three error messages and solutions to the error
situations.
The logic contains steps that use ‘All output parameters to pool’ option
even though the GRC parameter ‘all_output_parameters_support’ is set to
NO.
The error occurred because the All output parameters to pool check box in the
Output parameters section in the Step Details window was used to add all output
parameters to the current method’s parameter pool in Comptel Business Service Tool
releases prior to 3.1. In the current release, this is a time-consuming and unnecessary
operation in steps because Comptel Business Service Tool automatically generates
and returns the necessary parameters to the parameter pool.
This means that if you have provisioning logics that have been made with an older
Comptel Business Service Tool version and that use the All output parameters to
pool check box, it is recommended to edit the logics so that the check box is cleared.
Alternatively, you can turn the All output parameters to pool functionality back on
with a GRC parameter called all_output_parameters_support, which is
included for backward compatibility. The value of this parameter is NO by default. It
is highly recommended to use the default value NO, because it will significantly
increase performance.
1. After loading has failed and you have received the error message, check in the
Java Console, which steps use the check box.
If you are using MS Internet Explorer, in the main menu, select Tools and Sun
Java Console. The Java Console opens. Check the last line in the console log.
The message detailing the steps to be changed looks the following:
3. Modify the provisioning logic so that the check box is no longer needed in the
steps where it was used. All control parameters (parameters generated by the
step itself) are automatically entered into the parameter pool. However, if you
have made additional parameter mappings and you want them to go to the
parameter pool, list them in Add to parent pool in the Output parameters
section.
4. Change the value of the parameter back to NO. This ensures optimal
performance of Comptel Business Service Tool.
Note that the All output parameters to pool check box is always shown in the
Method windows’s method details so that all output parameters of a method can be
added to the parent method’s pool. An exception is the main_method, which has no
output parameters at all and the check box is therefore not required there.
The logic contains steps that have the ‘Overwrite’ option for a parameter set on
even though the GRC parameter ‘overwrite_support’ is set to NO.
The check box was removed for clarity and improved performance. Currently all
control parameters (parameters generated by the step itself) are entered into the
parameter pool even if a parameter with the same name is already in the pool. The
parameter with the same name is overwritten.
In the current release, the (O) Overwrite check box is not shown in the UI by default
after installing Comptel Business Service Tool Release 9.0.
This means that if you have provisioning logics that have been made with an older
Comptel Business Service Tool version and use the (O) Overwrite check box, it is
recommended to edit the logics so that the check box is cleared.
Alternatively, you can turn the overwrite functionality back on with a GRC
parameter called overwrite_support, which is included for backward
compatibility. The value of this parameter is NO by default. It is highly recommended
to use the default value NO, because it will significantly increase performance.
1. After loading has failed and you have received the error message, check in the
Java Console, which steps use the check box.
3. Modify the provisioning logic so that the check box is no longer needed in the
steps where it was used.
If the check box was used in a Switch step, you need to save the logic with
Save as to remove the check box in the Switch step.
4. Change the value of the parameter back to NO. This ensures optimal
performance of Comptel Business Service Tool.
Could not load logic <name of the logic>, there are two possible reasons for it:
1. Your workstation has run out of memory. To increase heap size, see Chapter
7 Memory Configuration.
2. Your logic has not been upgraded with the update_logic.ksh script. For
more information, see Chapter 14 Upgrading Old Provisioning Logics.
3. You have not updated BST Standalone Logic Editor. Delete the old
Standalone Logic Editor via Java Control Panel and install the new version
from Comptel InstantLink UI.
If you get an error message saying Could not load logic <name of the logic> Error
message: Loading of logic failed and an exception was thrown: Could not load
logic: null, there are three possible reasons for it:
1. Your user interface has run out of memory. To increase the UI heap size, see
Chapter 7 Memory Configuration.
2. Your logic uses a Debug, Print or LogValue step and you have not upgraded
the logic with the update_logic.ksh script with the
combine_log_steps option. For more information, see Chapter
14 Upgrading Old Provisioning Logics.
3. Comptel Business Service Tool Logic Editor does not open. The Business
Service Tool Logic Editor does not open when you click the Edit icon on the
Logic Versions page. There are three possible reasons for this:
• If nothing happens when you click the Edit icon, the popup blocker in
your Internet browser may be turned on. Configure you popup blocker to
allow opening the Business Service Tool user interface.
• If a blank page opens when you click the Edit icon, Java Plug-in for the
web browser is either not installed or has been corrupted. To verify that
Java Plug-in is installed in Internet Explorer, choose Tools and Internet
Options. On the Internet Options page, click the Advanced tab. Scroll
down the list to section Java (Sun). If java JRE is installed but the
Network Layout page remains still blank, it is recommended to re-install
Java.
• If the Business Service Tool user interface opens normally and you see the
Loading Logic dialog box when you click the Edit icon, but the loading
is interrupted, the logic has not been upgraded or the user interface is out
of memory.