Skip to content

Rename reference element#423

Merged
nllong merged 18 commits intodevelop-v3from
rename-reference-element
Dec 10, 2021
Merged

Rename reference element#423
nllong merged 18 commits intodevelop-v3from
rename-reference-element

Conversation

@JieXiong9119
Copy link
Copy Markdown
Contributor

Any background context you want to provide?

See proposal.

What does this PR do?

  1. Rename IDREF element as suggested in Docs/generic linking elements #415 :
    AlternativeSystemAdded -> AlternativeSystemIDAdded
    AlternativeSystemReplacement -> AlternativeSystemIDReplacement
    ExistingScheduleAffected -> ExistingScheduleIDAffected
    ExistingSystemAffected -> ExistingSystemIDAffected
    ExistingSystemRemoved -> ExistingSystemIDRemoved
    ExistingSystemReplaced -> ExistingSystemIDReplaced
    SourceHeatingPlantID -> HeatingPlantID
    LinkedHeatingPlantID -> HeatingPlantID
    DeliveryIDs -> LinkedDeliveryIDs
    DeliveryID -> LinkedDeliveryID
    MakeupAirSourceID -> MakeupAirSpaceID
    ModifiedSchedule -> ModifiedScheduleID
    ModifiedSystem -> ModifiedSystemID
    ReferenceCase -> ReferenceScenarioID

  2. Update the descriptions of the IDREF elements to include the valid reference paths as revealed in Docs/generic linking elements #415.

  3. Update the xslt translator to include the renaming changes.

  4. Update the examples.

What are the relevant tickets?

#415
#416

@JieXiong9119 JieXiong9119 added enhancement Schema: Measures Update to measures Schema: Reports Update to reports Schema: General General update to BuildingSync Schema: Systems Update to systems Breaking Change labels Nov 20, 2021
@JieXiong9119 JieXiong9119 self-assigned this Nov 20, 2021
@JieXiong9119 JieXiong9119 linked an issue Nov 20, 2021 that may be closed by this pull request
Copy link
Copy Markdown
Contributor

@macintoshpie macintoshpie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is awesome - so well documented! Great job!
I just had a few questions, and also was wondering if you could add some of the v2 id's to our translator test files so we know the v2->v3 translator is working?

Comment thread BuildingSync.xsd
Comment thread BuildingSync.xsd
Comment thread translation/rename.xsl Outdated
@JieXiong9119
Copy link
Copy Markdown
Contributor Author

This is awesome - so well documented! Great job! I just had a few questions, and also was wondering if you could add some of the v2 id's to our translator test files so we know the v2->v3 translator is working?

Yes I forgot to update that. Thanks for noticing!

@JieXiong9119
Copy link
Copy Markdown
Contributor Author

Lots of updates on the translators and test examples!

Copy link
Copy Markdown
Contributor

@macintoshpie macintoshpie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! I ran the translators locally and it seems to be working well.
I had just a few questions, but if they're actually non-issues then I think this is good to go!

Comment thread translation/v3_to_v2.xsl
Comment thread translation/v3_to_v2.xsl
Comment thread spec/validation_spec.rb
Comment on lines +319 to +323
# schema_doc = Nokogiri::XML(URI.open('https://raw.githubusercontent.com/BuildingSync/schema/v2.4.0/BuildingSync.xsd'))
BUILDINGSYNC_V2_PATH = 'BuildingSync-v2.4.0.xsd'
if !File.file?(BUILDINGSYNC_V2_PATH) then
open(BUILDINGSYNC_V2_PATH, 'wb') do |file|
file << open('https://raw.githubusercontent.com/BuildingSync/schema/v2.3.0/BuildingSync.xsd').read
file << open('https://raw.githubusercontent.com/BuildingSync/schema/v2.4.0/BuildingSync.xsd').read
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, thanks!

Comment thread spec/data/v3_for_translation.xml Outdated
<VentilationControlMethod>Scheduled</VentilationControlMethod>
</VentilationControlMethods>
<auc:MakeupAirSpaceID xmlns:auc="http://buildingsync.net/schemas/bedes-auc/2019">Zone22</auc:MakeupAirSpaceID>
<MakeupAirSpaceID IDref="Zone22"/>
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

Copy link
Copy Markdown
Contributor

@macintoshpie macintoshpie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚡ ⚡ ⚡ Great!

Copy link
Copy Markdown
Member

@nllong nllong left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Few questions, but overall this is looking great!

Comment thread BuildingSync.xsd
Comment thread BuildingSync.xsd
Comment thread BuildingSync.xsd
Comment thread BuildingSync.xsd
Comment thread BuildingSync.xsd
Comment thread BuildingSync.xsd
Comment thread BuildingSync.xsd
Comment thread examples/ASHRAE 211 Export.xml Outdated
Comment thread examples/Golden Test File.xml Outdated
Comment thread spec/data/v2_for_translation.xml
Copy link
Copy Markdown
Contributor

@markborkum markborkum left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes look good, thanks.

The only breaking change for Audit Template tool would be the renaming of the auc:SourceHeatingPlantID element.

@nllong nllong merged commit 42f9a15 into develop-v3 Dec 10, 2021
@nllong nllong deleted the rename-reference-element branch December 10, 2021 18:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Breaking Change enhancement Schema: General General update to BuildingSync Schema: Measures Update to measures Schema: Reports Update to reports Schema: Systems Update to systems

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update reference element (i.e. IDref) names

4 participants