<extract> tag
The <extract> tag defines the extraction to occur. The attributes of the extract tag are:
- name
- Specifies the name of the extraction.
- handler
- You can select a .jsp file to display the extracted information to the end user. A default macro handler is shipped with ZIETrans, and it is named default.jsp. You can find this file by clicking the ZIETrans Project View tab of the ZIETrans Toolkit and expanding the project name, and then expanding Macros > Macro Event Handlers. If you want to create your own handler, ensure that you return control to the ZIETrans runtime.
- showHandler
- Specifies whether the extracted information should be shown to the end user. Valid values are true and false.
- shared
- Specifies whether a global variable being extracted is shared between all the applications in the same EAR file.
- save
- Specifies whether the extracted information is saved to a global
variable. Valid values are
true
andfalse
. - variableName
- If the extracted information is being saved to a global variable, variableName specifies the name of a new or existing global variable.
- overwrite
- If the extracted information is being saved to an existing global
variable, overwrite specifies whether the extracted information is
to overwrite the current value of the existing global variable, or
whether the extracted information is to be appended to the current
value. Valid values are
true
andfalse
.True
specifies that the value of the existing global variable is overwritten. - index
- If the value being extracted is being written to an existing
indexed global variable, this attribute specifies the index number
to which the value being set is written. The effect of this attribute
is dependent on the value of the overwrite attribute.
If overwrite=true, the value being extracted overwrites the existing
variable, beginning at the specified index. If
overwrite=false
, the value being extracted is inserted into the existing variable, beginning at the specified index. - indexed
- Specifies whether the extracted information is a single string
or a list of strings. Valid values are
true
andfalse
.True
specifies that the extracted information is a list of strings. - isBidi
- Specifies whether the connection used in recording the macro
is bidirectional. Valid values are
true
andfalse
. - isRtlScreen
- Specifies whether the bidirectional screen is right-to-left.
Valid values are
true
andfalse
. - screenorientation
- Specifies the orientation of the extract action. Valid values
are
ltr
andrtl
.