BuildingSync / schema

BuildingSync® Schema
https://buildingsync.net
Other
23 stars 22 forks source link

Feature request: File attachments #391

Open markborkum opened 2 years ago

markborkum commented 2 years ago

Is your feature request related to a problem? Please describe.

Some building assessment standards require applicants to attach data files to their submissions. For example, the Integrated Physical Needs Assessment template requires applicants to attach photographs of premises, plants, and systems.

Describe the solution you'd like

A mechanism to describe an arbitrary number of file attachments for premises, plants, and systems.

The description for a file attachment should include:

For example, in the <auc:Building> element:

<auc:Building ID="Building-1">
  <!-- ... -->
  <auc:Files>
    <auc:File ID="File-1">
      <auc:FileName>north.png</auc:FileName>
      <auc:FileDescription>View of north face of building</auc:FileDescription>
      <auc:FileContentType>image/png</auc:FileContentType>
      <auc:FileSize>1024</auc:FileSize>
      <auc:FileSHA1Checksum>2fd4e1c67a2d28fced849ee1bb76e7391b93eb12</auc:FileSHA1Checksum>
      <auc:FileURL>https://www.example.com/buildings/1/north.png</auc:FileURL>
    </auc:File>
  </auc:Files>
  <!-- ... -->
</auc:Building>

Describe alternatives you've considered

Internal to the BuildingSync XML document, file attachments can be associated with premises, plants, and systems using user-defined fields.

External to the BuildingSync XML document, file attachments can be associated with arbitrary BuildingSync XML elements using their "ID" attributes.

Additional context

No additional context.