Deze service wordt gebruikt voor het initiëren en rapporteren van bulkverwerking van SIS-integratie.
Geïmplementeerde activiteiten
- announceBulkDataExchangeasynchronously.
- announceFailureBulkDataExchange
Aangeroepen bewerkingen
- ignoreBulkDataExchange
- cancelBulkDataExchange
- reportBulkDataExchange
- requestBulkDataExchange
Info over de announceBulkDataExchange-bewerking
De announceBulkDataExchange-bewerking wordt aangeroepen door een Studentinformatiesysteem wanneer het een Bulkintegratie-proces wil starten. Deze aanroep resulteert in een onmiddellijke respons van het systeem om aan te geven of de aanvraag al dan niet is ontvangen, en de bulkverwerking gaat asynchroon door.
Processtroom: announceBulkDataExchange
- Wanneer een LIS-aanvraag announceBulkDataExchange wordt ontvangen, wordt de aanvraag met behulp van de LIS-omzettingsprogramma's die zijn geconfigureerd voor ITranslateAnnounceBulkDataExchange omgezet in D2L® om de aanvraag te transformeren naar een indeling die het IPSIS-platform kan begrijpen.
- Zodra de aanvraag is omgezet, worden de handlers van het IPSIS-platform die zijn geconfigureerd voor IBulkFileReadyRequestHandler gebruikt om de bulkaanvraag bij IPSIS te registreren.
- De LIS-respons wordt vervolgens gegenereerd op basis van de respons van de handler. De respons bevat een lijst met de ondersteunde services van de implementatie met behulp van het geconfigureerde ITranslateSupportServices-omzettingsprogramma.
- Bulkverwerking vindt asynchroon plaats nadat de aankondigingsaanvraag is ontvangen en nadat hierop is gereageerd. The IPSIS Bulk Job Background Services moves the bulk job through the following steps: Files are retrieved using IBulkFileRetriever, files are processed using IBulkFileProcessor, and a response is generated using IBulkSendReportHandler, which uses reportBulkDataExchange to notify the SIS of the results.
Voorbeeld van announceBulkDataExchange-aanvraag
<SOAP-ENV:Envelope xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header>
<imsx_syncRequestHeaderInfo xmlns="http://www.imsglobal.org/services/lis/bdems1p0/wsdl11/sync/imsbdems_v1p0">
<imsx_version>V1.0></imsx_version>
<imsx_messageIdentifier>1234></imsx_messageIdentifier>
</imsx_syncRequestHeaderInfo>
<ims:imsx_epaRequestHeaderInfo xmlns:ims="http://www.imsglobal.org/xsd/gws/gwsv1p0/imsepa_v1p0"/></SOAP-ENV:Header>
<SOAP-ENV:Body>
<bdems:announceBulkDataExchangeRequest
xmlns:bdems="http://www.imsglobal.org/services/lis/bdems1p0/wsdl11/sync/imsbdems_v1p0">
<bdems:transactionId>Test-1234></bdems:transactionId>
<bdems:bulkBlockManifest>
<bdems:bulkBlockManifestId>Test-1234</bdems:bulkBlockManifestId>
<bdems:expiryDate>3000-01-01T00:00:00</bdems:expiryDate>
<bdems:bulkBlockDataFile>
<bdems:url>http://localhost://1234-a.xml></bdems:url>
<bdems:checkSum>00</bdems:checkSum>
<bdems:totalSize>0</bdems:totalSize>
<bdems:savePoint>2011-11-28T10:59:35.000000Z></bdems:savePoint>
<bdems:serviceSet>
<bdems:serviceRecord>
<bdems:serviceName>pmsv2p0</bdems:serviceName>
<bdems:interfaceName>personmanager</bdems:interfaceName>
<bdems:operationSet>
<bdems:operationName>replacePerson</bdems:operationName>
<bdems:operationName>deletePerson</bdems:operationName>
</bdems:operationSet>
</bdems:serviceRecord>
</bdems:serviceSet>
</bdems:bulkBlockDataFile>
<bdems:bulkBlockDataFile>
<bdems:url>http://localhost://1234-b.xml></bdems:url>
<bdems:checkSum>00></bdems:checkSum>
<bdems:totalSize>0></bdems:totalSize>
<bdems:savePoint>2011-11-28T10:59:35.000000Z></bdems:savePoint>
<bdems:serviceSet>
<bdems:serviceRecord>
<bdems:serviceName>gmsv2p0</bdems:serviceName>
<bdems:interfaceName>groupmanager</bdems:interfaceName>
<bdems:operationSet>
<bdems:operationName>replaceGroup</bdems:operationName>
</bdems:operationSet>
</bdems:serviceRecord>
</bdems:serviceSet>
</bdems:bulkBlockDataFile>
</bdems:bulkBlockManifest>
</bdems:announceBulkDataExchangeRequest>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Koptekst- en tekstvelden voor announceBulkDataExchange-aanvraag
Velden van aanvraagkoptekst
Zie Aanvraag- en responskopteksten voor meer informatie.
Velden van aanvraagtekst
De configuratie van het omzettingsprogramma voor sjablonen accepteert de volgende velden in de aanvraag:
Eigenschap
|
Toewijzing LIS-aanvraag
|
Verplicht
|
JobId
|
request.bulkBlockManifestId
|
Ja
|
Expiry DateTime
|
request.expiryDate
|
Ja
|
RemoteFileUrl(s)
|
request.bulkBlockDataFile[*].url
|
Ja
|
FileSize(s)
|
request.bulkBlockDataFile[*].totalSize
|
Ja
|
Checksum(s)
|
request.bulkBlockDataFile[*].checkSum
|
Ja
|
Savepoint(s)
|
request.bulkBlockDataFile[*].savePoint
|
Ja
|
Entity Type(s)
|
request.bulkBlockDataFile[*].serviceSet.serviceRecord[*].interfaceName
|
Ja
|
Voorbeeld van annouceBulkDataExchange-respons
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<h:imsx_syncResponseHeaderInfo
xmlns:h="http://www.imsglobal.org/services/lis/bdems1p0/wsdl11/sync/imsbdems_v1p0"
xmlns="http://www.imsglobal.org/services/lis/bdems1p0/wsdl11/sync/imsbdems_v1p0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<imsx_version>V1.0></imsx_version>
<imsx_messageIdentifier>BDEMS_announceBulkDataExchange_20120304T014745_2593446Z></imsx_messageIdentifier>
<imsx_statusInfo>
<imsx_codeMajor>success></imsx_codeMajor>
<imsx_severity>status></imsx_severity>
<imsx_description/>
<imsx_codeMinor>
<imsx_codeMinorField>
<imsx_codeMinorFieldName>TargetEndSystem></imsx_codeMinorFieldName>
<imsx_codeMinorFieldValue>fullsuccess></imsx_codeMinorFieldValue>
</imsx_codeMinorField>
</imsx_codeMinor>
</imsx_statusInfo>
</h:imsx_syncResponseHeaderInfo>
</s:Header>
<s:Body
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<announceBulkDataExchangeResponse
xmlns="http://www.imsglobal.org/services/lis/bdems1p0/wsdl11/sync/imsbdems_v1p0">
<supportedServices>
<personInterface>
<operationName>replacePerson</operationName>
<operationName>deletePerson</operationName>
</personInterface>
<groupInterface>
<operationName>replaceGroup</operationName>
<operationName>deleteGroup</operationName>
</groupInterface>
<membershipInterface>
<operationName>replaceMembership</operationName>
<operationName>deleteMembership</operationName>
</membershipInterface>
<templateInterface>
<operationName>replaceCourseTemplate</operationName>
<operationName>deleteCourseTemplate</operationName>
</templateInterface>
<offeringInterface>
<operationName>replaceCourseOffering</operationName>
<operationName>deleteCourseOffering</operationName>
</offeringInterface>
<sectionInterface>
<operationName>replaceCourseSection</operationName>
<operationName>deleteCourseSection&</operationName>
</sectionInterface>
<associationInterface>
<operationName>replaceSectionAssociation</operationName>
<operationName>deleteSectionAssociation</operationName>
</associationInterface>
</supportedServices>
</announceBulkDataExchangeResponse>
</s:Body>
</s:Envelope>
Koptekst- en tekstvelden voor announceBulkDataExchange-respons
Velden voor responskoptekst
Zie Aanvraag- en responskopteksten voor meer informatie.
Velden voor responstekst
De configuratie van het omzettingsprogramma voor sjablonen accepteert de volgende velden in de aanvraag:
Eigenschap
|
LIS-responstoewijzing
|
Verplicht
|
JobId
|
request.bulkBlockManifestId
|
Ja
|
Expiry DateTime
|
request.expiryDate
|
Ja
|
RemoteFileUrl(s)
|
request.bulkBlockDataFile[*].url
|
Ja
|
FileSize(s)
|
request.bulkBlockDataFile[*].totalSize
|
Ja
|
Checksum(s)
|
request.bulkBlockDataFile[*].checkSum
|
Ja
|
Savepoint(s)
|
request.bulkBlockDataFile[*].savePoint
|
Ja
|
Entity Type(s)
|
request.bulkBlockDataFile[*].serviceSet.serviceRecord[*].interfaceName
|
Ja
|
Info over de announceFailureBulkDataExchange-bewerking
Het AnnounceFailureBulkDataExchange-proces neemt een 'aanvraag aankondiging fout' en verwerkt deze, met als eindresultaat dat het bronsysteem dat overeenkomt met de aanvraag uit de bulkmodus wordt gehaald en dat de status van de bijbehorende record in de database die alle vereiste informatie voor de bulktaak bevat, wordt ingesteld op geannuleerd.
Processtroom: announceFailureBulkDataExchange
- Wanneer een LIS AnnounceFailureBulkDataExchange-aanvraag wordt ontvangen, haalt D2L® de transactie-id op uit de aanvraag en worden de foutcode en beschrijving opgeslagen indien deze zijn verstrekt. Voor deze bewerking wordt geen afzonderlijke inplugbaar omzettingsprogramma gebruikt.
- Zodra de aanvraag is omgezet, worden de handlers van het IPSIS-platform die zijn geconfigureerd voor IBulkAnnounceFailureRequestHandler gebruikt om de aanvraag te verwerken.
- De LIS-respons wordt gegenereerd op basis van de respons van de handler.
Voorbeeld van een announceFailureBulkDataExchange-aanvraag
<soapenv:Envelope
xmlns:ims="http://www.imsglobal.org/xsd/gws/gwsv1p0/imsepa_v1p0"
xmlns:ims1="http://www.imsglobal.org/services/lis/bdems1p0/wsdl11/sync/imsbdems_v1p0"
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header>
<ims:imsx_epaRequestHeaderInfo>
</ims:imsx_epaRequestHeaderInfo>
<ims1:imsx_syncRequestHeaderInfo>
<ims1:imsx_version>V1.0</ims1:imsx_version>
<ims1:imsx_messageIdentifier>1234</ims1:imsx_messageIdentifier>
</ims1:imsx_syncRequestHeaderInfo>
</soapenv:Header>
<soapenv:Body>
<ims1:announceFailureBulkDataExchangeRequest>
<ims1:transactionId>Samp-816</ims1:transactionId>
</ims1:announceFailureBulkDataExchangeRequest>
</soapenv:Body>
</soapenv:Envelope>
Koptekst- en tekstvelden voor announceFailureBulkDataExchange-aanvraag
Velden van aanvraagkoptekst
Zie Aanvraag- en responskopteksten voor meer informatie.
Velden van aanvraagtekst
De adapter accepteert de volgende velden in de aanvraag:
Eigenschap
|
Toewijzing LIS-aanvraag
|
Verplicht
|
TransactionId
|
request.transactionId
|
Ja
|
Foutcode
|
request.FailureReportType.failureCode
|
Nee
|
Omschrijving van fout
|
request.FailureReportType.failureDescription
|
Nee
|
Voorbeeld van announceFailureBulkDataExchange-respons
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<h:imsx_syncResponseHeaderInfo
xmlns:h="http://www.imsglobal.org/services/lis/bdems1p0/wsdl11/sync/imsbdems_v1p0"
xmlns="http://www.imsglobal.org/services/lis/bdems1p0/wsdl11/sync/imsbdems_v1p0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<imsx_version>V1.0</imsx_version>
<imsx_messageIdentifier>BDEMS_announceFailureBulkDataExchange_20120223T192808_3713232Z</imsx_messageIdentifier>
<imsx_statusInfo>
<imsx_codeMajor>success</imsx_codeMajor>
<imsx_severity>status</imsx_severity>
<imsx_messageRefIdentifier>1234</imsx_messageRefIdentifier>
<imsx_description/>
<imsx_codeMinor>
<imsx_codeMinorField>
<imsx_codeMinorFieldName>TargetEndSystem</imsx_codeMinorFieldName>
<imsx_codeMinorFieldValue>fullsuccess</imsx_codeMinorFieldValue>
</imsx_codeMinorField>
</imsx_codeMinor>
</imsx_statusInfo>
</h:imsx_syncResponseHeaderInfo>
</s:Header>
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"/>
</s:Envelope>
Koptekst- en tekstvelden voor announceFailureBulkDataExchange-respons
Velden voor responskoptekst
Zie Aanvraag- en responskopteksten voor meer informatie.
Tekstvelden van responsobject
Er worden geen velden geretourneerd in de tekst van de respons.
Info over ignoreBulkDataExchange-bewerking
De IPSIS LIS-adapter roept de IgnoreBulkDataExchange-bewerking aan die wordt geïmplementeerd door het SIS. De aanroep wordt geïmplementeerd binnen een handler die IBulkCancelRequestHandler implementeert en is geconfigureerd om te worden uitgevoerd wanneer een aanvraag Negeren ergens binnen het IPSIS-platform wordt gestart.
Processtroom: ignoreBulkDataExchange
Wanneer een bulkaanvraag om te negeren wordt geïnitieerd (meestal via de beheerinterface), roept de BulkManager de geconfigureerde handler aan die IBulkCancelRequestHandler implementeert. Voor systemen die het LIS gebruiken, initieert de geregistreerde handler een IgnoreBulkDataExchange-aanvraag naar het studentinformatiesysteem.
Voorbeeld van een ignoreBulkDataExchange-aanvraag
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/" xmlns:u="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<s:Header>
<h:imsx_syncRequestHeaderInfo xmlns:h="http://www.imsglobal.org/services/lis/bdems1p0/wsdl11/sync/imsbdems_v1p0" xmlns="http://www.imsglobal.org/services/lis/bdems1p0/wsdl11/sync/imsbdems_v1p0" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<imsx_version>V1.0</imsx_version>
<imsx_messageIdentifier>1234</imsx_messageIdentifier>
<imsx_sendingAgentIdentifier>LIS_Test_System</imsx_sendingAgentIdentifier>
</h:imsx_syncRequestHeaderInfo>
<h:imsx_epaRequestHeaderInfo xmlns:h="http://www.imsglobal.org/xsd/gws/gwsv1p0/imsepa_v1p0" xmlns="http://www.imsglobal.org/xsd/gws/gwsv1p0/imsepa_v1p0"/>
</s:Header>
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ignoreBulkDataExchangeRequest xmlns="http://www.imsglobal.org/services/lis/bdems1p0/wsdl11/sync/imsbdems_v1p0">
<transactionId>testRequest1</transactionId>
</ignoreBulkDataExchangeRequest>
</s:Body>
</s:Envelope>
Koptekst- en tekstvelden voor IgnoreBulkDataExchange-aanvraag
Velden van aanvraagkoptekst
Zie Aanvraag- en responskopteksten voor meer informatie.
Velden van aanvraagtekst
Eigenschap
|
Beschrijving
|
transactionId
|
De unieke id die aan deze transactie is toegewezen door de vorige aanvraag voor het uitwisselen van bulkgegevens van de serviceklant.
|
Voorbeeld van ignoreBulkDataExchange-respons
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ims="http://www.imsglobal.org/services/lis/bdems1p0/wsdl11/sync/imsbdems_v1p0">
<soapenv:Header>
<ims:imsx_syncResponseHeaderInfo>
<ims:imsx_version>V1.0</ims:imsx_version>
<ims:imsx_statusInfo>
<ims:imsx_codeMajor>success</ims:imsx_codeMajor>
<ims:imsx_severity>status</ims:imsx_severity>
<ims:imsx_codeMinor>
<ims:imsx_codeMinorField>
<ims:imsx_codeMinorFieldName>TargetEndSystem</ims:imsx_codeMinorFieldName>
<ims:imsx_codeMinorFieldValue>fullsuccess</ims:imsx_codeMinorFieldValue>
</ims:imsx_codeMinorField>
</ims:imsx_codeMinor>
</ims:imsx_statusInfo>
</ims:imsx_syncResponseHeaderInfo>
</soapenv:Header>
<soapenv:Body>
<ims:ignoreBulkDataExchangeResponse>?</ims:ignoreBulkDataExchangeResponse>
</soapenv:Body>
</soapenv:Envelope>
Koptekst- en tekstvelden voor ignoreBulkDataExchange
Velden voor responskoptekst
De reactie wordt gegenereerd door de serviceprovider (bijvoorbeeld Oracle) en vervolgens teruggestuurd naar D2L® op basis van het verzenden van de bovenstaande aanvraag.
Veld
|
Terugkeren
|
Waarde
|
imsx_syncResponseHeaderInfo.imsx_version
|
De serviceprovider retourneert "V1.0" ongeacht de waarde in de aanvraagkoptekst.
|
|
imsx_syncResponseHeaderInfo.imsx_statusInfo.imsx_codeMajor
|
De serviceprovider retourneert de hoofdstatuscode zoals gedefinieerd door IMS.
|
success - wanneer de aanvraag voor negeren is ontvangen door de serviceprovider.
failure - wanneer de aanvraag om te negeren niet is ontvangen door de serviceprovider.
|
imsx_syncResponseHeaderInfo.imsx_statusInfo.imsx_severity
|
De serviceprovider retourneert de ernst (severity) zoals gedefinieerd door IMS.
|
status
|
imsx_syncResponseHeaderInfo.imsx_statusInfo.imsx_messageRefIdentifier
|
De serviceprovider retourneert de waarde uit de imsx_syncRequestHeaderInfo.imsx_messageIdentifier
|
|
imsx_syncResponseHeaderInfo.imsx_statusInfo.imsx_codeMinor.imsx_codeMinorField.imsx_codeMinorFieldValue
|
De serviceprovider retourneert de waarde van het veld Minor Status Code zoals gedefinieerd door IMS.
|
full success - wanneer de aanvraag voor negeren is ontvangen door de serviceprovider.
invalidtransactionid - wanneer de door de serviceconsument geretourneerde transactie-id onbekend is bij de serviceprovider. Er wordt een foutconditie geregistreerd bij de serviceprovider, maar er wordt geen verdere verwerking uitgevoerd.
|
Velden voor responstekst
Geen.
Info over de cancelBulkDataExhange-bewerking
De CancelBulkDataExchange-bewerking wordt gebruikt om een annuleringsaanvraag naar het SIS te verzenden.
Processtroom: cancelBulkDataExchange
- Genereer en verzend een aanvraag.
- Bij annulering van een bulktaak vertrouwt de Bulk Manager op de geconfigureerde IBulkCancelRequestHandler.
- Voor systemen die LIS gebruiken, initieert de geregistreerde handler een CancelBulkDataExchange-aanvraag naar het SIS.
Voorbeeld van cancelBulkDataExchange-aanvraag
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:u="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<s:Header>
<h:imsx_syncRequestHeaderInfo
xmlns:h="http://www.imsglobal.org/services/lis/bdems1p0/wsdl11/sync/imsbdems_v1p0"
xmlns="http://www.imsglobal.org/services/lis/bdems1p0/wsdl11/sync/imsbdems_v1p0"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<imsx_version>V1.0</imsx_version>
<imsx_messageIdentifier>1234</imsx_messageIdentifier>
<imsx_sendingAgentIdentifier>LIS_Test_System</imsx_sendingAgentIdentifier>
</h:imsx_syncRequestHeaderInfo>
<h:imsx_epaRequestHeaderInfo xmlns:h="http://www.imsglobal.org/xsd/gws/gwsv1p0/imsepa_v1p0"
xmlns="http://www.imsglobal.org/xsd/gws/gwsv1p0/imsepa_v1p0"/>
</s:Header>
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<cancelBulkDataExchangeRequest xmlns="http://www.imsglobal.org/services/lis/bdems1p0/wsdl11/sync/imsbdems_v1p0">
<transactionId>testRequest1</transactionId>
</cancelBulkDataExchangeRequest>
</s:Body>
</s:Envelope>
Koptekst- en tekstvelden voor cancelBulkDataExchange
Velden van aanvraagkoptekst
Zie Aanvraag- en responskopteksten voor meer informatie.
Velden van aanvraagtekst
Eigenschap
|
Beschrijving
|
transactionId
|
De unieke identificatie die aan deze transactie is toegewezen door de vorige aanvraag voor het uitwisselen van bulkgegevens.
|
Voorbeeld van cancelBulkDataExchange-respons
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ims="http://www.imsglobal.org/services/lis/bdems1p0/wsdl11/sync/imsbdems_v1p0">
<soapenv:Header>
<ims:imsx_syncResponseHeaderInfo>
<ims:imsx_version>V1.0</ims:imsx_version>
<ims:imsx_statusInfo>
<ims:imsx_codeMajor>success</ims:imsx_codeMajor>
<ims:imsx_severity>status</ims:imsx_severity>
<ims:imsx_codeMinor>
<ims:imsx_codeMinorField>
<ims:imsx_codeMinorFieldName>?</ims:imsx_codeMinorFieldName>
<ims:imsx_codeMinorFieldValue>fullsuccess</ims:imsx_codeMinorFieldValue>
</ims:imsx_codeMinorField>
</ims:imsx_codeMinor>
</ims:imsx_statusInfo>
</ims:imsx_syncResponseHeaderInfo>
</soapenv:Header>
<soapenv:Body>
<ims:cancelBulkDataExchangeResponse>TargetEndSystem</ims:cancelBulkDataExchangeResponse>
</soapenv:Body>
</soapenv:Envelope>
Koptekst- en tekstvelden voor cancelBulkDataExchange-respons
Velden voor responskoptekst
De respons wordt gegenereerd door de serviceprovider (bijvoorbeeld Oracle) en vervolgens teruggezonden naar D2L® op basis van het verzenden van de aanvraag.
Koptekst
|
Terugkeren
|
Waarde
|
imsx_syncResponseHeaderInfo.imsx_version
|
De serviceprovider retourneert "V1.0" ongeacht de waarde in de aanvraagkoptekst.
|
|
imsx_syncResponseHeaderInfo.imsx_statusInfo.imsx_codeMajor
|
De serviceprovider retourneert de hoofdstatuscode zoals gedefinieerd door IMS.
|
success - wanneer de aanvraag om te negeren is ontvangen door de serviceprovider.
failure - wanneer de aanvraag om te negeren niet is ontvangen door de serviceprovider.
|
imsx_syncResponseHeaderInfo.imsx_statusInfo.imsx_severity
|
De serviceprovider retourneert de ernst (severity) zoals gedefinieerd door IMS.
|
status
|
imsx_syncResponseHeaderInfo.imsx_statusInfo.imsx_messageRefIdentifier
|
De serviceprovider retourneert de waarde uit de imsx_syncRequestHeaderInfo.imsx_messageIdentifier
|
|
imsx_syncResponseHeaderInfo.imsx_statusInfo.imsx_codeMinor.imsx_codeMinorField.imsx_codeMinorFieldValue
|
De serviceprovider retourneert de waarde van het veld Minor Status Code zoals gedefinieerd door IMS.
|
fullsuccess - wanneer de aanvraag om te negeren is ontvangen door de serviceprovider.
invalidtransactionid - wanneer de door de serviceconsument geretourneerde transactie-id onbekend is bij de serviceprovider. Er wordt een foutconditie geregistreerd bij de serviceprovider, maar er wordt geen verdere verwerking uitgevoerd.
|
Velden voor responstekst
Geen.
Info over de reportBulkDataExchange-bewerking
De IPSIS LIS-adapter ondersteunt de ReportBulkDataExchange-bewerking niet, maar roept deze bewerking aan de SIS-kant aan wanneer een bewerking voor uitwisseling van bulkgegevens is voltooid.
Processtroom: reportBulkDataExchange
Verwerk en verzend de aanvraag. Na voltooiing van een bulktaak vertrouwt de BulkManager op de geconfigureerde IBulkSendReportHandler-handlers. Voor systemen die LIS gebruiken, initieert de geregistreerde handler een ReportBulkDataExchange-aanvraag naar het studentinformatiesysteem.
Voorbeeld van een reportBulkDataExchange-aanvraag
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:u="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<s:Header>
<h:imsx_syncRequestHeaderInfo
xmlns:h="http://www.imsglobal.org/services/lis/bdems1p0/wsdl11/sync/imsbdems_v1p0"
xmlns="http://www.imsglobal.org/services/lis/bdems1p0/wsdl11/sync/imsbdems_v1p0"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<imsx_version>V1.0</imsx_version>
<imsx_messageIdentifier>1234</imsx_messageIdentifier>
<imsx_sendingAgentIdentifier>LIS_Test_System</imsx_sendingAgentIdentifier>
</h:imsx_syncRequestHeaderInfo>
<h:imsx_epaRequestHeaderInfo xmlns:h="http://www.imsglobal.org/xsd/gws/gwsv1p0/imsepa_v1p0"
xmlns="http://www.imsglobal.org/xsd/gws/gwsv1p0/imsepa_v1p0"/>
</s:Header>
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<reportBulkDataExchangeRequest xmlns="http://www.imsglobal.org/services/lis/bdems1p0/wsdl11/sync/imsbdems_v1p0">
<transactionId>testRequest1</transactionId>
<bulkBlockReport>
<bulkBlockManifestIdRef>testRequest1</bulkBlockManifestIdRef>
<reportSummary>
<noofTotalFullSuccess>6</noofTotalFullSuccess>
<noofTotalPartialSuccess>0</noofTotalPartialSuccess>
<noofTotalFailure>1</noofTotalFailure>
<interfaceSummaryReport>
<interfaceName>groupmanager</interfaceName>
<noofFullSuccess>2</noofFullSuccess>
<noofPartialSuccess>0</noofPartialSuccess>
<noofFailure>0</noofFailure>
</interfaceSummaryReport>
<interfaceSummaryReport>
<interfaceName>personmanager</interfaceName>
<noofFullSuccess>0</noofFullSuccess>
<noofPartialSuccess>0</noofPartialSuccess>
<noofFailure>1</noofFailure>
</interfaceSummaryReport>
<interfaceSummaryReport>
<interfaceName>coursetemplatemanager</interfaceName>
<noofFullSuccess>1</noofFullSuccess>
<noofPartialSuccess>0</noofPartialSuccess>
<noofFailure>0</noofFailure>
</interfaceSummaryReport>
<interfaceSummaryReport>
<interfaceName>courseofferingmanager</interfaceName>
<noofFullSuccess>1</noofFullSuccess>
<noofPartialSuccess>0</noofPartialSuccess>
<noofFailure>0</noofFailure>
</interfaceSummaryReport>
<interfaceSummaryReport>
<interfaceName>coursesectionmanager</interfaceName>
<noofFullSuccess>1</noofFullSuccess>
<noofPartialSuccess>0</noofPartialSuccess>
<noofFailure>0</noofFailure>
</interfaceSummaryReport>
<interfaceSummaryReport>
<interfaceName>membershipmanager</interfaceName>
<noofFullSuccess>1</noofFullSuccess>
<noofPartialSuccess>0</noofPartialSuccess>
<noofFailure>0</noofFailure>
</interfaceSummaryReport>
</reportSummary>
<transactionReportList>
<transactionReport>
<transactionOpIdentifierRef>Copy3</transactionOpIdentifierRef>
<serviceName>pmsv2p0</serviceName>
<transactionFailStatusVocabulary>http://www.imsglobal.org/lis/bdemsv1p0/transactionfailstatusvocabularyv1p0</transactionFailStatusVocabulary>
<transactionFailStatus>unknownvocabulary</transactionFailStatus>
</transactionReport>
</transactionReportList>
</bulkBlockReport>
</reportBulkDataExchangeRequest>
</s:Body>
</s:Envelope>
Koptekst- en tekstvelden voor reportBulkDataExchange-aanvraag
Velden van aanvraagkoptekst
Zie Aanvraag- en responskopteksten voor meer informatie.
Velden van aanvraagtekst
Eigenschap
|
Beschrijving
|
transactionId
|
De transactie-id die overeenkomt met de aankondigingsaanvraag die is verzonden.
|
reportSummary
|
Geeft het totale aantal transacties weer dat is opgenomen in de aankondigingsaanvraag en de status van elke transactie. Bevat de interfaceSummaryReports.
|
interfaceSummaryReport
|
De container voor de samenvattende informatie over de verwerking van de bulkgegevensbestanden door de serviceconsument voor een specifieke service-interface.
|
transactionReport
|
De container voor de status rapporteert over alle transacties binnen het bulkgegevensbestand die niet met succes zijn voltooid door de serviceklant. Als er geen rapporten aanwezig zijn, is de announceBulkDataExchange-aanvraag met succes voltooid.
|
reportFailureDetail
|
De container voor de set rapporten waarmee de transacties worden beschreven die hebben geleid tot het genereren van statuscodes voor fouten.
|
Voorbeeld van reportBulkDataExchange-respons
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ims="http://www.imsglobal.org/services/lis/bdems1p0/wsdl11/sync/imsbdems_v1p0">
<soapenv:Header>
<ims:imsx_syncResponseHeaderInfo>
<ims:imsx_version>V1.0</ims:imsx_version>
<ims:imsx_statusInfo>
<ims:imsx_codeMajor>success</ims:imsx_codeMajor>
<ims:imsx_severity>status</ims:imsx_severity>
<ims:imsx_codeMinor>
<ims:imsx_codeMinorField>
<ims:imsx_codeMinorFieldName>TargetEndSystem</ims:imsx_codeMinorFieldName>
<ims:imsx_codeMinorFieldValue>fullsuccess</ims:imsx_codeMinorFieldValue>
</ims:imsx_codeMinorField>
</ims:imsx_codeMinor>
</ims:imsx_statusInfo>
</ims:imsx_syncResponseHeaderInfo>
</soapenv:Header>
<soapenv:Body>
<ims:reportBulkDataExchangeResponse>?</ims:reportBulkDataExchangeResponse>
</soapenv:Body>
</soapenv:Envelope>
Koptekst- en tekstvelden voor reportBulkDataExchange-respons
De respons wordt gegenereerd door de serviceprovider (bijvoorbeeld Oracle) en vervolgens teruggezonden naar D2L® op basis van het verzenden van de aanvraag.
Velden voor responskoptekst
Koptekst
|
Terugkeren
|
Waarde
|
imsx_syncResponseHeaderInfo.imsx_version
|
De serviceprovider retourneert "V1.0" ongeacht de waarde in de aanvraagkoptekst.
|
|
imsx_syncResponseHeaderInfo.imsx_statusInfo.imsx_codeMajor
|
De serviceprovider retourneert de hoofdstatuscode zoals gedefinieerd door IMS.
|
success - wanneer de aanvraag om te negeren is ontvangen door de serviceprovider.
failure - wanneer de aanvraag om te negeren niet is ontvangen door de serviceprovider.
|
imsx_syncResponseHeaderInfo.imsx_statusInfo.imsx_severity
|
De serviceprovider retourneert de ernst (severity) zoals gedefinieerd door IMS.
|
status
|
imsx_syncResponseHeaderInfo.imsx_statusInfo.imsx_messageRefIdentifier
|
De serviceprovider retourneert de waarde uit de imsx_syncRequestHeaderInfo.imsx_messageIdentifier
|
|
imsx_syncResponseHeaderInfo.imsx_statusInfo.imsx_codeMinor.imsx_codeMinorField.imsx_codeMinorFieldValue
|
De serviceprovider retourneert de waarde van het veld Minor Status Code zoals gedefinieerd door IMS.
|
fullsuccess - wanneer het rapport met succes is ontvangen door de serviceprovider en de verstrekte gegevens geldig zijn.
invalidtransactionid - wanneer de door de serviceconsument geretourneerde transactie-id onbekend is bij de serviceprovider. Er wordt een foutconditie geregistreerd bij de serviceprovider, maar er wordt geen verdere verwerking uitgevoerd.
incompletedata - wanneer de serviceprovider heeft gedetecteerd dat een verplicht deel van het BulkBlockReport-object ontbreekt.
invaliddata - wanneer een deel van het BulkBlockReport-object ongeldig is.
expireddata - wanneer het bulkgegevensbestand expiryDate laat zien dat het bestand niet langer geldig is.
|
Velden voor responstekst
Geen.
Info over de requestBulkDataExchange-bewerking
De IPSIS LIS-adapter roept de RequestBulkDataExchange-bewerking aan die is geïmplementeerd door het studentinformatiesysteem. De aanroep wordt geïmplementeerd in een handler die IBulkRequestDataHandler implementeert en is geconfigureerd om te worden uitgevoerd wanneer een aanvraag ergens binnen het IPSIS-platform wordt gestart.
Processtroom: requestBulkDataExchange
Verwerk en verzend de aanvraag. Wanneer een aanvraag voor het uitwisselen van bulkgegevens wordt geïnitieerd (meestal via de beheerinterface), roept de BulkManager de geconfigureerde handler op die IBulkRequestDataHandler implementeert.
Voorbeeld van een requestBulkDataExchange-aanvraag
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ims="http://www.imsglobal.org/xsd/gws/gwsv1p0/imsepa_v1p0" xmlns:ims1="http://www.imsglobal.org/services/lis/bdems1p0/wsdl11/sync/imsbdems_v1p0">
<soapenv:Header>
<ims1:imsx_syncRequestHeaderInfo>
<ims1:imsx_version>V1.0</ims1:imsx_version>
<ims1:imsx_messageIdentifier>1234</ims1:imsx_messageIdentifier>
<ims1:imsx_sendingAgentIdentifier>LIS_TEST_SYSTEM</ims1:imsx_sendingAgentIdentifier>
</ims1:imsx_syncRequestHeaderInfo>
</soapenv:Header>
<soapenv:Body>
<ims1:requestBulkDataExchangeRequest>
<ims1:transactionId>060d01bf-8c5a-4e87-85f5-92a8aca30ef8</ims1:transactionId>
<ims1:filter>
<!--1 of meer herhalingen:-->
<ims1:filterRule>
<ims1:filterTypeVocabulary>http://www.imsglobal.org/lis/bdemsv1p0/filtertypevocabularyv1p0</ims1:filterTypeVocabulary>
<ims1:filterType>object</ims1:filterType>
<!--Optioneel:-->
<ims1:filterValueVocabulary>http://www.imsglobal.org/lis/bdemsv1p0/filtervalueobjectvocabularyv1p0</ims1:filterValueVocabulary>
<ims1:filterValue>All</ims1:filterValue>
</ims1:filterRule>
</ims1:filter>
</ims1:requestBulkDataExchangeRequest>
</soapenv:Body<
</soapenv:Envelope>
Koptekst- en tekstvelden voor requestBulkDataExchange-aanvraag
Velden van aanvraagkoptekst
Zie Aanvraag- en responskopteksten voor meer informatie.
Velden van aanvraagtekst
Eigenschap
|
Beschrijving
|
transactionId
|
De unieke id die aan deze transactie is toegewezen door de vorige aanvraag voor het uitwisselen van bulkgegevens van de serviceklant.
|
Voorbeeld van requestBulkDataExchange-respons
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ims="http://www.imsglobal.org/services/lis/bdems1p0/wsdl11/sync/imsbdems_v1p0">
<soapenv:Header>
<ims:imsx_syncResponseHeaderInfo>
<ims:imsx_version>V1.0</ims:imsx_version>
<ims:imsx_statusInfo>
<ims:imsx_codeMajor>success</ims:imsx_codeMajor>
<ims:imsx_severity>status</ims:imsx_severity>
<ims:imsx_codeMinor>
<ims:imsx_codeMinorField>
<ims:imsx_codeMinorFieldName>TargetEndSystem</ims:imsx_codeMinorFieldName>
<ims:imsx_codeMinorFieldValue>fullsuccess</ims:imsx_codeMinorFieldValue>
</ims:imsx_codeMinorField>
</ims:imsx_codeMinor>
</ims:imsx_statusInfo>
</ims:imsx_syncResponseHeaderInfo>
</soapenv:Header>
<soapenv:Body>
<ims:requestBulkDataExchangeResponse>?</ims:requestBulkDataExchangeResponse>
</soapenv:Body>
</soapenv:Envelope>
Koptekst- en tekstvelden voor requestBulkDataExchange-respons
Velden voor responskoptekst
De respons wordt gegenereerd door de serviceprovider (bijvoorbeeld Oracle) en teruggezonden naar D2L® op basis van de verzending van de aanvraag.
Koptekst
|
Terugkeren
|
Waarde
|
imsx_syncResponseHeaderInfo.imsx_version
|
De serviceprovider retourneert "V1.0" ongeacht de waarde in de aanvraagkoptekst.
|
|
imsx_syncResponseHeaderInfo.imsx_statusInfo.imsx_codeMajor
|
De serviceprovider retourneert de hoofdstatuscode zoals gedefinieerd door IMS.
|
success - wanneer de aanvraag om te negeren is ontvangen door de serviceprovider.
failure - wanneer de aanvraag om te negeren niet is ontvangen door de serviceprovider.
|
imsx_syncResponseHeaderInfo.imsx_statusInfo.imsx_severity
|
De serviceprovider retourneert de ernst, zoals gedefinieerd door IMS.
|
status
|
imsx_syncResponseHeaderInfo.imsx_statusInfo.imsx_messageRefIdentifier
|
De serviceprovider retourneert de waarde uit de imsx_syncRequestHeaderInfo.imsx_messageIdentifier.
|
|
imsx_syncResponseHeaderInfo.imsx_statusInfo.imsx_codeMinor.imsx_codeMinorField.imsx_codeMinorFieldValue
|
De serviceprovider retourneert de waarde van het veld Minor Status Code zoals gedefinieerd door IMS.
|
fullsuccess - wanneer de aanvraag is ontvangen en het doel kan voldoen aan de aanvraag.
invaliddata - wanneer de geïdentificeerde objectgegevenstypen onbekend zijn in de serviceprovider.
savepointerror - wanneer er een fout is opgetreden bij het verwerken van de informatie over de opslagpunt-id, waardoor het onmogelijk is om de juiste objecten uit de database te lezen.
savepointsyncerror - wanneer de waarde van de opslagpuntverwijzing van de bron later was dan die van het doelsysteem. Er worden geen synchronisatiegegevens beschikbaar gemaakt.
|
Velden voor responstekst
De tekst van de respons bevat een lijst met ondersteunde services. Dit kunnen onder andere zijn:
- personInterface.replacePerson
- personInterface.deletePerson
- groupInterface.replaceGroup
- groupInterface.deleteGroup
- membershipInterface.replaceMembership
- membershipInterface.deleteMembership
- templateInterface.replaceCourseTemplate
- templateInterface.deleteCourseTemplate
- offeringInterface.replaceCourseOffering
- offeringInterface.deleteCourseOffering
- sectionInterface.replaceCourseSection
- sectionInterface.deleteCourseSection
- associationInterface.replaceSectionAssocation
- associationInterface.deleteSectionAssociation