Archibus Web Central

Specifying Files to Display in the 360 Viewer

The 360 Viewer displays images that are associated with records in the Assigned Documents ( docs_assigned ) table.

Note: Archibus V.25.3 removes the open-source pannellum library. For details, see the V.25.3 Revision History .

To associate images and movies with assets (rooms and equipment) you use the Assets / Enterprise Assets / Background Data - Facilities & Finance / Manage Reference Documents task . (This task is also available from the Background Data processes of the Assets, Corrective Maintenance, and Preventive Maintenance applications.)

360_doc_table.png

Complete the fields of the Assigned Documents table as follows. The image can be uploaded and stored in the database, or it can be referenced as a URL. In the above example, the image is uploaded.

Note the maximum size of the documents you can upload is 100MB. You must also be sure that the MaxDocumentSize field attribute for the docs_assigned.doc is set to reflect the size of files you will be uploading. See How to Add a Document Field to the Data Dictionary (System Management Help) .

Field Value
Document Name Enter a descriptive name of the image. The 360 Viewer displays this value as the panorama’s description.
Document

Upload a document. The 360 Viewer displays this value as the panorama’s title.

Or, leave this field empty and enter the URL to the document in the URL field.

For images, you can enter files that are in jpg and png format.

For video, enter files that are in mp4 format (although other formats are supported if you edit and afm-confg.xml file, as described below.)

Document Notes

The details of the behavior of the document are entered as JSON data in this field. See the below section for details.

Building/Floor/Room The location of the item with which this image is associate. For example, when adding a 360 movie for an equipment item, you enter the location of the equipment in these fields.
URL

If you don't upload a document (the Document Name field), you can provide its URL.

Example: https://pannellum.org/images/alma.jpg

Author If set, the 360 Viewer displays this value as the panorama’s author. If no author is desired, don’t set this parameter.

File Format

The 360 Viewer can display Equirectangular, partial, cubic, and multi-resolution panoramas. The 360 Viewer supports movies in MP4 format, and images in JPG and PNG format.

To use movies other than MP4 -- such as AVI, .WEBM, and .MOV-- you must modify the <documentManagement> section of \WEB-INF\config\context\compatibility\afm-config.xml .

<fileType extension="mp4"> <operations> <operation type="showDocument"> <header contentType="video/mp4" contentDisposition="attachment; filename="/> </operation> <operation type="checkOut"> <header contentType="application/octet-stream" contentDisposition="attachment; filename="/> </operation> </operations> </fileType>

Controlling the Image with Pannellum Parameters

The 360 Viewer uses the Pannellum open source panorama viewer. Below are the major parameters, which you enter in the Document Notes field as shown in the above image. For more information on Pannellum, see https://pannellum.org/documentation/reference/#json-configuration-file-options

Parameter Description
compass (boolean) If true, a compass is displayed. Normally defaults to false; defaults to true if heading information is present in Photo Sphere XMP metadata.
northOffset (number) Set the offset, in degrees, of the center of the panorama from North. As this affects the compass, it only has an effect if compass is set to true.
minHfov and maxHfov (number) Sets the minimum / maximum horizontal field of view, in degrees, that the viewer can be set to. Defaults to 50 / 120.
minPitch and maxPitch (number) Sets the minimum / maximum horizontal field of view, in degrees, that the viewer can be set to. Defaults to 50 / 120.
minYaw and maxYaw (number) Sets the minimum / maximum yaw the viewer edge can be at, in degrees. Defaults to -180 / 180, i.e. no limit.
hfov (number) Sets the panorama’s starting horizontal field of view in degrees. Defaults to 100.
pitch (number) Sets the panorama’s starting pitch position in degrees. Defaults to 0.
yaw (number) Sets the panorama’s starting yaw position in degrees. Defaults to 0.
autoRotate (number) Setting this parameter causes the panorama to automatically rotate when loaded. The value specifies the rotation speed in degrees per second. Positive is counter-clockwise, and negative is clockwise. The autoRotateInactivityDelay parameter can be specified to have the panorama begin rotating again after there is no user interaction for the specified number of milliseconds.
hotSpots (array)

This specifies an array of hot spots that can be links to other scenes, information, or external links.

"hotSpots": [{
"type": "scene", // required
"sceneId": "document2" // required; docs_assigned.name of another uploaded image for that room
"text": "Some text displayed", //optional
"pitch": -2.1, //optional
"yaw": 132.9 //optional
}
]}

autoLoad (boolean) When set to true, the panorama will automatically load. When false, the user needs to click on the load button to load the panorama. Defaults to true.
isDefault (boolean) When set to true, this image/video will automatically load first. This is useful when you have multiple 360 images or videos for the same room and you want to decide the default image/video that is selected in the viewer.
hotSpotDebug (boolean) When true, the mouse pointer’s pitch and yaw are logged to the browser console when the mouse button is clicked. Defaults to false.

Using with Archibus pre-V.23.2

The 360 Viewer is part of the  V.23.2 Equipment Systems Console.

If you wish to use this feature with pre-V23.2 Archibus views, you must:

  • modify afm-config.xml to support video upload
  • change the Max Doc size in the docs_assigned.doc field from 10 MB to 100 MB