BL Scripting with JavaScript

Logging in JavaScript

Example Code

print (getCurrentDateStr(DATETIMEUtc));

Execution of this line results in the following record in the application log:

[NOTE]  20131023-08:28:53.651 [4320] [../FixEdge/conf/test.js] - JavaScript '../FixEdge/conf/test.js' output: 20131023-08:28:53

Operations with session

Example Code

startSession("StartByEvent")

Example Code

startSession("FIXEdge","SimpleClient")

Example Code

startSession("FIXEdge","SimpleClient","Q1")

Example Code

disconnectSession("DisconnectByEvent","Disconnect by message")

Example Code

disconnectSession("FIXEdge","SimpleClient","Disconnect by message")

Example Code

disconnectSession("FIXEdge","SimpleClient","Disconnect by message","Q1")

Example Code

terminateSession("TerminateByEvent","Terminate by message")

Example Code

terminateSession("FIXEdge","SimpleClient","Terminate by message")

Example Code

terminateSession("FIXEdge","SimpleClient","Q1","Terminate by message")

Please note:

1. The session will not be visible in FIXICC or manageable (start, disconnect, etc) from FIXICC/BL/JS/scheduler.
2. The termination and the disconnection occur with async way after rule completion. In case of fail <OnRuleFailEvent> will be called.

Operations with messages across BL rules

Example Code

setCtxKV("messageID","123")

The function sets the value to the key to transfer information about the message between different BL rules. If the function argument's type is not a string then the function throws an exception.

Example Code

var id = getCtxKV("messageID")

var id = getCtxKV("messageID","0")

The function gets the value of the key from another BL rule.

If the function argument's type is not a string then the function throws an exception.

If the default value is specified and there is a key stored in the context then the function returns the value stored for the key.

If the specified key is not stored in the context:

• If the default value is specified then the function returns the default value.
• If the default value is not specified then the function throws an exception.

Example Code

delCtxKV("messageID")

The function deletes the value of the key. If the function's argument type is not a string then the function throws an exception.

Operations with group fields

Example Code

hndl = getGroup(78);

isGroupValid(hndl)

Gets a handle on group 78 and tests whether handle 78 is valid

Example Code

hndl = getGroup(552);

isGroupValid(hndl);

hndl2 = getGroup(hndl, 0, 518);

isGroupValid(hndl2); 

if(hndl2 != hndl){

    setNumField(552, 4);

}

Gets a handle on group 552 and tests whether the handle 552 is valid

Gets a handle from the first record of 552 group on group 518 and tests whether the handle 518 is valid

If the group handles are not identical, then increase the number of group 552 elements up to 4

Example Code

hndl = getGroup(78);

isGroupValid(hndl);

removeField(hndl, 0, 79);

Gets handle on group 78 and tests whether the handle 78 is valid 

Removes tag 79 from group 78

Example Code

//see the example above 

Example Code 1 

setNumField(268, 200);
hndl = getGroup(268);

bulkSetStringField(hndl, 0, 269, '0', 100);
bulkSetStringField(hndl, 100, 269, '1', 100);

Example Code 2 

bid_qty_list = [10, 20, 30, 40, 50];
ask_qty_list = [11, 22, 33];

setNumField(268, bid_qty_list.length + ask_qty_list.length);
hndl = getGroup(268);

bulkSetStringField(hndl, 0, 271, bid_qty_list);
bulkSetStringField(hndl, bid_qty_list.length, 271, ask_qty_list);

Example 1

Resizes group 268 (NoMDEntries) to 200

Gets a handle on group 268 (NoMDEntries)

For entries 0 - 99 set tag 269 (MDEntryType) to '0' ('Bid')

For entries 100 - 199 set tag 269 (MDEntryType) to '1' ('offer')

This is equivalent to code:

for (var i = 0; i < 100; i++) {
setStringField(hndl, i, 269, '0');
}

for (var i = 100; i < 200; i++) {
setStringField(hndl, i, 269, '1');
}

Example 2

Creates a bid_qty_list variable with 5 elements and ask_qty_list with 3 elements

Resizes group 268 (NoMDEntries) to 8 (total size of 2 lists)

Gets a handle on group 268 (NoMDEntries)

For entries 0-4, copy values from bid_qty_list, so that entry[i][271] = bid_qty_list[i]

For entries 5-7, copy values from ask_qty_list, so that entry[5+i][271] = ask_qty_list[i]

This is equivalent to code:

for (var i = 0; i < bid_qty_list.length; i++) {
  setStringField(hndl, i, 271, bid_qty_list[i]);
}

for (var i = 0; i < ask_qty_list.length; i++) {
  setStringField(hndl, bid_qty_list.length + i, 271, ask_qty_list[i]);
}

Example Code

bids = [ [0.1, 10], [0.2, 20], [0.3, 30], [0.4, 40], [0.5, 50] ] ;

asks = [ [1.1, 11], [2.2, 20], [3.3, 30] ] ;

setNumField(268, bid_qty_list.length + ask_qty_list.length);
hndl = getGroup(268);

bulkSetStringFieldMapped(hndl, 0, 270, bids, 0);
bulkSetStringFieldMapped(hndl, 0, 271, bids, 1);

bulkSetStringFieldMapped(hndl, bid_qty_list.length, 270, bids, 0);
bulkSetStringFieldMapped(hndl, bid_qty_list.length, 271, bids, 1);

For alternative source structure

bids = [ {"price": 0.1, "qty": 10}, 
         {"price": 0.2, "qty": 20},
         {"price": 0.3, "qty": 30},
         {"price": 0.4, "qty": 40}, 
         {"price": 0.5, "qty": 50}] ;

asks = [ {"price": 1.1, "qty": 11}, 
         {"price": 2.2, "qty": 22}, 
         {"price": 3.3, "qty": 33}] ;

setNumField(268, bid_qty_list.length + ask_qty_list.length);
hndl = getGroup(268);

bulkSetStringFieldMapped(hndl, 0, 270, bids, 'price');
bulkSetStringFieldMapped(hndl, 0, 271, bids, 'qty');

bulkSetStringFieldMapped(hndl, bid_qty_list.length, 270, bids, 'price');
bulkSetStringFieldMapped(hndl, bid_qty_list.length, 271, bids, 'qty');

Creates a bids variable with 5 nested pairs of elements, and ask_qty_list with 3 pairs.

Resizes group 268 (NoMDEntries) to 8 (total size of 2 lists)

Gets a handle on group 268 (NoMDEntries)

For entries 0-4, copy Price(270) and Size(271) values from bids;

For entries 5-7, copy Price(270) and Size(271) values from asks.

This is equivalent to code:

for (var i = 0; i < bid_qty_list.length; i++) {
bid = bid_qty_list[i];
setStringField(hndl, i, 270, bid[0]);
setStringField(hndl, i, 271, bid[1]);
}

for (var i = 0; i < ask_qty_list.length; i++) {
ask = ask_qty_list[i];
setStringField(noMDEntries, bid_qty_list.length + i, 270, ask[0]);
setStringField(noMDEntries, bid_qty_list.length + i, 271, ask[1]);
}

For alternative source structure

for (var i = 0; i < bid_qty_list.length; i++) {
  bid = bid_qty_list[i];
  setStringField(hndl, i, 270, bid['price']);
  setStringField(hndl, i, 271, bid['qty']);
}

for (var i = 0; i < ask_qty_list.length; i++) {
  ask = ask_qty_list[i];
  setStringField(noMDEntries, bid_qty_list.length + i, 270, ask['price']);
  setStringField(noMDEntries, bid_qty_list.length + i, 271, ask['qty']);
}

Operations with message fields

Example Code

removeField(58);

Example code

createReject("Target42sohSender42");

Example Code:

if ( isSupportedField( 58 ) )
    removeField( 58 );

The example shows how to remove tag 58 from the message if it is defined in the dictionary

The script checks if tag 58 is defined for the message
And remove it from the message.

Example Code

partiesGrp = getGroup(448);
if ( isGroupValid(partiesGrp) && isSupportedField(partiesGrp, 2376) )
    removeField( partiesGrp, 0 , 2376 );

The example shows how to remove non required tag 2376 from the Parties group entry #0. 

The script gets the repeating group 448 handle.
Then checks if the group is valid and present in the message. And if tag 2376 is defined in the dictionary.
Then removes tag 2376 from the group entry #0

Example Code

getNumField(78);

Returns a numeric value of field 78

Example Code

hndl = getGroup(552);

isGroupValid(hndl);

setNumField(552,getNumField(hndl, 0, 581));

Gets handle on group 552 and tests whether the handle 552 is valid

Gets a numeric value of field 581 and assigns it to field 552

Example Code

getDateField(64, YYYYMMDDLmd);

Gets a date value of the field 64 in YYYYMMDD format

Example Code

hndl = getGroup(778);

isGroupValid(hndl);

getDateField(hndl, 0, 779, YYYYMMDDLmd);

Gets handle on group 778 and tests whether the handle 778 is valid

Gets a date value of the field 779 in the YYYYMMDD format from the first element of group 778

Example Code

getStringField(78); 

Returns a string value of field 78

Example Code

hndl = getGroup(552);

isGroupValid(hndl);

setStringField(552,getStringField(hndl, 0, 581));

Gets a handle on group 552 and tests whether handle 552 is valid

Gets a string value of field 581 and assigns it to field 552

Example Code

tmp = getMStringField(18);

if(3 == tmp.length){

setStringField(55, tmp[0]);

setStringField(65, tmp[1]);

}

Gets a multiple string value of field 18 and assigns it to the tmp variable

If the number of strings in the tmp variable equals to 3, then the value of the first string is assigned to field 55 and the value of the second string is assigned to field 65

Example Code

hndl = getGroup(552);

isGroupValid(hndl);

tmp = getMStringField(hndl, 0, 18);

Gets a handle on group 552 and tests whether handle 552 is valid

Gets a multiple string value of field 18 found in the first entry of group 552 and assigns it to the tmp variable

Example Code

tmp = getRawDataField(91);

Gets a raw data value of field 91 and assigns it to the tmp variable

Example Code

hndl = getGroup(5521);

isGroupValid(hndl);

tmp = getRawDataField(hndl, 0, 91); 
        

Gets a handle on group 5521 and tests whether handle 5521 is valid

Gets a raw data value of field 91 found in the first entry of group 5521 and assigns it to the tmp variable

Example Code

//see the sample for the getNumField();

Example Code

tmp = getDateField(64, YYYYMMDDLmd);

setYear(tmp, 1979);

setDateField(64, YYYYMMDDLmd, tmp);

Gets a date value of field 64 in the YYYYMMDD format and assigns it to the tmp variable

Sets the year of the date to 1979 in the tmp variable

Assigns a date from the tmp variable back to field 64

Example Code

// see the example for getMStringField();

Example Code

tmp = ["aa", "abb", "bbbc"];

setMStringField(18, tmp);

Sets an array of strings named tmp

Assigns the array of strings to multiple string field 18

Example Code

tmp = [12, 56, 0, 34];

setRawDataField(91, tmp);

Sets an array of numbers named tmp

Assigns the array of numbers to raw data field 91

Example Code

hndl = getGroup(552);

isGroupValid(hndl); 

setNumField(hndl, 1, 519, 4);

Explanations

Gets a handle on group 552 and tests whether handle 552 is valid

Field 519 from the second entry of group 552 is assigned to 4

Example Code

tmp = getDateField(64, YYYYMMDDLmd);

hndl = getGroup(5521);

isGroupValid(hndl); 

setDateField(hndl, 0, 64, YYYYMMDDLmd, tmp);

Gets a date in the YYYYMMDD format from field 64 and assigns the obtained value to the tmp variable

Gets a handle on group 5521 and tests whether handle 5521 is valid

Field 64 from the first entry of group 5521 is assigned the value from the tmp variable

Example Code

tmp = getStringField(581);

hndl = getGroup(5521);

isGroupValid(hndl); 

setDateField(hndl, 0, 581, tmp);

Gets a string value from field 581 and assigns it to the tmp variable

Gets a handle on group 5521 and tests whether handle 5521 is valid

Field 581 from the first entry of group 5521 is assigned the value from the tmp variable

Example Code

tmp = getMStringField(18);

hndl = getGroup(5521);

isGroupValid(hndl); 

setMStringField(hndl, 0, 18, tmp); 
        

Gets a multiple strings value from field 18 and assigns it to the tmp variable

Gets a handle on group 5521 and tests whether handle 5521 is valid

Field 18 from the first entry of group 5521 is assigned the value from the tmp variable

Example Code

tmp = getRawDataField(91);

hndl = getGroup(5521);

isGroupValid(hndl); 

setRawDataField(hndl, 0, 91, tmp);

Gets a multiple raw data value from field 91 and assigns it to the tmp variable

Gets a handle on group 5521 and tests whether handle 5521 is valid

Field 91 from the first entry of group 5521 is assigned the value from the tmp variable

Example Code

swapFields(63, 573);

Values of field 63 and field 573 were exchanged

Example Code

hndl = getGroup(552);

isGroupValid(hndl); 

swapFields(hndl, 1, 11, 572);]

Gets a handle on group 552 and tests whether handle 552 is valid

Exchanges values of field 11 in the second entry of group 552 and field 572 outside of it

Example Code

hndl = getGroup(552);

isGroupValid(hndl);

swapFields(hndl, 1, 11, hndl, 1, 37);

Gets a handle on group 552 and tests whether handle 552 is valid

Exchanges values of field 11 in the second entry and field 37 in the first entry of group 552

Create date from current date or using passed arguments.

Example Code

getCurrentDate(DATETIMEUtc);

Creates the date data of the DATETIMEUtc format

Example Code

tmp = createDate(YYYYMMDD, 1995, 12, 23);

setStringField(55, dateToString(tmp));

Creates a date of the YYYYMMDD format with corresponding values and assigns it to the tmp variable

Converts the value of the tmp variable to string and assigns this string to be the value of field 55

Example Code

setStringField(55, getCurrentDateStr(DATETIMEUtc));

Gets a current date as a string and assigns this string to be the value of field 55

Example Code

tmp = createDateStr(YYYYMMDD, 1995, 12, 23);]

Creates a date of YYYYMMDD format with corresponding values returns this date as string and assigns it to the tmp variable

Convert from date to string

Example Code

//see the example of createDate()        
        

Example Code

tmp = createDate(YYYYMMDD, 1995, 12, 23);

setStringField(55, dateToString(tmp, YYYYMM));

Creates a date from given data in one format and assigns it to the tmp variable

Field 55 is assigned a value of the tmp varible

Get part of the date - year, month, day, etc.

Example Code

tmp = getCurrentDate(DATETIMEUtc);

tmp2 = getYear(tmp);

setDateField(64, YYYYMMDDLmd, tmp2);

Creates a date handle of the current date

Extracts the year from the tmp variable and assigns it to the tmp2 variable

Sets the value of field 64 to the beginning of current year

Example Code

tmp = getCurrentDate(DATETIMEUtc);

tmp3 = getMonth(tmp);

Creates a date handle of the current date

Extracts the month value from the tmp variable and assigns it to the tmp3 variable

Example code

tmp = createDate(YYYYMMWW, 1995, 12, 2);

setStringField(55, getWeek(tmp));

Creates a date handle <date handle>

Sets the value of the tmp variable to field 55

Example Code

tmp = getCurrentDate(DATETIMEUtc);

tmp4 = getDay(tmp);

Creates a date handle of the current date

Extracts the day value from the tmp variable and assigns it to the tmp4 variable

Example Code

tmp = getCurrentDate(DATETIMEUtc);

tmp5 = getHour(tmp);

Creates a date handle of the current date

Extracts the hour value from the tmp variable and assigns it to the tmp5 variable

Example Code

tmp = getCurrentDate(DATETIMEUtc);

tmp6 = getMinutes(tmp);

Creates a date handle of the current date

Extracts the minutes value from the tmp variable and assigns it to the tmp6 variable

Example Code

tmp = getCurrentDate(DATETIMEUtc);

tmp7 = get Sec(tmp);

Creates a date handle of the current date

Extracts the seconds value from tmp variable and assigns it to the variable tmp7

Example Code

tmp = getCurrentDate(DATETIMEUtc);

tmp7 = getMSec(tmp);

Creates a date handle of the current date

Extracts the mile seconds value from the tmp variable and assigns it to the tmp7 variable

Example Code

tmp = getCurrentDate(DATETIMENanoUtc);

tmp7 = getNSec(tmp);

Creates a date handle of the current date

Extracts the nanoseconds value from the tmp variable and assigns it to the tmp7 variable

Set date part - year, month, day, etc.

Example Code

tmp = getDateField(64, YYYYMMDDLmd);

setYear(tmp, 1979);

setDateField(64, YYYYMMDDLmd, tmp);

Gets the date value of field 64 in the YYYYMMDD format and assigns it to the tmp variable

Sets the year of the date to 1979 in the tmp variable

Assigns the date from the tmp variable back to field 64

Example Code

tmp = getDateField(64, YYYYMMDDLmd);

setMonth(tmp, 06);

setDateField(64, YYYYMMDDLmd, tmp);

Gets the date value of field 64 in the YYYYMMDD format and assigns it to the tmp variable

Sets the month of the date to 06 in the tmp variable

Assigns the date from the tmp variable back to field 64

Example Code

tmp = createDate(YYYYMMWW, 1995, 12, 2);

setWeek(tmp, 4);

setStringField(55, dateToString(tmp));

Gets the date value of field 64 in the YYYYMMWW format and assigns it to the tmp variable

Sets the week of the date to 4 in the tmp variable

Assigns the date from the tmp variable to field 55 in the string format

Example Code

tmp = getDateField(64, YYYYMMDDLmd);

setDay(tmp, 27);

setDateField(64, YYYYMMDDLmd, tmp);

Gets the date value of field 64 in the YYYYMMDD format and assigns it to the tmp variable

Sets the day of the date to 27 in the tmp variable

Assigns the date from the tmp variable back to field 64

Example Code

tmp = getDateField(64, DATETIMEUtc);

setHour(tmp, 10);

 setDateField(64, DATETIMEUtc, tmp);

Gets the date value of field 64 in the DATETIMEUtc format and assigns it to the tmp variable

Sets the hour of the date to 10 in the tmp variable

Assigns the date from the tmp variable back to field 64

Example Code

tmp = getDateField(64, DATETIMEUtc);

setMinutes(tmp, 20);

 setDateField(64, DATETIMEUtc, tmp);

Gets the date value of field 64 in the DATETIMEUtc format and assigns it to the tmp variable

Sets the minutes of the date to 20 in the tmp variable

Assigns the date from the tmp variable back to field 64

Example Code

tmp = getDateField(64, DATETIMEUtc);

setSec(tmp, 20);

 setDateField(64, DATETIMEUtc, tmp);

Gets the date value of field 64 in the DATETIMEUtc format and assigns it to the tmp variable

Sets the seconds of the date to 20 in the tmp variable

Assigns the date from the tmp variable back to field 64

Example Code

tmp = getDateField(64, DATETIMEUtc);

setMSec(tmp, 50);

setDateField(64, DATETIMEUtc, tmp);

Gets the date value of field 64 in the DATETIMEUtc format and assigns it to the tmp variable

Sets the milliseconds of the date to 50 in the tmp variable

Assigns the date from the tmp variable back to field 64

Example Code

tmp = getDateField(64, DATETIMENanoUtc);

setNSec(tmp, 50);

setDateField(64, DATETIMENanoUtc, tmp);

Gets the date value of field 64 in the DATETIMENanoUtc format and assigns it to the tmp variable

Sets the nanoseconds of the date to 50 in the tmp variable

Assigns the date from the tmp variable back to field 64

Change date part with automatic date recalculation

Example Code

tmp = getDateField(64, DATETIMEUtc);

changeYear(tmp, 2);

setDateField(64, DATETIMEUtc, tmp);

Gets the date value of field 64 in the DATETIMEUtc format and assigns it to the tmp variable

Adds 2 years to the value of the date in the tmp variable

Assigns the date from the tmp variable back to field 64

Example Code

tmp = getDateField(64, DATETIMEUtc);

changeMonth(tmp, 5);

 setDateField(64, DATETIMEUtc, tmp);

Gets the date value of field 64 in the DATETIMEUtc format and assigns it to the tmp variable

Adds 5 months to the value of the date in the tmp variable

Assigns the date from the tmp variable back to field 64

Example Code

tmp = getDateField(64, DATETIMEUtc);

changeDay(tmp, 10);

 setDateField(64, DATETIMEUtc, tmp);

Gets the date value of field 64 in the DATETIMEUtc format and assigns it to the tmp variable

Adds 10 days to the value of the date in the tmp variable

Assigns the date from the tmp variable back to field 64

Example Code

tmp = getDateField(64, DATETIMEUtc);

changeHour(tmp, 24);

setDateField(64, DATETIMEUtc, tmp);

Gets the date value of field 64 in the DATETIMEUtc format and assigns it to the tmp variable

Adds 24 hours to the value of the date in the tmp variable

Assigns the date from the tmp variable back to field 64

Example Code

tmp = getDateField(64, DATETIMEUtc);

changeMinutes(tmp, 600);

 setDateField(64, DATETIMEUtc, tmp);

Gets the date value of field 64 in the DATETIMEUtc format and assigns it to the tmp variable

Adds 600 minutes to the value of the date in the tmp variable

Assigns the date from the tmp variable back to field 64

Example Code

tmp = getDateField(64, DATETIMEUtc);

changeSec(tmp, 3600);

setDateField(64, DATETIMEUtc, tmp);

Gets the date value of field 64 in the DATETIMEUtc format and assigns it to the tmp variable

Adds 3600 seconds to the value of the date in the tmp variable

Assigns the date from the tmp variable back to field 64

Example Code

tmp = getDateField(64, DATETIMEUtc);

changeMSec(tmp, 36);

setDateField(64, DATETIMEUtc, tmp);

Gets the date value of field 64 in the DATETIMEUtc format and assigns it to the tmp variable

Adds 36 milliseconds to the value of the date in the tmp variable

Assigns the date from the tmp variable back to field 64

Example Code

tmp = getDateField(64, DATETIMENanoUtc);

changeNSec(tmp, 36);

setDateField(64, DATETIMENanoUtc, tmp);

Gets the date value of field 64 in the DATETIMENanoUtc format and assigns it to the tmp variable

Adds 36 nanoseconds to the value of the date in the tmp variable

Assigns the date from the tmp variable back to field 64

Routing functions

Example Code

clientID = getSourceClientId();

Gets the TA client ID of the session context where the script is applied.

Note: Returns NULL value, if the session is not TA client.

Example Code

clientID = getSourceSessionId();

Gets the FIX session ID of the session context where the script is applied.

Note: Returns NULL value, if the session is not FIX session.

Example Code

sessionQualifier = getSourceSessionQualifier();

Example Code

ParserID = getSessionParser("SOME_SESSION");
transform(ParserID,"8");

Example Code

ParserID = getSessionParser("FIXEdge","SimpleClient");
transform(ParserID,"8");

Example Code

ParserID = getSessionParser("FIXEdge","SimpleClient","Q1");
transform(ParserID,"8");

Example Code

active = isSessionActive("SOME_SESSION");

if (active)        

        print("SOME_SESSION active");

Checks if FIX Session with the "SOME_SESSION" name is active

Prints a message

Example Code

convert("FIX.4.4", "FIX.4.2");

Converts message in the given script context replaces a source FIX44 message with converted to FIX42.

Example Code

transform("FIX.4.2", "8");

Transforms message in the given script context, replaces a source message with transformed to FIX42 MsgType="8".

Example Code

getMsgBySeqNum("TestSender", "TestTarget", 12345);

Searches for message with given SeqNum in the session identified by the ‘sender|target’ pair.

Note: FIX Session where search occurs must be active and use persistent storage.

Example Code

send("sender", "target");

send("exchange");

Sends a message into the session identified by the ‘sender|target’ pair.

Sends a message into the session identified by the ‘exchange’ source identifier.

Example Code

params = [["Storage", "file.txt"], ["ClearTime", "22:00"]]

handler("CMEHandler", params);

Routes a message in the “CMEHandler” handler and sets additional parameters for processing:

Storage = file.txt, ClearTime = 22:00

Example Code

processNetStatusRequest();

Replaces a Network Status Request message (“BC”) with Response (“BD”) in the routing

Example Code

createNotification("E","Session is rejected"); 
        

Creates a notification message (“C”) with “Status = ERROR”, “Code=201”,  “Reason = Session is rejected” in three entries of group (58).

Note: <category> applies values “N” – NOTE, “W” – WARNING, “E” – ERROR, “F” - FATAL

Example Code

strategySend("OrderFlow5");

Processes a message by the default routing strategy with the “OrderFlow5” name.

Note: only default routing strategies can be used for processing: 
deliveryToStrategy, OrderFlowStrategy and WheelOrderFlowStrategy.

Example Code

strategyReject("orders", true);

Rejects a message that was stored by some strategy in the ‘orders’ history. Creates ‘j’ Business Reject when message rejecting has failed.

Notes: The method is used only in the default routing. Searching in history processes by the ‘ClOrdID’ key in the original message if its type: ‘D’, ‘AB’ or by ‘OrigClOrdID’ key in original message if its type: ‘AC’, ‘F’, ‘G’. 
Inapplicable for other messages.

Example Code

msg = serializeMessage();

Example Code

msg = serializeMessage("|");

Parses a message from the specified string and replaces the current message with it.

Error Handling Functions

Example Code:

setStringField(58, "Error (" + getErrorCode() + ") " + getErrorText());

This example assigns the values 'error code' and 'error text' to field 58.

As a result of this function, the content of tag 58 inside the FIX message could be, for example,: "Error (500) Internal server error"

Example Code:

setStringField(58, "Error (" + getErrorCode() + ") " + getErrorText());

This example assigns the values 'error code' and 'error text' to field 58.

As a result of this function, the content of tag 58 inside the FIX message could be, for example,: "Error (500) Internal server error"

History functions

Example Code:

key = new Array("snd","tgt");
time = getFromHistory("orders", key, "ExpireDateTime"); 
        

Returns the ‘20121221-10:52:00’ value from the record with key (snd,tgt) that has been updated by the previous sample.

Notes: the column which is created by the <expireDateTime> parameter always has the “ExpireDateTime” name in history. 
Other columns have names as described in the history description in BL_Config.xml or as a tag number in string representation if the column name is absent in the history description.

Example Code:

key = new Array("snd","tgt");
record = getRecordFromHistory("orders", key);
print(record); 

Returns a fields array of the record with the key (snd,tgt), then prints content into a log. 
The result will show “snd, tgt, ClOrdID, dest2, 20121221-10:52:00” if the record (snd, tgt) has been saved and updated by previous samples.

Notes: Empty fields have NULL values and printing represents it as “<null>”.
If <keyFields> is composite, then all fields in the key set should be filled.

Example Code:

key = new Array("snd","tgt");

removeRecordFromHistory("orders", key);  

Removes a record with a key (snd, tgt) from the ‘orders’ history.

Notes: If <keyFields> is composite, then all fields in the key set should be filled.

Example Code:

key = new Array("snd","");

ndeleted = removeRecordFromHistoryByCompositeKey ("orders", key);

Removes all records with keys which have first the “snd” field in a key.

Notes: the composite <keyFields> set should contain at least one field. All empty fields in a key will be ignored in searching.

Direct Database API functions

Example Code:

var connection = "Odbc1"; 
var query = "DECLARE @tempInt int = ?;
select @tempInt";
var params = [123];
var result = executeSQL(connection, query, params);

The function call consists of the following parameters:

• connection: This is a required string parameter where you specify the connection name that matches the 'DatabaseConnection.Name' in BL_Config.xml.

• query: This is a required string parameter where you write the SQL statement that you want to be executed on the server-side.

• params: This is a required array of integers, doubles, or strings that represent the query parameters to be sent to the server.

• result: This is a required JS Object that you have to initialize as follows:

var result = {
"affectedRowCount":-1,// Mandatory integer, denotes the number of affected rows if the query modifies any data
"data":[[123]]// Mandatory array, includes rows of selected data or an empty array if no data was selected.};

The affectedRowCount field contains the number of rows affected if the query modifies any data. The data field consists of the rows of selected data (each row is an array of the selected columns). If no data is selected, it returns an empty array.

Example Code:

encryptedPass = getStringField("554");
pass = decryptString(encryptedPass);

Example Code:

hash = hashString("MyPassword");

Getting hash for the "MyPassword" string.

Note: string for calculating hash should be not "null".

Example Code:

setSessionSeqNums(sessionId, inoutSeqnums)

The parameters for the function call are as follows:

• sessionId: This is a mandatory argument that identifies the session. It can either be a string or a dictionary:

  • If it is a string, it is treated as a sessionId. For example, setSessionSeqNums('MySession', 1).
  • If it is a dictionary, it must contain the following keys to identify the session: 'sender' and 'target'. An optional 'qualifier' key may also be included. For example, setSessionSeqNums({sender: 'Sender1', target: 'Target1' }, 1).

• inoutSeqnums: This argument sets the incoming and outgoing sequence numbers. It can either be an integer or a dictionary:

  • If it is an integer, it sets the incoming seqnum. For example, setSessionSeqNums('MySession', 1).
  • If it is a dictionary, it must include at least one of the 'inSeqNum' or 'outSeqNum' keys. An error occurs if neither of these keys is included. For example, setSessionSeqNums('MySession', { inSeqNum: 1, outSeqNum: 1}).

The function also accepts a third argument. If three arguments are provided, the second and third arguments must be integers representing the incoming and outgoing sequence numbers respectively. Both must be greater than 0. For example, setSessionSeqNums('MySession', 1, 100).The function returns 'undefined' if the call is successful.

Please note that any other combination or types of input arguments will be treated as an error. In case of an error, the standard error condition signaling is used.