CALLUI

Contents


Callui is used to execute a pre-determined action on the client workstation. The list of actions is shown below.  

Syntax

   Callui return = "" with action, list_param

Parameters

Element

Description

Restrictions

return

returns information in the form of a string of characters

action

code action: character string in the form:
"UIAction="+chr$(1)+"action_value"

list_param

List of id_param separated by the character ','.

The expressions must be alphanumerical and are limited to 255.

id_param

parameter: character string in the form:
"cd_param="+chr$(1)+"param_value"

The expressions must be alphanumerical and are limited to 255.

Examples

# Example 1: copy a file from the server to the client workstation
Callui RETOUR="" With "UIAction="+chr$(1) + "GetFileAlways",
& "UIRemoteFile="+ chr$(1) + "PIC/AUS_PC.jpg",
& "UILocalFile="+ chr$(1) + "Pepere.jpg",
& "UILocalDir="+chr$(1) + "RtsTemp"

Infbox "GetFileAlways"+RETURN

# Example 2: open this file (on the client workstation)
Callui RETOUR="" With "UIAction="+chr$(1)+"OpenFile",
& "UILocalDir="+chr$(1) + "RtsTemp",
& "UILocalFile="+ chr$(1) +"Pepere.jpg"

Infbox "OpenFile"+RETURN

# Example 3: open an Internet browser session (on the client workstation)
Callui RETOUR="" With "UIAction="+chr$(1)+"OpenFile",
& "UILocalDir="+chr$(1) + "RtsTemp",
& "UILocalFile="+ chr$(1) +"Pepere.jpg"

# Example 4: open an Internet browser session with an url corresponding to a sub-file of the X3_PUB folder
Callui RETOUR="" With "UIAction="+chr$(1)+"OpenFile",
& "UILocalDir="+chr$(1) + "HTTP",
& "UILocalFile="+ chr$(1) + "172.16.12.41:80/x3webdata/GX3APP/TMP/F5963808_EDITRTWEB_53711.xml"
& "UIAdxPubSubFile="+ chr$(1) +"1"

Description and comments

Callui is used to pilot the client. The client receives (via the engine) the order to execute a Callui. It interprets the associated parameters and it takes charge of the transfer or opening of the file.

Callui is used to launch one of the following actions:

A single action can be specified at a time.

On completion, a code specifies that the action has been correctly carried out or not.

action :

This parameter is used to identify the action to be launched on the client.

The available actions are as follows:

Action

Description

OpenFile

Open a file on the client workstation

GetFile

Transfer of a file from the server to the client workstation if the file on the server is more recent.

GetFileAlways

Transfer of a file from the server to the client workstation

PutFile

Transfer of a file from the client workstation to the server only if the file on the server is more recent

PutFileAlways

Transfer of a file from the client workstation to the server

id_param

Used to specify the parameters of an action.

the list of parameters is the following:

Parameters

Description

UILocalFile

File name on the workstation
or URL when the "UlLocalDir" = HTTP parameter (the URL must not contain the prefix "http://")
Caution the URL cannot exceed 240 characters.

UILocalDir

Directory of the file on the client workstation

3 directories are available:

Temp: installdir\X3\Temp
Report: installdir\X3\Report\folder_server_service
RtsTemp: nstalldir
\X3\RTS\Temp

if the directory is not stipulated, TEMP is used by default

UIRemoteFile

File name on the server workstation, preceded by the path.
The path from the folder installation directory should be specified
For instance: "REPORT/ARCCLIENT.rpt"

UIAdxPubSubFile

Flag set to 1, used to identify the urls corresponding to sub-files of the X3_PUB folder. 

List of possible parameters by action:

Action

Parameters

OpenFile

UILocalDir

UILocalFile

GetFile
GetFileAlways
PutFile
PutFileAlways

UILocalDir

UILocalFile

UIRemoteFile

return :

This parameter is used to identify the variable that will contain the information on the return of the instruction.

The instruction returns the name of the action, followed by the status code.

The status code takes one of the following values:

1 :   the action unfolded as planned

0 :  an error occurred during the action.

New to version 130

This is a new instruction.

Web specificities

In web mode, like for the Openi, Openo and Openio orders, Callui does not make it possible to open or write a file located on the client workstation. On the other hand, the Callui UIlocaldir=HTTP operates properly and allows a browser instance to be opened.

Associated errors

Error

Description

 

 

Associated keywords

 GETUI - ASKUI


CONTENTS

Copyright © Sage 1999 - 2007