NHSDigital / DataDictionaryPublication

Apache License 2.0
7 stars 1 forks source link

Orchestrator Change Paper Preview #525

Open KatePalmerLilley opened 1 month ago

KatePalmerLilley commented 1 month ago

Question - when running a change paper there is an option to "include data set definitions", should this be selected?

image

The change paper preview is giving very limited information, it's not clear what has actually changed. Note that I have produced the change paper twice, once with "include data set definitions" selected, and another with "include data set definitions" unselected.

DD Orchestrator> Changes> CR8001 - National Hair Colour Data Set Version 1:

Image

I have compared the item in CR8001 Vs Main and cannot see any differences.

AngelaFaulding commented 1 month ago

I have a Data Set in CR800 with data groups and sub groups:

image

But it doesn't display in the Orchestrator Changes:

image

AngelaFaulding commented 1 month ago

As per Kate's comment above regarding "include data set definitions". In the document you sent you stated "Optionally tick the box for "Include data set definitions". Finally, click the "Run" button."

What does that do? What difference will we see if we tick it or don't tick it?

image

pjmonks commented 1 month ago

If a data set is included in the change paper (either new or updated), "Include data set definitions" will list every related Data Element and Attribute that is linked to those data set(s), even if those Data Elements/Attributes were not modified in the branch. If not checked, only new/updated Data Elements/Attributes would be listed.

Also, checking "Include data set definitions" will also include all the data set tables and sub-groups for any data sets included in the change paper.

AngelaFaulding commented 3 weeks ago

19/08/24 - please see Kate's comment above: The change paper preview is giving very limited information, it's not clear what has actually changed. Can you answer this please?

pjmonks commented 2 weeks ago

In reference to CR8000, the most obvious differences are that the data set specifications appear when you tick "Include data set definitions".

Without "Include data set definitions":

Image

With "Include data set definitions":

Image

The other major difference when "Include data set definitions" is ticked is that the summary of changes list will include Attributes/Data Elements that are used in the data set you have created/modified, even if you have not directly changed those Attributes/Data Elements. They appear listed as "Changed Data Set" (like you old change papers), and provide the definitions of those data set components.

With "Include data set definitions":

Image

In this example, these Data Elements do not appear when "Include data set definitions" is not ticked because these have not been changed.

AngelaFaulding commented 1 week ago

Ticket updated, content deleted and copied onto new tickets:

pjmonks commented 2 days ago

This issue has been fixed and deployed to TEST, TRAINING and LIVE. Please move this to the "Ready for NHS E Testing" state.