Data description for IT

Owned by D.Pachula
Last updated: 14.Oct.2024
7 min read

The IATF audits have different types of data structures. The used data structure is a mix of data structure design and efficient structure to be used in the application and requirements during the development. Fields are only generated if they receive a value, by default a missing field is an undefined field.

Data types

data types

description

data types

description

bit

has values 0 and 1 (used for yes/no questions) as string “1”

boolean

has true and false (used for selects and business logic)

string

not limited string value (checked with business logic where possible, example Auditor Id)

int

int have only positive values

double

double have only positive values

different option types

every type is described in the data definition

date

exported as text string “2019-11-06T00:00:00.000Z”

timestamp

int in milliseconds

file data

All files are saved as base64 encoded string. Files are limited to jpeg image files and pdf files for security reasons

Supported Tags for formatted fields

  • b/strong, i/em, del, a, h1, br, del, ul and ol with li, p

  • other tags will be also evaluated in the digital version but not in print

  • If you are importing data you need to skip or remove “<!--block-->" which will be added by the used editor

Export Format

All data can be exported as json or xml file. We recommend the use of json due to it’s lesser overhead a simpler rule set.

JSON

The json file is loaded as object into CARA.

XML

All xml exports of a report or nc management will be contained withing <CaraReport> tag. To comply with xml requirements on export all elements in the data structure starting with a number receive an Xz insert before the number (example index 1 becomes Xz1 and 4.1 becomes Xz4.1). All fields are encoded to be xml compatible. On import all xml tags defined as arrays are cast to array all other elements are created as objects. The Xz compatibility tag prefix will be removed. All values are decoded and cast into date, int, double types.

CARA does not check the provided files for CARA non conform data fields. Those fields will be loaded but not used. For internal data exchange and management purpose additional id fields etc. can be added (in xml additional array fields should be avoided).

CARA works with the implemented business logic for printing and displaying data. Data fields which are entered and later hidden due to business logic will almost always keep their data (e.g. Organisation information page → Dedicated to automotive)

Descriptions

All reports keep the same data structure. Fields are shown based on business logic. Most of the application structure is replicated in the data structure. Please check the sites of the different report types, to identify the data structure blocks not part of the specific report type. Not required data won’t be used/shown, while still kept in the data structure. The data structure versioning will comply with the major release versioning of the audit tool because only major releases will have changes on the data structure. If minor version is attached some corrections on the description were made.

You will find attached the description for the report data structure. All data fields are always contained within the page they are belonging to or connected to the base data object like Processes. The description for a field contains the text within the application or additional information if the field is not part of the application.

All reports get a unique id and a created and changed value.

Due to the business logic which depends on previous fields and not so much on the chosen audit type and to avoid a complex business logic column in the data description we recommend checking the applied logic using CARA and the defined help descriptions.

CARA is downward compatible. If is required to transform/move any data fields this functionality will be implemented into CARA so existing reports will work with the new formatted data. This will also happen for loaded reports (generated by IT). If they are based on previous data formats that data will be moved by CARA when the report is opened for edit.

DATA DESCRIPTION FILES

Data types for CARA reports

Data type

Report Type

Data type

Report Type

Stage1ReadinessReview

Stage 1 readiness review

AuditReport

Audit report

RemoteAuditReport <deprecated with CARA 1.5; Imports will still work>

Remote support function audit report

SpecialReport

Special audit report

NcManagement

NC management report when exported on it’s own. In general the Nc management is connected to the report it belongs to

AdhocNcReport

Adhoc Nc report

JSON Schema files

Audit Report JSON Schema

NC Management JSON Schema

Functionality on import

On import the data is not checked against the business logic. The only transformation is handled on xml data integrating into arrays where required and removing the Xz on tags starting with a number. At the moment checks are connected to the page in which that content will be entered. This is due to avoid to many calculations within the browser on each change of any data.

How to export/import

For now the CARA tool uses the manual process of creating an export within the application and saving it in defaults download folder or using save as. The import is a file choosing process for a file to import. The system checks against already existing reports in the local browser database with a unique id and warns the user if the report he is importing is going to be overwritten.

Data Description Release Information

Version

Date

Changes

Version

Date

Changes

1.4RC1

31.05.22

  • added ReasonForLetterOfConformance in AuditData

  • Receiving support from location

    • added NotYetAudited

  • changed Customer Information

    • Customers container added to collect customer information

      • part of CustomerRequirementsAuditedObject moved to CustomerKpiObject

      • part of CustomerRequirementsAuditedObject moved to CustomerCsrObject rest to CustomerObject

      • full legacy support with data migration from old to new data structure

  • Manufacturing processes was moved to legacy support and is replaced by Shifts data migration not possible

  • changed ProcessObject

    • added Shifts array of new ShiftsObject for manufacturing shifts in Stage 1 and Audit report

    • added ExtendedShifts of new ShiftsObject for extended manufacturing shifts in Stage 1 and Audit report

    • added AuditNotes of AuditNoteObject replacing AuditInformation with full legacy support migrating AuditInformation into AuditNotes

    • added CustomerCsrReference referencing id in CustomerCsrObject from CustomerObject

  • NcManagment

    • AudiData

      • added IsCertificateRequired, IsUsiRequired business logic helpers

      • added IATFCertificateNo, Usi

      • added text field for all nc client answer section for translations

    • NcActionsObject

      • added MajorSubmissions of array SubmissionObject

For example data creation and testing please use the development site. Data description files:

1.3.2

02.10.22

  • added IATF USI to

    • Organization Information

    • Extended Manufacturing Sites

    • Providing Support Locations

    • Receiving Support Locations

  • AuditData

    • WitnessedBy

      • added Witnessed Auditors as array of AuditorIds

  • Extended Manufacturing sites

    • TotalNumberEmployees

  • CustomerInformation

    • CustomerrRequirementsAudited

      • added EmsSupplierCodes as Object with Object: { ExtendedManufacturinSite.Id : string, … }

1.3.1

18.07.22

  • Audit report

    • Conclusion

      • PreviousAuditNonconformitiesObject

        • added ProcessAuditLead; for merge of audit reports

  • added Complaint; for preformance complaint data attachment

1.3

12.04.22

This update added a lot of fields due to business rules and inheritance functionality capabilities. Most noticable are new mandatory NcObservedProcess and the PreviouslyAudited for the process audited history.

  • Audit reports

    • IsRemoteSupportLocation

    • InternalNotes

    • ReportPdf (base64 encoded reporrts)

    • OrganizationInfromation

      • HasChangesSinceLastAudit

    • Process

      • ProcessObject

        • ProcessEntryState

      • PreviouslyAudited

        • 1 (Stage2)

        • 3 (Surveillance 1)

        • 4 (Surveillance 2)

        • 5 (Surveillance 3)

        • 6 (Surveillance 4)

        • 7 (Surveillance 5)

      • Activities (inheritance field)

      • ProcessPerformance

        • History (array of HistoryObjects)

          • AuditType

          • CurrentTarget

          • Achieved

          • Results

          • TrendLastAudit

    • ExtendenManufacturingSite

      • Comments

    • CustomerInformation

      • CustomerPerformance

        • Id

      • CustomerRequirementsAudited

        • LinkedCustomerPerformanceId

    • Conclusion

      • PreviousAuditNonconformities

        • NcObservedProcess

        • StatementOfNonconformity

        • ObjectiveEvidence

        • SystemicEvidenceOfImplementation

        • ActionTakenVerifyImplementation

  • Nc managamenet

    • Signature

      • AuditorId

    • State as enum(AuditorNcEntry,OrganizationNcEntry, CbNcEntry, NcCompleted)

    • ReportPdf

1.2.2.1

17.09.21

  • Correction of field value due to typo

    • auditTypeOptions Stage 2 / Letter of conformance = 20 is 2

1.2.2

26.07.21

  • Only correction of data field name typos in the document

    • ManufacturingProcesses

      • NoOperationalShifts0 was and is NoOperationalShifts, reamined for Stage1 was migrated NoOperationalShiftsX per Shift in audit report

      • AuditTypeShiftObject (fields are based on audit type id and on 2 is the letter of conformance)

        • NoOperationalShifts2 = NoOperationalShifts3

        • NoOperationalShifts3 = NoOperationalShifts4

        • NoOperationalShifts4 = NoOperationalShifts5

        • NoOperationalShifts5 = NoOperationalShifts6

        • NoOperationalShifts6 = NoOperationalShifts7

1.2

02.05.21

  • Nc Management data description

    • password (internal)

    • encActivatedByOrganisation (internal)

    • fileSizeAttachments (internal + check in meta information)

    • IsAdhocNcMangement (only adhoc)

    • Organization

      • EvidenceOfImplementationFiles

      • RootCauseAnalysisImpactOtherProcesses

    • CbPreviousAnswers

  • Audit data description

    • fileSizeAttachments (internal + check in meta information)

    • AuditorNotes

    • AuditData

      • LastPerformedAuditCycle

      • AuditDateWaiver

      • ReportIssueData (only adhoc)

      • ReasonForAdhoxNc (only adhoc)

    • Address

      • Street 3

    • OrganizationInformation

      • CertificateScopeLanguage

      • CertificateScopeNative (migrated to CertificateScopeOther)

      • CertificateScopeOther

        • CertificateScope

        • Language

      • CorporateSchemeReferenceNumber

    • Process

      • ProcessNotAudited

      • ProcessAuditRemotely

    • ProvidingSupportSites

      • CbCertificateNo

    • ReceivingSupportSites

      • CbCertificateNo

    • ManufacturingProcesses

      • ShiftProcess

        • NoOperationalShiftsx (Shifts now per process)

        • ShiftTimes (collect shift times)

    • CustomerInformation

      • CustomerRequirementsAuditedObject

        • DateCSRDocument (type changed to string from date)

    • Conclusion

      • HasPreviousAuditNonconformities

      • PreviousAuditNonconformitiesObject

        • Id (internal use random)

        • SpecialAuditConducted

        • CreatedBy (internal use ADP)

1.1.9

15.12.20

  • New remote audit report fields

1.1.8

03.10.20

  • Fixed wrong position of CustomerRequirementsAudited

1.1.6

19.08.20

  • Fixed typos on Activities (no option addded)

1.1.4

13.07.20

  • Added missing data description for already existing Stage 1 results section fields (marked blue)

1.1

01.06.20

  • Nc Management data description

    • Removed OfiPoitiveAspects data block

    • Added AuditTeam (for business logic use)

    • Added MinorDate60, MajorDate20, MajorDate60 (for business logic use)

  • Audit data description

    • Added OfiPositiveAspects data block (moved from Nc management, CARA will automatically move that data block to the report when a report is loaded)

    • Added AddressNative to organisation information and all sites of type adress

    • Added CertificateScopeNative

    • Added Id field to addresses

    • Moved NextScheduledAuditType and DateNextScheduledAudit from AuditData to Results section (will be moved by Cara automatically when report is loaded)

    • Changed LanguageByManagementPersonnel, LanguageBySupportingPersonnel, LanguageByManufacturingPersonnel to array of string (converted by CARA)

    • Changed AuditTeamRecommendation to array of boolean (converted by CARA)

1.0.2

14.01.20

  • added encode/decode for xml files for compatibility

  • fixed mixing NCs on merging

  • added auto calculation and NC sync on audit merging

1.0.1

12.01.20

  • Patches on

    • Nc Management report

    • Audit data merge

    • Remote support function audit report

    • printing

1.0.0

06.01.20

  • Changes are marked in red for better recognition

  • Changes in Cara report audit data structure

    • LanguagesBy changed to array for multiple languages

    • AuditMergeDataObject added for Processes

  • Changes in Nc management data structure

    • Added Clause and Process to Ofi and PA

    • Added Id and CreatedBy based on application auditor id for data merging

    • Added RootCauseResult, RootCauseResultFiles

0.98.20

 

  • Changed in CaraReportAuditData OrganizationInformation fields

    • Management Supporting, Manufacturing personnel to array of string

  • Changed NcManagement

    • Process Ids and Names are imported from report to the NcManagement

    • NcAction

      • Nonconformity observed in process was changed to reference field to a process id, to connect it exactly to a report process. Deleting a process in the report will result in deleting the reference

0.98.02

25.11.19

Audit report description:

Removed OpportunitiesImprovement and replaced by

NumberOpportunitiesImprovement

Removed PositiveAspects and replaced by NumberPositiveAspects

0.98.01

21.11.19

Added missing fields in audit data and organization information