User Tools

Site Tools


host_adaptor_3270

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

host_adaptor_3270 [2024/12/10 13:13]
montse [Connection]
host_adaptor_3270 [2024/12/10 13:23] (current)
montse [Predefined functions]
Line 51: Line 51:
  
  
-  * **clearAndWriteField**: ​Clears ​and writes a text in a field in the indicated field.  +  * **clearAndWriteField**: ​clears ​and writes a text in a field in the indicated field.  
-    * Parameter Field: ​Field number starting with 1  +    * Parameter Field: ​field number starting with 1  
-    * Parameter Offset: ​Offset ​in the field starting with 1    +    * Parameter Offset: ​offset ​in the field starting with 1    
-    * Parameter Value: ​Text.+    * Parameter Value: ​text.
  
-  * **clearField**: ​Clears ​the field with field number entered in the parameter.+  * **clearField**: ​clears ​the field with field number entered in the parameter.
  
-  * **containsText(Text):​**This function evaluates if within a host screen, there is a specific text that we define in this function.\\ ​  +  * **containsText(Text):​**this function evaluates if within a host screen, there is a specific text that we define in this function.\\ ​  
-      *Parameter Text: In the message mapping, the text that we want to find is added in the "Value field"​.+      *Parameter Text: in the message mapping, the text that we want to find is added in the "Value field"​.
  
-  * **getLenghField**: ​Gets the length of the field with field number entered in the parameter.+  * **getLenghField**: ​gets the length of the field with field number entered in the parameter.
  
-  * **nextScreen:​** ​This function advances directly to the next navigation screen (you will have previously had to go through it to find it). It requires no parameters in its coding.+  * **nextScreen:​** ​this function advances directly to the next navigation screen (you will have previously had to go through it to find it). It requires no parameters in its coding.
  
-  * **previusScreen:​** ​This function advances directly to the previous navigation screen. No coding parameters are required.+  * **previusScreen:​** ​this function advances directly to the previous navigation screen. No coding parameters are required.
  
-  * **readField(Field,​Offset,​Length):​** ​This function reads a field that we define in its parameters.\\  +  * **readField(Field,​Offset,​Length):​** ​this function reads a field that we define in its parameters.\\  
-     ​*Parameter Field: ​Position ​(numeric) in which the field is located. +     ​*Parameter Field: ​position ​(numeric) in which the field is located. 
-     ​*Parameter Offset: ​Position ​within the field from which you want to read. +     ​*Parameter Offset: ​position ​within the field from which you want to read. 
-     ​*Parameter Length: ​Length ​of the field to be read.\\ These 3 parameters are obtained by clicking the right mouse button, on the field we want to read.\\ ​+     ​*Parameter Length: ​length ​of the field to be read.\\ \\ These 3 parameters are obtained by clicking the right mouse button, on the field we want to read.\\ ​
 {{ :​en:​image_2021_01_11t12_08_14_736z.png?​400 |}}\\  ​ {{ :​en:​image_2021_01_11t12_08_14_736z.png?​400 |}}\\  ​
  
-  * **readRow(Row):​** ​This function reads a particular line on the screen. The whole line.\\ +  * **readRow(Row):​** ​this function reads a particular line on the screen. The whole line.\\ 
-     ​*Parameter Row: Position ​(numerical) in which the line is located.\\ This parameter is obtained by clicking the right mouse button on the line we want to read.\\  ​+     ​*Parameter Row: position ​(numerical) in which the line is located.\\ \\ This parameter is obtained by clicking the right mouse button on the line we want to read.\\  ​
 {{ :​en:​image_2021_01_11t12_08_14_736z.png?​400 |}}\\  ​ {{ :​en:​image_2021_01_11t12_08_14_736z.png?​400 |}}\\  ​
  
-  * **readScreen:​** ​This function reads the screen on which you are positioned. Function without parameters.+  * **readScreen:​** ​this function reads the screen on which you are positioned. Function without parameters.
  
-  * **readScreenByRows**: ​Reads the current screen by rows. +  * **readScreenByRows**: ​reads the current screen by rows. 
  
-  * **rowContaintsText(Text,​Row):​** ​This function checks if a certain text exists in a screen line.\\ +  * **rowContaintsText(Text,​Row):​** ​this function checks if a certain text exists in a screen line.\\ 
-        *Parameter Text: Enter the text to search for. +        *Parameter Text: enter the text to search for. 
-        *Parameter Row: Position ​(numeric) of the line.\\ These parameters are obtained by pressing the right mouse button, on the line we want to find the defined text.\\ ​+        *Parameter Row: position ​(numeric) of the line.\\ \\ These parameters are obtained by pressing the right mouse button, on the line we want to find the defined text.\\ ​
 {{ :​en:​image_2021_01_11t12_08_14_736z.png?​400 |}}\\  ​ {{ :​en:​image_2021_01_11t12_08_14_736z.png?​400 |}}\\  ​
  
-  * **waitCRC(screen_CRC):​** ​This function waits for the screen we want to see next.\\  +  * **waitCRC(screen_CRC):​** ​this function waits for the screen we want to see next.\\  
-        *Parameter screen_CRC: ​Value -> Obtained by right-clicking on the screen we want to display.\\ ​+        *Parameter screen_CRC: ​value -> Obtained by right-clicking on the screen we want to display.\\ ​
 {{ :​en:​image_2021_01_11t12_08_14_736z.png?​400 |}}\\  ​ {{ :​en:​image_2021_01_11t12_08_14_736z.png?​400 |}}\\  ​
  
-  * **waitFor**: ​Wait for the time in seconds received in the parameter to elapse.+  * **waitFor**: ​wait for the time in seconds received in the parameter to elapse.
  
-  * **waitForChange(TimeOut(msec)):​** ​This function waits for time for the next screen to be displayed. +  * **waitForChange(TimeOut(msec)):​** ​this function waits for time for the next screen to be displayed. 
-        *Parameter TimeOut (msec): ​Value -> Time in msec to wait to be displayed.+        *Parameter TimeOut (msec): ​value -> Time in msec to wait to be displayed.
  
   * **waitForText(Text,​Row,​Column):​** This function waits for a certain text to appear before displaying the following screen.\\ ​   * **waitForText(Text,​Row,​Column):​** This function waits for a certain text to appear before displaying the following screen.\\ ​
-       ​*Parameter Text: Value-> Text to be displayed. +       ​*Parameter Text: value-> Text to be displayed. 
-       ​*Parameter Row: Row of the word. +       ​*Parameter Row: row of the word. 
-       ​*Parameter Column: ​Column ​of the word.+       ​*Parameter Column: ​column ​of the word.
  
-  * **writeAftherLabel (Label,​Text):​** ​This function writes to the screen any text, after the label we have defined in the Label parameter has been displayed (on the screen).\\  +  * **writeAftherLabel (Label,​Text):​** ​this function writes to the screen any text, after the label we have defined in the Label parameter has been displayed (on the screen).\\  
-       ​*Parameter Label: ​Value-> Text to be displayed. +       ​*Parameter Label: ​value-> Text to be displayed. 
-       ​*Parameter Text: Text that we are going to write.+       ​*Parameter Text: text that we are going to write.
  
-  * **writeBeforeLabel (Label,​Text):​** ​This function writes to the screen any text, before the label we have defined in the Label parameter has been displayed (on the screen).\\  +  * **writeBeforeLabel (Label,​Text):​** ​this function writes to the screen any text, before the label we have defined in the Label parameter has been displayed (on the screen).\\  
-       ​*Parameter Label: ​Value-> Text to be displayed. +       ​*Parameter Label: ​value-> Text to be displayed. 
-       ​*Parameter Text: Text that we are going to write.+       ​*Parameter Text: text that we are going to write
 + 
 +  * **writeField (Text,​Field,​Offset):​** this function writes to a given field the value we defined in the Text parameter.\\ 
 +       ​*Parameter Text: value-> Text to appear. 
 +       ​*Parameter Field: field to be written. 
 +       ​*Parameter Offset: position of the field.\\ \\ These parameters are obtained by right-clicking on the screen we want to display.
  
-  * **writeField (Text,​Field,​Offset):​** This function writes to a given field the value we defined in the Text parameter.\\ 
-       ​*Parameter Text: Value-> Text to appear. 
-       ​*Parameter Field: Field to be written. 
-       ​*Parameter Offset: Position of the field.\\ These parameters are obtained ​ by right-clicking on the screen we want to display.\\ ​ 
 {{ :​en:​image_2021_01_11t12_08_14_736z.png?​400 |}}\\  {{ :​en:​image_2021_01_11t12_08_14_736z.png?​400 |}}\\ 
  
   * **writeKey (Key):** This function executes a predefined key on the screen.\\ (ENTER, PF8, PF4, etc…).   * **writeKey (Key):** This function executes a predefined key on the screen.\\ (ENTER, PF8, PF4, etc…).
-       ​*Parameter Key: Value-> Function key.+       ​*Parameter Key: value-> Function key.
  
   * **writeKeyUntilFind(Key,​ Text)**: This function executes the function key (Key) and waits for the text (Text) to appear on the screen.   * **writeKeyUntilFind(Key,​ Text)**: This function executes the function key (Key) and waits for the text (Text) to appear on the screen.
  
   * **writeText (Text,​Row,​Column):​** This function writes a text in a defined position.(line and column).   * **writeText (Text,​Row,​Column):​** This function writes a text in a defined position.(line and column).
-        *Parameter Text: Value-> Text to write. +        *Parameter Text: value-> Text to write. 
-        *Parameter Row: Value-> Row Number. +        *Parameter Row: value-> Row Number. 
-        *Parameter Column: ​Value-> Column number.\\ These parameters are obtained by right-clicking on the screen we want to display.\\ ​+        *Parameter Column: ​value-> Column number.\\ \\ These parameters are obtained by right-clicking on the screen we want to display.\\ ​
 {{ :​en:​image_2021_01_11t12_08_14_736z.png?​400 |}}\\ \\  {{ :​en:​image_2021_01_11t12_08_14_736z.png?​400 |}}\\ \\ 
  
host_adaptor_3270.1733836436.txt.gz · Last modified: 2024/12/10 13:13 by montse