Processes any statements just before the MobiLink server commences preparing the download.

Parameters

In the following table, the description provides the SQL data type. If you are writing your script in Java or .NET, you should use the appropriate corresponding data type. See SQL-Java data types and SQL-.NET data types.

In SQL scripts, you can specify event parameters by name or with a question mark, but you cannot mix names and question marks within a script. If you use question marks, the parameters must be in the order shown below and are optional only if no subsequent parameters are specified (for example, you must use parameter 1 if you want to use parameter 2). If you use named parameters, you can specify any subset of the parameters in any order.

Default action

None.

Remarks

The MobiLink server executes this event as the first step in the processing of downloaded information. Download information is processed in a single transaction. The execution of this event is the first action in this transaction.

See also

• Script parameters
• Adding and deleting scripts
• end_download connection event
• Using remote IDs and MobiLink user names in scripts
• Using last download times in scripts

SQL example

The following example calls ml_add_connection_script to assign the event to a stored procedure called SetDownloadParameters.

CALL ml_add_connection_script (
   'Lab',
   'begin_download',
   'CALL SetDownloadParameters( {ml s.last_table_download}, {ml s.username} )' )

Java example

The following call to a MobiLink system procedure registers a Java method called beginDownloadConnection as the script for the begin_download connection event when synchronizing the script version ver1.

CALL ml_add_java_connection_script(
   'example_ver',
   'begin_download',
   'ExamplePackage.ExampleClass.beginDownloadConnection' )

Following is the sample Java method beginDownloadConnection. It calls a Java method (prepDeleteTables) that prepares the delete tables using a JDBC synchronization that was set earlier.

public String beginDownloadConnection(
  Timestamp ts, 
  String user )
  throws java.sql.SQLException {  
  prepDeleteTables ( _syncConn, ts, user );
  return ( null );
}

.NET example

The following call to a MobiLink system procedure registers a .NET method called BeginDownload as the script for the begin_download connection event when synchronizing the script version ver1.

CALL ml_add_dnet_connection_script(
  'ver1',
  'begin_download',
  'TestScripts.Test.BeginDownload'
)

Following is the sample .NET method BeginDownload. It calls a .NET method (prepDeleteTables) that prepares the delete tables using a JDBC synchronization that was set earlier.

public string BeginDownload(
  DateTime timestamp,
  string user ) {  
  prepDeleteTables ( _syncConn, ts, user );
  return ( null );
}