HELiOS URL for Object Types
When using the HELiOS protocol, e.g. to call HELiOS objects from an external software, you can also use the object-specific
- Document number
- Article number
- Project number
- Folder number
- Pipe class number
- User-defined types such as customer number or material designation
instead of the Head ID.
In such cases, the URL is composed of the call of the HELIOS protocol ("helios://"), the display command for a particular object type ("SHOWDOCUMENT", "SHOWARTICLE" or "SHOWPROJECT") separated by a "?", the corresponding HELIOS attribute type ("HEL_DOKUMENTNUMMER", "HEL_SACHNUMMER" or "HEL_PROJEKTNUMMER), a "=" and the individual object number.
Examples:
- helios://SHOWDOCUMENT?HEL_DOKUNUMMER=ZN-00001 (call of a document with the document number "ZN-00001")
- helios://SHOWARTICLE?HEL_SACHNUMMER=SN-000001 (call of an article with the article number "SN-000001")
- helios://SHOWPROJECT?HEL_PROJNUMMER=PN-01-06-K (call of a project with the designation "PN-01-06-K")
- HELIOS://SHOWFOLDER?HEL_MAPNUMMER=Mappe1 (call of a folder with the folder number "Mappe1")
-
HELIOS://SHOWUTO?HEL_SAMMEL=Werkstoff&BZ=S355J2G4 (call of a material with the designation "S355J2G4 ")
-
HELIOS://SHOWUTO?HEL_SAMMEL=Kunde&KUNDENNUMMER=1000 (call of customer data with customer number "1000")
-
HELIOS://SHOWPIPECLASS?HEL_RKLNAME=RN-00008 (call of a pipe class with the class name "RN-00008")
Additionally, search criteria can be connected using "&", e.g.:
-
helios://SHOWARTICLE/?HEL_SACHNUMMER=SN-030569&BENENNUNG=Cuboid
Strings can also be enclosed in quotation marks, e.g.:
-
helios://SHOWARTICLE/?HEL_SACHNUMMER=SN-030569&BENENNUNG='Cuboid'
When you call a URL the corresponding HELiOS object detail mask will be opened.
If a URL cannot be called, a corresponding error message appears.
For more precise information, a distinction is made between the ambiguity of an entered URL (error message "The selected HELiOS URL describes more than one object.") and the non-existence of a URL (error message: "No object found for selected HELiOS URL.").
In the latter case, for example, there may also be a syntax error.
Please note:
One possible use case would involve a listing of HELiOS documents and/or articles with various attributes such as the document number or the article number. You could then create a macro, which will "assemble" the link for each of these HELiOS objects via formulae and add it to a table column to enable direct access by a simple mouse-click.
Whitespaces in attribute values are not allowed for URL calls.
