Dev Studio
Dev Studio
DevStudio
User Guide
No part of this document may be reproduced or transmitted in any form or by any means,
electronic or mechanical, for any purpose, without the express written permission of TEMENOS Holdings NV.
Table of Contents
Overview .................................................................................................................................................. 4
Setup ....................................................................................................................................................... 5
Display Settings ................................................................................................................................... 5
Locations .............................................................................................................................................. 6
Run Time Settings ............................................................................................................................... 6
Your Details ......................................................................................................................................... 7
The Code Editor ...................................................................................................................................... 7
User Details ......................................................................................................................................... 7
The Development Environment ........................................................................................................... 8
The Tool Bar ..................................................................................................................................... 8
The Main Pane ............................................................................................................................... 10
The Navigation Pane ...................................................................................................................... 11
The Tools Pane .............................................................................................................................. 12
Basic Features ................................................................................................................................... 12
Creating a New Program ................................................................................................................ 12
Opening a Program ........................................................................................................................ 13
Editing the Code ............................................................................................................................. 14
Viewing Code on the Server .......................................................................................................... 15
Saving Code ................................................................................................................................... 15
Compiling Code .............................................................................................................................. 15
Find & Replace ............................................................................................................................... 16
Autosave ........................................................................................................................................ 16
Advanced Features ............................................................................................................................ 16
System & User Defined Macros ..................................................................................................... 16
Creating GOSUBs .......................................................................................................................... 18
Creating Regions............................................................................................................................ 18
Bookmarks & Modification Marks ................................................................................................... 19
Program Locking ............................................................................................................................ 20
My T24 Projects ..................................................................................................................................... 22
The Project Console .......................................................................................................................... 22
Creating a New Project ...................................................................................................................... 22
Adding Files to your Project ............................................................................................................... 23
Project Properties .............................................................................................................................. 24
The T24 Visual Debugger...................................................................................................................... 26
Pre-requisite Set-up ........................................................................................................................... 26
Starting the T24 Visual Debugger...................................................................................................... 27
Overview
The T24 DevStudio contains a set of productivity tools to aid T24 Developers. This component can be
used by both Temenos developers and external clients when writing T24 core or local developments.
Since the T24 DevStudio is provided as a ToolBox plug-in all pre-requisites for installing and running
the ToolBox application must be met.
Setup
The DevStudio Options can be accessed via the Options Icon shown in ToolBox or via the Code
Editor Tools Menu.
The Options dialog allows user to specify all required settings needed by DevStudio alls user
preferences such as colours and fonts to be specified.
The Options have been categorised into four sections:
1. Display Settings: to hold fonts & colours etc.
2. Locations: to hold local and server paths
3. Run Time Settings: to hold required settings
4. Your Details: to hold details required for Program locking.
The Options dialog displays a ‘Restore Defaults’ button that can be used to re-set the options values if
required.
Display Settings
Option Name Description
Background The Background Colour of the Code Editor.
CodeFont The Font Used in the Code Editor.
Comment The Colour Applied to Code Comments
CommonVariables The Colour Applied to T24 Common Variables
CurrentLineHighlight The Colour Applied to the Current Line Highlight
DescriptionText The Colour Applied to the Description Text within the “<desc>…..</desc>’
tags
Foreground The Colour Applied to Normal Text
HighlightCurrentLine If set to True the current line will be Highlighted
IndentationGuides If set to True a faint line will indicate the indentation level
Locations
Option Name Description
LocalWorkPath The local working directory. This is where your local programs and autosave
will be saved.
ServerDirList The list of Directories where your programs are stored on the T24 Server.
Separate each entry by ‘,’ e.g. BP,T24.BP,TEST.BP….
Your Details
Option Name Description
Email User email address
Telephone User telephone number
Username User Name or ID
User Details
The first time the Code Editor is launched a dialog will appear to prompt for user details. One person
can only edit server program files at any one time. This ensures that different people do not make
conflicting changes. In order to facilitate this a locking mechanism has been created which registers
which user has locked which file for edit. Therefore, a User Name must be supplied when logging in to
the T24 DevStudio. This should be clear enough that the person editing a particular file can be
identified should any problems occur. The Login screen also allows you to add additional contact
information, although this will not be stored in the jBASE database at present.
When the OK button is pressed this information is saved to the T24 DevStudio Options file. This
information can be changed at any time via the Options Icon found under the T24 DevStudio plug-in.
Refresh the Ctrl+R Refreshes the List pane as well as re-processes the
Code Window colouring of the program code
Format the Ctrl+Shift+F Formats the program code by indenting text that is of the
Code same statement level.
Print Ctrl+P Prints the current code.
Display the Ctrl+I Displays a dialog showing the current locking information
current for the currently open program.
Program’s
Locking info.
Convert Ctrl+Shift+C Converts an F.READ Statement into a CACHE.READ
F.READ to statement if detected.
CACHE.READ
Toggle - Adds or removes a bookmark to the currently open
Bookmark program.
Go to Previous - Jumps to the previous bookmark if any.
Bookmark
Go to Next - Jumps to the next bookmark if any.
Bookmark
Clear - Clears All defined bookmarks.
Bookmark
Go to Previous - Jumps to the Previous Modification mark if any.
Modification
Go to Next - Jumps to the Next Modification mark if any.
Modification
Clear All - Clears all Modification marks.
Modification
Marks
Basic Features
Creating a New Program
To create a NEW program, click the ‘Create a New Program’ icon from the Toolbar or select the ‘New’
menu item from the ‘File’ Menu.
The New Program wizard will started and the user will be prompted to enter the name for the New
program. The wizard will allow the user to select if a template should be used or a just blank program
be created.
The New Program dialog. Once the user has input a name and
selected whether a template should be applied ‘Next’ should be clicked.
If ‘Use Template’ is selected then the user will be prompted with a list of templates that can be applied.
‘Finish’ should now be clicked and the program will be generated. The user is now able to edit the
program as required.
Opening a Program
The user is able to open both ‘local’ and ‘server’ programs. Local programs are defined as all
programs saved on the local machine and Server programs are defined as all programs saved on the
T24 server. To open local programs use the ‘Open Local File’ option and DevStudio will display a
standard browse and select dialog so that the required file be specified.
To open a Server sided program use the ‘Open Server File’ option and DevStudio will display the
‘Open Server File’ dialog
The option is given to ‘Browse’ the directory specified. If this is clicked then DevStudio will display a
list of all programs found under that location.
The Browse Server dialog displayed the contents of the specified directory. The user is able to search
for specific files by using the ‘Search Now’ button. The required operand can be specified and a value
to search for.
Once selected the required program can be opened by clicking ‘OK’.
The context menu provides standard editing options, cut, copy & paste. It also gives the options to
Open the selected text in the current session of a new session. Selection New session will open a
new DevStudio code editor. A lock will be applied to the program when it is opened. If the selected
text does not match an existing program DevStudio will be unable to resolve it and it will not be
opened. If ‘View’ is selected then the program will be opened in ‘Read-Only’ mode and a lock will not
be applied to that program.
The ‘Last Position’ option can be used to jump to the previous cursor (usually the position of the cursur
before an item was selected from the navigation tools.
Saving Code
Once a program has been modified the user is able to save the program either to the server or locally.
The following options from the ‘File’ menu item can be used to save a program to the server or locally:
Compiling Code
Only server programs can be compiled. The option to compile will be disabled for local programs.
To compile a program select the ‘Compile’ toolbar item or select the ‘Compile’ menu item from the
‘Build’ menu. Once requested DevStudio will send a request to the server to compile the program.
Compilation output will be displayed in the ‘Output’ tab of the Tools pane. Any warnings, errors or
information messages will be displayed in the ‘Task List’ pane.
Compile Output
The Find & Replace facility in DevStudio allows users to specify values to find and replace. The
results are displayed and items can be clicked on to move the cursor to that item.
Autosave
DevStudio has a built in Autosave mechanism. All auto-saved items will be saved in the following
location:
[LocalWorkPath]\Autosave\
The LocalWorkPath is specified in the DevStudio Options. A sub-directory will be created called
‘Autosave’ and all programs will be saved to that location using the specified AutoSaveInterval. All
auto-saved programs will have a ‘.sav’ extension.
The DevStudio status bar will indicate if the auto-save has been successful or not.
Advanced Features
System & User Defined Macros
DevStudio is deployed with a set of Standard Macros. These Macros or code snippets allow the user
to rapidly insert commonly used code snippets. The standard set of macros can be seen via the
‘Macro’ tab on the navigation pane.
To run a Macro the user can simply position the cursor at the required section in the program. Select
the Marco and either double-click on it or click the ‘Run’ button.
After the Marco has been run, any user prompts will be displayed and then the code snippet inserted.
Users have been given the ability to create their own Macros. To create a Macro click the ‘Create’
button and a dialog will be displayed that will allow the user to design the required Macro.
The Prompts field holds the sets of questions that the user will be asked when using this command.
This is used to supply command data that will vary each time this command is run.
In the case of the example above, a conditional debug command will be inserted and the user must
supply the operator. When more that one prompt is required, each instance of the prompt should be
placed on a new line. The prompts field is optional. In this case just the text in the Text field is inserted
directly in to the program code pane. This facility is useful when common code is required to be
inserted but no differentiation is required in the text inserted.
The Text field holds the text to be inserted in to the program code when the ‘Run’ button is pressed
from the Macro pane. This text should be inserted including any new line characters that are required.
The answers to the prompts are placed in the ‘<>’ placeholders, where ‘x’ is a number corresponding
to the prompt number. The prompt numbers start at 1, this matches with the answer to the first prompt
line.
Creating GOSUBs
When writing a large and complicated program, a user may wish to move some code in to a separate
GOSUB within the same file. To do this the ‘Create Gosub’ item should be selected from the ‘Tools’
menu. The user may pre-select the code to be moved into the Gosub before the ‘Create Gosub’ item
is selected. If no text has been selected then a new ‘empty’ Gosub will be created. On selecting this
item the following dialog is displayed:
The name of the new GOSUB should be entered and an optional description. When OK is pressed the
selected code is moved to the end of the program code (or where the previously ‘* ’ label has been
inserted) and the selected code replaced with a call to the new GOSUB.
Creating Regions
Regions are expandable and collapsible user defined areas. Regions help to organise programs
logically and help with maintenance. It allows logical grouping of program subroutines. Creating
regions is done in a very similar manner as when creating GOSUBs.
A name and optional description should be supplied when creating the region. As with GOSUBs if the
user has pre-selected text then the new region will encapsulate it. If the user has not then an empty
region will be created.
The region code encapsulating some text. The region is shown expanded.
The region as detected by the ‘Regions’ pane. Refresh should be clicked to re-fresh this list.
Users and declare Bookmarks within the open program by simply placing the cursor at the required
line and clicking the ‘Toggle Bookmark’ icon on the toolbar. A blue bookmark icon will appear on the
left hand margin.
The user can specify multiple bookmarks within the same program and use the Previous and Next
bookmark icons to quickly navigate between them. All bookmarks can be cleared by clicking the
‘Clear bookmarks’ icon.
Bookmark information will NOT be saved with the program. When you closed your program user
bookmarks are not maintained.
Modification marks appear as a highlight line next to every line that has been modified by the user
since the program was opened. Rapid navigation between them is provided and the user can reset
these at any time by using the ‘Clear Modification Marks’ icon. Again these marks are not saved when
the program is closed.
Program Locking
As previously mentioned, in order that only one person edits server code at any one time, a locking
mechanism is used. This involves adding an entry to the jBASE application EB.DEV.LOCKING. The
key to this application is the program file name.
The underlying jBASE file used by the EB.DEV.LOCKING application is F.EB.DEV.LOCKING.
The EB.DEV.LOCKING application has the following fields :-
User The name of the user who locked the program file. Taken from the Login
Mandatory
Name screen.
Email The email address of the user who locked the program file. Taken from the
Optional
Address Login screen.
Contact The contact number of the user who locked the program file. Taken from the
Optional
Number Login screen.
Lock Date The date that the program file was locked. Mandatory
The fetching and returning of program code automatically locks and unlocks files. However, the jBASE
EB.DEV.LOCKING program can be used to view current program locks, as well as unlock files that
were locked by mistake or no longer need to be locked.
The use of the Verify function on a EB.DEV.LOCKING record will remove the lock for the specified
program file. Please note that this should only be performed in emergencies and only by a senior
developer.
DevStudio provides a facility to Manage your individual locks and for you to view the program lock
information for the currently open program.
To display all Program locks maintained by the current user the ‘Program Locks…’ item should be
selected. The following dialog will be displayed.
This dialog gives user the facility to un-lock all or individual items. This dialog will be automatically
displayed to the user when all DevStudio code sessions are closed. All locks are held on the T24
server so DevStudio will only attempt to retrieve them if your ToolBox is signed-on.
To display the locking information for the currently open file then select the ‘Program Lock Information’.
A dialog will display the lock information for that program.
If a user attempts to open a locked program (that does not belog to them) then DevStudio will display
the Program Lock Information dialog but give the user the option to open the program in a ‘Read-Only’
mode.
My T24 Projects
This component allows developers to group Server and Local program files into projects. It provides a
useful interface to access these items and allows you to include other project resource files such as
Functional and Technical Specifications.
When ‘My T24 Projects’ is launched from ToolBox the T24 Project Console is displayed. This allows
users the Open existing projects, Remove existing projects or Create a New Project.
The project console displays the Name & Description of the selected project and lists all files included
within that project.
The user can specify the name of the project, a description and a location. By default the location will
created from the LocalWorkPath option and the Project Name.
Once ‘OK’ is clicked the Project explorer will be displayed:
The project explorer is empty so the user must add files to it.
If you wish to add a server file’ then select the ‘Server File’ Icon and click ‘Add’. If you wish to add a
local file then select the ‘Local File’ icon. If you wish to add any other file such as a document, viso
diagram, spreadsheet, project plan etc.. then select the ‘Other File’ icon and click ‘Add’.
The Project Explorer will display the appropriate dialog to add the particular item.
Once items have been selected the Project Explorer will display the items within a tree.
Each project item can be launch by double-clicking on it. All Server and Local Files will be open by
the DevStudio Code editor. All Other Files will be launched using the associated application e.g. MS
Word, MS Project etc.
Once all items have been added to the Project then it must be saved using the save icon on the
toolbar or the ‘Save Local’ option from the File Menu.
To remove an item from the project simply select it within the Project Explorer right-click can select
‘Remove Item’ from the context menu. The item will be removed.
The Project Explorer can be docked to the Left or Right of the Windows Desktop. This allows the
Project Explorer to be always visible and manage your DevStudio and other application sessions.
To Dock the Project Explorer select the ‘Docking’ menu item and check the required docking position
from the menu.
Project Properties
Pre-requisite Set-up
Before the T24 Visual Debugger can be used the T24 Browser, TCServer T24 account must be
configured accordingly:
NOTE: The setup indicated in this document should be used as guide lines only. Please refer to the
documentation of each component for further information.
T24 Account:
Ensure that the environment variable is set in the T24 account that you wish to debug:
JBASE_DEBUG_PIPE=1
This can be set in the .profile, environment.vars or remote.cmd
TC Server:
In the file ‘tcserver.xml’ found under the ‘conf’ directory ensure that the ADAPTER that the T24
Browser channels are using has a <MAX_SESSION> value of at least 2. An example would be:
<ADAPTER id="T24">
<MAX_SESSION> 5 </MAX_SESSION>
<MIN_SESSION> 1 </MIN_SESSION>
<TIMEOUT>3000</TIMEOUT>
<STARTIN>/storage1/globus.accounts/globus.acc.2/srdevc.run</STARTIN>
<JBASEPATH>/usr/jbc</JBASEPATH>
<PROGRAM>tSS</PROGRAM>
<PARAMETER>WZ</PARAMETER>
</ADAPTER>
T24 Browser:
In the file ‘BrowserParameters.xml’ found in the root of the Browser Application the following values
must be set:
<?xml version="1.0"?>
<browserParameters xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<messageData>
<parameter>
<parameterName>Server Connection Method</parameterName>
<parameterValue>INSTANCE</parameterValue>
<!-- Options: GLOBUSCONNECTOR / INSTANCE / SOCKET / EJB -->
</parameter>
<parameter>
<parameterName>Instance</parameterName>
<parameterValue>production</parameterValue>
</parameter>
.
.
Under the \WEB-INF\conf directory locate the file ‘BrowserConnection.xml’ and ensure it contains an
Instance name as defined above ‘production’ in this case. Ensure that this instance defines the
required channels as defined in ‘channels.xml’.
<instances>
<instance name="production">
<encrypt>false</encrypt>
<compress>false</compress>
<retryperchannel>2</retryperchannel>
<encoding></encoding>
<verbose>false</verbose>
<channels>
<channel>browser.1</channel>
<channel>browser.2</channel>
</channels>
</instance>
</instances>
Before the T24 Visual Debugger can be started the ‘Run Time’ options within the DevStudio Options
dialog must be provided:
DebugPortNumber:
This should be the same port number that the TC Server will redirect the Debugger output to. This
value is held in the ‘tcserver.xml’ file under the <DEBUGGER_PORT> attribute.
ServerIP:
This should be the IP address of your host server.
Once these parameters have been supplied you should be able to start the T24 Visual Debugger. To
do this, execute the ‘Visual Debugger’ icon shown in the DevStudio tools suite.
The T24 Visual Debugger will attempt to connect to the IP address and port specified. Once
completed a tray icon is created and an information balloon displays the connection details. The main
T24 Visual Debugger window also displays the connection information and informs the user that it is
awaiting a Debug statement:
When using Browser to run T24 programs if a DEBUG statement is encountered normally your
program will appear to hang and the an invalid response will be received.
If however the T24 Visual Debugger is active a screen prompt and information balloon will appear
informing you that a DEBUG statement has been detected and will ask you if you wish to launch the
T24 Visual Debugger.
If you click ‘Debug’ then the T24 Visual Debugger is launched. If ‘Continue’ is pressed then the
program will continue until a further DEBUG statement is detected or until execution is complete.
When ‘Debug’ is pressed the T24 Visual Debugger is launched and the source code of your program
is retrieved. (Ensure that you have signed on in ToolBox). The T24 Visual Debugger will display a
dialog that will allow the user to specify the source program to open. The T24 Visual Debugger will
attempt to pre-fill the program name and it directory if it is contained within the Debugger output.
Once the program has been opened the current line is highlighted and the user will be able to use the
debugger commands to step-over, step-in, set break points, continue etc as required. The ‘Debug’
menu item shows the commands that can be executed.
Once debugging is complete the T24 Visual Debugger will close and your program should now be
active.
NOTE: If you have taken a long time to debug your program you may receive the following error
message in T24 Browser:
This indicates that you have exceeded the time-out settings for the response. To over come this
problem set the time out values in Browser and in the TCServer to higher values. Alternatively debug
in an efficient manner so that you do not exceed the time out threshold values.
Adding Watches
The T24 Visual Debugger allows user to evaluate variables by setting watches. The lower pane of the
main debugger window contains a ‘Watches’ section.
Watches can be added to the list by clicking the ‘Click to Add..’ item. A dialog will appear and will
allow the user to enter the required variable name.
Once ‘OK’ is clicked the variable will appear on the list. To evaluate that variable simply select that
item and click the ‘Refresh’ icon above it. The variable will be evaluated.
If there are multiple variables in the list each must be ‘refreshed’ by the user individually and each
should be ‘refreshed’ manually during debugging.
Context Menu
The T24 Visual Debugger window provides a context menu to give access to commonly used
commands. To access this menu right-click on the source code window.
The context menu can be used to set a breakpoint at a given line or a double-click action can be used.
For conditional breakpoints, use the ‘New Breakpoint’ item under the Debug menu to display the
following dialog.
Insert values as required and a conditional break point will be set at the specified location.
Memory Allocation
Due T24’s stateless architecture it has become increasingly difficult to determine the status of each
message going back and forth. There are many layers and components involved and from a
developers point of view it can be very time consuming to determine what has gone wrong.
The Spy Session allows developers to see all response messages sent from the T24 server.
The Command session allows developers to execute jBASE and shell commands without the need for
3rd party terminal emulator software.