Previous | Index | Next

Chapter 6: How to use with TestStand

This chapter provides a general introduction to some more advanced features of ExtraPuTTY. For extreme detail and reference purposes, chapter 4 is likely to contain more information.

6.1 Getting Started

Procedure

To manage exchange with remote device :

  1. Using "Initialize Connection" step to intialize the connection.
  2. Using "Send-Received data" step to send-received data.
  3. Using "Waiting Message" step to wait one message on putty terminal.
  4. Using "Close Connection" step to close the connection.
  5. Using "Close all Connections" step to close all connections.
  6. Using "FTP Loader" step to transferring files.
  7. Using "Wait Session ReConnect" step to wait automatic session ReConnect.
  8. Using "Run Lua Script " step to run lua script.
  9. Using "Retrieve existing Connection" step to retrieve an existing connection and to keep a live a connection.
  10. Using "Force To Close Connection" step to force the closure of the connection.

6.2 TestStand Step description

For "TestStand" application 10 steps are available :

ProcedureProcedure

1. "Initialize Connection" step used to establish the connection, (used "Connexion_F" function of extraputty DLL) :

Parameters Description
TargetName TargetName or PuttySession Name (in this case Protocol must be equalt to 4).
ConnectionId Connection ID.
Login optinonal parameter.
Password optinonal parameter.
ShowPuTTY TRUE: Putty Terminal is display, FALSE: not display.
Protocol 0:Telnet,1:SSH,2:Rlogin,3:Raw,4:LoadPutty Session,5:Serial Link.
PortNumber If the parameter is set to 0, the value of the default settings of putty is used. This field correspond to the speed for serial line protocol.
GenerateReport 1:extraputty report activate,0:Not activate.
CRLF 1:0A0D,2:0D0A,3:0A,4:0D.
NewCRLF String used to replace the CRLF parameter find in data (for example CRLF = 1,NewCRLF : <br>)
ReportFileData Parameter already set in step. Name and path of report generate by TestStand in order to generate extraputty report.
arg10 Parameter already set in step. State of the step (Pass or failed).
arg11 Parameter already set in step. Step result report.
arg12 Parameter already set in step. Error occured during step (True or false).
arg13 Parameter already set in step. Error code.
arg14 Parameter already set in step. Error Message.

2. "Send-Received data" step used to send-received data, (used "SendRcvData_F" function of extraputty DLL) :

Parameters Description
ConnectionId ConnectionId set by Initialize Connection step (shall be > 0).
Command Data to send to the target.
Title Title of your command,used only if extraputty report is activate.
Comments Comments of your command,used only if extraputty report is activate.
TimeCapture Time used to capture the reply data in ms.
DataRcv Parameter already set in step.Buffer which contain your data if TimerCapture is > 0.
MaxSizeofData Size of DataRcv Buffer or maximum data size in DataRcv
Settings Bit fields of settings (2^0 : CRLF (0 send,1 not send),...reserved)
arg8 Parameter already set in step. State of the step (Pass or failed).
arg9 Parameter already set in step. Step result report.
arg10 Parameter already set in step. Error occured during step (True or false).
arg11 Parameter already set in step. Error code.
arg12 Parameter already set in step. Error Message.

3. "Waiting Message" step is used to wait one message on putty terminal, (used "WaitingMessage_F" function of extraputty DLL) :

Parameters Description
ConnectionId ConnectionId set by Initialize Connection step (shall be > 0).
Message Message to wait on putty terminal.
TimeCapture Timeout value of wait in ms.
arg6 State of the step (Pass or failed).
arg7 Step result report.
arg8 Error occured during step (True or false).
arg9 Error code.
arg10 Error Message.

4. "Close Connection" step used to close the current connection, (used "CloseConnexion_F" function of extraputty DLL) :

Parameters Description
ConnectionId ConnectionId set by Initialize Connection step (shall be > 0).
arg2 Parameter already set in step. State of the step (Pass or failed).
arg3 Parameter already set in step. Step result report.
arg4 Parameter already set in step. Error occured during step (True or false).
arg5 Parameter already set in step. Error code.
arg6 Parameter already set in step. Error Message.

5. "Close all Connections" step used to close all connections, (used "CloseAllConnexion_F" function of extraputty DLL) :

Parameters Description
arg1 Parameter already set in step. State of the step (Pass or failed).
arg2 Parameter already set in step. Step result report.
arg3 Parameter already set in step. Error occured during step (True or false).
arg4 Parameter already set in step. Error code.
arg5 Parameter already set in step. Error Message.

6."FTP Loader" step is used to transferring files with FTP protocol, (used "FtpLoader_F" function of extraputty DLL) :

Parameters Description
Target Hostname of target.
FilePath path of the files to upload.
DestPath destination of the files on target.
Show Display FTPLoader terminal.
Login login (size 1 - 99).
Password password (size 1 - 99).
TransfertMode transfert mode (BINARY or ASCII).
verbose explain what is being done (verbose) (param show shall be set to TRUE).
arg9 State of the step (Pass or failed).
arg10 Step result report.
arg11 Error occured during step (True or false).
arg12 Error code.
arg13 Error Message.

7. "Wait Session ReConnect" step used to wait automatic session ReConnect only when "Close window on exit" parameter of session is configured to "Never,Auto-Connect", (used "WaitRestart_F" function of extraputty DLL) :

Parameters Description
ConnectionId ConnectionId set by Initialize Connection step (shall be > 0).
TimeOut Timeout value of wait in ms.
arg6 State of the step (Pass or failed).
arg7 Step result report.
arg8 Error occured during step (True or false).
arg9 Error code.
arg10 Error Message.

8. "Run Lua Script" step used to run lua script, (used "lua_dofile_F" function of extraputty DLL) :

Parameters Description
ConnectionId ConnectionId set by Initialize Connection step (shall be > 0).
PathFile Path and name of lua script file.
arg6 State of the step (Pass or failed).
arg7 Step result report.
arg8 Error occured during step (True or false).
arg9 Error code.
arg10 Error Message.

9. "Retrieve Existing Connection" step used to reconnect to a existing session and free AND to keep a live the connection, (used "RetrieveExistingConnection_F" function of extraputty DLL) :

Parameters Description
ConnectionHandle Handle of the connection (value : 1 to 255).
Be careful the connection handle and connection id (used with all other functions) are not the same, the connection handle is used for a global identification of a connection where as the connection id is local at the DLL.
PathFile Path and name of lua script file.
arg6 State of the step (Pass or failed).
arg7 Step result report.
arg8 Error occured during step (True or false).
arg9 Error code.
arg10 Error Message.

10. "Force To Close Connection" step used to force closure of connection, (used "ForceToClose_F" function of extraputty DLL) :

Parameters Description
ConnectionId ConnectionId set by Initialize Connection step (shall be > 0).
PathFile Path and name of lua script file.
arg6 State of the step (Pass or failed).
arg7 Step result report.
arg8 Error occured during step (True or false).
arg9 Error code.
arg10 Error Message.

Note

Note the following about ExtraPuTTY Windows Installer:

6.3 How to used ExtraPuTTY without ExtraPuTTY installer

The ExtraPuTTY DLL need the path of PuTTY.
In order to do that you must create in the environment variable ExtraPutty with the path where PuTTY is install.


If you want to provide feedback on this manual or on the ExtraPuTTY tools themselves, see the Feedback page.

[ExtraPuTTY release 0.29 Compile with PuTTY release 0.64]