The Vertical Reporting Task Force has the following responsibilities:
This object contains information on authorities that provide ReportManifest objects and/or collect SIF_ReportObject objects, such as state departments of education, regional service agencies, or other report collecting agencies.
SIF_Events are reported for this object.
Figure 6.6.1-1: ReportAuthorityInfoElement/@Attribute | Char | Description | Type | |
---|---|---|---|---|
ReportAuthorityInfo | This object contains information on authorities that provide ReportManifest objects and/or collect SIF_ReportObject objects, such as state departments of education, regional service agencies, or other report collecting agencies. | |||
@![]() | RefId | M | The unique identifier for this agency/report authority. | RefIdType |
AuthorityName | M | Name of the agency/report authority. | xs:normalizedString | |
AuthorityId | M | The zone unique case-sensitive identifier for the authority. This will be the contents of the SIF_SourceId element in the header of requests for reports. | xs:token | |
AuthorityDepartment | O | Department, office, or subdivision of the agency/report authority. | xs:normalizedString | |
AuthorityLevel | M | Level of the authority. | values:
| |
ContactInfo | O | Information on the contact person in this agency. | ContactInfo | |
Address | O | Address | ||
PhoneNumber | O | PhoneNumber | ||
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
This object provides a way to define a report within a SIF zone. It contains metadata about the report. This object represents a mutual agreement between senders and receivers of the report.
SIF_Events are reported for this object.
Figure 6.6.2-1: ReportManifestElement/@Attribute | Char | Description | Type | |
---|---|---|---|---|
ReportManifest | This object provides a way to define a report within a SIF zone. It contains metadata about the report. This object represents a mutual agreement between senders and receivers of the report. | |||
@![]() | RefId | M | The unique identifier for this report manifest. | RefIdType |
@ | ReportAuthorityInfoRefId | M | ID (GUID) of the authority providing this manifest. | IdRefType |
SIF_Version | M |
Specifies which SIF Specification version should be used when returning the report data; wildcards are allowed. When a wildcard is specified,
the responding agent SHOULD attempt to return the report data in the version specified by | VersionWithWildcardsType | |
SIF_MaxBufferSize | M | Specifies the maximum size of a packet to be returned to the report authority. | xs:unsignedInt | |
ReceivingAuthority | O | The GUID of the authority for whom the report is intended, usually the same authority that defines this manifest. | IdRefType | |
@ | SIF_RefObject | M | The name of the object referenced. | values:
|
ReportName | M | The authority's accepted name for the report. | xs:normalizedString | |
Description | O | The description for the report. | xs:string | |
ReportingPeriod | O | Information on the period of time over which the report spans. | ||
ReportingPeriod/BeginReportDate | O | The first date for which the report contains information. | xs:date | |
ReportingPeriod/EndReportDate | O | The last date for which the report contains information. May be the same as BeginReportDate for snapshot-type reports. | xs:date | |
ReportingPeriod/BeginSubmitDate | O | The first date on which the report may be submitted to the authority. | xs:date | |
ReportingPeriod/EndSubmitDate | O | The last date on which the report may be submitted to the authority. | xs:date | |
ReportingPeriod/DueDate | O | The official due date of the report. | xs:date | |
ReportDefinitionSource | M |
Indicates where the report definition can be found.
If Type is | xs:string | |
@ | Type | M | This attribute indicates the source of the report definition. | values:
|
@ | QueryLanguage | M |
The vendor-defined query language used in the report definition (e.g. | xs:token |
ReportFormatList | O | An optional list of one or more third-party formats that describe the visual representation of the report data. If more than one report format is associated with a manifest, the implementation can choose the most applicable format by examining the ContentType attribute. | List | |
ReportFormatList/ReportFormat | MR | A third-party format that describes the visual representation of the report data. | xs:string | |
@ | Type | M | This attribute indicates the encoding of the format reference. | values:
|
@ | ContentType | M |
The vendor-defined content type (e.g. | xs:normalizedString |
SIF_QueryGroup | C |
Parent element containing the querying criteria for extracting the report information if | List | |
SIF_QueryGroup/SIF_Query | MR | SIF_Query | ||
SIF_ExtendedQuery | C |
Query criteria for extracting the report information if | SIF_ExtendedQuery | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |
This object is an envelope used to send other data objects, typically reports, to authorities such as state departments of education, district offices, other schools, etc. It is also used to signal a data collector agent that a report is compiled and ready to be requested. SIF_ReportObject contains a data object, which is either complete or partial (a partial data object is one that contains a subset of the elements for the data object). One or a series of SIF_ReportObjects contained within one or a series of related SIF_Response messages makes up a complete report.
SIF_Events are reported for this object.
Figure 6.6.3-1: SIF_ReportObjectElement/@Attribute | Char | Description | Type | |
---|---|---|---|---|
SIF_ReportObject | This object is an envelope used to send other data objects, typically reports, to authorities such as state departments of education, district offices, other schools, etc. It is also used to signal a data collector agent that a report is compiled and ready to be requested. SIF_ReportObject contains a data object, which is either complete or partial (a partial data object is one that contains a subset of the elements for the data object). One or a series of SIF_ReportObjects contained within one or a series of related SIF_Response messages makes up a complete report. | |||
@![]() | RefId | M | The ID (GUID) that uniquely identifies this instance of a report. | RefIdType |
ReportInfo | C | Identifies the manifest for the report and characteristics of the submission. This element is a conditional element. This element, the ReportData element, or the SIF_ExtendedQueryResults element is included but never more than one at the same time within an instance of this object. See examples of the usage of the object below. | ||
@ | ReportManifestRefId | M | The report manifest corresponding to this report. | IdRefType |
ReportInfo/CalculationDate | M | The date on which the report was calculated. | xs:date | |
ReportInfo/SubmissionNumber | M | A number that identifies the submission; beginning at 1 and incremented each time a submission is done for a particular report; used to indicate resubmission(s). | xs:positiveInteger | |
ReportInfo/SubmissionReason | M | Reason for the report submission. | values:
| |
ReportInfo/ReportSubmitterInfo | C | Identifies the submitter of the report. This element is conditional depending on the context in which the SIF_ReportObject is used. It must be present in the ReportInfo element when a SIF_ReportObject is sent to a report authority in a SIF_Event message. However, its presence is optional in SIF_ReportObject packets delivered to report authorities in SIF_Response messages. | ||
ReportInfo/ReportSubmitterInfo/ SIF_RefId | O | If the submitter is described by another SIF data object such as a SchoolInfo or LEAInfo instance, this element references that object by RefId. | IdRefType | |
@ | SIF_RefObject | M | The name of a SIF data object. When used in the context of ReportSubmitterInfo, this attribute must have one of the following values. | values:
|
ReportInfo/ReportSubmitterInfo/ SubmitterName | M | Name of the report submitter. This is a descriptive string that names the entity submitting the SIF_ReportObject to the report authority. It could be the name of an agency, a district, a school, the SIF_SourceId of the submitting agent, or any other string that a report authority could use to identify the submitter of a report. This element may be present regardless of the presence of the SIF_RefId and SIF_RefObject elements. When those elements are used, it is recommended that collector agents reproduce the name of the LEA or school here. | xs:normalizedString | |
ReportInfo/ReportSubmitterInfo/ SubmitterDepartment | O | Department, office, or subdivision of the agency submitting the report. | xs:normalizedString | |
ReportInfo/ReportSubmitterInfo/ ContactInfo | O | Information on the contact person in this agency submitting the report. | ContactInfo | |
ReportInfo/ReportSubmitterInfo/ Address | O | Address | ||
ReportInfo/ReportSubmitterInfo/ PhoneNumber | O | PhoneNumber | ||
ReportInfo/ReportSubmitterInfo/ SubmitterNotes | O | Optional notes for the report authority, such as information about a district's reporting policies and procedures, instructions for contacting the district for technical support, etc. | xs:string | |
ReportInfo/Description | O | xs:string | ||
ReportData | C |
Container element for the report content; one valid SIF object can occur as a child here. This element is conditional.
This element or | ReportDataObjectType | |
SIF_ExtendedQueryResults | C |
The report content resulting from a | SIF_ExtendedQueryResults | |
SIF_Metadata | O | SIF_Metadata | ||
SIF_ExtendedElements | O | SIF_ExtendedElements |