Jameleon - Jagacy Plug-in - Syntax Reference

Last published: 13 February 2008 11:11 | Doc for 0.5.6

Jagacy Plug-in

Technical Documents

Project Documentation

Available Tags

This is a list of available tags for Jagacy 3270 Plug-in. This list of tags is also available in the Jameleon GUI. You can get there by selecting the "Functional Points" tab on the lower-left. All tags, including custom tags and other enabled plug-ins' tags, show up in the GUI.

Jagacy 3270 Plug-in Tags

Tag	Short Description
<jagacy-is-text-present/>	Checks for text on the current screen and stores the result (true/false) in the provided context variable name.
<jagacy-send-key/>	Enters a given key.
<jagacy-send-string/>	Sends a series of non-command keys to the screen.
<jagacy-session/>	A Session tag for the Jagacy 3270 plug-in.
<jagacy-set-field/>	Sets the provided field to the provided value.
<jagacy-set-label-value/>	Sets the value of a field marked by the preceeding text.
<jagacy-set-value-at-rowcolumn/>	Sets the value of a field located at the row column coordinates.
<jagacy-validate-text-not-present/>	Verifies that the given text doesn't exist on the screen or on the provided row if defined.
<jagacy-validate-text-present/>	Verifies that the given text exists on the screen or on the provided row if defined.
<jagacy-wait-for-change/>	Waits for the screen to change for the time provided or 4 seconds.
<jagacy-wait-for-text/>	Waits for the provided text to display on the screen.

jagacy-is-text-present

Checks for text on the current screen and stores the result (true/false) in the provided context variable name.

Take a look at this tag's API docs and source code for more information.

Attribute Name	Context Name	Description	Default	Required	Type
text		The text that should exist on the screen		true	java.lang.String
varName		The context variable name to the store the result in.		true	java.lang.String
row		The row number that the text should exist on. If not set, then the entire screen is searched.		false	java.lang.Integer
functionId		The id of this function. This is used in the macro as a short description of the function		true	java.lang.String
breakPoint		Tells the GUI to stop at this functional point		false	boolean
precondition		Specifies this is a precondition		false	boolean
postcondition		Specifies this is a postcondition and will therefore get executed even if a previous functional point or session tag failed.		false	boolean
expectFailure		Specifies a failure is expected.		false	boolean
expectException		Specifies an exception is expected.		false	boolean
functionDelay		The delay time to use at the end of each functional point	-1	false	long

jagacy-send-key

Enters a given key. The following keys are valid: 'ATTN', 'BACK TAB', 'BACKSPACE', 'CLEAR', 'DOWN ARROW', 'DUPLICATE', 'ENTER', 'ERASE EOF', 'ERASE INPUT', 'HOME', 'LEFT ARROW', 'NEWLINE', 'PA1', 'PA2', 'PA3', 'PF1', 'PF10', 'PF11', 'PF12', 'PF13', 'PF14', 'PF15', 'PF16', 'PF17', 'PF18', 'PF19', 'PF2', 'PF20', 'PF21', 'PF22' 'PF23', 'PF24', 'PF3', 'PF4', 'PF5', 'PF6', 'PF7', 'PF8', 'PF9', 'RESET', 'RIGHT ARROW', 'SYSREQ', 'TAB', 'UP ARROW'

Take a look at this tag's API docs and source code for more information.

Attribute Name	Context Name	Description	Default	Required	Type
key		The name of a key to send to the screen		true	java.lang.String
functionId		The id of this function. This is used in the macro as a short description of the function		true	java.lang.String
breakPoint		Tells the GUI to stop at this functional point		false	boolean
precondition		Specifies this is a precondition		false	boolean
postcondition		Specifies this is a postcondition and will therefore get executed even if a previous functional point or session tag failed.		false	boolean
expectFailure		Specifies a failure is expected.		false	boolean
expectException		Specifies an exception is expected.		false	boolean
functionDelay		The delay time to use at the end of each functional point	-1	false	long

jagacy-send-string

Sends a series of non-command keys to the screen.

Take a look at this tag's API docs and source code for more information.

Attribute Name	Context Name	Description	Default	Required	Type
key		After the given text is sent to the screen, a key, if provided, will be pressed.		false	java.lang.String
text		The desired text to send to the screen.		true	java.lang.String
functionId		The id of this function. This is used in the macro as a short description of the function		true	java.lang.String
breakPoint		Tells the GUI to stop at this functional point		false	boolean
precondition		Specifies this is a precondition		false	boolean
postcondition		Specifies this is a postcondition and will therefore get executed even if a previous functional point or session tag failed.		false	boolean
expectFailure		Specifies a failure is expected.		false	boolean
expectException		Specifies an exception is expected.		false	boolean
functionDelay		The delay time to use at the end of each functional point	-1	false	long

jagacy-session

A Session tag for the Jagacy 3270 plug-in. An example of its use might:

    <testcase xmlns="jelly:jameleon">
<jagacy-session host="locis.loc.gov" beginSession="true">
<jagacy-is-text-present
functionId="Check that page has 'the' in it."
text="the"/>
</jagacy-session>
</testcase>

Take a look at this tag's API docs and source code for more information.

Attribute Name	Context Name	Description	Default	Required	Type
host				false	java.lang.String
visible				false	boolean
application		The name of the application being run according to the *-TestCaseTag.properties file		false	java.lang.String
organization		The organization (affiliate or company name) this application will be tested against.		false	java.lang.String
postcondition				false	boolean
sessionDelay		Sets the tag to delay x milliseconds before anything else is executed.	0	false	long
beginSession		Starts the applicattion and gets it to the state defined in the $testEnviroment-Applications.properties. DEFAULTS to `false`		false	boolean

jagacy-set-field

Sets the provided field to the provided value. The field is defined by the number of the field on the screen and it's offset value.

Take a look at this tag's API docs and source code for more information.

Attribute Name	Context Name	Description	Default	Required	Type
field		The field number on the screen. The first field is 1.		true	java.lang.Integer
offset		The field's offset.		true	java.lang.Integer
value		The value of the field		false	java.lang.String
functionId		The id of this function. This is used in the macro as a short description of the function		true	java.lang.String
breakPoint		Tells the GUI to stop at this functional point		false	boolean
precondition		Specifies this is a precondition		false	boolean
postcondition		Specifies this is a postcondition and will therefore get executed even if a previous functional point or session tag failed.		false	boolean
expectFailure		Specifies a failure is expected.		false	boolean
expectException		Specifies an exception is expected.		false	boolean
functionDelay		The delay time to use at the end of each functional point	-1	false	long

jagacy-set-label-value

Sets the value of a field marked by the preceeding text. For example, if a screen contains:

User ID: _______

then the label would be User ID:

Take a look at this tag's API docs and source code for more information.

Attribute Name	Context Name	Description	Default	Required	Type
label		The label of the field		true	java.lang.String
value		The value of the field		false	java.lang.String
functionId		The id of this function. This is used in the macro as a short description of the function		true	java.lang.String
breakPoint		Tells the GUI to stop at this functional point		false	boolean
precondition		Specifies this is a precondition		false	boolean
postcondition		Specifies this is a postcondition and will therefore get executed even if a previous functional point or session tag failed.		false	boolean
expectFailure		Specifies a failure is expected.		false	boolean
expectException		Specifies an exception is expected.		false	boolean
functionDelay		The delay time to use at the end of each functional point	-1	false	long

jagacy-set-value-at-rowcolumn

Sets the value of a field located at the row column coordinates. For example, if a screen contains an input field at line 7 and row 2 according to the emulation view of a panel then the the text woud be set at the field found by getPosition((7)*80+(2),...) To support more flexible data driven tests, an empty value doesn't cause an error but just a trace warning. jagacy counts rows and columns starting from 0 !

Take a look at this tag's API docs and source code for more information.

Attribute Name	Context Name	Description	Default	Required	Type
key		Dummy Key to fullfill JagacySendKey's requirements.	PF8	false	java.lang.String
row		The row of the field		true	int
column		The column of the field		true	int
value		The value of the field		false	java.lang.String
functionId		The id of this function. This is used in the macro as a short description of the function		true	java.lang.String
breakPoint		Tells the GUI to stop at this functional point		false	boolean
precondition		Specifies this is a precondition		false	boolean
postcondition		Specifies this is a postcondition and will therefore get executed even if a previous functional point or session tag failed.		false	boolean
expectFailure		Specifies a failure is expected.		false	boolean
expectException		Specifies an exception is expected.		false	boolean
functionDelay		The delay time to use at the end of each functional point	-1	false	long

jagacy-validate-text-not-present

Verifies that the given text doesn't exist on the screen or on the provided row if defined.

Take a look at this tag's API docs and source code for more information.

Attribute Name	Context Name	Description	Default	Required	Type
text		The text that should not exist on the screen		true	java.lang.String
row		The row number that the text should exist on. If not set, then the entire screen is searched.		false	java.lang.Integer
functionId		The id of this function. This is used in the macro as a short description of the function		true	java.lang.String
breakPoint		Tells the GUI to stop at this functional point		false	boolean
precondition		Specifies this is a precondition		false	boolean
postcondition		Specifies this is a postcondition and will therefore get executed even if a previous functional point or session tag failed.		false	boolean
expectFailure		Specifies a failure is expected.		false	boolean
expectException		Specifies an exception is expected.		false	boolean
functionDelay		The delay time to use at the end of each functional point	-1	false	long

jagacy-validate-text-present

Verifies that the given text exists on the screen or on the provided row if defined.

Take a look at this tag's API docs and source code for more information.

Attribute Name	Context Name	Description	Default	Required	Type
text		The text that should exist on the screen		true	java.lang.String
row		The row number that the text should exist on. If not set, then the entire screen is searched.		false	java.lang.Integer
functionId		The id of this function. This is used in the macro as a short description of the function		true	java.lang.String
breakPoint		Tells the GUI to stop at this functional point		false	boolean
precondition		Specifies this is a precondition		false	boolean
postcondition		Specifies this is a postcondition and will therefore get executed even if a previous functional point or session tag failed.		false	boolean
expectFailure		Specifies a failure is expected.		false	boolean
expectException		Specifies an exception is expected.		false	boolean
functionDelay		The delay time to use at the end of each functional point	-1	false	long

jagacy-wait-for-change

Waits for the screen to change for the time provided or 4 seconds

Take a look at this tag's API docs and source code for more information.

Attribute Name	Context Name	Description	Default	Required	Type
waitTime		The number of milliseconds to wait until the screen changes. A check will be made every 100 milliseconds.	4000	false	int
functionId		The id of this function. This is used in the macro as a short description of the function		true	java.lang.String
breakPoint		Tells the GUI to stop at this functional point		false	boolean
precondition		Specifies this is a precondition		false	boolean
postcondition		Specifies this is a postcondition and will therefore get executed even if a previous functional point or session tag failed.		false	boolean
expectFailure		Specifies a failure is expected.		false	boolean
expectException		Specifies an exception is expected.		false	boolean
functionDelay		The delay time to use at the end of each functional point	-1	false	long

jagacy-wait-for-text

Waits for the provided text to display on the screen. This is useful when several requests are made before the application is the desired state to continue.

Take a look at this tag's API docs and source code for more information.

Attribute Name	Context Name	Description	Default	Required	Type
text		The desired text to appear and therefore stop waiting.		true	java.lang.String
waitTime		The total time to wait for the text to appear	8000	false	int
intervalWaitTime		The number of milliseconds to wait between changes until the text appears.	100	false	int
functionId		The id of this function. This is used in the macro as a short description of the function		true	java.lang.String
breakPoint		Tells the GUI to stop at this functional point		false	boolean
precondition		Specifies this is a precondition		false	boolean
postcondition		Specifies this is a postcondition and will therefore get executed even if a previous functional point or session tag failed.		false	boolean
expectFailure		Specifies a failure is expected.		false	boolean
expectException		Specifies an exception is expected.		false	boolean
functionDelay		The delay time to use at the end of each functional point	-1	false	long