Release 4 CAB Batch File Definitions_

Transcription

1 Release 4 CAB Batch File Definitions_ Steria Limited Guide to the use of CAB batch files to interface with Release 4 of the Diploma aggregation service QCDA Prepared b: Steria Business Analst Document reference: QCDA Product Reference 2.15 Version number: Version 2.0 Date of Issue: 02 June 2010 creativit_ simplicit_ independence_ respect_ openness_

2 Document histor Version no. Date Change 0.1 November 2009 Initial version for DAS Release 4, based on Release 3 Batch File Definitions v November 2009 Updated with internal feedback. 0.3 November 2009 Updated for planned programm of stud (PPoS): Section 2.5 Notification of PPoS sssignment change added December December 2009 Timestamps on notifications to include seconds Issued to QCDA for review December 2009 QCDA review comments: Format of Award Date on Results file corrected Format of permissible range for Publish date on results file corrected N and Q record tpes on Notification of PPoS assignment file clarified Februar 10 Final version updates (identified during development): Februar 10 Eternal review comments General removal of actual error message wording full list of error messages included in BFD Overview document. Section 2.5 amendment to format of Change date; amendment to note 2 in Section Section 2.6 addition of PPoSName and amendment to format of claim date (to align with format for other organisations) Correction to eample to remove time element (section 2.5.2) Februar 10 R4 Technical Design Signoff Baseline version March 10 Post TD Signoff - Amendments (1) June 2010 End of R4 Baseline Planned Programme of Stud acronm should be PPoS in all instances, including field names Ref: QCDA Product Reference 2.15 Page 2 of 33

3 Related documents Reference Title 1 Release 4 Batch File Definitions Overview 2 Release 4 Centre Batch File Definitions 3 Release 4 DAB Batch File Definitions 4 Release 4 QCDA Batch File Definitions 5 Release 4 Error Messages 6 Release 4 Use Case documents 7 Release 4 Interfaces document 8 Release 4 Role Matri Authorisation Name Title Signature Dawn Beattie Bruce Kerr Manish Midha QCDA Business Architect QCDA Business Assurance QCDA Technical Assurance Reviewers Name Title Signature Dolo Miah Vikas Gupta Principal Solution Architect Lead Developer Ref: QCDA Product Reference 2.15 Page 3 of 33

4 Contents 1 Introduction Purpose File tpes for CABs CAB Batch Files ULN Epression of Interest from CAB to Diploma aggregation service Result from CAB to Diploma aggregation service ULN Activations from Diploma aggregation service to CAB Notification of Learner Accounts Split Notification of PPoS assignment change File upload status report from Diploma aggregation service to CAB...32 Ref: QCDA Product Reference 2.15 Page 4 of 33

5 1 Introduction 1.1 Purpose This document describes the batch files used b CABs to upload data to and download data from the Diploma aggregation service (DAS). It is part of a suite of documents that define the batch file definitions available in Release 4 of DAS. Please see also the Release 4 Batch File Definitions Overview which gives batch file information that is not organisation specific Approach for tracking changes Changes made since the previous version of the document will be tracked b version in the document histor. 1.2 File tpes for CABs Each organisation that has access to the Diploma aggregation service has the abilit to load batch files appropriate to the tpe of organisation. Note: the list available to each individual user is determined b the role(s) assigned to that user (see Doc. Ref. [8]) Uploads The following tpes of file can be loaded b CABs: ULN Epressions of Interest Results Downloads CABs have access to the following downloads: ULN activations (via the Retrieve ULNs menu option) Notifications (via the Notice board ) File upload status report (via the View status of uploaded files sub-option within the Manage information via a file upload menu option) Ref: QCDA Product Reference 2.15 Page 5 of 33

6 2 CAB Batch Files Please note that an references below to section A.nn can be found in Appendi A of the Release 4 Batch File Definitions Overview. Appendi A contains Code Lists that are common to the batch file definitions for all tpes of organisation. 2.1 ULN Epression of Interest from CAB to Diploma aggregation service Batch File Laout Data From To Use Case References ULN Epression of Interest CAB DAS RR02 Column Heading Length Tpe F/V M/O Validation/Constraints 10 A F M Sample file laout Ref: QCDA Product Reference 2.15 Page 6 of 33

7 2.1.3 Validation Column(s) Validation/Condition Code Severit Column(s) Returned If the epression of interest is successfull recorded 173 I The ULN is mandator 005 E The format of the ULN must conform to the LRS format 084 E and check-digit rules All An invalid file format row has been found (see Release 4 Batch File Definitions Overview Section 2.1.1) 307 E Ref: QCDA Product Reference 2.15 Page 7 of 33

8 2.2 Result from CAB to Diploma aggregation service Batch File Laout Data From To Use Case References Result CAB DAS RR01 Column Heading Length Tpe F/V M/O Validation/Constraints 10 A F M Must eist on Learner table GivenName 35 A V M FamilName 35 A V M QualificationTpe 15 A V O (see section A.13) 10 A V M Suffi 4 A V O Onl sent for results relating to qualifications with pathwas 10 A V O Onl sent for PL unit results 30 A V M (see section A.16) Grade 20 A V O A? in this column indicates that this is an epected result record Points 5 N V O Credit 5 N V O Achieved 1 A F M Y (achieved) N (fail) Must be set to N for epected results ProjectTitle 400 A V O 7 Date F M MM/CCYY PublishDate 10 Date F O Mandator for actual results Must be blank for epected results AssessmentCentreId 50 A V M AssessmentCentreName 255 A V M WithdrawResult 1 A F M Y (withdraw) N (not withdrawn) Ref: QCDA Product Reference 2.15 Page 8 of 33

9 2.2.2 Sample file laout,givenname,familname,qualificationtpe,,suffi,,,grade,points,credit,ach ieved,projecttitle,,publishdate,assessmentcentreid,assessmentcentrename,withdrawresult ,Michelli,Johanson,GCSE,100/0956/5,,,OCR,C,,0,Y,,05/2008, ,6,TVULM,N ,Michelli,Johanson,PL,500/4019/4,,Y/501/5221,OCR,F,2,0,Y,,12/2007, ,116,Welsh Joint Ed Com,N ,Michelli,Johanson,PL,500/4019/4,,H/501/5223,OCR,C,2,0,Y,,12/2007, ,116,Welsh Joint Ed Com,N ,Michelli,Johanson,VRQ,500/1784/6,,,OCR,,,0,Y,,05/2008, ,6,TVULM,N ,Michelli,Johanson,FS,500/2561/2,,,OCR,,,0,Y,,05/2008, ,6,TVULM,N ,Michelli,Johanson,FS,500/2563/6,,,OCR,,,0,Y,,05/2008, ,6,TVULM,N ,Michelli,Johanson,FS,500/2557/0,,,OCR,,,0,Y,,05/2008, ,6,TVULM,N ,Michelli,Johanson,PL,500/4019/4,,R/501/5220,OCR,C,2,0,Y,,12/2007, ,116,Welsh Joint Ed Com,N ,Michelli,Johanson,PL,500/4019/4,,D/501/5222,OCR,F,2,0,Y,,12/2007, ,116,Welsh Joint Ed Com,N ,Michelli,Johanson,PL,500/4019/4,,,OCR,F,16,0,Y,,12/2007, ,116,Welsh Joint Ed Com,N ,Michelli,Johanson,PROJ,500/2407/3,,,OCR,E,3,0,Y,Project title,12/2007, ,116,welsh Joint Ed Com,N ,Michelli,Johanson,PL,500/4019/4,,L/501/5216,OCR,F,2,0,Y,,12/2007, ,116,Welsh Joint Ed Com,N ,Michelli,Johanson,PL,500/4019/4,,R/501/5217,OCR,C,2,0,Y,,12/2007, ,116,Welsh Joint Ed Com,N ,Michelli,Johanson,PL,500/4019/4,,A/501/5213,OCR,F,2,0,Y,,12/2007, ,116,Welsh Joint Ed Com,N ,Michelli,Johanson,PL,500/4019/4,,J/501/5215,OCR,C,2,0,Y,,12/2007, ,116,Welsh Joint Ed Com,N Ref: QCDA Product Reference 2.15 Page 9 of 33

10 2.2.3 Validation Column(s) Validation/Condition Code Severit Suf fi Suf fi Suf fi WithdrawResult If a new result is successfull recorded If a result amendment is successfull recorded If a result is successfull withdrawn Column(s) Returned 170 I Suffi 171 I Suffi 172 I Suffi Ref: QCDA Product Reference 2.15 Page 10 of 33

11 Column(s) Validation/Condition Code Severit Suf fi QualficationCodeSuff i Points If an epression of interest is successfull recorded for the first time The ULN on the result has been merged with another ULN The points on the overall PL qualification result should match the sum of the points on the PL unit records Column(s) Returned 173 I Suffi 295 I Suffi 338 W Suffi Ref: QCDA Product Reference 2.15 Page 11 of 33

12 Column(s) Validation/Condition Code Severit Column(s) Returned The ULN is mandator 005 E Suffi GivenName The learner account must eist in the sstem The learner s given name must be provided and not be more than 35 characters in length 007 E Suffi 008 E Suffi Ref: QCDA Product Reference 2.15 Page 12 of 33

13 Column(s) Validation/Condition Code Severit FamilName The learner s famil name must be provided and not be more than 35 characters in length The format of the ULN must conform to the LRS format and check-digit rules CAB must eist on the table of awarding bodies (see section A.16) Column(s) Returned 009 E Suffi 084 E Suffi 061 E Suffi Ref: QCDA Product Reference 2.15 Page 13 of 33

14 Column(s) Validation/Condition Code Severit QualificationTpe Grade If the qualification tpe is provided, it must eist on the table of qualification tpes (see section A.13) If the unit code is provided it must be a valid unit code If provided must conform to the grading scheme for the qualification Column(s) Returned 068 E Suffi 069 E Suffi 070 E Suffi Ref: QCDA Product Reference 2.15 Page 14 of 33

15 Column(s) Validation/Condition Code Severit Points QualificationTpe Points QualificationTpe Grade If present, the points field must be numeric Points is a mandator field for PL qualification results Grade is a mandator field for PL qualification results Column(s) Returned 198 E Suffi 073 E Suffi 074 E Suffi Ref: QCDA Product Reference 2.15 Page 15 of 33

16 Column(s) Validation/Condition Code Severit QualificationTpe Points QualificationTpe Grade QualificationTpe Points Points is a mandator field for PL unit results Grade is a mandator field for PL unit results Points is a mandator field for project results Column(s) Returned 075 E Suffi 076 E Suffi 077 E Suffi Ref: QCDA Product Reference 2.15 Page 16 of 33

17 Column(s) Validation/Condition Code Severit QualificationTpe Grade Grade is a mandator field for project results The award date must not be before 1 Januar 2005 Column(s) Returned 078 E Suffi 079 E Suffi Award Date is a mandator field 081 E Suffi Ref: QCDA Product Reference 2.15 Page 17 of 33

18 Column(s) Validation/Condition Code Severit The award date must be a valid date in the format mm/cc Column(s) Returned 128 E Suffi PublishDate Publish Date is a mandator field 082 E Suffi PublishDate The publish date must be a valid date 129 E Suffi Ref: QCDA Product Reference 2.15 Page 18 of 33

19 Column(s) Validation/Condition Code Severit Suf fi WithdrawResult GivenName FamilName GivenName FamilName A result cannot be withdrawn if the original result has not been recorded in the sstem The learner details submitted must match those held in the DAS or in LRS The learner details provided do not match those in DAS, the LRS is unavailable and MIAP contingenc has not been invoked so the learner details supplied cannot be validated Column(s) Returned 083 E Suffi 199 E Suffi 235 E Suffi Ref: QCDA Product Reference 2.15 Page 19 of 33

20 Column(s) Validation/Condition Code Severit AssessmentCentreId AssessmentCentreN ame WithdrawResult Assessment Centre ID is a mandator field and must not be more than 50 characters in length Assessment Centre Name is a mandator field and must not be more than 50 characters in length Withdraw Result is a mandator field Column(s) Returned 278 E Suffi 279 E Suffi 280 E Suffi Ref: QCDA Product Reference 2.15 Page 20 of 33

21 Column(s) Validation/Condition Code Severit Qualification Code is a mandator field The Qualification Code must eist in NDAQ Column(s) Returned 281 E Suffi 282 E Suffi Achieved Achieved is a mandator field 283 E Suffi Ref: QCDA Product Reference 2.15 Page 21 of 33

22 Column(s) Validation/Condition Code Severit Column(s) Returned Achieved Achieved must be Y or N 284 E Suffi PublishDate The date must fall within the valid date range of the sstem The unit code must belong to the specified qualification code for PL unit results 366 E Suffi 287 E Suffi Ref: QCDA Product Reference 2.15 Page 22 of 33

23 Column(s) Validation/Condition Code Severit Points Credit The total points on the overall PL result is cross-checked against the sum of the points for the units so all of the units must be present for the check to take place If present, the credit field must be numeric Column(s) Returned 288 E Suffi 291 E Suffi WithdrawResult Withdraw Result must be Y or N 292 E Suffi Ref: QCDA Product Reference 2.15 Page 23 of 33

24 Column(s) Validation/Condition Code Severit Suf fi Grade A given result must not occur more than once in a single batch file For split level qualifications, a grade must be supplied so that the appropriate level of achievement can be identified A user can onl submit results on behalf of their own organisation Column(s) Returned 304 E Suffi 306 E Suffi 312 E Suffi Ref: QCDA Product Reference 2.15 Page 24 of 33

25 Column(s) Validation/Condition Code Severit Suf fi Suf fi Suf fi A user can onl submit results for qualifications awarded b their own organisation Actual results must not be mied with epected results for the same learner and qualification Epected results for a learner s qualification must not be duplicated in the same file Epected results must not be mied with corresponding withdrawals in the same file Column(s) Returned 313 E Suffi 317 E Suffi 318 E Suffi 319 E Suffi Ref: QCDA Product Reference 2.15 Page 25 of 33

26 Column(s) Validation/Condition Code Severit Grade PublishDate Grade Achieved Suf fi Suf fi If the result is an epected result, the publish date must not be present If the result is an epected result, the achieved indicator must be N An epected result cannot be recorded in the sstem more than once An epected result cannot be recorded where an actual result alread eists Column(s) Returned 320 E Suffi 322 E Suffi 323 E Suffi 361 E Suffi Ref: QCDA Product Reference 2.15 Page 26 of 33

27 Column(s) Validation/Condition Code Severit Suf fi Grade WithdrawResult Suf fi Suf fi All An epected result cannot be withdrawn if the original result has not been recorded in the sstem The qualification code suffi provided must be valid for the qualification code provided The qualification code provided requires a qualification code suffi An invalid file format row has been found (see Release 4 Batch File Definitions Overview Section 2.1.1) Column(s) Returned 324 E Suffi 327 E Suffi 340 E Suffi 307 E Ref: QCDA Product Reference 2.15 Page 27 of 33

28 2.3 ULN Activations from Diploma aggregation service to CAB Batch File Laout Data ULN Activations From DAS To CAB Use Case References LA01 AS03 Block 1 (first 4 rows) Column Heading Length Tpe F/V M/O Validation/Constraints SearchCriteria 50 A V M Column heading followed b the list of possible search criteria entered to select the records in the file ActivationSearchStart Date EpressedInterestOnl Value 50 A V O The value associated with each criterion entered b the user Block 2 (subsequent rows) Column Heading Length Tpe F/V M/O Validation/Constraints 10 A F M DateLearnerAccountCreated 10 Date F M Derivation of column content Column Heading DateLearnerAccountCreated Contents Alwas present Alwas present Sample file laout SearchCriteria,Value ActivationSearchStartDate, EpressedInterestOnl,Yes,None,DateLearnerAccountCreated , :09 Ref: QCDA Product Reference 2.15 Page 28 of 33

29 2.4 Notification of Learner Accounts Split This notification is generated when a learner record is identified in LRS as actuall referring to two different learners a new ULN is generated in LRS for the second learner. Data Notification of Learner Accounts Split From DAS To CAB Use Case References RD02 AS02 Block 1 (first 4 rows) Column Heading Length Tpe F/V M/O Validation/Constraints SearchCriteria 50 A V M Column heading followed b the list of possible search criteria entered to select the records in the file Number of Das From Date To Date Value 50 A V O The value associated with each criterion entered b the user Block 2 (subsequent rows) Column Heading Length Tpe F/V M/O Validation/Constraints Original 10 N F M OriginalGivenName 35 A V M OriginalFamilName 35 A V M New 10 N F M SplitDate 10 Date F M Derivation of column content Column Heading Original OriginalGivenName OriginalFamilName New SplitDate Contents Alwas present Alwas present Alwas present Alwas present Alwas present Ref: QCDA Product Reference 2.15 Page 29 of 33

30 2.4.2 Sample file laout SearchCriteria,Value NumberOfDas,180 FromDate, ToDate, Original,OriginalGivenName,OriginalFamilName,New,SplitDate ,Helen,Bach, , Notification of PPoS assignment change This notification is generated when a planned programme of stud (PPoS) is assigned to a Diploma on a learner account and the PPoS contains a qualification offered b the CAB. The notification will also be generated when a PPoS assignment gets removed or if the qualifications in an assigned PPoS change. Data Notification of PPoS assignment change From DAS To CAB Use Case Reference LA14 RR13 Block 1 (first 4 rows) Column Heading Length Tpe F/V M/O Validation/Constraints SearchCriteria 50 A V M Column heading followed b the list of possible search criteria entered to select the records in the file Number of Das From Date To Date Value 50 A V O The value associated with each criterion entered b the user Block 2 (subsequent rows) Column Heading Length Tpe F/V M/O Validation/Constraints RecordTpe 13 A F M 10 N F M ChangeDate 10 Date F M CCYY-MM-DD 10 A V O Suffi 4 A V O Ref: QCDA Product Reference 2.15 Page 30 of 33

31 2.5.1 Derivation of column content Column Heading RecordTpe ChangeDate Suffi Contents Alwas present will be Notification or Qualification Alwas present Alwas present Alwas present on Qualification record Ma be present on Qualification record Note1: When a PPoS gets assigned to a Diploma on a learner account, there will be one Notification record and a Qualification record for each qualification offered b the CAB that is included in an assigned PPoS on that learner account. Note 2: When an assigned PPoS gets removed, there will onl be a Notification record Sample file laout SearchCriteria,Value NumberOfDas,7 FromDate, ToDate, RecordTpe,,ChangeDateTime,,Suffi Notification, , ,, Qualification, , ,100/3712/3,0006 Qualification, , ,100/3953/3, Notification, , ,, Notification, , ,, Qualification, , ,100/3712/3,0006 Qualification, , ,100/3602/7, Ref: QCDA Product Reference 2.15 Page 31 of 33

32 2.6 File upload status report from Diploma aggregation service to CAB Batch File Laout Data File upload status report From DAS To CAB Use Case References RR01 RR02 Block 1 (first 2 rows) Column Heading Length Tpe F/V M/O Validation/Constraints FileName 50 A V M Column heading followed b the name of the file submitted b the user Block 2 (subsequent rows) Column Heading Length Tpe F/V M/O Validation/Constraints TransactionTpe 3 A F M Identifies the tpe of transaction where an error has been encountered (see section A.9) RowNumber N V M Code 3 A F M (see Related document 2) Message 255 A V M Severit 3 A F M (see section A.10) 10 A F O Centre 10 N V O Dab 30 A V O (see section A.16) 30 A V O (see section A.16) 10 A V O Suffi 4 A V O 10 A V O UserId 200 A V O Role 3 A V O (see section A.20) BatchJobId 9 N V O LineOfLearning 15 A V O (see section A.5) Level 1 A F O (see section A.6) 7 Date F O ClaimDate 10 Date F O PPoSName 50 A V O Formatted Table Ref: QCDA Product Reference 2.15 Page 32 of 33

33 2.6.2 Derivation of column content Column Heading TransactionTpe RowNumber Code Message Severit Centre Dab Suffi UserId Role BatchJobId LineOfLearning Level ClaimDate PPoSName Contents Alwas present Alwas present Alwas present Alwas present Alwas present Onl present where relevant for transaction tpe Empt field for CAB batch interfaces Empt field for CAB batch interfaces Onl present where relevant for transaction tpe Onl present where relevant for transaction tpe Onl present where relevant for transaction tpe Onl present where relevant for transaction tpe Empt field for CAB batch interfaces Empt field for CAB batch interfaces Empt field for CAB batch interfaces Empt field for CAB batch interfaces Empt field for CAB batch interfaces Onl present where relevant for transaction tpe Empt field for CAB batch interfaces Empt field for CAB batch interfaces Sample file laout FileName Results.csv TransactionTpe,RowNumber,Code,Message,Severit,,Centre,Dab,,Qualification Code,Suffi,,UserId,Role,BatchJobId,LineOfLearning,Leve l,,claimdate,pposname 039,1,170,The result has been successfull recorded.,1, ,,,,500/4019/4,,,,,,,,12/2007,, 039,2,007,A learner account for the ULN provided does not eist in the Diploma aggregation service.,3, ,,,,500/2407/3,,,,,,,,05/2008,, Ref: QCDA Product Reference 2.15 Page 33 of 33