AccessKitExhibition
Reference for AccessKit Exhibition entities.
What is an Exhibition?
An Exhibition serves as a container for one or more Works. It typically
corresponds to an actual exhibition which may be occurring at your gallery or
museum, but it can also be used to store a list of content that is related but not part
of an actual exhibiton, e.g. informational videos throughout the museum.
Visitors and guests will be able to navigate to an Exhibition via a
QR code or through a direct link to see the list of Works contained within
it.
Finding an Exhibition
An Exhibition can be found in the Admin Dashboard in the list organized by Exhibition Status.
Upcoming exhibitions appear at the top of the list, followed by Current exhibitions,
and then Archived exhibitions in a collapsed list at the end.
Click the [edit] button next to the Exhibition you would like to edit to access its management page, or click on its name to access the Exhibition's public-facing guest view.
An Exhibition will always have two relevant permalinks:
| Name | URL Rule | Description |
|---|---|---|
| Guest View Permalink | https://<your-subdomain>.accesskit.cc/exhibition/<id> | The permalink for the exhibition on the public-facing guest web application. |
| Admin Dashboard Edit Page | https://<your-subdomain>.accesskit.cc/admin/exhibition/<id> | The permalink for the Exhibition's edit page on the admin dashboard. |
Form fields
The following fields are available when creating a new Exhibition or editing an existing Exhibition.
| Field | Type | Optional | Editable | Description |
|---|---|---|---|---|
| Exhibition Name | string | No | Yes | The name of the exhibition. |
| Hero Image Url | string [url] | Yes | Yes | The URL of the hero image for the exhibition. This image displays above the Exhibition Name in the list of exhibitions on the public-facing guest web application home page. |
| Hero Image Alt Text | string | Yes | Yes | The alt text for the hero image. |
| Secondary Image Url | string [url] | Yes | Yes | The URL of the secondary image for the exhibition. This image displays below the Exhibition Name in the list of exhibitions on the public-facing guest web application home page. |
| Secondary Image Alt Text | string | Yes | Yes | The alt text for the secondary image. |
| Quiet Mode | number [0.0 ... 1.0] | Yes | Yes | A control to temporarily adjust the volume of all AccessKit BrightSign Mediaplayers in the exhibition. 1 corresponds to full volume, 0.5 corresponds to half volume, and 0 corresponds to off. |
| Work Label | string | Yes | Yes | The label to display when listing the number of works in the exhibition, e.g. Work or Audio Zone will result in 1 Work / 1 Audio Zone if a single Work is included or n Works / n Audio Zones if multiple Works are included. |
| Exhibition Status | enum [upcoming, current, archived] | No | Yes | The status of the exhibition. This only affects internal organization of Exhibitions in the Admin Dashboard. |
| Published? | boolean | No | Yes | Whether the exhibition is published. When false, the exhibition is not visible to the public in the public-facing guest web application. |
| ID | number [1+] | No | No | The unique identifier for the exhibition. This is automatically generated when the exhibition is first created. It is used in all permalinks related to the exhibition, e.g. https://<your-subdomain>.accesskit.cc/exhibition/<id> will always resolve to this exhibition. |
Remember to click Update Exhibition to commit your changes.
Records
The following records are available for Exhibitions.
| Record | Description |
|---|---|
Guest View Permalink | The permalink for the exhibition on the public-facing guest web application. |
QR Code | A QR code for the exhibition. This can be used to link to the exhibition on a mobile device. |