• Have any questions?
  • info.zbook.org@gmail.com

Technical Specification Template Technical User Group

2m ago
61 Views
6 Downloads
572.93 KB
9 Pages
Last View : 1d ago
Last Download : 1d ago
Upload by : Helen France
Share:
Transcription

Technical SpecificationTemplate Technical SpecificationTemplate Version:1.0Document Version:0Date Created:5/21/2019Technical SpecificationApplication Name Update to reflect the application name Document Version: 0 Update to reflect the document version, not the template version. Current Version Date: 10/18/2017 Version Created date

Technical SpecificationTemplate Technical SpecificationTemplate Version:1.0Document Version:0Date Created:5/21/2019Revision History Add details for the current version at the top so the users can easily see the changes DateVersionDescription05/17/20192.1Updates to servicename to support project name 10/18/20182.0Update to Use Model for servicename 05/06/20181.9Included use model for servicename Added a new service servicename to support project name Additional fault code fault code addedISO PublicPage 2 of 9Copyright 2017 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved.Information in this document is subject to change.

Technical SpecificationTemplate Technical SpecificationTemplate Version:1.0Document Version:0Date Created:5/21/2019TABLE OF CONTENTS1 Introduction. 41.1 Purpose . 41.2 Related Documents . 41.3 Reference Documents . 42 Document Release Notes . 52.1 Version x.x . 53 Consolidated List of Supported Artifacts . 54 Services . 64.1 Service Description: Example:EIM RT Interchange Schedule Data . 64.1.1Operation Details . 64.1.2Certificate Roles Requirement . 64.1.3Use Model . 74.1.4Element Table . 75 Fault Return Codes . 9ISO PublicPage 3 of 9Copyright 2017 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved.Information in this document is subject to change.

Technical SpecificationTemplate Technical SpecificationTemplate Version:1.0Document Version:0Date Created:5/21/20191 Introduction1.1 PurposeThe purpose of this document is to capture the information a developer would need to completeinterface development. This document establishes a basis for initiation and development of theservices.The technical specifications capture the service information, element description, formattingconditions of the data that is essential for the development of interfaces.1.2 Related DocumentsFor more information on current or past project initiative releases that impacted the technicalspecification, please refer to the release planning page ing/Default.aspx1.3 Reference DocumentsPlease refer to the following specifications and documents for help with developing the interface. Please do not modify this section. Please replace the highlighted app name below with theactual application URL from the developer site DocumentNameDocument LinkDocument ation.pdfB2B Security Standards ecification.pdfAcceptable formats for specifying the dateTime datatype for submit and request nts& plication.aspx?app app name Developers are encouraged to test the interfaceagainst the market simulation environment (MAPStage). Please refer to the developer site for Mapstage URLs, Production URLs, technicalspecification, Service Artifacts, Sample Files etc.User/Certificate pages/AIM.aspxAIM is an application that supports provisioning ofthe roles necessary for the certificate to interfacewith the ISO’s applications.ISO PublicPage 4 of 9Copyright 2017 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved.Information in this document is subject to change.

Technical SpecificationTemplate Technical SpecificationTemplate Version:1.0Document Version:0Date Created:5/21/20192 Document Release Notes2.1 Version x.x Version section captures the services that are impacted along with the XSD used and themajor/minor version supported specific to this release This document release version affects the following system data interface specifications:ProjectEx:EIM 2019CCDEBEVersion #New vice v1DataService v1.xsd1v20191001RequestDataService v1.xsd1V20191001UpdateRequestDataService v1ReplyDataService v1.xsd1V20181001SchemaMajorEx:Ex:3 Consolidated List of Supported Artifacts This section captures the versions of Services that are supported by the application interface This section shows all the supported service versions for this application:Data SetSupported Service VersionsExample:Example:Market SchedulesretrieveMarketSchedules v2.wsdlretrieveMarketSchedules v2 DocAttach.wsdlretrieveMarketSchedules v3.wsdlretrieveMarketSchedules v3 DocAttach.wsdlsubmitRawBidSet v2.wsdl – Deprecated upon CCDEBE DeploymentSubmit BidssubmitRawBidSet v2 DocAttach.wsdl – Deprecated upon CCDEBE DeploymentsubmitRawBidSet v3.wsdlsubmitRawBidSet v3 DocAttach.wsdlISO PublicMinorPage 5 of 9Copyright 2017 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved.Information in this document is subject to change.

Technical SpecificationTemplate Technical SpecificationTemplate Version:1.0Document Version:0Date Created:5/21/2019submitRawBidSet v4.wsdl – Active upon CCDEBE DeploymentsubmitRawBidSet v4 DocAttach.wsdl – Active upon CCDEBE Deployment4 Services4.1 Service Description: Example:EIM RT Interchange Schedule Data This section will repeat for all wsdls that are used in this application The following sections are relevant for both RPC and DocAttach service types.4.1.1 Operation DetailsThe service has one operation with three message types. All input and output messages are inXML format.Refer to Appendix B for time data logic on data horizon InputsubmitDataService v1submitDataServicev1.wsdlDataService v1.xsdOutputStandard reply bmitDataServicev1 4.1.2 Certificate Roles RequirementThis section should provide a matrix for the different roles that can access this particular service. In this section, provide details around the roles that can use the service being discussed Example:Certificate Role NameAIM Display Role NameRole DetailsApp sibr write ext: SC or AccessGroups SIBR Read/WriteThis role can use this serviceto submit data to SIBRISO PublicPage 6 of 9Copyright 2017 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved.Information in this document is subject to change.

Technical SpecificationTemplate Technical SpecificationTemplate Version:1.0Document Version:0Date Created:5/21/20194.1.3 Use Model In this section, provide details on how the service is expected to be used, for submit service howoften is the data required to be submitted, what type of data should be submitted, how the datashould be submittedFor the request services this should include any limitation such as time frame of request, how arequest should be executedAcceptable Use Policy should be included in this section Example:ID#Use Model Description001The data set should be submitted in a rolling interval basis002If changes occur within the data only the incremental information should besubmitted003The file attachment shall not exceed 15 MB4.1.4 Element Table The element column below should be automatically generated from the XSD. Add the“Application Specific Comments” column to the right and populate with details only for thoseelements that have specific usage. The table below describes any application specific logic that is validated for the elements in theservice artifact.ElementApplication Specific CommentsExample:Example:TimeDateSourceVersionDate reflecting the release this latest version update was related to.Valid value is: mentDataISO PublicPage 7 of 9Copyright 2017 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved.Information in this document is subject to change.

Technical SpecificationTemplate Technical SpecificationElementTemplate Version:1.0Document Version:0Date Created:5/21/2019Application Specific CommentsExample:Example:measurementTypeType of the measurement.Valid values are: LOAD or GEN or MBMA**Meter Befor Meter After (MBMA) can only be used upon ESDER 2 projectactivation for DRS Replacement.Measurement types are the same as channel ID in current metering solution.LOAD is channel 1 and GEN is channel 4.The resource type and sub type to measurement type mapping is provided in thetable below. The resource ID should always be entered in the XML element thatmatches the resource type classification in the MF. For example, when submittingdata for an energy storage unit, the resource ID should always be included inRegisteredGenerator element even though the measurementtype can be eitherLOAD or GEN.Master FileRESTYPEGENMaster File RESSUBTYPEAll Generatorsincluding Pumps,Storage etc.XML ElementMeasurement TypeRegisteredGeneratorGEN or EN or LOADLOADRegisteredLoadLOADTIEFlowgateGEN or LOADISO PublicPage 8 of 9Copyright 2017 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved.Information in this document is subject to change.

Technical SpecificationTemplate Technical SpecificationTemplate Version:1.0Document Version:0Date Created:5/21/20195 Fault Return CodesThis section describes the fault codes that are returned for any service requests that does notpass all the validation rules. The table below should list all the possible faults that the API can encounter while interfacingwith the application Fault CodeFault DescriptionFault Details1000Invalid ResourceThe resource specified is not valid for the datespecified1015Invalid Resource typeThe resource id is associated to a wrong XMLelement for resource type1029Invalid SC ID or ACL GroupThe SC ID or ACL Group being specified isnot provisioned to the user SOAP Fault MessageHeader version ismissing or invalidMessageHeader version number is requiredfor backwards compatibility: "v20171001"ISO PublicPage 9 of 9Copyright 2017 CALIFORNIA INDEPENDENT SYSTEM OPERATOR. All rights reserved.Information in this document is subject to change.

May 21, 2019 · Template Version: 1.0 Document Version: 0 Template Technical Specification Date Created: 5/21/2019 Technical Specification Application Name Update to reflect the application name Document Version: 0 Update to reflect the document version, not the template version. Curr