DDF jsonata Report template - Add ReadMe sheet and some improvements.

[BSnoeijerCD]

As discussed with @ASL-rmarshall and also mentioned during the sprint review, we propose the following improvements to the output file:

• add the ReadMe sheet as indicated in the attached example.
• add the CDISC Rule ID column to the Issue Summary sheet as well.
• rename column H in the Issue Detail sheet to 'Attributes'

CDISC_Pilot_Study_v4_Dirty_20251028_comments.xlsx

[ASL-rmarshall]

@gerrycampion Above are the template changes I mentioned. I also found that using instanceType for entity/dataset is not handled consistently for all parts of the report (the Entity column on the Issue Summary sheet was blank even when the Entity column on the Issue Details sheet was populated).

I fixed this locally by changing

cdisc-rules-engine/cdisc_rules_engine/utilities/jsonata_processor.py

Lines 57 to 89 in 233c00e

	for result in results:
	error_entity = ValidationErrorEntity(
	value=result,
	dataset=result.get("dataset") or "",
	row=result.get("row"),
	USUBJID=result.get("USUBJID"),
	SEQ=result.get("SEQ"),
	entity=result.get("entity")
	# For backwards compatibility. To be removed in the future:
	or result.get("dataset") or result.get("instanceType"),
	instance_id=result.get("instance_id") or result.get("id"),
	path=result.get("path") or result.get("_path"),
	)
	errors[result.get("dataset")].append(error_entity)
	validation_error_container = [
	ValidationErrorContainer(
	dataset=dataset,
	domain=dataset,
	targets=rule.get("output_variables"),
	errors=error,
	message=next(iter(rule.get("actions", [])), {})
	.get("params", {})
	.get("message"),
	status=(
	ExecutionStatus.SUCCESS.value
	if results
	else ExecutionStatus.EXECUTION_ERROR.value
	),
	entity=dataset,
	).to_representation()
	for dataset, error in errors.items()
	]
	return validation_error_container

to assign entity and they use it in both error_entity and validation_error_container:

            for result in results:
                entity=result.get("entity") or result.get("dataset") or result.get("instanceType")                
                error_entity = ValidationErrorEntity(
                    value=result,
                    dataset=entity,
                    row=result.get("row"),
                    USUBJID=result.get("USUBJID"),
                    SEQ=result.get("SEQ"),
                    entity=entity,
                    instance_id=result.get("instance_id") or result.get("id"),
                    path=result.get("path") or result.get("_path"),
                )
                errors[entity].append(error_entity)
        validation_error_container = [
            ValidationErrorContainer(
                dataset=entity,
                domain=entity,
                targets=rule.get("output_variables"),
                errors=error,
                message=next(iter(rule.get("actions", [])), {})
                .get("params", {})
                .get("message"),
                status=(
                    ExecutionStatus.SUCCESS.value
                    if results
                    else ExecutionStatus.EXECUTION_ERROR.value
                ),
                entity=entity,
            ).to_representation()
            for entity, error in errors.items()
        ]
        return validation_error_container

Could you apply something similar?

[BSnoeijerCD]

@gerrycampion @ASL-rmarshall : Attached is an example output with the proposed ReadMe sheet.

CDISC_Pilot_Study_v4_Dirty_20251028_comments.xlsx