Syntax: OLE Automation (SAP Library

Syntax: OLE Automation

Separate the name of the application and commands used to communicate with this application. You can split these commands further into method calls, attribute settings and the retrieval of object attributes:

Name of the application

Commands for communication with the application

Method calls (see Calling Object Methods)

Attribute settings (see Setting Object Attributes)

Retrieving attributes (see Retrieving Object Attributes)

The application names and the communication syntax are described in the user documentation for the application to be called. The application names are also frequently called object names.

Example

Object names:

	Application name for WinWord:	WORD.BASIC
	Application name for Excel:	EXCEL.APPLICATION

Transfer of Variables using ArchiveLink

So that you can communicate universally from ArchiveLink using OLE, is it necessary to transfer variables/parameters to OLE objects or to obtain values of OLE objects and to transfer these values to variables in ArchiveLink. For this purpose, variables have been defined which you can transfer to OLE applications or into which you can transfer values of OLE objects. These parameters are specified in the application administration of the OLE function.

Note

All variables are string variables (no integers).

The following variables are defined:

OLE Variables

Variable	Description
@DPA	File path on front end, display path
@AID	Storage
@DTI	Document class
@DID	Document ID (arc_doc_id)
@SPA	Path on application server, basic path or archive path
@WID	Window ID
@WIT	Window title
@ADA	Storage date
@ATI	Storage time
@STA	Document status (online, offline,...)
@COU	Number of retrieved files
@DFN	Names of retrieved files
@UID	User name
@LAN	Logon language
@ETX	Error text
@DPO	Document path
@PAG	Page number
@FPA	Front end path
EID	Error number/return code (0 for okay, string for error)

Note

OLE parameter @DPA is used most frequently.