0% found this document useful (1 vote)
570 views

Comptel Business Service Tool™: Reference Manual

Uploaded by

IvanIvanov
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (1 vote)
570 views

Comptel Business Service Tool™: Reference Manual

Uploaded by

IvanIvanov
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 58

Release 9.

Comptel Business Service Tool™

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.

© 2016 Comptel Corporation,


Salmisaarenaukio 1, FI-00180 Helsinki, Finland
No part of this document may be reproduced, translated, or transmitted in any form or by any means, electronic or mechanical, for any
purpose without the express written permission of Comptel Corporation, and then only on the condition that this notice is included in any
such reproduction. No information as to the contents of this document may be communicated to any third party without the prior written
consent of Comptel Corporation.

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.

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ ii
Release 9.0
Reference Manual
Joint Confidential

1 About This Document 1


1.1 Audience 1

1.2 Terms and Concepts 1

1.2.1 Abbreviations 1

1.2.2 Terminology 2

1.3 Related Documentation 2

2 GRC Parameters 3
2.1 GRC Parameters in Detail 3

2.1.1 all_output_parameters_support and overwrite_support Parameters 7

2.1.2 use_sas3_task_status_values Parameter 8

2.1.3 old_logic_support Parameter 9

2.2 Importing and Exporting GRC Parameters 10

3 Request Parameters 11
3.1 REQUEST_TRACE Request Parameter 11

3.2 IL_BYPASS_BST_LOGIC Request Parameter 11

4 Directory Structure 13

5 System Log Files 15


5.1 Log Files 15

5.2 Logging Level Values 16

6 File Cleaning 18
6.1 Cleaning Request Trace Data 18

6.2 Manual Cleaning of Files Created on Workstation 18

7 Memory Configuration 19
7.1 Memory Consumption 20

7.2 Configuring InstantLink Service Module Engine Memory Usage 20

7.3 Configuring Workstation Memory Usage 22

7.4 Configuring Workstation Timeout Usage 23

7.5 Configuring UI Server Memory Usage 24

7.6 Configuring Standalone Logic Editor Timeout Usage 24

7.7 Configuring Standalone Logic Editor Memory Usage 25

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ iii
Release 9.0
Reference Manual
Joint Confidential

8 Provisioning Logic Transfer 28

9 Managing Provisioning Logics from Command Line 30


9.1 Listing Provisioning Logics and Library Logics 30

9.2 Downloading Provisioning Logics and Library Logics to File System 31

9.3 Inserting Provisioning Logics and Library Logics to Database 31

9.4 Deleting Provisioning Logics and Library Logics 32

9.5 Listing Active Logic Set and Current Working Set 32

9.6 Activating and Deactivating Provisioning Logics and Library Logics 33

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

9.9 Activating Changes 34

9.10 Exporting BST Trace 35

10 Provisioning Logic Report 36

11 Comparing Logics 37

12 Number Range Import and Export from Command Line 39


12.1 Syntax of Number Range Text File 40

13 Managing Lookup Tables from Command Line 42


13.1 Listing Lookup Tables 42

13.2 Deleting Lookup Tables 42

13.3 Downloading Lookup Tables 43

13.4 Uploading Lookup Tables 43

14 Upgrading Old Provisioning Logics 45


14.1 Checking Switch Step Parameter Values 49

15 Regular Expression Syntax in the EdifactParser and RegExp Steps 50

16 Troubleshooting 51
16.1 All Output Parameters to Pool Check Box 51

16.2 Overwrite Check Box 52

16.3 Loading a Logic Failed 53

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 1
Release 9.0
Reference Manual
Joint Confidential

1 About This Document


This document provides technical reference information about Comptel Business
Service Tool, an add-on module of Comptel InstantLink.

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 Terms and Concepts


The following abbreviations, terms and concepts are used in the document:

1.2.1 Abbreviations
BST Business Service Tool
GRC Global Resource Configuration
OSS/BSS Operations and Business Support System
UI User Interface

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 2
Release 9.0
Reference Manual
Joint Confidential

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.

1.3 Related Documentation


The following documents provide more information about Comptel Business Service
Tool:
• Comptel Business Service Tool Release Notes
• Comptel Business Service Tool Functional Description
• Comptel Business Service Tool Online Help
• Comptel Business Service Tool User’s Guide (includes the same information as
the Online Help
• Comptel Provisioning and Activation Installation Guide

For more information about Comptel InstantLink, see the Comptel InstantLink
documentation.

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 3
Release 9.0
Reference Manual
Joint Confidential

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.

2.1 GRC Parameters in Detail


The following table lists the parameters that affect Comptel Business Service Tool.
These parameters are located in the Comptel Business Service Tool GRC section.

Table 1. Parameters in the Comptel Business Service Tool GRC section


GRC parameter name Technical name Description
Auto save interval of BST auto_save_interval Defines the autosave interval of the
logic provisioning logic in the Comptel
Business Service Tool Logic Editor.
Parameter value has to be given in full
minutes.
Possible values:
• 0 (autosave is off)
• 1 - n
Default value: 15 (autosave interval
is 15 minutes)
If the provisioning logic is large,
increase the default autosave interval
to 30 or more.
Bypass BST Engine bypass_expiration_mecha Enables the user to override the entire
expiration mechanism nism Comptel Business Service Tool request
expiration mechanism and transfer
control to the provisioning logic. This
parameter gives flexibility to handle
different expiration situations in the
logic.
Bypassing the expiration should be
avoided, because then the logic has full
responsibility of detecting expiration
situations. When the parameter is set to
YES, the request never expires in
Comptel Business Service Tool.
Possible values:
• YES
• NO
Default value: NO

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 4
Release 9.0
Reference Manual
Joint Confidential

Table 1. Parameters in the Comptel Business Service Tool GRC section


GRC parameter name Technical name Description
Maximum depth for nested nesting_limit Maximum number of methods that can
methods be invoked from each other (to prevent
endless recursion).
Value range: 2-99
Default value: 15
Request trace level request_trace Defines the request trace level for all
requests. The request trace information
is used in BST Tracer and the
Coverage Analysis UI. For more
information, see Comptel Business
Service Tool Online Help.
Do not turn the GRC parameter on in
the production environment, because it
slows down request processing
considerably.
You can override the request trace
level for one single request in the
production environment without
turning the GRC parameter on for all
requests. For more information, see
Section 3.1 REQUEST_TRACE
Request Parameter.
Possible values:
• NONE = no trace data is written
(recommended for production)
• EXECUTION_PATH = the whole
request execution trace and the
control parameters of each step
and method are recorded
• EVERYTHING = the whole request
execution trace with pool content
before and after each unit are
recorded
• MIXED = the parameter pool
contents are written to the trace by
changing the REQUEST_TRACE
parameter value during logic
execution. When the value is
EVERYTHING, the parameter pool
content is written to the trace,
otherwise only the execution path
gets written. Mixed mode is useful
when testing large BST workflows
that would generate a large trace
file (> 10 MB) with trace level
EVERYTHING.
Default value: NONE

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 5
Release 9.0
Reference Manual
Joint Confidential

Table 1. Parameters in the Comptel Business Service Tool GRC section


GRC parameter name Technical name Description
Request expiration trigger request_expiration_trig Parameters that start with the prefix
ger @NEW@ or @REQ@ can be copied from
the pool to the response. This
parameter is used only if a request has
expired in Comptel Business Service
Tool.
Possible values:
• 0 = nothing is copied.
• 1 = only parameters starting with
the prefix @NEW@ are copied.
• 2 = only parameters starting with
the prefix @REQ@ are copied.
• 3 = parameters starting with either
the prefix @NEW@ and @REQ@ are
copied.
Default value: 0
Use old logics with old old_logic_support Defines whether previously active
requests logics are used to process requests.
When the default value NO is used,
requests are processed with the
currently active logics.
For more information about the
parameter, see Section
2.1.3 old_logic_support
Parameter.
Possible values:
• NO
• YES
Default value: NO
Use SAS3 task status values use_sas3_task_status_va Functionality is included for
lues backward compatibility.
Defines whether MDS/SAS 3 task
status values are used.
For more information about the
parameter, see Section
2.1.2 use_sas3_task_status
_values Parameter
Possible values:
• YES
• NO
Default value: NO

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 6
Release 9.0
Reference Manual
Joint Confidential

Table 1. Parameters in the Comptel Business Service Tool GRC section


GRC parameter name Technical name Description
Diagnostic level for BST diag_level Defines the level of detail of the
logging information written to the
BST_SME<n>_<date>_<number>.l
og file about Comptel Business
Service Tool Engine.
For more information, see Section
5.2 Logging Level Values.
Default value: WARNING
Diagnostic level for BST UI diag_level_ui Defines the level of detail of the
server logging information written to the
BST_UI_<date>_<seqno>.log file
and Java Console about the Business
Service Tool Logic Editor, Lookup
Table Editor and Number Range
Editor.
For more information, see Section
5.2 Logging Level Values.
Default value: WARNING
Enable All output all_output_parameters_ For backward compatibility.
parameters to pool support Defines whether the All output
functionality parameters to pool check box is
available in the Step Details window.
For more information, see Section
2.1.1 all_output_parameter
s_support and
overwrite_support
Parameters.
Possible values:
• YES
• NO (For performance reasons
value NO is recommended.)
Default value: NO

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 7
Release 9.0
Reference Manual
Joint Confidential

Table 1. Parameters in the Comptel Business Service Tool GRC section


GRC parameter name Technical name Description

Enable the overwrite overwrite_support For backward compatibility.


functionality Defines whether the overwrite check
box is available in the Step Details and
Method windows.
If the GRC parameter’s value is NO, the
check box is not available. All new
parameters are entered to the
parameter pool without checking if the
parameter already exists in the pool.
Any parameters with the same name
are overwritten.
If the value is YES, the check box is
available. When the check box is
selected, all new parameters are
entered to the pool without checking if
the parameter already exists in the
pool. Any parameters with the same
name are overwritten. However, if the
check box is cleared, the parameter is
not entered to the pool if a parameter
with the same name is already in the
pool.
For more information, see Section
2.1.1 all_output_parameter
s_support and
overwrite_support
Parameters.
Possible values:
• YES
• NO (highly recommended for
performance reasons)
Default value: NO
In addition, the common section includes the log_dir parameter, which defines the
directory where log files are written. The value can be defined with parameter
expansion, such as $(il_dir)/logdir/logs. Furthermore, this parameter also
specifies where the log files of Comptel InstantLink components are located.

2.1.1 all_output_parameters_support and overwrite_support Parameters


The all_output_parameters_support and overwrite_support parameters
are included for backward compatibility. Provisioning logics that were created with
earlier versions of Comptel Business Service Tool may contain ‘parameter overwrite’
or ‘all output parameters to pool’ definitions. When you try to open such a
provisioning logic in Business Service Tool Logic Editor with default GRC parameter
values, logic loading fails and you get an error message informing you about it.

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 8
Release 9.0
Reference Manual
Joint Confidential

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.

For more information on troubleshooting possible problems related to these


parameters, see Chapter 16 Troubleshooting.

2.1.2 use_sas3_task_status_values Parameter


The use_sas3_task_status_values parameter enables re-using the
provisioning logics created originally with MDS/SAS Business Service Tool 1.0. The
use_sas3_task_status_values parameter informs Comptel Business Service
Tool whether the task status values compatible with MDS/SAS 3 or Comptel
InstantLink are used in Comptel Business Service Tool.

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 1. Task status mapping from Comptel InstantLink to MDS/SAS 3 values

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 9
Release 9.0
Reference Manual
Joint Confidential

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.

Figure 2. Task status mapping from MDS/SAS 3 to Comptel InstantLink values

2.1.3 old_logic_support Parameter


The old logic support function guarantees that every request is correctly processed
with the provisioning logic that was active when Comptel InstantLink received the
request. The old logic support is used only if the GRC parameter
old_logic_support 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.

On the Active Logics page, you can view


• under Currently active logics, the provisioning logics that are active at the
moment. All new requests are processed with the currently active logic.
• under Previously active logics, the logics that used to be active. Requests that are
unfinished, timed to be processed at a later time or whose processing lasts long,
are run with the logic that was active when the request was received to Comptel
InstantLink.
The logics are listed on this page only if the GRC parameter old_logic_support
is set to YES. If old_logic_support is set from YES to NO, all requests are run
with the currently active logics, and the previously active provisioning logics are not
shown on the Active Logics page.

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 10
Release 9.0
Reference Manual
Joint Confidential

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 default value is 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.

2.2 Importing and Exporting GRC Parameters


The GRC parameters of Comptel Business Service Tool can be exported and
imported, for example, between a test and production environment using the Comptel
InstantLink import/export tool. For more information, see Comptel InstantLink
Online Help and Comptel InstantLink Operation and Maintenance Guide.

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 11
Release 9.0
Reference Manual
Joint Confidential

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.

3.1 REQUEST_TRACE Request Parameter


Parameter REQUEST_TRACE allows enabling and disabling request tracing for a
request. In test environment it is possible to enable request tracing for all request by
using GRC parameter request_trace. This is, however, not recommended in the
production environment because it slows down request processing considerably.
Instead, you can turn on request tracing in one single request in the production
environment by adding the request parameter REQUEST_TRACE in the request
message. The request parameter REQUEST_TRACE allows limited troubleshooting in
the production environment without compromising the overall performance.

The request parameter REQUEST_TRACE has the following possible values:


• EXECUTION_PATH = the whole request execution trace and the control
parameters of each step and method
• EVERYTHING = the whole request execution trace with pool content before and
after each unit
• MIXED = the parameter pool contents are written to the trace by changing the
REQUEST_TRACE parameter value during logic execution. When the value is
EVERYTHING, the parameter pool content is written to the trace, otherwise only
the execution path gets written. Mixed mode is useful when testing large BST
workflows that would generate a large trace file (> 10 MB) with trace level
EVERYTHING.
• NONE = no trace data is written

For more information on using GRC parameter request_trace, see Section


2.1 GRC Parameters in Detail.

3.2 IL_BYPASS_BST_LOGIC Request Parameter


The IL_BYPASS_BST_LOGIC request parameter can be used when you want to
bypass a provisioning logic, that is, not to send a request to Comptel Business Service
Tool. If you want to resend a task from the Archive Database, Comptel InstantLink
creates a new request with the task information and sends it directly to the network
element, not to be processed by the provisioning logic in Comptel Business Service
Tool.

The request parameter IL_BYPASS_BST_LOGIC has the following values:


• YES = request is not sent to Comptel Business Service Tool
• NO = request is sent to Comptel Business Service Tool

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 12
Release 9.0
Reference Manual
Joint Confidential

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.

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 13
Release 9.0
Reference Manual
Joint Confidential

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.

Table 2. Directory structure of Comptel Business Service Tool


Directory Description
<installdir>/sas/bst Home directory of Comptel Business Service Tool.
<installdir>/sas/bst/bin Contains script tools used in Comptel Business
Service Tool.
<installdir>/sas/bst/capabilities Obsolete.
<installdir>/sas/bst/extensions Contains configuration for, for example, BST
Interface for Subscriber Profile Repository and BST
Interface for Comptel Catalog steps which are not
part of the basic Comptel Business Service Tool
delivery.
<installdir>/sas/bst/logics/active Contains the active provisioning and library logics
and logic rules defined for them. The logics are in
subdirectories.
<installdir>/sas/bst/logics/old Obsolete.
<installdir>/sas/bst/logics/ The directory is used when the
old_logics_dir old_logic_support parameter is set to YES.
Contains the previously activated provisioning and
library logics.
For more information about the parameter, see
Section 2.1.3 old_logic_support
Parameter.
<installdir>/sas/bst/trace Contains request trace data files.
<installdir>/sas/data Contains example requests.
<installdir>/sas/lib Contains Comptel Business Service Tool class files.
<installdir>/sas/lib/steps Contains step files.
<installdir>/sas/reports Contains reports generated from the Comptel
InstantLink UI.
<installdir>/sas/sql Contains SQL scripts for creating Comptel
Business Service Tool specific database tables.
<installdir>/sas/ui/webapps/sas5/ Contains Business Service Tool Logic Editor pages.
plugins/bst
<installdir>/sas/ui/webapps/sas5/ Contains the Business Service Tool Logic Editor
conf/plugins properties file.
<installdir>/sas/ui/webapps/sas5/ Contains Business Service Tool Logic Editor files.
WEB-INF/lib
<installdir>/sas/ui/webapps/bst/WEB- Contains Business Service Tool Logic Editor files.
INF/lib
<installdir>/sas/ui/webapps/bst/ Contains applet files.
applets
<installdir>/sas/ui/webapps/bst/ Contains logic reports generated in Business
reports Service Tool Logic Editor.

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 14
Release 9.0
Reference Manual
Joint Confidential

Table 2. Directory structure of Comptel Business Service Tool (Continued)


Directory Description
C:\Documents and Settings\<Windows Contains the standalone configuration file
user ID>\BST BST.properties and provisioning logics saved in
the standalone UI. In addition, it contains
emergency and autosaves made in the standalone
and normal Business Service Tool Logic Editor.
C:\Documents and Settings\<Windows Contains the online help for all installed standalone
user ID>\BST\help UIs.

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 15
Release 9.0
Reference Manual
Joint Confidential

5 System Log Files


This chapter describes the contents and location of the Comptel Business Service
Tool log files.

5.1 Log Files


Comptel Business Service Tool log files contain detailed information about the
system’s operation.

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.

Table 3. Log information is available through UI and UNIX


Component Name of the log file in UNIX
Same log information
through Comptel
InstantLink UI
Business Service Tool Engine BST_SME<n>_<date>_<number Maintenance > System Status >
>.log Comptel Business Service Tool
Example: Log
BST_SME1_20131015_7.log
BST pages in Comptel UI_<date>_<seqno>.log Maintenance > System Status >
InstantLink UI User Interface Log
Configuration audit log BST_MA_<date>_<seqno>.log BST > Audit Trail
Business Service Tool Logic BST_UI_<date>_<seqno>.log –––––
Editor

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.

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 16
Release 9.0
Reference Manual
Joint Confidential

5.2 Logging Level Values


The GRC parameters diag_level and diag_level_ui in the GRC section bst
determine the amount of information written to the Comptel Business Service Tool
log files. The diag_level parameter writes information about Business Service
Tool Engine and the diag_level_ui parameter about the Business Service Tool
Logic Editor server, Number Range Editor and Lookup Table Editor.

The GRC parameter diag_level in the GRC section user_interface determines


the logging level for the BST pages in the Comptel InstantLink UI. The parameter
also affects the Comptel InstantLink UI. For more information, see Comptel
InstantLink Reference Manual.

No logging levels are used with the configuration audit log files. Configuration audit
log cannot be turned off.

Table 4 lists the available logging level values.

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.

Table 4. Logging level values


Logging level Description
ALL The log file provides information about all operations of
Comptel Business Service Tool.
INFO The log file provides information about the high level
activities (top-level use cases) within the application. For
example:
• refreshing system parameters
• messages logged from a step

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 17
Release 9.0
Reference Manual
Joint Confidential

Table 4. Logging level values (Continued)


Logging level Description
WARNING The log file provides information about minor errors that do
not stop the application, for example, when:
• an error happens while executing provisioning logic for a
request
• main method ends without creating a request response
SEVERE The log file provides information only about fatal errors from
which the application cannot recover automatically (without
operator assistance), for example:
• database down
• database operation fails
• invalid configuration parameters
• invalid provisioning logic

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.

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 18
Release 9.0
Reference Manual
Joint Confidential

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.

6.1 Cleaning Request Trace Data


If request trace data is collected to follow the execution of requests with BST Tracer,
the trace data directory needs to be cleaned regularly. Trace data is collected to
<installdir>/sas/bst/trace if the GRC parameter request_trace has the
value EXECUTION_PATH, EVERYTHING or MIXED, or if the request parameter
REQUEST_TRACE exists with value EVERYTHING, EXECUTION_PATH or MIXED.

You can schedule automatic trace data cleaning by using UNIX crontab.

To schedule trace data cleaning in crontab

1. Give the following command to edit the crontab file:


crontab -e

2. Add scheduling commands to clean the files automatically. The following


example shows how to clean trace data regularly:

# Delete request trace data files older than 7 days


25 0 * * * /comptel/ilink/sas/bin/delete_file.ksh 7 -all
/comptel/ilink/sas/bst/trace

3. Save the changes and exit crontab.

6.2 Manual Cleaning of Files Created on Workstation


Saving may create unnecessary temporary folders with the _tmp suffix, for example,
EMERGENCY_default_logic_20141014_084004.jar_tmp, in the
C:\Documents and Settings\<user id>\BST directory. It is safe to remove
the folders manually to save disk space.

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 19
Release 9.0
Reference Manual
Joint Confidential

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.

Figure 3. Memory configuration of workstation and server side

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 20
Release 9.0
Reference Manual
Joint Confidential

7.1 Memory Consumption


Comptel InstantLink components Request Processing Engine, Service Module
Engine, Task Engine and Network Model Manager have a predefined value
specifying the maximum amount of memory (more precisely, the maximum amount
of heap) the component is allowed to use. Usually, the default values are sufficient.
However, if you have a large installation with a lot of requests per day or a large
provisioning logic, increase the maximum amount of memory that a component is
allowed to use by modifying the component-specific startup scripts.

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.

7.2 Configuring InstantLink Service Module Engine Memory Usage


If the provisioning logic is large (jar size over 1 MB) or several provisioning logics
are active at the same time, you must increase the memory allocation for InstantLink
Service Module Engine.

The example below shows the MAX_HEAP definition of the


start_ServiceModuleEngine.ksh file when the host has at least 4 GB memory
and the provisioning logic is large.

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

1. Shut down Comptel InstantLink.

2. Go to the <installdir>/sas/bin directory by giving the following


command:

cd <installdir>/sas/bin

3. Grant write privileges to the start_ServiceModuleEngine.ksh file as


follows:

chmod u+w start_ServiceModuleEngine.ksh

4. Open the start_ServiceModuleEngine.ksh file with a text editor.

5. Change the maximum allowed heap size defined with the parameter
MAX_HEAP as follows:

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 21
Release 9.0
Reference Manual
Joint Confidential

#!/bin/ksh

SASBASE=/comptel/ilink/sas
. $SASBASE/.profile

# the maximum heap size for JVM


MAX_HEAP="1024m"

MODULE_NAME=$1
JMX_PORT=$2

echo "Starting module $MODULE_NAME with jmxport:


$JMX_PORT"

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"

#This variable contains all arguments that are given to


Java Virtual Machine
JAVA_OPTS="$JAVA_OPTS $JMX_OPTS -Dtask_processor_count=7
-Dresp_forwarder_count=7 -Dmodule.name=$MODULE_NAME -
Dcom.comptel.mds.sas5.requestengine.use_priority_upgrade
r=false -Duse_tcp_no_delay=false -
Duse_statement_cache=false -
Duse_connection_verifier=true -
Dcom.comptel.cs.util.memory.max_heap_size=$MAX_HEAP -
Dcollect_statistics=true"

# Extra flags to JVM


#JAVA_OPTS="-Xint $JAVA_OPTS -Xms128m -Xmx256m"
if [ `uname` = "AIX" ] ; then
JAVA_OPTS=" $JAVA_OPTS -Xms256m -Xmx$MAX_HEAP"
else
JAVA_OPTS="-server -XX:NewRatio=1 $JAVA_OPTS -Xms256m -
Xmx$MAX_HEAP"
fi

6. Save the changes.

7. Start up Comptel InstantLink.

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 22
Release 9.0
Reference Manual
Joint Confidential

7.3 Configuring Workstation Memory Usage


When working with large provisioning logics, saving or loading a logic may fail if the
workstation memory settings are not adequate. A provisioning logic can be
considered large if the size of the jar file containing the logic is larger than 1 MB.

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.

If an error message Java Run time environment cannot be loaded is


shown, it is possible that the maximum heap size defined in Java Runtime settings is
too high, then you need to decrease the maximum heap to appropriate size. The
appropriate size depends on each specific workstation properties.

To configure workstation memory usage

1. Launch the Windows Start menu.

2. Click Programs.

3. Find the Java program listing.

4. Click Configure Java to launch the Java Control Panel.

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

7. Click OK to save the changes.

To verify that the memory settings are effective

1. Close your java applets and web browsers.

2. Enable Java Console from Java Control Panel (Advanced tab).

3. Open a web browser and log in to Comptel InstantLink UI.

4. Open Business Service Tool Logic Editor.

5. Open the Java Console.

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 23
Release 9.0
Reference Manual
Joint Confidential

6. Press s to see system properties and verify the javaplugin.maxHeapSize


value .

7.4 Configuring Workstation Timeout Usage


When working with large provisioning logics, saving or loading a logic may fail if the
workstation timeout values are not adequate. A provisioning logic can be considered
large if the size of the jar file containing the logic is larger than 1 MB.

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.

To configure workstation timeout usage

1. On your Windows desktop, click Start, Settings and Control Panel.

2. In Control Panel, to open the Java Control Panel, double-click the Java icon.

3. In the Java Control Panel, click the Java tab.

4. In the Java Runtime Environment Settings area, click View...


The Java Runtime Environment Settings dialog box opens.

5. In the Java Runtime Environment Settings dialog, set connection timeout


and read timeout to appropriate size by typing new values in the Runtime
Parameters column, for example:
-Dconnect_timeout=600000 -Dread_timeout=600000

6. Click OK to save the changes.

To verify that the timeout settings are effective

1. Close your java applets and web browsers.

2. Enable Java Console from Java Control Panel (Advanced tab).

3. Open a web browser and log in to Comptel InstantLink UI.

4. Open Business Service Tool Logic Editor.

5. Open the Java Console.

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 24
Release 9.0
Reference Manual
Joint Confidential

6. Press s to see system properties and verify that the modified


connect_timeout and read_timeout values are present.

7.5 Configuring UI Server Memory Usage


The maximum heap size for the UI server is configured in the tomcat_control
script. By default, the maximum heap size is 256 MB.

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.

To increase UI heap size

1. Go to the <installdir>/sas/bin directory by giving the following


command:

cd <installdir>/sas/bin

2. Grant write privileges to the tomcat_control file as follows:

chmod u+w tomcat_control

3. Open the tomcat_control file with a text editor.

4. Change the following line at the top of the tomcat_control file and save
the file:

MAX_HEAP="256m"

5. Restart Comptel InstantLink as follows:

. <installdir>/sas/.profile
ctl_control stop
ctl_control start

7.6 Configuring Standalone Logic Editor Timeout Usage


The default connection and read timeout values for the standalone Logic Editor is 300
seconds (300000 milliseconds). If you wish to increase these values, you can update
the -Djnlp.read_timeout and -Djnlp.connect_timeout values that are
located in the bst_standalone.jnlp file.

To change the maximum timeout values of standalone Logic Editor in the


bst_standalone.jnlp file

1. Go to <installdir>/sas/ui/webapps/bst.

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 25
Release 9.0
Reference Manual
Joint Confidential

2. Grant write privileges to the bst_standalone.jnlp file as follows:

chmod u+w bst_standalone.jnlp

3. Open the bst_standalone.jnlp file with a text editor.

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"/>

5. Save the changes.

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.

7.7 Configuring Standalone Logic Editor Memory Usage


When editing a large provisioning logic by standalone Logic Editor, you may have to
increase the heap size.The MAX_HEAP parameter for standalone Logic Editor is
specified in the bst_standalone.jnlp file.

To change the maximum heap size of standalone Logic Editor, edit the
bst_standalone.jnlp file

1. Go to the <installdir>/sas/ui/webapps/bst directory by giving the


following command:

cd <installdir>/sas/ui/webapps/bst

2. Grant write privileges to the bst_standalone.jnlp file as follows:

chmod u+w bst_standalone.jnlp

3. Open the bst_standalone.jnlp file with a text editor.

4. Change the maximum allowed heap size, for example:

<resources>

<j2se version="1.8+" initial-heap-size="256m" max-heap-


size="512m"/>

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 26
Release 9.0
Reference Manual
Joint Confidential

5. Save the changes.

For the changes to take effect, you must uninstall standalone Logic Editor and then
reinstall the new version from the Comptel InstantLink UI pages.

To uninstall standalone Logic Editor

1. Launch the Windows Start menu.

2. Click Programs.

3. Find the Java program listing.

4. Click Configure Java to launch the Java Control Panel.

5. On the General tab, in the Temporary Internet Files section, click View...
The Java Cache Viewer dialog box opens.

6. On the dialog box Show drop-down menu, select Applications.

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.

To reinstall standalone Logic Editor

1. Make sure that Comptel InstantLink is in configuration mode.

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.

5. In the dialog box, click Yes to create a shortcut to your desktop.

The standalone version is installed on your workstation and the BST


Standalone dialog box opens. Wait until the online help has been installed.

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 27
Release 9.0
Reference Manual
Joint Confidential

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.

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 28
Release 9.0
Reference Manual
Joint Confidential

8 Provisioning Logic Transfer


This chapter instructs how to transfer in UNIX a provisioning logic between two
environments, for example, from development environment to production
environment. The source and target release of Comptel Business Service Tool must
be the same.

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.

The JAR files are located in the database table BST_LOGIC_VERSIONS.

To transfer the provisioning logic

1. Choose the provisioning logic you want to transfer, for example,


TestLogic_20141014_130040.jar, and download it from the database to
the /tmp directory with the following command:

bst-admin.ksh --get-logic TestLogic_20141014_130040.jar /


tmp.

2. Import the logic version to the correct environment either:

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

b) or through an FTP connection when the two environments reside on


different hosts by using the following UNIX commands:

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

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 29
Release 9.0
Reference Manual
Joint Confidential

ssh target_host_name
cd <installdir2>/sas
. .profile

bst_admin.ksh --insert-logic /tmp/


TestLogic_20141014_130040.jar

3. Activate the provisioning logic. For instructions on how to activate the


provisioning logic, see Comptel Business Service Tool Online Help.

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 30
Release 9.0
Reference Manual
Joint Confidential

9 Managing Provisioning Logics from Command Line


Provisioning logics are usually managed from the user interface. Additionally, it is
possible to manage Comptel Business Service Tool configuration from the command
line.

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.

Note The bst_admin.ksh script replaces the old logic_management.ksh,


activate_logic.ksh and export_trace.ksh scripts.

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.

9.1 Listing Provisioning Logics and Library Logics


The listing functionality does not require any options. It shows all provisioning logic
versions or library logic versions present in the database.

Long name Short name Description


--list-logic-versions -lv Lists the main logic versions in the system.
--list-library-versions -llv Lists the library logic versions in the system.

Example: List logic versions

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

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 31
Release 9.0
Reference Manual
Joint Confidential

9.2 Downloading Provisioning Logics and Library Logics to File System


To be able to move provisioning logics and library logics between systems,
bst_admin.ksh includes options for downloading logics from the database to the
file system. The full name of the version to be downloaded and the absolute directory
path are required as arguments for these options.

Long name Short name Description Arguments


--get-logic -g Downloads a logic version from 1. Version name
the database to the file system. 2. Directory to download the
file to
--get-library -gl Downloads a library logic version 1. Version name
from the database to the file 2. Directory to download the
system. file to

Example: Download logic

bst_admin.ksh --get-logic
Provisioning_logic_example_20080603_150000.jar /tmp

This command downloads the


Provisioning_logic_example_20080603_150000.jar logic to the /tmp
directory.

9.3 Inserting Provisioning Logics and Library Logics to Database


The bst_admin.ksh script has options for inserting new provisioning logics and
library logics to the database. This is needed when moving logics between
environments.

Long name Short name Description Arguments


--insert-logic -i Inserts a logic to the Full path to the logic file
database.
--insert-library -il Inserts a library logic to the Full path to the library logic
database. file

Example: Insert library logic to database

bst_admin.ksh --insert-library /tmp/library/


My_library_logic_20161103_151200.jar

This command saves the My_library_logic_20161103_151200.jar logic


from the /tmp/library directory to the database.

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 32
Release 9.0
Reference Manual
Joint Confidential

9.4 Deleting Provisioning Logics and Library Logics


Unnecessary versions can be deleted from the database with the following options:

Long name Short name Description Arguments


--delete-logic- -dlv Deletes a provisioning logic Name of the logic to be
version from the database deleted
--delete-library- -dliv Deletes a library logic from Name of the library logic to
version the database. be deleted

Example: Delete logic from database

bst_admin.ksh --delete-logic-version
Provisioning_logic_example_20080603_150000.jar

This command removes the


Provisioning_logic_example_20080603_150000.jar provisioning logic
from the database.

9.5 Listing Active Logic Set and Current Working Set


The active logic set consists of currently active logic rules, provisioning logics and
library logics. The active set is read by the BST Engine.

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:

Long name Short name Description


--list-active-set -las Lists the currently active rules, logics and library
logics.
--list-current-set -lc Lists the current versions of logic rules,
provisioning logics and library logics.

Example: List active set

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;;

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 33
Release 9.0
Reference Manual
Joint Confidential

9.6 Activating and Deactivating Provisioning Logics and Library Logics


It is possible to activate and deactivate provisioning logics and library logics from the
current working set with the following bst_admin.ksh options:

Long name Short name Description Arguments


--activate-logic -al Activates a provisioning Full name of the
logic. Only possible if some provisioning logic version to
version of the same logic is be activated
already active or there os
only one active logic.
--activate-library -all Activates a library logic. If Full name of the library
another version of the same logic to be activated
library logic is currently
active, it is deactivated and
the new version is activated.
--deactivate-logic -deal Deactivates a provisioning Full name of the
logic. provisioning logic version to
be deactivated
--deactivate- -deall Deactivates a library logic. Full name of the library
library logic to be deactivated

Example: Activate logic

bst_admin.ksh --activate-logic
Provisioning_logic_example_20140929_155922.jar

This command activates the provisioning logic


Provisioning_logic_example_20140929_155922.jar.

9.7 Downloading and Uploading rules.properties for Provisioning Logics and


Library Logics
In addition to activating and deactivating provisioning logics and library logics one
by one, it is possible to download the logic rules file rules.properties for
modification. You can also upload the modified rules.properties file back to the
database.

Long name Short name Description Arguments


--get-rules- -grp Downloads the Full path to the directory to
properties rules.properties file to which the file is copied.
the file system.
--get-rules- -grpl Downloads the Full path to the directory to
properties-library rules.properties file which the file is copied.
for library logics to the file
system.

Example: Downloading rules.properties for provisioning logics

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 34
Release 9.0
Reference Manual
Joint Confidential

bst_admin.ksh --get-rules-properties /tmp

As a result, the rules.properties file is downloaded to the /tmp directory.

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.

Long name Short name Description Arguments


--download-rules -dr Downloads the currently Full path to the target
active logics and libraries as directory.
LOGIC_RULES.zip.
--upload-rules -ur Uploads the contents of the Full path to the uploaded zip
LOGIC_RULES.zip file to file.
the current working set.

Example: Download logic rules zip

bst_admin.ksh --download-rules /tmp

LOGIC_RULES_<yyyyMMdd_hhmmss>.zip is created in the /tmp directory.

9.9 Activating Changes


After making changes to the working set of active provisioning logics, rules or library
logics, the changes need to be activated. There is an option in bst_admin.ksh for
moving the current working set to the active set.

Long name Short name Description


--activate-current-set -acs Activates the current working set of provisioning
logics, rules and library logics.

Example: Activating the current set

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.

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 35
Release 9.0
Reference Manual
Joint Confidential

9.10 Exporting BST Trace


BST Trace is usually exported from the Comptel Business Service Tool user
interface. Additionally, you can export a trace and the related logic into a zip file from
the command line. Executed library logics and their traces are also put to the same zip
file. For example, in error cases, you can export a trace and send it to customer
service for review.

The following table describes the export trace option for the bst_admin.ksh script:

Long name Short name Description Arguments


--export-trace -et Exports a trace and the Request ID
related logic into a zip file.
The number on the trace file
name after the trace_
prefix refers to the request
ID. For library logics, the
trace file name also includes
a _<index> postfix. The
index indicates the execution
order and is not to be passed
as a command line
parameter for the script.

Example: Export BST Trace

bst_admin.ksh --export-trace 1

This command exports the trace for the request with request ID 1.

If the <installdir>/sas/bst/trace directory has the following BST trace files:

trace_1
trace_1_1
trace_1_2

and you execute bst_admin.ksh --export-trace 1 command, all the three


trace files are copied into a zip file which is saved into <installdir>/sas/backup
directory.

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 36
Release 9.0
Reference Manual
Joint Confidential

10 Provisioning Logic Report


You can produce a report on a specific provisioning logic from the command line.
The report is stored as a zip file to the <installdir>/sas/reports directory.

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.

To produce a report on the provisioning logic from command line

1. Start report generation using the script located in <installdir>/sas/bst/


bin:

cd <installdir>/sas/bst/bin
./create_logic_report.ksh

2. Enter the name of logic file name.

Example:

default_logic_20141014_130407.jar

The report is generated in a zip file to the <installdir>/sas/reports


directory.

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 37
Release 9.0
Reference Manual
Joint Confidential

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 syntax for the compare_logics.ksh script is:

compare_logics.ksh -source <logic_1> -target <logic_2> [-


report [SIMPLE|HTML]] [-report_base <directory>]

The following table lists the command line parameters for the compare_logics
.ksh script.

Command line parameter Description


-source <logic_1> <logic_1> stands for full path to the first logic file to be used
in the comparison
-target <logic_2> <logic_2> stands for full path to the second logic file to be
used in the comparison.
-report Defines the format of the report file
• SIMPLE - text file (default)
• HTML - HTML file
-report_base <directory> Specifies the directory where the report is produced. If base
directory is not defined the report is created in the
<installdir>/sas/bst directory.

To compare two BST logics

1. Go to the <installdir>/sas/bst/bin/ directory by giving the following


command:

cd comptel/ilink/sas/bst/bin/

2. Compare the logic versions by giving the following command:

./compare_logics.ksh -source /tmp/


default_logic_20141014_120000.jar -target /tmp/
default_logic_20141014_140000.jar

As a default result compare produces a simple report to <installdir>/


sas/bst/ directory. The name of the default report file is
compare_report_<timestamp>.log or
compare_report_<timestamp>.html depending on the report type
(SIMPLE or HTML).

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 38
Release 9.0
Reference Manual
Joint Confidential

Example:

compare_report_08102014_132502.log
compare_report_02102014_132621.html

Table 5 lists different elements between two logic versions.

Table 5. Different elements between two logic versions


Element Description
Unique elements Elements (steps and methods) that were found from the
source logic but not from the target logic (or vice
versa).
Search is done with element ID and the list can contain
multiple instances of elements. For example, the source
logic can contain five instances of MapStep named
MapAllParams and the target logic ten instances of the
same step.
Elements with changed name These element instances have the same ID, but
different name in the source and target logic versions.
Shared elements Element instances are found from both source and
targets logic versions.
Shared elements - unique parameters Same element is found from source and target logic
versions, but they have some parameters (parameter
names) that are not found from the other element.
Shared elements - changed parameter values Same element is found from source and target logic
versions and they have parameters with same name but
different values.

For more information on how to compare logics, see Comptel InstantLink Online
Help.

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 39
Release 9.0
Reference Manual
Joint Confidential

12 Number Range Import and Export from Command Line


You can import and export Comptel Business Service Tool number ranges from a text
file that is located in the UNIX file system. The import/export is launched by
executing a manage_number_ranges.ksh script from the command line. The
script allows listing all the NumberRange steps within a logic file. The name of the
NumberRange steps can then be used to import of export the contents of the step.

The syntax for the manage_number_ranges.ksh command is:

manage_number_ranges.ksh [-l <logic file> | [-i | -e] <logic


file> <number_range_file> <number_range_step> | -h ]

The following table describes the manage_number_ranges.ksh commands.

Command line parameter Description


-e <logic file> Exports the contents of step named number_range_step in the
<number_range_file> logic identified by the logic file to file named
<number_range_step> number_range_file.
-h Shows the help for manage_number_ranges.ksh.
-i <logic file> The content of the number_range_step is replaced with the data in
<number_range_file> the number_range_file. However, the default value in the step
<number_range_step> remains the same.
-l <logic file> Lists the names of all the number range steps located in the logic
identified by the logic file.

This script handles only the NumberRange step and does not have an impact on other
parameters.

To import a number range file

1. Go to the <installdir>/sas/bst/bin directory.

2. List the different number ranges in the logic, by entering the following
command:

./manage_number_ranges.ksh -l <logic file>

3. Choose a NumberRange step you want to import a file to.

4. Import a specific number range, by entering the following command:

manage_number_ranges.ksh -i <logic file>


<number_range_file> <number_range_step>

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.

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 40
Release 9.0
Reference Manual
Joint Confidential

Note If you give a non-supported flag as the first parameter, an error


message is displayed and the operation is not performed.

Before the number range is imported to the step, a sanity check is performed. The
check includes the following:

• Values exist in both start and end fields.


• The start value is less than the end value.
• There are no overlapping ranges within the same NE type.

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.

To export a number range file

1. Go to the <installdir>/sas/bst/bin directory.

2. Export a specific number range by entering the following command:

./manage_number_ranges.ksh <-e> <logic file>


<number_range_file> <number_range_step>

During the export, a step called <number_range_step> is looked inside the


logic with name <logic file>. The results are written into a
<number_range_file>

12.1 Syntax of Number Range Text File


If only one parameter is mapped against a number range, the format of the file is the
following (delimiter-separated values, the pipe '|' being the separator character):

<range_min_value>|<range_max_value>|<network_element_type>|<pa
rameter_name>|<parameter_value>

The following table lists the Number Range text file parameters.

Command line parameter Description


<range_min_value> The beginning of the number range.

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 41
Release 9.0
Reference Manual
Joint Confidential

Command line parameter Description


<range_max_value> The end of the number range. The value must be higher or the
same as <number_range_low>.
<network_element_type> Identifies the Network Element Type the number range applies
to.
<parameter_name>|<parameter Defines the name and the value of a parameter to be added to
_value> the parameter pool if number range is matched.

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

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 42
Release 9.0
Reference Manual
Joint Confidential

13 Managing Lookup Tables from Command Line


This chapter instructs how to list, delete, upload and download lookup tables from the
command line using the store_lookup_files_to_db.ksh script.

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.

13.1 Listing Lookup Tables

To list lookup tables

1. Log in to the UNIX host using the same UNIX group ID and user ID as in
Comptel InstantLink.

2. List the lookup tables by with the following command:

<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.

13.2 Deleting Lookup Tables

To delete lookup tables

1. Log in to the UNIX host using the same UNIX group ID and user ID as in
Comptel InstantLink.

2. Delete one or more lookup tables with the following command:

<installdir>/sas/bst/bin/store_lookup_files_to_db.ksh -
delete <table_list>

where table_list is a comma separated list of lookup table names.

Example:

/comptel/ilink/sas/bst/bin/store_lookup_files_to_db.ksh
-delete table1,table2,table3

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 43
Release 9.0
Reference Manual
Joint Confidential

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.

3. Perform Comptel InstantLink system refresh to remove the deleted lookup


table data for the BST LookUp step.

13.3 Downloading Lookup Tables


Comptel Business Service Tool stores lookup tables in a database. The downloaded
lookup tables are stored in a zip file.

To download lookup tables

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.

13.4 Uploading Lookup Tables

To upload lookup tables

1. Log in to the UNIX host using the same UNIX group ID and user ID as in
Comptel InstantLink.

2. Upload the lookup tables with the following command:

<installdir>/sas/bst/bin/store_lookup_files_to_db.ksh
[<option> <file_name>] <directory>

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 44
Release 9.0
Reference Manual
Joint Confidential

In the above command:

Command line parameter Description


-upload Creates a new lookup table and its content.
-update Updates the content of a lookup table.
• If the lookup table key value matches the existing key,
the values are updated.
• If the lookup table key value does not match the
existing key, the key and the values are added.
• If the lookup table does not exist, it is created.
-replace Replaces the current content of a lookup table.
If the lookup table does not exist, it is created.
<file_name> A zip file name containing lookup table files or a lookup
table file name.
<directory> A full path to the directory containing the lookup table
file(s).

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:

SEVERE: Storing lookup file <lookup table file name>


failed
SEVERE: ORA-00001: unique constraint
(<oracle_user>.UNI_BST_LOOKUP_TABLE_NAME) violated

3. Perform Comptel InstantLink system refresh to activate the lookup table data
for the BST LookUp step.

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 45
Release 9.0
Reference Manual
Joint Confidential

14 Upgrading Old Provisioning Logics


If a provisioning logic has been created with Comptel Business Service Tool releases
2.1.2, 3.0, 3.0.1, 3.1, 3.1.1, or 3.2, it must be upgraded with the update_logic.ksh
script before it can be used with Comptel Business Service Tool 9.0. Provisioning
logics done with InstantLink Business Service Tool 4.0 or later do not require
upgrading.

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.

The update_logic.ksh script has the following syntax:

update_logic.ksh INPUT_DIR | PATH_TO_JAR_FILE [options]

The upgraded logic jar file is created to the current directory.

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

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 46
Release 9.0
Reference Manual
Joint Confidential

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

Updates the provisioning logic using all the mandatory options

-check_element_names, -add_ids, -combine_log_steps and


-edifact_update.

-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

Changes simple parameter referencing in the MapParameter steps for backward


compatibility with InstantLink Business Service Tool 2.1.2. The parameter values
with simple referencing, such as $PARAM_VALUE, are changed to [$PARAM_VALUE]
when the 'All output parameters to pool' option is not used.

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 47
Release 9.0
Reference Manual
Joint Confidential

-l log_dir

Sets the directory where the log file will be saved.

-remove_needless_params

Removes input parameters with the needless mappings:


PARAM = $PARAM
PARAM = ($PARAM)
PARAM = [$PARAM]
Output parameters are left untouched.

-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.

However, take the following into account:

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

Performs all supported upgrade operations: -check_element_names, -add_ids,


-add_brackets, -remove_needless_params, -percent_to_dollar,
-combine_log_steps, and -update_edifact.

-?
or alternatively
-help

Shows help text for the upgrade script.

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 48
Release 9.0
Reference Manual
Joint Confidential

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

The upgrade creates a file named PHASE_34_<date>.jar, for example,


PHASE_34_20141014_112629.jar.

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:

update_logic.ksh /<path to>/MyLog


ic_20141014_120000.jar -mandatory_updates

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

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 49
Release 9.0
Reference Manual
Joint Confidential

update_logic.ksh /comptel/ilink/sas/bst/logics/versions/AUTOSA
VE_Administrator_MyLogic.jar -n MyNewLogic

14.1 Checking Switch Step Parameter Values


In the InstantLink Business Service Tool 3.2 PB4 the switch step was changed to
accept commas as parameter values. This change may cause wrong parameter values
in the existing logics. You can check the parameter values using the
update_logics.ksh script with the -check_parameters_with_comma option.

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:

logic filename":"logic name":"parameter name"="parameter value

To check the switch step parameter values

1. Move to the <installdir>/sas/bin directory with the following


command:

cd <installdir>/sas/bin

2. Start the script with the following command:

update_logic.ksh /<path to>/logics -check_par

ameters_with_comma 2>/dev/null

The following example (with one parameter including commas) describes the
output of the script:

Searching commas in logic's parameters started

/tmp/test_logic_20141014_145544.jar:xml/
Switch_1.xml:DEFAULT__TEST=1,201

Searching commas in logic's parameters ended

To make sure that the logic works properly, check the parameters listed in the output
from Business Service Tool Logic Editor.

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 50
Release 9.0
Reference Manual
Joint Confidential

15 Regular Expression Syntax in the EdifactParser and RegExp


Steps
Starting from InstantLink Business Service Tool release 3.1, the rules for evaluating
regular expression syntax in the EdifactParser step and RegExp step have slightly
changed.

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.

To check the 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).

6. Repeat steps 4-5 to all RegExp steps.

7. Save the changes and test the provisioning logic.

For a full description on the regular expression syntax, see Java documentation.

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 51
Release 9.0
Reference Manual
Joint Confidential

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.

16.1 All Output Parameters to Pool Check Box


If you have upgraded to the latest release and try to open a provisioning logic that
uses the All output parameters to pool check box, logic loading is cancelled and
you get an error message:

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.

Figure 4. All output parameters to pool check box


In the current release, the All output parameters to pool 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 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.

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 52
Release 9.0
Reference Manual
Joint Confidential

To modify the logic so that the check box is no longer used

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:

20141014 114644 com.comptel.mds.sas5.servicemodu


les.bst.ui.applet.StepManager a Level: WARNING:900 Could
not set BSTLogic. The logic contains steps that use the
'All output parameters to pool' option even though the
GRC parameter 'all_output_parameters_support' is set to
'NO'. Please refer to GRC settings in Installation Guide.
The steps are: resp_XEB, mapDefault2, resp_UNT, resp_UNB,
resp_UNH

2. Change the value of the all_output_parameters_support parameter to


YES to make the check box available in the UI.

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.

16.2 Overwrite Check Box


If you have upgraded to the latest release and try to open a logic that uses the (O)
Overwrite check box, logic loading is cancelled and you get an error message:

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.

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 53
Release 9.0
Reference Manual
Joint Confidential

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.

To modify the logic so that the check box is no longer used

1. After loading has failed and you have received the error message, check in the
Java Console, which steps use the check box.

2. Change the value of the overwrite_support parameter to YES to make the


check box available in the UI.

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.

16.3 Loading a Logic Failed


If you get an error message:

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.

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved
Comptel Business Service Tool™ 54
Release 9.0
Reference Manual
Joint Confidential

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.

© 2016 Comptel Corporation Document Version 1.0


All Rights Reserved

You might also like