Serial Numbers > Change strings (TX, TXQ, TXQL)

All three commands (TX, TXQ and TXQL) are used to change the text of a serial number entity in a job. They differ in the following: The TX command can only change one serial number at a time. The TXQ command can also only change one serial number at a time but several TXQ commands can be used directly after each other to fill a queue (list) of texts which will be marked sequentially. The TXQL command allows to change several serial numbers at once and to fill multiple entries of the queue with one FCI command.

	TX	TXQ	TXQL
Advantages and particularities	•Easy to use. •Not only set but also get current text. •Usable with and without (but not while in) trigger mode [a].	•Set up queue of texts. •Fill queue while in trigger mode [a]. •Last text is repeated if queue empty.	•Set up queue of texts. •Fill queue while in trigger mode [a]. •No further marking output if queue empty. •Reduced FCI calls for queue generation. •Up to 4000 texts.
Requirements	•Only valid for ScSerialnumber2D entities (SN). •The SN needs an Entity Name <EN> (SAMLight -> Entity Info -> Name). •The SN needs increment set to '0' (SAMLight -> Serial Number -> Inc. Value).
Get next marking	Yes, with TX <EN>	No [b]	No [b]
Change text while M = 1	No	Yes	Yes
Reset to default text [c]	The current value [b] is reset with one of the following actions: •loading the job in SLR 1 mode •CJP •rebooting the USC card
Set up queue of texts	No	Yes, see table 50	Yes, see table 50

Table 50: Comparison of TX, TXQ and TXQL

[a]: Entering trigger mode: ET 1, M 1 Leaving trigger mode: M 0 Marking without trigger mode: ET 0, M 1 [b]: It is not possible to get the text for the next marking. However, TX <EN> gives the current value (last buffered text). [c]: The default text of a serial number can be set in SAMLight -> Serial Number -> Format (with "custom format" enabled). This default can be changed with SI F and saved with JS. Examples:
TX: TX "SN1" "a" TX "SN2" "aa"	TXQ: TXQ 1 "SN1" "a" TXQ 1 "SN2" "aa" TXQ 2 "SN1" "b" TXQ 2 "SN2" "bb"	TXQL: TXQL ",1,SN1,a,1,SN2,aa,2,SN1,b,2,SN2,bb"

[a]: Entering trigger mode: ET 1, M 1
Leaving trigger mode: M 0
Marking without trigger mode: ET 0, M 1

[b]: It is not possible to get the text for the next marking. However, TX <EN> gives the current value (last buffered text).

[c]: The default text of a serial number can be set in SAMLight -> Serial Number -> Format (with "custom format" enabled). This default can be changed with SI F and saved with JS.

Examples:

TX:

TX "SN1" "a"
TX "SN2" "aa"

TXQ:

TXQ 1 "SN1" "a"
TXQ 1 "SN2" "aa"
TXQ 2 "SN1" "b"
TXQ 2 "SN2" "bb"

TXQL:

TXQL ",1,SN1,a,1,SN2,aa,2,SN1,b,2,SN2,bb"

	TXQ	TXQL
Fill queue	The queue can be filled when the desired job is loaded, regardless of the state of the trigger mode [a] (on or off).
Maximum queue length	24 queue texts [d]	4000 queue texts [d], [e]
Execute queue	The queue will be executed only in trigger mode. [a]
Marking output when queue is empty	Last text of queue is repeated. [i]	No further marking, the whole job will not be marked. [f], [g]
Clear queue	The queue is cleared with one of the following actions: •TXQ 0 or TXQL 0 (TXQL 0 since version 3.8.5_19) •loading a different job •CJP •reboot of the USC card
Buffered texts from queue	With entering the trigger mode [a], some queue texts are taken into the buffer - and are simultaneously removed from the queue. Thus, when leaving the trigger mode [a], all buffered texts [h] are lost.
Clear buffer	•with leaving trigger mode [a] •with reboot of card	•with leaving trigger mode [a] •with reboot of card •after first entering TXQL mode
<Sync>	<Sync> describes which queue entries belong together and have to be executed before the next marking operation. In general, the <Sync> parameter of successive queue entries must not be the same. Only if multiple serial numbers should be changed simultaneously, these successive queue entries need to be with identical <Sync> parameter.

Table 51: Queue handling of TXQ and TXQL

[d]: Each of the queue texts may contain up to 4095 characters. In general, each FCI command may contain up to 9999 characters.

[e]: Due to RAM reasons, the maximum queue length for TXQL starts with 24. If needed, the maximum queue length is automatically increased up to 4000.

[f]: Prevent Further Mark is reset with:

•loading a different job

•CJP

•Card reboot

[g]: In Flash JobIOSelection Mode, the ready for trigger signal is inactive if the queue is empty and if there are no texts left in the buffer.

[h]: The maximum number of buffered texts depends on the job size. See ETB for further information.

[i]: Note that this behavior is only true as long as no TXQL command has been sent. Sending TXQL once will switch the card into the TXQL mode where no further marking is executed when the end of the list is reached. Consequently, do not mix TXQ and TXQL!

TX <EN> [<Text>] Get/Set text of serial number
Description	Get or set the text of a serial number.
<EN>	Value: <string>	Function
	empty	Not available. This parameter is obligatory.
	Entity_Name	Get or set a text of the serial number with the entity name <EN>. If this string contains spaces, quotation marks are necessary.
<Text> [optional]	Value: <string>	Function
	empty	Get the text of the serial number.
	Text	Set <Text> to the serial number. If this string contains spaces, quotation marks are necessary.
Example	Command	Return	Note
	TX "SN1" "Hi"	0:	Set text Hi to serial number SN1.
	TX "SN1"	0: "Hi"	Get text of serial number SN1.

Notes	•There is a special string for <Text> to not mark the serial number or barcode: @@@Scaps.SpecialTag.DoNotMark@@@ •If there are several serial numbers with identical entity name <EN> in the job, all these serial numbers will be changed with the TX command.
Save	•Current serial number text can be saved with JS.
Restriction	•Set: not allowed during marking •The entity needs to be a ScSerialnumber2D entity. •The SN needs an Entity Name <EN> (SAMLight -> Entity Info -> Name). •The SN needs increment set to '0' (SAMLight -> Serial Number -> Inc. Value).
Errors	•1: Too many parameters •5: Not allowed during marking •6: Entity not found •18: SN increment must be 0

Table 52: TX

TXQ [<Sync>] [<EN>] [<Text>] Get queue information or set text of serial number into a queue
Description	Add the text of the serial number to a queue or get the queue information.
<Sync> [optional]	Value: <int>	Function
	empty	TXQ returns two values: the number of queue entries which are currently used and filled with commands and the maximum size of the queue.
	0	TXQ 0 clears all queue entries.
	Sync [-231, 231-1]	<Sync> describes which queue entries belong together and have to be executed before the next marking operation. In general, the <Sync> parameter of successive queue entries must not be the same. Only if multiple serial numbers should be changed simultaneously, these successive queue entries need to be with identical <Sync> parameter. Parameter 2 and parameter 3 obligatory.
<EN> [optional]	Value: <string>	Function
	empty	Without parameter 2 and parameter 3, the number of queue entries which are currently used and filled with commands and the maximum size of the queue. Can only be used if parameter 3 is also empty.
	Entity_Name	<EN> is the name of the serial number. If this string contains spaces, quotation marks are necessary.
<Text> [optional]	Value: <string>	Function
	empty	Without parameter 2 and parameter 3, the number of queue entries which are currently used and filled with commands and the maximum size of the queue. Can only be used if parameter 2 is also empty.
	Text	Add <Text> to the queue for the serial number <EN> with <Sync>. If this string contains spaces, quotation marks are necessary.
Example	Command	Return	Note
	TXQ 0	0:	Queue is cleared.
	TXQ 1 "SN1" "Hi"	0:	Add Hi to the queue for serial number SN1, Sync 1.
	TXQ 2 "SN1" "123"	0:	Add 123 to the queue for serial number SN1, Sync 2.
	TXQ 2 "SN2" "Hallo"	0:	Add Hallo to the queue for serial number SN2, Sync 2.
	TXQ	0:3 24	Get current state of the queue. The queue has 3 entries, maximum queue length is 24.
	When trigger mode is started with this queue, the serial numbers of the current job will be changed in the following way: •First marking result will be "Hi" for SN1 and <DefaultText> for SN2. •Second marking result will be "123" for SN1 and "Hallo" for SN2. •Further marking results will be "123" for SN1 and "Hallo" for SN2, because queue empty.
Notes	•There is a special string for <Text> to not mark the serial number or barcode: @@@Scaps.SpecialTag.DoNotMark@@@ •When queue is empty, the last text of queue is repeated. •With entering the trigger mode, some queue texts are taken into the buffer - and are simultaneously removed from the queue. Thus, when leaving the trigger mode, all buffered texts are lost. •If there are several serial numbers with identical entity name <EN> in the job, all these serial numbers will be changed with the TXQ command.
Save	N/A
Restriction	•The entity needs to be a ScSerialnumber2D entity. •The SN needs an Entity Name <EN> (SAMLight -> Entity Info -> Name). •The SN needs increment set to '0' (SAMLight -> Serial Number -> Inc. Value). •The queue will be executed only in trigger mode. •The maximum queue length is 24.
Errors	•1: Too many parameters •8: Parameter out of range •11: The internal queue is full and cannot accept any more commands

Table 53: TXQ

TXQL [<Sep><Sync><Sep><EN><Sep><Text>]* Get queue information or set multiple texts of serial numbers into a queue If this string contains spaces, quotation marks are necessary.
Description	Add multiple texts of serial numbers to a queue or get the queue information.
<Sep> [optional]	Value: <char>	Function
	empty	TXQL returns two values: the number of queue entries which are currently used and filled with commands and the maximum size of the queue.
	0	TXQL 0 clears all queue entries.
	Separator [0x23, 0xFF]	<Sep> must be one ASCII character. <Sep> may not occur in <Sync>, <EN> and <Text>. Obligatory to set new information in queue.
<Sync> [optional]	Value: <int>	Function
	empty	Without any parameters: Get queue entries With "0" as parameter 1: Clear the queue.
	Sync [-231, 231-1]	<Sync> describes which queue entries belong together and have to be executed before the next marking operation. In general, the <Sync> parameter of successive queue entries must not be the same. Only if multiple serial numbers should be changed simultaneously, these successive queue entries need to be with identical <Sync> parameter. Parameter 3 and parameter 4 obligatory.
<EN> [optional]	Value: <string>	Function
	empty	Without any parameters: Get queue entries With "0" as parameter 1: Clear the queue.
	Entity_Name	<EN> is the name of the serial number. If this string contains spaces, quotation marks are necessary. Parameter 2 and parameter 4 obligatory.
<Text> [optional]	Value: <string>	Function
	empty	Without any parameters: Get queue entries With "0" as parameter 1: Clear the queue.
	Text	Add <Text> to the queue for the serial number <EN> with <Sync>. If this string contains spaces, quotation marks are necessary. Parameter 2 and parameter 3 obligatory.
Example	Command	Return	Note
	TXQL 0	0:	Queue is cleared.
	TXQL ",1,SN1,Hi,2,SN1,123,2,SN2,Hallo"	0:3 24	Add Hi to the queue for serial number SN1, Sync 1. Add 123 to the queue for serial number SN1, Sync 2. Add Hallo to the queue for serial number SN2, Sync 2.
	TXQL "@1@SN1@a@2@SN1@b"	0:5 24	Add a to the queue for serial number SN1, Sync 1. Add b to the queue for serial number SN2, Sync 1.
	TXQL	0:5 24	Get number of queue entries which are currently used and filled with commands and the maximum size of the queue. In this example 5 of 24 are filled.
	When trigger mode is started with this queue, the serial numbers of the current job will be changed in the following way: •First marking result will be "Hi" for SN1 and <DefaultText> for SN2. •Second marking result will be "123" for SN1 and "Hallo" for SN2. •Third marking result will be "a" for SN1 and "Hallo" for b. •Further markings will be prevented, because queue empty.
Notes	•There is a special string for <Text> to not mark the serial number or barcode: @@@Scaps.SpecialTag.DoNotMark@@@ •When queue is empty, no further marking, the whole job will not be marked. •* The parameters [<Sep><Sync><Sep><EN><Sep><Text>] can be repeated. •With entering the trigger mode, some queue texts are taken into the buffer - and are simultaneously removed from the queue. Thus, when leaving the trigger mode, all buffered texts are lost. •If there are several serial numbers with identical entity name <EN> in the job, all these serial numbers will be changed with the TXQL command.
Save	N/A
Restriction	•The entity needs to be a ScSerialnumber2D entity. •The SN needs an Entity Name <EN> (SAMLight -> Entity Info -> Name). •The SN needs increment set to '0' (SAMLight -> Serial Number -> Inc. Value). •The queue will be executed only in trigger mode. •The maximum queue length is 4000.
Errors	•2: Too few parameters. This happens if the element count is not a multiple of three. No entries will be added to the queue. •6: Entity not found •11: The internal queue is full and cannot accept any more commands. No entries will be added to the queue.

Table 54: TXQL