Information Center

Editing macro screens: Actions

Lists the actions to be performed when a screen within a macro is recognized.

The Actions tab provides all of the actions to perform on the selected screen when it is identified by the macro. To modify an action, choose the action from the Action list. The name of each action is created automatically based on the action type and the contents of the action. To create a new action, choose the appropriate type of action you want to create (for example, <new input action>).

For any field except Screen Name, you can use a variable name or an arithmetic expression as the field value. You can enter these variable names and expressions directly into text areas or add them to lists by selecting <Expression> from the list. If you select <Expression> from the list and the only other options in the list are True and False, the expression must return either True or False.

A variable name should have the following format: $var_name$, where var_name can be alphanumerics, the dash symbol, and the underscore symbol. Variable names must be enclosed in dollar signs. Variable names are case sensitive.

If an action requires row and column values, you can click on the session window at the desired position and the values appear in the row and column field. Click once to give the session window focus, and again for the values of the position you select to appear in the row and column field.

For more information see Macro Actions in the Macro Programming Guide .

In the following descriptions, the macro runtime is the Host On-Demand program module that plays back macros. When the user clicks the Play Macro icon, the macro runtime reads the contents of the specified macro script and generates the macro playback.

To delete a defined action, select it and click Delete.

Click Order to change the order the actions should be performed on the screen.

For more information about the macro script syntax see the Macro Programming Guide.

Input

The Input action sends a sequence of keystrokes to the session window. The sequence can include keys that display a character (such as a, b, c, #, &, and so on) and also action keys (such as [enter], [enterreset], [copy], [paste], and others). For more detailed information see Input action in the Macro Programming Guide.

This action simulates keyboard input from an actual user.

Row and Column
Use the Row and Column fields to specify the row and column location in the session window at which you want the sequence of keystrokes to begin.

String
Use the String input field to specify the key sequence that you want the Input action to perform.

Translate Host Action Keys
The Translate Host Action Keys field indicates whether the macro runtime is to interpret action key names (such as [copy], [enterreset], [tab], and so on) in the input key sequence as action keys or as literal sequences of characters. The default is true (interpret the action key names as action keys).

Move Cursor to End of Input
When the value of this listbox is true (the default), then the macro runtime moves the text cursor in the same way that it would be moved if an actual user were entering keyboard input.

For example, if the key is a text character, such as 'a', then the macro runtime types the character on the session window and then moves the text cursor to the first character position after the 'a'. Similarly, if the key is [tab], then the macro runtime moves the text cursor to the next tab location.

In contrast, if the value of the Move Cursor to End of Input listbox is false, then the macro runtime does not move the text cursor at all. The text cursor remains in the same position as it occupied before the macro runtime performed the Input action.

Password
Selecting the Password checkbox encrypts the input key sequence contained in the String input field. Encryption allows you to include confidential data (such as a password) in the input key sequence without exposing the confidential data to the casual view of anyone looking at the macro script.

Before using this feature you should read and understand the description of this feature in the Password section of Macro Programming Guide.

Follow these steps to encrypt the input key sequence in the String field: Before you start, the Password checkbox should be cleared (not checked).

  1. If the input key sequence that you want is not already present in the String field, type the input key sequence into the String field.
    • The input key sequence appears normally in the String field (for example, 'myPassWord').
    • If you are using the advanced macro format, remember to enclose the input key sequence in single quotes ('myPassWord').
  2. Select the Password checkbox.
    • The Macro Editor encrypts the input key sequence and displays it in the String field using asterisks (***********************).

If you want to revise the encrypted input key sequence, or if you decide that you do not want it encrypted, then clear the Password checkbox. The Macro Editor discards the encrypted string and clears the String field. You can now encrypt a different input key sequence using the method described above, or you can use an unencrypted input key sequence.

Do not try to revise an encrypted input key sequence by typing over or inserting characters into the string of asterisks in the String field (*******)! If you do, then you corrupt the encrypted input key sequence with your unencrypted revisions.

Host ID
The session to which this action applies. Leave the Host ID field blank to have the action apply to the session that launches the macro. See Specifying a Host ID.

Extract

The extract action allows you to capture text that the application is displaying on the screen, or to capture other screen information (depending on the plane selected). You can set options that will save this extracted data into a variable for use later on, or print the data. For more detailed information see Extract action in the Macro Programming Guide.

To create a new extract action use either of the following methods:

Start Row and Start Column
Top left position of the bounding extract rectangle.
End Row and End Column
Bottom right position of the bounding extract rectangle.
Extraction Name
Name of the extraction. Use a name to identify what is being extracted from the session screen. This name is passed to the MacroExtractEvent.
Data Plane
Select one or more of the following planes to extract. You must select at least one plane.
TEXT_PLANE
The text plane contains the text on the screen. When you add a new extract action, TEXT_PLANE is the default data plane.
COLOR_PLANE
The color plane contains color information for each character of the presentation space.
FIELD_PLANE
The field plane represents the field positions and their attributes in the presentation space.
EXFIELD_PLANE
The extended field plane contains extended character attribute data.
DBCS_PLANE
The DBCS plane contains double-byte character set attribute data for each character and field attribute in the presentation space. You can only select DBCS_PLANE when you are running a DBCS session.
GRID_PLANE
The grid plane contains information for displaying the grid.
Unwrap Text
Unwrap text in a field that spans multiple lines on the screen.
Assign Text Plane to a Variable
Assigns the extracted texts into a specified variable.
Host ID
The session to which this action applies. Leave the Host ID field blank to have the action apply to the session that launches the macro. See Specifying a Host ID.
You can enter negative numbers for rows and columns. Negative numbers are virtual positions from the bottom row.

Prompt

Prompts the user for information during macro playback. For more detailed information see Prompt action in the Macro Programming Guide.

The prompt popup window contains text, an input field, and three buttons (OK, Cancel, Help). The text solicits information from the user (for example, "Enter a user ID:"). Typically the user types characters into the input field (such as "myuserid") and then clicks OK. The macro runtime then reads the text from the input field, removes the popup window, and types the same text into the session window beginning at a particular row and column location that you specify. Thus this action allows a macro to solicit text input from the user and then to type this text as keystrokes into a particular location in the session window.

Row and Column
The row and column in the session window where the macro runtime begins typing the text that the user enters. For example, if Row is 4 and Column is 12, then the macro runtime types the text into the session window beginning at row 4, column 12.
Prompt Name
The text that you want to appear to the left of the input field in the popup window. Typically this text states the type of information requested. For example, if you want the user to enter a user ID, the prompt text could be Enter your user ID:.

Remember that if the checkbox for Use Variables and Arithmetic Expressions in Macro is checked then the text must be enclosed in single quotation marks (for example, 'Enter your user ID:').

Prompt Title
The text that you want to appear as the prompt window title. If this field is left blank or if there are multiple prompts in the macro and the macro is configured to show all prompts at the start of the macro, the title will be "Prompt".
Clear Host Field
Determines whether the macro runtime, before typing the text into the session window beginning at the specified Row and Column location, clears the field in the session window that contains that Row and Column location.
Prompt Text
A description of the prompt. This description is for your information only. It is not displayed.
Default Response
Text that the macro runtime initially displays in the input field of the popup window as a default response from the user. The user can either retain this default response or type a different response instead. For example, if the input field is for a file name, the default text could be MyFile. The user could keep this text or type in a different file name.

If you do not want to provide a default value, leave this field blank.

Password Response
Determines whether the macro runtime treats the text that the user types into the input field as confidential information, such as a password.

Response Length
The maximum length for the response value (number of characters).

Translate Host Action Keys
Accepts host key mnemonics, for example [enter], as input for a field on the session screen. The default is true.

Require Response
Determines whether the macro runtime disables the OK button of the popup window until the input field of the popup window contains text. The input field can contain text either because you have specified a default response or because the user has typed text into the input field.

If several prompt actions in the macro have the Require Response field set to true, and if also the Show all Prompts at Start of Macro field is set to true on the Macro tab, then at the start of macro playback, when the macro runtime displays all the prompt input fields in a single popup window, the macro runtime

Move Cursor to End of Input
Places the cursor at the end of the input value on the session screen for subsequent input actions. If action keys such as [tab], [up], or [down] are included in the String field, the Move Cursor to End of Input option is ignored by the macro. That is because the action keys require the cursor to move to a specific place on the screen.
Assign to a Variable
Assigns a user's input to a specified variable. If the variable is an integer, a double, a boolean, or a field, the user input or response must match, otherwise an error or unexpected result occurs. For more information about variable types, see the online help for Variables.
Don't Write to Screen
Enabled only if you select Assign to a Variable. If you select true, the user's input is assigned to a variable, but does not appear on the screen. The default is false.
Host ID
The session to which this action applies. Leave the Host ID field blank to have the action apply to the session that launches the macro. See Specifying a Host ID.

Message

Displays a message to the user. For more detailed information see Message action in the Macro Programming Guide.

Message Title
Caption that appears in the title bar of the message window. The default is to use the macro name.
Message Text
Message displayed in the message window.

Pause

Pauses the macro for the specified amount of time. For more detailed information see Pause action in the Macro Programming Guide.

Duration
Time in milliseconds to pause the macro when it is running.

Transfer

Transfers a file to or from a host. Click Advanced for more options. For more detailed information see Xfer action in the Macro Programming Guide.

Send/Receive
Select if you are sending or receiving files from the host.
Host File Name
Enter the name of the file that you are sending or receiving. The file name must be in the host file format.
Local File Name
Enter the path name and file you are sending or receiving. The file name must be in local file format. Click Browse to locate the file on your system.
Host ID
The session to which this action applies. Leave the Host ID field blank to have the action apply to the session that launches the macro. See Specifying a Host ID.
Advanced Options
Clear before Transfer
Clears the host screen before transferring the file. You should not change this setting because in nearly every case, CMS and CICS require that this command be sent, whereas TSO and i5/OS and OS/400 do not.
Timeout
Specify the length of time (in milliseconds) to wait for a file to transfer. If the transfer does not complete in this time, the macro ends and displays a message. The default is 10000 milliseconds, or 10 seconds.
Options
Enter the host specific options for the file transfer. Options are different for each type of host system.
Local Code-page
Select the local code page for the transfer. This code page should match the code page set in the session configuration properties. The code page is a table that translates EBCDIC codes to local 1-byte codes, or vice versa, when files are transferred. Only valid code pages for your computer's locale are included in this list.
Host File Orientation
Specify whether the host files will be saved in left-to-right or right-to-left format. Use this option if the session is configured to use an Arabic or Hebrew host code page. The default is left-to-right.
Local-File Orientation
Specify whether the local files will be saved in left-to-right or right-to-left format. Use this option if the session is configured to use an Arabic or Hebrew host code page. The default is left-to-right.
Local-File Type
Specify whether the local files you transfer will be saved in the format in which they are saved (implicit) or in the format which they should be displayed. The default is implicit. Use this option if the session is configured to use an Arabic or Hebrew host code page.
Lam-Alef Expansion
Specify if files containing the character Lam_alef should be expanded into two characters, Lam followed by Alef, when received from the host. Use this option if the session is configured to use an Arabic host code page.
Lam-Alef Compression
Specify if files containing the characters Lam followed by Alef should be compressed into one character, Lam_alef, when sent to the host. Use this option if the session is configured to use an Arabic host code page.
Symmetric Swapping
Specify whether brackets are reversed from the source to the target. If symmetric swapping is enabled, brackets are reversed from the source to the target. For example, ( is replaced by ) and ) is replaced by ( when host file orientation is right-to-left. If symmetric swapping is not enabled, the brackets are not reversed. Use this option if the session is configured to use an Arabic or Hebrew host code page and affects the brackets during file transfer.
Numerals Shape
Specify how numerals appear when sending files to the host. The Numerals Shape indicates one of the following:
  • Nominal: all numerals are Arabic numerals
  • National: all numerals are Hindi numerals
  • Contextual: numerals appear Arabic after English text, or numerals appear Hindi after Arabic text
Use this option if the session is configured to use an Arabic host code page.
Round Trip
Specify that if numerals are preceded by Arabic characters, the numerals exchange places with the Arabic characters when transferring files. Use this option if the session is configured to use an Arabic host code page.

Comm wait

Waits for a communication status from the host while the macro is running. For more detailed information see Comm wait action in the Macro Programming Guide.

Connection Status
The type of communication status, as defined by the ECLConnection class, to wait for.
Timeout
Time to wait, in milliseconds, for the communication wait. If a status is not received by the specified time, that macro stops.
Host ID
The session to which this action applies. Leave the Host ID field blank to have the action apply to the session that launches the macro. See Specifying a Host ID.

More information about the ECLConnection class can be found in the Host Access Class Library for Java document included with the Host On-Demand Toolkit.

Trace

Writes out a trace record. For more detailed information see Trace action in the Macro Programming Guide.

Trace Handler
Where the trace text is sent.
Trace Text
Text sent to the trace handler.

Mouse click

Sets the cursor using a mouse click at the specified row and column. For more detailed information see Mouse click action in the Macro Programming Guide.

Row and column
The host screen row and column position for the mouse click.
Host ID
The session to which this action applies. Leave the Host ID field blank to have the action apply to the session that launches the macro. See Specifying a Host ID.

Box select

Marks an area on the screen, replacing a previous selection. For more detailed information see Box selection action in the Macro Programming Guide.

Row (top) and Column (top)
Top left row of the marked rectangle. These values must be numbers within the host screen coordinate system, for example, 24 rows by 80 columns. Negative numbers are virtual positions from the last row.
Row (bottom) and Column (bottom)
Bottom right row of the marked rectangle. These values must be numbers within the host screen coordinate system, for example, 24 rows by 80 columns. Negative numbers are virtual positions from the last row.
Host ID
The session to which this action applies. Leave the Host ID field blank to have the action apply to the session that launches the macro. See Specifying a Host ID.

Run program

Runs a program while the macro plays. For more detailed information see Run program action in the Macro Programming Guide.

Program
The name of the program.
Parameters
The program parameters.
Wait for Program
If you select true, the macro pauses until the program completes. The default is false.
Assign Exit Code to Variable
Enabled only if Wait for Program is true. Select a variable from the list.

Variable update

Updates a variable with a new value. For more detailed information see Variable update action in the Macro Programming Guide.

Name
Select the name of the variable to update.
Type
Displays the type of the currently selected macro. If the variable is not defined in the current macro, no type appears.
Value
Any valid expression, for example, 'hello', 5, or $var$ + 1.
Current
Click Current to assign the content of the screen at the current cursor position to a variable. When the macro runs, the content of the screen at the cursor position you specify becomes the value for the variable. Current is enabled only for field variables.

Play macro

Stops the currently running macro and starts playing the macro you specify. You can only select macros that are available in your current session. For more detailed information see PlayMacro action in the Macro Programming Guide.

Macro Name
Lists the available macros by name. Macro names are case-sensitive! Therefore, mymacro is a different name than MyMacro, MyMacrO, myMacro, and so on.
Macro Description
The description you gave the macro when you created it.
Start Screen Name
Lists all screens for the macro you select, as well as *DEFAULT*. If you select a specific screen from the list, the chained macro starts at the screen you specify. If you select *DEFAULT*, the macro starts at the screen you defined as the start screen when you created the macro.
Variable Transfer
If you select Transfer, all of the current variables are transferred to the next running macro. The default is No Transfer.

Perform

Invokes a method on an instance of a class. The type which represents the imported class must be declared on the Variables tab, unless the variable containing the instance is inherited from another macro. For more detailed information see Perform action in the Macro Programming Guide.

Action to perform
The call to the method or constructor.
Example Comments
$fis.close()$ Calls the close() method of the Java class (such as java.io.FileInputStream) underlying the imported type to which the variable fis belongs.
$zis.createZipEntry( $name$ )$ Calls the createZipEntry() method of the Java class (such as java.util.zip.ZipInputStream) underlying the imported type to which the variable zis belongs.
$userVar.update( 5, 'Application', $str$)$ Calls the update() method of the Java class (such as mypackage.MyClass) underlying the imported type to which the variable userVar belongs.

Conditional

Allows you to place conditions around actions. If you want to use the Conditional action, select Use Variables and Arithmetic Expressions in Macro on the Macro tab in the Macro Editor. Otherwise, your macro might not work as expected. For more detailed information see Conditional action in the Macro Programming Guide.

Condition
Type a valid condition, for example, ($varA$ == 'abc') && ($varB$ != 1). If you do not type a conditional, the default is true. The following table shows the syntax for conditionals:
Symbol Definition
== equal to
!= not equal to
< less than
> greater than
<= less than or equal to
>= greater than or equal to
|| or
&& and
! not

You can use parentheses to show the order of operations,, and you can include arithmetic expressions as terms in conditional expressions. For example, the following expression evaluates to true:
(((5+2)*3) == 21)

Condition is true
The actions that appear in the Actions list will be performed on the screen if the condition is true. For each conditional action you create, you can specify one condition, along with a set of actions to perform if the condition is true and a different set of actions to perform if the condition is false.
Action
You can create any action for a conditional action except another conditional action.
  • Input
    Sends keystrokes to the screen.
  • Extract
    Extracts data from the screen.
  • Prompt
    Prompts the user for information while the macro is running.
  • Message
    Displays a message to the user.
  • Pause
    Pauses the macro for the specified amount of time.
  • Transfer
    Transfers a file to or from the host.
  • Comm wait
    Waits for a communication status.
  • Trace
    Writes out a trace record.
  • Mouse click

    • Simulates a user mouse click.
  • Box select

    • Marks an area on the screen.
  • Run program

    • Runs any program that can be executed by the run time.
  • Variable update

    • Updates a variable with a new value.
  • Play macro

    • Stops the currently running macro and starts playing the macro you specify.
Condition is false
The actions that appear in the Actions list will be performed on the screen if the condition is false.

The Condition field is grayed out. For each conditional action you create, you can specify one condition, along with a set of actions to perform if the condition is true and a different set of actions to perform if the condition is false.

Action
You can create any action for a conditional action except another conditional action.
  • Input
    Sends keystrokes to the screen.
  • Extract
    Extracts data from the screen.
  • Prompt
    Prompts the user for information while the macro is running.
  • Message
    Displays a message to the user.
  • Pause
    Pauses the macro for the specified amount of time.
  • Transfer
    Transfers a file to or from the host.
  • Comm wait
    Waits for a communication status.
  • Trace
    Writes out a trace record.
  • Mouse click

    • Simulates a user mouse click.
  • Box select

    • Marks an area on the screen.
  • Run program

    • Runs any program that can be executed by the run time.
  • Variable update

    • Updates a variable with a new value.
  • Play macro

    • Stops the currently running macro and starts playing the macro you specify.

Example of a conditional

In this example, your macro has a run program action that assigns an exit code to the variable $exit$ (0 if the program executes successfully, non-zero if not). You can use the conditional action to display one message if the exit code is 0 (success), and another message if the exit code is not zero (failure). Complete the following steps to create the conditional action:

  1. In the Macro Editor, open your macro that runs the program.
  2. On the Screens tab, select the screen with the run program action. On the Actions tab, select <new conditional action> from the Action list.
  3. In the Condition field, type the condition $exit$ == 0.
  4. On the Condition is True tab, select <new message action> from the Action list.
  5. In the Message Text field, type 'Program executed successfully.'

    If the condition is true, for example, the exit code for your program is 0, a message appears saying the program executed successfully. You can specify more actions on this tab. The macro performs these actions if the exit code is 0.

  6. On the Condition is False tab, select <new message action> from the Action list.

    Note: The Condition field is grayed out. For each conditional action you create, you can specify one condition, along with a set of actions to perform if the condition is true and a different set of actions to perform if the condition is false. Currently, there should be no actions defined on the Condition is False tab.

  7. In the Message Text field, type 'Program exited abnormally with an exit code of: ' + $exit$

    If the condition is false, for example, the exit code for your program is not 0, a message appears saying the program exited with an error and the exit code will be displayed. You can specify more actions on this tab. The macro performs these actions only if the exit code is not 0.

Your macro is now ready. If you select Edit Code on the Macro Editor window, you should see the following code: 


        <actions>
           ...
            <if condition="$exit$ == 0" >
                  <message title="" value="'Program executed successfully'" />
            </if>
            <else>
                  <message title="" value="'Program exited abnormally with an exit code of: '+$exit$" />
            </else>
           ...
        </actions>

Note: Toggling back and forth between the Condition is True tab and the Condition is False tab populates the Action list with the actions from the <if> block and the actions from the <else> block, respectively.

Print Start

Starts a print session for this macro. If a print session is already started for this macro, then the print session is ended and a new print session is started using the printer setup and page setup specified for this Print Start action. For more detailed information see Print actions in the Macro Programming Guide.

Note Print Start is supported for 3270 Display sessions only.
Printer Setup
Displays a printer setup window that allows you to configure the printer setup for this print session. This printer setup window is similar to the Printer window that is displayed for a 3270 Printer session.
Page Setup
Displays a page setup window that allows you to configure the page setup for this print session. This page setup window is similar to the Page Setup window that is displayed for a 3270 Printer session.
Assign Return Code to a Variable
Allows you to assign to a variable the return code from the attempt to start a print session. To choose a variable, either click the name of an existing variable or click <New Variable> to create a new variable.
Note The return code will be either 0 for success or -1 for failure. Also, there are some printer errors that can cause the macro to end with errors.

Print Extract

Copies data from a rectangular area of the screen and sends it to the current print destination. If a Print Start action has not been performed then a Print Start with a default printer setup and a default page setup is sent to the print destination before this Print Extract action is performed. For more detailed information see Print actions in the Macro Programming Guide.

Note Print Extract is supported for 3270 Display sessions only.

You should use the Print Extract action with the Print Start and Print End actions as follows:

  1. Do a Print Start action to start a print session.
  2. Do Print Extract actions to send data to the print destination.
  3. Do a Print End action to end the print session.
Start Row and Start Column
Top left corner of the bounding extract rectangle.
End Row and End Column
Bottom right corner of the bounding extract rectangle.
Assign Return Code to a Variable
Allows you to assign to a variable the return code from the attempt to send the extracted data to the print destination. To choose a variable, either click the name of an existing variable or click <New Variable> to create a new variable.
Note The return code will be either 0 for success or -1 for failure. Also, there are some printer errors that can cause the macro to end with errors.
Host ID
The session to which this action applies. Leave the Host ID field blank to have the action apply to the session that launches the macro. See Specifying a Host ID.

Print End

Allows you to end a print session. For more detailed information see Print actions in the Macro Programming Guide.

Note Print End is supported for 3270 Display sessions only.
Assign Return Code to a Variable
Allows you to assign to a variable the return code from the attempt to send the extracted data to the print To choose a variable, either click the name of an existing variable or click <New Variable> to create a new variable.
Note The return code will be either 0 for success or -1 for failure. Also, there are some printer errors that can cause the macro to end with errors.

SQLQuery

Sends an SQL statement to a remote database server, retrieves the data resulting from the statement, and either displays the data, writes the data into a global variable, or writes the data into a file. For more detailed information see SQLQuery action in the Macro Programming Guide.

The SQLQuery action supports only SQL statements of type Select. It does not support SQL statements of type Insert, Update, or Delete.

The SQLQuery action has two main sections: a statement section and a result section.

The statement section occupies the upper area of the window and includes the following fields: Database URL, Driver Identifier, Driver Class, User ID, Password, and Statement. You can modify the information in this section in three ways:

You can edit any of the fields at any time by typing into the field.

The result section occupies the lower area of the window and includes the remaining fields: Output Result To, File Name, Show in Web browser, File Type, Hold on output window, Overwrite, and Append. You can use the fields in this section to direct the data resulting from an SQL statement in one of three ways:

SQL Wizard
Click SQL Wizard to invoke the SQL Wizard:
  1. With the SQL Wizard you can create an SQL statement, test it, and view the results.
  2. When you have created the SQL statement that you want to use in the macro, then do one of the following actions to save the SQL statement and its associated information into the SQLQuery action window of the Macro Editor:
    • If you are running a Java 1 browser:
      • On the SQL tab, click Save SQL; or
      • On the Results tab, click Save SQL.
    • If you are running a Java 2-enabled browser:
      • On the Review tab, click Save; or
      • On the Results tab, click Save SQL.
  3. The SQL Wizard writes the SQL statement and its associated information into the appropriate fields of the SQLQuery action window in the Macro Editor. For a description of the fields that are updated, see Using the SQL Wizard in the Macro Programming Guide.
  4. When you have finished using the SQL Wizard, click Cancel to close it.
Import Query
Click Import Query to import an SQL statement. You can import an SQL statement either from the current session or from a Personal Library.
Database URL
Type a Database URL (see Specifying a database URL).
Driver Identifier
The listbox includes the names of all the JDBC drivers that have been registered with Host On-Demand. Expand the listbox and click the name of the registered JDBC driver that you want to use, or click Other to specify another driver.

For general information on using a JDBC driver, see Registering a JDBC driver.

Driver Class
The fully qualified Java class name of the JDBC driver.
User ID
User ID required to access the database (if required.)
Password
Password required to access the database (if required.)
Statement
The SQL statement that you want to send to the database server. If the Statement field already contains an SQL statement, you can edit it (even if the SQL statement was imported or was created using the SQL Wizard).
Output Result To:
Selects the output destination for the data resulting from an SQL statement:
File Name
When the Output Result To field is File, type the path of the output file into this field. Note: You must specify a complete file path and name, including the drive letter if any (for example, c:\Documents and Settings\user1\output.txt).
Show in Web browser
When the Output Result To field is File, select this checkbox to display the contents of the file in the default browser. The browser must have the required plug-in.

For some browsers, you must configure the security settings of the browser to allow a Java applet or application to launch an instance of the browser to display a local file (see Configuring a browser to display a local file ).

File Type
When the Output Result To field is File, click the format (such as ASCII Text, Comma separated values, and so on) that you want Host On-Demand to use for the output file.
Hold on output window
When the Output Result To field is Display, select this checkbox to cause the macro runtime to wait to process the next action until the user clicks Continue on the display window.
Overwrite, Append
When the Output Result To field is File, click Overwrite to overwrite the contents of an existing file, or click Append to append the data to an existing file. If the file does not exist, then either Overwrite or Append creates the new file.
Advanced Options
Local-File Type
This option specifies whether local files are in Logical or Visual format. Use this option if the session is configured to use an Arabic or Hebrew host code page. The default is Logical.
Local-File Orientation
This option specifies whether local files are in left-to-right or right-to-left format. Use this option if the session is configured to use an Arabic or Hebrew host code page. The default is Left-to-Right.
Host-File Type
This option specifies whether the Host file should be saved in logical or visual format. This option should be visual for zSeries host. Use this option if the session is configured to use an Arabic or Hebrew host code page. The default is Visual. (This option is not enabled for the JDBC driver from the AS/400 Toolbox for Java.)
Host-File Orientation
This option specifies whether the Host file should be saved in left-to-right or right-to-left format. Use this option if the session is configured to use an Arabic or Hebrew host code page. The default is Left-to-Right. (This option is not enabled for the JDBC driver from the AS/400 Toolbox for Java.)
Lam-Alef Expansion
This option specifies the behavior of the Lam-Alef characters. When receiving Arabic data from the host through the SQL Wizard statement, the character Lam-Alef is expanded into two characters, Lam followed by Alef if there is space after the Lam-Alef character. This option is enabled only for a session configured to use an Arabic host code page. The default is on.
Lam-Alef Compression
This option specifies the behavior of the Lam-Alef characters. When sending Arabic data to the host through the File Upload statement, the characters Lam followed by Alef are compressed into one character and space is added after the Lam-Alef character. This option is enabled only for a session configured to use an Arabic host code page. The default is on. (This option is not enabled for the JDBC driver from the AS/400 Toolbox for Java.)
Symmetric Swap
This option specifies the behavior of the symmetric characters such as brackets; the inversion of the screen causes directional characters to be replaced by their counterparts. Use this option if the session is configured to use an Arabic or Hebrew host code page. The default is on. (This option is not enabled for the JDBC driver from the AS/400 Toolbox for Java.)
Round Trip
This option specifies the behavior of the numerals; where it disables the reversal of the numerals if preceded by Arabic/Hebrew characters. Use this option if the session is configured to use an Arabic or Hebrew host code page. The default is on.
Numeral Shape
This option specifies the shape of the numeral in the Host file for a File Upload statement; the numeral shape could be (NOMINAL, NATIONAL, or CONTEXTUAL). This option is enabled only for a session configured to use an Arabic host code page. The default is NOMINAL. (This option is not enabled for the JDBC driver from the AS/400 Toolbox for Java.)

FileUpload

Allows you to create, append data to, replace, or update a table in a remote database. For more detailed information see FileUpload action in the Macro Programming Guide.

Database URL
Type a Database URL (see Specifying a database URL).
Driver Identifier
The listbox includes the names of all the JDBC drivers that have been registered with Host On-Demand. Expand the listbox and click the name of the registered JDBC driver that you want to use, or click Other to specify another driver.

For general information on using a JDBC driver, see Registering a JDBC driver.

Driver Class
The fully qualified Java class name of the JDBC driver.
User ID
User ID required to access the database (if required.)
Password
Password required to access the database (if required.)
File Name
The path of the local file containing the data that you want to add to the table in the host database. NOTE: You must specify a complete file path and name in this field, including the drive letter if any (for example, c:\Documents and Settings\user1\input.txt).
File Type
The format (such as ASCII Text, Comma separated values, and so on) of the local file containing the data that you want to add to the table in the host database.
Upload Type
The File Upload operation that you want to perform:
Table Name
The name (such as hodtest01) or schema and name (such as hod.hodtest01) of the table in the host database that you want to append to, update, replace, or create.
Field Description Table
For a create operation, type the name of the table in the host database from which you want the database server to read the column names and column widths for the new table.
Key Columns
For an update operation, type the name or names of the column or columns that you want to update.
Advanced Options
Local-File Type
This option specifies whether local files are in Logical or Visual format. Use this option if the session is configured to use an Arabic or Hebrew host code page. The default is Logical.
Local-File Orientation
This option specifies whether local files are in left-to-right or right-to-left format. Use this option if the session is configured to use an Arabic or Hebrew host code page. The default is Left-to-Right.
Host-File Type
This option specifies whether the Host file should be saved in logical or visual format. Use this option if the session is configured to use an Arabic or Hebrew host code page. The default is Visual. (This option is not enabled for the JDBC driver from the AS/400 Toolbox for Java.)
Host-File Orientation
This option specifies whether the Host file should be saved in left-to-right or right-to-left format. Use this option if the session is configured to use an Arabic or Hebrew host code page. The default is Left-to-Right. (This option is not enabled for the JDBC driver from the AS/400 Toolbox for Java.)
Lam-Alef Expansion
This option specifies the behavior of the Lam-Alef characters. When receiving Arabic data from the host through the SQL Wizard statement, the character Lam-Alef is expanded into two characters, Lam followed by Alef if there is space after Lam-Alef character. This option is enabled only for a session configured to use an Arabic host code page. The default is on.
Lam-Alef Compression
This option specifies the behavior of the Lam-Alef characters. When sending Arabic data to the host through the File Upload statement, the characters Lam followed by Alef are compressed into one character and space is added after Lam-Alef character. This option is enabled only for a session configured to use an Arabic host code page. The default is on. (This option is not enabled for the JDBC driver from the AS/400 Toolbox for Java.)
Symmetric Swap
This option specifies the behavior of the symmetric characters such as brackets; the inversion of the screen causes directional characters to be replaced by their counterparts. Use this option if the session is configured to use an Arabic or Hebrew host code page. The default is on. (This option is not enabled for the JDBC driver from the AS/400 Toolbox for Java.)
Round Trip
This option specifies the behavior of the numerals; where it disables the reversal of the numerals if preceded by Arabic/Hebrew characters. Use this option if the session is configured to use an Arabic or Hebrew host code page. The default is on.
Numeral Shape
This option specifies the shape of the numeral in the Host file for a file upload statement; the numeral shape could be (NOMINAL, NATIONAL and CONTEXTUAL). This option is enabled only for a session configured to use an Arabic host code page. The default is NOMINAL. (This option is not enabled for the JDBC driver from the AS/400 Toolbox for Java.)

To delete a defined action, select it and click Delete.

Click Order to change the order the actions should be performed on the screen.

Related topics

  • Bidirectional language support
  • Transferring files
  • Variables
  • Macro Programming Guide
    •