Parameters

Explanation:

• ClassId and ObjectID - pair of Object's class ID and Object ID field used in HDC internaly. Both parameters are required. 
  ClassId can be retrieved from Object Classes configuration and Object ID is a value of Class Field marked as ID Field.

• DocumentForSpot - when set to 1, image contains document, on which spot is linked to this object.

• SpotMarginPercent - percent of area surrounding spot (e.g. “100” – spot only; “110” – add 10% margins around spot boundaries).

• Width and Height -  width and height ot returned spot.

• ClassName(or ClassId), FieldName, FieldValue - searching for object based on internal HDC metadata. 

• Domain - external domain name or ID. Matching object is searched using External Domain ID's. Can be used in two ways:

  • with CID or CN and ID which in this case (DN present in url) will represent External domain object class id and object id,

  • with ClassName, FieldName, FieldValue - than CID and ID is not needed

• contextObjects - in case there is a need to resolve macros or presentations in context of different object then added in HOPA locator, here they can be added. 
  When printing from HDC viewer, this is added automatically based what object is being selected in Tree. This is common for proper resolving macros, for instance when one document is linked to many floors. In case of presentations, you can simulate option "Only for selected object". 
  The value of this parameter should consists of pair or pairs of classID and objectID. With additional S letter when object is to be used for presentation. Examples:

  &contextobjects=528503,105;528505,107,S &contextobjects=528503,107 &contextobjects=528505,107,S &contextobjects=528505,107;528505,107,S

   

Samples

Basic URL structure

Multiple FieldVales

When using ClassName/ClassId locators (with or without external domain), multiple Field values can be given to HOPA call, separated with comma.

If provided objects are on same drawing, all will be highlighted on single page.
If used with MV=1 additional pages will appear if objects are on different drawings and/or if objects have multiple links to different drawings as usual.
Example:

Data for macros will show data only for first given object.

Handling multiple viewports

For detailed description of view-port options, please refer to Print Templates section.

Parameters for a specific viewport require viewport ID suffix as follows:

• ViewportID = without suffix - such parameters will apply to all viewports on printout (unless this parameter is used again but with viewport number)

• ViewportID = 1 parameters with suffix "1", e.g ScaleMode1 - influnces only viewport 1

• ViewportID = 2 parameters with suffix "2", e.g ScaleMode2 - flunces only viewport 2

• ViewportID = 3 parameters with suffix "3", e.g ScaleMode3 - flunces only viewport 3

• and so on...

Sample code for single object view without Print Template:

 Note: Object class, object Id and template ID are from specific database, so they will not work in your database.

(URL exmaples are separated to provide easier readability)

^{HopaGetView4Object ?classId=108 &objectId=76931 &DocumentForSpot=1 &Width=600 &Height=801 &SpotMarginPercent=122}

Open

With added print template:

^{HopaGetView4Object ?classId=108 &objectId=76931 &DocumentForSpot=1 &SpotMarginPercent=122 &TID=3255}

Master viewport is filled in with our test object. Since we have't specified any parameters for two extra viewports, defaults are used. 

Set of specific parameters for each viewport can be added to obtain diferent documents or scale modes:

For example, a new target class is provided for Vieweport #3 (that option is only available for use in Template)

Specific scale mode and scale value can be added for viewport #2 and mask mode for viewport #1:

HOPA: Using HQL as search criteria

New parameter hql/HQL is added, that allows to locate objects via HQL statements.

Some examples by operator

• Equals: HopaGetView4Object?CID=118&HQL=hd_docdescr = "Italic"

• In Set: HopaGetView4Object?PSETID=493&TID=6405&classId=108&HQL=fi2space_id in ("000480000900059","000480000900051","000480000900040")&MV=1&DFS=1&SM=2

• Before: HopaGetView4Object?CID=118&HQL=hd_docdate before "1990-12-01"

• Contains: HopaGetView4Object?PSETID=493&TID=6405&classId=108&HQL=fi2space_id contains "48000090004"&DFS=1&MV=1

• Starts With: HopaGetView4Object?cid=108&HQL=fi2space_descr starts-with "RUM 2"&DFS=1

• Before and after (date): HopaGetView4Object?CID=118&hql=hd_docdate before "1996-11-05" and hd_docdate after "1996-11-03"

• In Set and Not In Set: HopaGetView4Object?cid=108&HQL=fi2space_class in ("02","ÖVA") and fi2space_function not in ("KOMMUNIKATION","03","02","00","PERSONAL","SERVICE","99","TEKNIK","01")&DFS=1