[CGMES export] UUID of fullModel on each file should be unique

[colinepiloquet]

Please check if the PR fulfills these requirements

• The commit message follows our guidelines
• Tests for the changes have been added (for bug fixes / features)
• Docs have been added / updated (for bug fixes / features)

Does this PR already have an issue describing the problem?

No

What kind of change does this PR introduce?

Bug fix

What is the current behavior?

When introducing the naming strategy for CGMES export, the creation of the FullModel UUIDs of each file (EQ, TP, SSH, SV) was changed to be persistent. They are always the same and based on the type of file.

What is the new behavior (if this is a feature change)?
The creation of this UUID is now back as before so that we get a unique ID for each export for each file.

Does this PR introduce a breaking change or deprecate an API?

• Yes
• No

[zamarrenolm]

The network was passed to the writeHeader method to provide a unique id based on the network id itself, the instance file profile, and the fact that the ID was made for "FullModel" output:

 modelId = "urn:uuid:" + context.getNamingStrategy().getCgmesId(refTyped(network), ref(subset), Part.FULL_MODEL);

The call to refTyped(network) was intended to return a unique ID based on the network id PLUS the network object type, in this case "Network", suffixed as "_N".

If we want stable IDs for network models and instance files we must keep the existing way.

if we need to export revisions of the same network model / instance files we could use the version attribute of the FullModel.

[annetill]

This is not enough to have a unique id for several time step and different model version (when we re-import model after fixes):

• We need the case date somwhere ;
• We need the model version.
  Where are these informations to generate a unique id?

[zamarrenolm]

If the full model identifier has to be dependent on the scenarioTime and the version, we can pass these references to the naming strategy, instead of building new random identifiers for every export.

[zamarrenolm]

Both attributes are available in the method that is building the identifier for the full model object.

[zamarrenolm]

We could just add items to the list of object references that will be used as a seed for stable identifiers in the naming strategy:

        CgmesObjectReference[] modelRef = {
                refTyped(network),
                ref(subset),
                ref(DATE_TIME_FORMATTER.format(context.getScenarioTime())),
                ref(format(modelDescription.getVersion())),
                Part.FULL_MODEL};
        String modelId = "urn:uuid:" + context.getNamingStrategy().getCgmesId(modelRef);

[zamarrenolm]

Business processes involving CGMES exports typically will require the exchanged data to be unique by:

• Effective date time (or scenario time).
• Business process (market, operation, ...).
• Sourcing actor (who is producing the file).
• Model part (our CGMES subset).
• Version of the file (sequential, as an integer).

If we consider that the IIDM network id includes information about the sourcing actor (is different for each sourcing actor), then with the lines above we would be covering the requirement for unique identifiers, with the exception of business process: we would be generating the same ID for all business processess.

[colinepiloquet]

I will open a new PR with the introduction of a parameter for the business process.

[colinepiloquet]

However, we do not use the sourcing actor really no? I am not sure that it is necessary

[zamarrenolm]

for the purpose of generating unique model ids, I think we can rely on the IIDM network identifier to give different results for different sourcing actors; no need to explicitly use an additional reference to a sourcing actor

[sonarqubecloud]

Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud