This class describes a searchable resource in the DOCUMENTS retrieval system. More...

Public Attributes
String	resId
	A identifier of the resource. More...

String	server
	For archive resources: the technical name of the archive server. Otherwise empty. More...

number	type
	The resource type encoded as an integer. See the enumeration constants in this class. More...

Searchable Resource
These constants are equally available in each instance of RetrievalSource and in the constructor object. Resource macroes can only occur in the "FillSearchMask" exit. Within an "OnSearch" exit they have already been replaced by their single components.
Integer	ST_DLC_FILETYPE
	Integer code of the source type "DOCUMENTS file type".

Integer	ST_EEI_ARCHIVE
	Integer code of the source type "EASY ENTERPRISE.i archive".

Integer	ST_EEX_VIEW
	Integer code of the source type "EASY ENTERPRISE.x view".

Integer	ST_EEX_USERVIEW
	Integer code of the source type "EASY ENTERPRISE.x user specific view".

Integer	ST_EAS_FILETYPE
	Integer code of the source type "DOCUMENTS file type within an EAS/EDA store".

Integer	MST_EAS_SERVER
	Integer code of the macro source type "EAS server" (Apply selected file types also to the identified EDA-store)

Integer	MST_EAS_ONLY
	Integer code of the macro source type "EAS only" (Remove standard file type sources after MST_EAS_SERVER macro expansion) More...

Detailed Description

This class describes a searchable resource in the DOCUMENTS retrieval system.

Since: DOCUMENTS 4.0c HF2

Member Data Documentation

◆ MST_EAS_ONLY

Integer RetrievalSource::MST_EAS_ONLY

Integer code of the macro source type "EAS only" (Remove standard file type sources after MST_EAS_SERVER macro expansion)

Remarks: A "FillSearchMask" script can usually find a source of this type, when the user has deselected the "actual processes" checkbox. This source has not got any parameters. If there are user accounts in the system, for which the checkbox does not show up, the script code should not interpret this source type at all.

◆ resId

String RetrievalSource::resId

A identifier of the resource.

For conventional file type resources the identifier equals the technical name of the file type. Archive related identifiers consist of a software dependent key or name plus an "@serverName" appendix.

Note: Modifications of this property won't be forwarded to the retrieval system.

Since: DOCUMENTS 4.0c

◆ server

String RetrievalSource::server

For archive resources: the technical name of the archive server. Otherwise empty.

Note: Modifications of this property won't be forwarded to the retrieval system.

Since: DOCUMENTS 4.0c

◆ type

number RetrievalSource::type

The resource type encoded as an integer. See the enumeration constants in this class.

Note: Modifications of this property won't be forwarded to the retrieval system.