DDLS: Add "External Entity"

[BeckerWdf]

Source type can also be "External Entity"

[Markus1812]

Adding a new value to an enum is technically incompatible, if no default is defined for the type (see here).

abap-file-formats/file-formats/ddls/type/zif_aff_ddls_v1.intf.abap

Lines 4 to 7 in d749248

	"! <p class="shorttext">Source Type</p>
	"! Source type
	"! $values {@link zif_aff_ddls_v1.data:co_source_type}
	TYPES ty_source_type TYPE c LENGTH 1.

Is it possible to add a default value for ty_source_type?

[BeckerWdf]

Adding a new value to an enum is technically incompatible.

Interesting. We will add more and more of these source types once we "invent" new types.

Is it possible to add a default value for ty_source_type?

We could add "initial" as a default value though. How should be proceed?

[schneidermic0]

Interesting. We will add more and more of these source types once we "invent" new types.

Maybe, some background information, why we declared this as incompatible change. How shall the system behave, if a user would port a DDLS object with a source type that is unknown in the target system, what information shall be stored in this system. If this should be "initial" or "notDefined", this is fine if your object type can handle this. In basically most cases, it was fine to set it to the most common value.

We could add "initial" as a default value though. How should be proceed?

I think this would be fine. As mentioned above "notDefined" might be also a possible value. I have no strong opinion on this.

[BeckerWdf]

If this should be "initial" or "notDefined", this is fine if your object type can handle this.

Yes that should be possible. The source type states which kind of statement is in the source code (DEFINE VIEW, EXTEND VIEW, ...) So if you import a DDLS with a source type that the system does not (yet) know because that source type / kind of statement was added in a later release the following would happen.
You could import that but could not activate it (because you would get syntax errors).

In basically most cases, it was fine to set it to the most common value.

There is no "most common value" for this attribute in this case.

[schneidermic0]

Yes that should be possible. The source type states which kind of statement is in the source code (DEFINE VIEW, EXTEND VIEW, ...) So if you import a DDLS with a source type that the system does not (yet) know because that source type / kind of statement was added in a later release the following would happen.
You could import that but could not activate it (because you would get syntax errors).

Then I suggest to go for this. If the ABAP field is set to the default value, it won't be serialized in the JSON, since it is not a required field. I think this makes also sense, in your case 👍

[BeckerWdf]

Then I suggest to go for this. If the ABAP field is set to the default value, it won't be serialized in the JSON, since it is not a required field. I think this makes also sense, in your case 👍

Currently it's mandatory

      "! <p class="shorttext">Source Type</p>
      "! Source type
      "! $required
      source_type    TYPE ty_source_type,

So do you propose to change it to no longer be mandatory?

[schneidermic0]

Currently it's mandatory

Sorry, I somehow missed this. I think I wouldn't change the mandatory annotation, if this is not really beneficial. During serialization it would end up with "notDefined" (or similar) in the JSON representation.

[BeckerWdf]

I added "unknown" as additional value for source type

[schneidermic0]

Thanks, @BeckerWdf. Looks good to me.

I will ask @Markus1812 to re-review this change, too.

[Markus1812]

Thanks for the update and the new unknown constant. Can you please also set this as a default for the type?

abap-file-formats/file-formats/ddls/type/zif_aff_ddls_v1.intf.abap

Lines 4 to 7 in 80b8a0d

	"! <p class="shorttext">Source Type</p>
	"! Source type
	"! $values {@link zif_aff_ddls_v1.data:co_source_type}
	TYPES ty_source_type TYPE c LENGTH 1.

Below $values, can you please add the following line:

"! $default {@link zif_aff_ddls_v1.data:co_source_type.unknown}

When generating a new schema, this should then also include the new default value.

[BeckerWdf]

Thanks for the update and the new unknown constant. Can you please also set this as a default for the type?

abap-file-formats/file-formats/ddls/type/zif_aff_ddls_v1.intf.abap

Lines 4 to 7 in 80b8a0d

	"! <p class="shorttext">Source Type</p>
	"! Source type
	"! $values {@link zif_aff_ddls_v1.data:co_source_type}
	TYPES ty_source_type TYPE c LENGTH 1.

Below $values, can you please add the following line:

"! $default {@link zif_aff_ddls_v1.data:co_source_type.unknown}

When generating a new schema, this should then also include the new default value.

done

[schneidermic0]

I guess you want to set the default for ty_source_type (not ty_source_origin), don't you?

[BeckerWdf]

🙈

[schneidermic0]

Looks good to me, now. :)

[Markus1812]

Thanks for the update