Updates made to latest draft since Herndon

Sony Corporation

Toshiaki Kojima

Proposal of Template for Type Description

S0.1.1.1.1.1 BaseRequestType

The BaseRequestType contains the common elements that are inherited by all service interfaces executing job

requests. Specific job request types (such as transfer job request or transform content request) shall use or

extend this data type or the MediaRequestType.

Description

The BaseRequestType contains the common elements that are inherited by all service interfaces executing job

requests.

Service Description Content of Service Description

Normative Requirements

Specific job request types (such as transfer job request or transform content request) shall use or extend this data

type or the MediaRequestType.

Class Diagram

Separate Normative Requirements from Description.

Add Service Description Field (as in some case, Service Description is required for Type rather than parameter).

Remove factoring diagrams.

Proposal of Class Diagram

Main class diagram only.No sub-type class diagram.

Show reference to the sub-type in the parameter description table.

Proposal of Template for Parameter Description

Name Description Type Required Array

notifyAt Specifies the endpoints where a service can send back a

notification for a job completed or failed. If this element is

set, the service shall send a notification to the address

indicated in the replyTo field for successful completion and a

notification to the address indicated in the faultTo field for

failure. If this element is not set, the service shall not send

notifications to the requestor.

AsyncEndpointType No No

notifyAt

Description

Specifies the endpoints where a service can send back a notification for a job completed or failed. If this element is set, the service shall send

a notification to the address indicated in the “replyTo” field for successful completion and a notification to the address indicated in the “faultTo”

field for failure.

Type Occurrence Inclusion Default

AsyncEndpointType (S0.1.1.2.2.2) 0…1 Optional

Service Description Content of Service Description

Required (S0.2.2.1) If this element is supported.

Normative Requirements

A service shall support either Notification or Palling.

If this element is set, the service shall send a notification to the address indicated in the “replyTo” field for successful completion and a

notification to the address indicated in the “faultTo” field for failure. If this element is not set, the service shall not send notifications to the

requestor.

Separate Normative Requirements from Description.

Add reference of Type.

Add Inclusion and Default fields

Add Service Description field

Sony General Comment

No Description No Description

G1 ✓ Update the diagram. G14 ✓

G2 PENDING(IBM). G15 ✓ Same as G2

G3 ✓ [S2] Change “terminate” to ”stop”.[S3] Delete “CaptureStop” request and ack. G16 NO CHANGE

G4 ✓ G17 PENDING(class diagram).

G5 NO CHANGE G18 PENDING (BaseProfile)

G6 ✓ Already done at the document separation. G19 ✓

G7 ✓ Already done at the document separation. G20 PENDING (RTP Capture)

G8 ✓ [S6] Remove ”anonymous” from SFTP.[S7] PENDING G21 NO CHANGE

G9 ✓ Already done at the document separation. G22 ✓ Change “Informative:” to “Note:”.

G10 ✓ Already done at the document separation. G23 PENDING (extension)

G11 ✓ Already done at the document separation. G24 PENDING (class diagram).

G12 ✓ A service shall support either Notification or Polling. G25 ✓ Remove all complex types.

G13 ✓ G26 ✓ G25

Sony General Comment

No Description No Description

G27 ✓ G40 ✓ G36.

G28 ✓ Remove “value” type. G41 ✓

G29 ✓ [S20] Remove the sentence on URI.[S21] NO CHANGE G42 ✓

G30 NO CHANGE G43 ✓

G31 ✓ G44 PENDING (Error Code)

G32 PENDING (Class diagram) G45 ✓[E21] PENDING (Example of regular expression)[E22] Updated[E23] PENDING (Metadata)

G33 NO CHANGE G46 PENDING (Metadata)

G34 PENDING (Error Code) G47 ✓ Remove “sourceID”.

G35 PENDING (Class diagram) G48 ✓

G36 ✓Merge “extendedJobInfo” and “compactJobInfo”.Change “jobInfoSelection” to “includdeJobInfo”.

G49 ✓ Remove “This parameter…”.

G37 PENDING (Class diagram) G50 ✓

G38 PENDING (Extension) G51 PENDING (Service Consumer Interface)

G39 ✓

Sony Comments on Service Description

Parameter Description

extension IBM to propose

jobInfo Agreed on integrating ExtendedJobInfo and CompactJobInfo into JobInfo

Profile IBM to propose (BaseProfile)

priority Agreed on not mandatory

notifyAt Agreed on mandatory either Notification or polling

finishBefore Agreed on leaving as it is

wrapperMetadata IBM (and metadata sub-group) to propose

modifyJobProfileType Agreed on removing

serviceProvideJobID Agreed on leaving as it is

queueCommand Agreed that all commands are optional

maxNumberResults Agreed on leaving as it is

outputFileNamePattern IBM to propose examples. Agreed on moving into profile

StartProcessByTimeMarkType Agreed on leaving as it is

TimeType Agreed on leaving as it is

sourceID, sourceTyp Agreed that minOccure = 1

profileID Agreed on deleting

description Agreed that the Service Description is not needed

fault Agreed that minOccure = 1

Sony Comments on Service Description

No Description No Description

P1 ✓ Change the minOccurs of “priority” to 0. P18 NOT CHANGE

P2 ✓ G12 P19 ✓ Format combination is described in Service Description.

P3 NO CHANGE P20 ✓ Remove “profileID”.

P4 ✓ Only “ByNoWaitType” is mandatory. P21 NO CHANGE

P5 NO CHANGE P22 NO CHANGE

P6 PENDING (Extension) P23 ✓P7 ✓ All commands are optional. P24 ✓P8 ✓ Change “modifyJob” to “modifyPriority”. P25 ✓ Remove “profileID”.

P9 NO CHANGE P26 ✓P10 ✓ All commands are optional. P27 ✓P11 ✓ G36 P28 NO COMMENT

P12 ✓ Both “ByIDType” and “ByFilterType” are optional. P29 ✓

P13 ✓ P30 ✓P14 ✓ Add “outputFileName” to Service Description. P31 NO CHANGE

P15 NO CHANGE P32 PENDING (Error Code, Feature Not Supported)

P16 ✓ Only “ByServiceDefinedType” is mandatory. P33 ✓ Change minOccurs of “fault“ to 1.

P17 ✓ P34 ✓ G47

Other Comments

No Description

IBM

1. Not yet

2. PENDNG (IBM)

3. NO CHANGE

4. Not yet

EBU1. PENDING (Guideline)

2. PENDING (Metadata)

Cube-Tec PENDING (Metadata)

HR(1), (2)

Chapter 5.5.3: NO CHANGE

Chapter 8.1.1.2: NO CHANGE

Chapter 9: PENDING (Guideline)

Chapter 9.3.1: NO CHANGE

HR(3)

1. What means… : Updated

2. How can… : PENDING

3. Sometimes, … : NO CHANGE

4. How can… : NO CHANGE

5. Should the… : Done already

HR (4) PENDING (Refactoring and Guideline)

HR (5) NO CHANGE

Other Comments

No Description

IRT (1)

[Page12 of 122] NO CHANGE

[Page 26 of 122] PENDING (IBM)

[Page 29 of 122] PENDING (IBM)

[Page 120 of 122] Not yet

IRT (2)[Page 18 of 122] PENDING

[Page 26 of 122] NO CHANGE

IBM/Bloomberg PENDING (Metadata)

Quantel (1) PENDING (Refactoring)

Quantel (2) PENDING (Refactoring)

Quantel (3)

- Why use xs:sequence… : NO CHANGE

- Why use xsattribute:… : NO CHANGE

- In fact, … : NO CHANGE

- The time type… : PENDING

- For true … : PENDING

Other Comments

No Description

BBC (1) PENDING (Refactoring)

BBC (2)

- Secton7… : PENDING- 7.2 Service… : PENDING- In 7.1.1, … : Updated- Althiugh it’s… : PENDING- Also in this… : Updated (Removed when document separation.)-

BBC (3)

- Section 8.1.9… : PENDING- Section 8.2.1… : PENDING- Section 8.2.2… : Updated (already done at the document separation.)- Section 9.3.1… : Updated- Section 9.3.2.6.1… : Updated- Appendix1 : Not yet

Proposal for Error Code numbering policy

INF_Sxx_xxxx Infrastructure errors (system, storage, network, memory, processor)

DAT_Sxx_xxxx Data errors (validation, missing, duplication)

OPN_Sxx_xxxx Operation errors (existence, support, lock, connection, failure)

SEC_Sxx_xxxx Security errors (authentication, authorization)

EXT0000 Extended code. See extended error code for detail.

SYSxxxx System level errors

DATAxxxx Data validation errors

APPxxxx Service level errors

EXT0000 Extended code. See extended error code for detail.

XXX_S00_0001 - Common errors

XXX_S01_0001 - Transfer Service errors

XXX_S02_0001 - Transform Service errors

XXX_S03_0001 - Capture Service errors

Proposal for Error Code numbering policy

Category Current Proposed Code Description

Common

SYS0100 INF_S00_0001 System Unavailable

SYS0101 INF_S00_0002 System Timeout

SYS0102 INF_S00_0003 System Internal Error

SYS0103 INF_S00_0004 Unable to connect to the database

SYS0104 INF_S00_0005 System out of memory

SYS0105 INF_S00_0006 System out of disk space

Common

APP0100 OPN_S00_0001 Job Command is not currently supported by the service URI specified

APP0101 OPN_S00_0002 Queue Command is not currently supported by the service or the device

APP0102 OPN_S00_0003 Operation requested is not currently supported by the service or the device

APP0103 OPN_S00_0004 Service unable to find/lookup device endpoint

APP0104 OPN_S00_0005 Job Command failed

APP0105 OPN_S00_0006 Queue Command failed

APP0106 OPN_S00_0007 Service unable to connect to device endpoint

APP0107 OPN_S00_0008 Job Queue is full, locked or stopped. No new jobs being accepted

APP0108 OPN_S00_0009 Job ended with a failure

Proposal for Error Code numbering policy

Category Current Proposed Code Description

Common

APP0200 OPN_S00_0010 Service received no response from device

APP0201 OPN_S00_0011 Service received an exception from device. See description or exception detail

APP0202 OPN_S00_0012 Service received an unknown or an internal error from device. See description for error detail

APP0203 OPN_S00_0013 Unable to connect to client's notification service endpoint (replyTo) to send the asynchronous result notification response.

APP0204 OPN_S00_0014 Unable to connect to client's service endpoint (faultTo) to send the asynchronous job fault response

APP0205 OPN_S00_0015 Feature not supported

APP0206 OPN_S00_0016 Deadline passed

APP0207 OPN_S00_0017 Time constraints in request cannot be met

APP0300 OPN_S00_0018 Internal or Unknown error encountered. See description for error detail.

EXT0000 EXT_S00_0001 Extended code. See extended error code for detail.

Proposal for Error Code numbering policy

Category Current Proposed Code Description

Common

DATA0100 DAT_S00_0001 Invalid Request XML Format

DATA0102 DAT_S00_0002 Invalid Input Media Format

DATA0103 DAT_S00_0003 Invalid jobID - the supplied jobID does not exists

DATA0104 DAT_S00_0004 Missing required service metadata in request

DATA0105 DAT_S00_0005 Duplicate jobGUID detected for new job

DATA0106 DAT_S00_0006 Invalid Request Parameters

DATA0107 DAT_S00_0007 Job Command not valid

DATA0108 DAT_S00_0008 Queue Command not valid

DATA0109 DAT_S00_0009 Invalid Priority

DATA0110 DAT_S00_0010 Input Media not found. Invalid Resource URI specified

Transfer

DATA0220 DAT_S01_0001 Invalid URI protocol specified for Transport operations.

DATA0221 DAT_S01_0002 Invalid OutpurDirectory or Target URI path

DATA0222 OPN_S01_0001 Unsupported protocol

DATA0223 OPN_S01_0002 Unsupported hash type

DATA0224 OPN_S01_0003 Encryption not supported

DATA0225 OPN_S01_0004 Authentication not supported

Proposal for Error Code numbering policy

Category Current Proposed Code Description

Transfer

DATA0226 OPN_S01_0005 Integrity check not supported

DATA0227 OPN_S01_0006 File too large

DATA0228 OPN_S01_0007 Times not possible

DATA0229 OPN_S01_0008 Incorrect file size

DATA0230 OPN_S01_0009 Rejected by operator

DATA0231 OPN_S01_0010 Transfer process ended unexpectedly

DATA0232 OPN_S01_0011 Incorrect Hash. File received does not have same hash as specified in the file hash value property.

DATA0233 INF_S01_0001 Network link with insufficient bandwidth

DATA0234 INF_S01_0002 Link Timed Out

Transform DATA0101 OPN_S02_0001 Invalid target media format

Capture

DATA0200 OPN_S03_0001 Invalid target media format

DATA0201 DAT_S03_0001 Invalid source ID

DATA0202 OPN_S03_0002 Inconsistent time constraints