Documentation sur les intégrations

Service de gestion d'échange de données en bloc (SGEDB)

Ce service est utilisé pour lancer et produire un rapport sur le traitement d’intégration en bloc au SIS.

Opérations mises en œuvre

announceBulkDataExchangeasynchronously.
announceFailureBulkDataExchange

Opérations appelées

ignoreBulkDataExchange
cancelBulkDataExchange
reportBulkDataExchange
requestBulkDataExchange

À propos de l’opération announceBulkDataExchange

L’opération announceBulkDataExchange est appelée par un système informatique de renseignements sur les apprenants lorsqu’il souhaite commencer un processus d’intégration en bloc. Cet appel se traduit par une réaction immédiate du système pour indiquer si la requête a bien été reçue ou non et le traitement en bloc se poursuit de façon asynchrone.

Flux de traitement : announceBulkDataExchange

Lorsqu’une requête announceBulkDataExchange du LIS est reçue, D2L la traduit à l’aide des traducteurs LIS configurés pour ITranslateAnnounceBulkDataExchange qui convertissent la requête dans un format que la plateforme IPSIS comprend.
Une fois la requête traduite, les gestionnaires de la plateforme IPSIS configurés pour IBulkFileReadyRequestHandler servent à enregistrer la requête de traitement en bloc avec IPSIS.
La réponse du LIS est ensuite générée depuis le gestionnaire de réponse. La réponse comprend une liste des services pris en charge pour la mise en œuvre à l’aide du traducteur ITranslateSupportedServices configuré.
Le traitement en bloc s’effectue de façon asynchrone une fois la requête reçue et répondue. Les services de traitement global en arrière-plan d’IPSIS font passer la tâche globale par toutes les étapes suivantes : Les fichiers sont extraits par IBulkFileRetriever, ils sont traités à l’aide de IBulkFileProcessor et une réponse est générée au moyen de IBulkSendReportHandler, qui utilise reportBulkDataExchange pour aviser le SIS des résultats.

Exemple de requête announceBulkDataExchange

<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&gt;

               <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&gt;

               <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>

champs d’en-tête et de corps de requête announceBulkDataExchange

Champs de l’en-tête de la requête

Pour plus d’information, se reporter à la grille d'évaluation En-têtes de requête et de réponse.

Champs du corps de la requête

Le modèle de configuration du traducteur traite les champs suivants de la requête :

Propriété	Mise en correspondance de requête LIS	Requise
CodeTâche	request.bulkBlockManifestId	Oui
Expiry DateTime	request.expiryDate	Oui
RemoteFileUrl(s)	request.bulkBlockDataFile[*].url	Oui
FileSize(s)	request.bulkBlockDataFile[*].totalSize	Oui
CheckSum(s)	request.bulkBlockDataFile[*].checkSum	Oui
Savepoint(s)	request.bulkBlockDataFile[*].savePoint	Oui
Type d’entité(s)	request.bulkBlockDataFile[].serviceSet.serviceRecord[].interfaceName	Oui

Exemple de réponse announceBulkDataExchange

<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>

champs d’en-tête et de corps de réponse announceBulkDataExchange

Champs de l’en-tête de réponse

Pour plus d’information, se reporter à la grille d'évaluation En-têtes de requête et de réponse.

Champs du corps de réponse

Le modèle de configuration du traducteur traite les champs suivants de la requête :

Propriété	Correspondance de réponse LIS	Requise
CodeTâche	request.bulkBlockManifestId	Oui
Expiry DateTime	request.expiryDate	Oui
RemoteFileUrl(s)	request.bulkBlockDataFile[*].url	Oui
FileSize(s)	request.bulkBlockDataFile[*].totalSize	Oui
CheckSum(s)	request.bulkBlockDataFile[*].checkSum	Oui
Savepoint(s)	request.bulkBlockDataFile[*].savePoint	Oui
Type d’entité(s)	request.bulkBlockDataFile[].serviceSet.serviceRecord[].interfaceName	Oui

À propos de l’opération announceFailureBulkDataExchange

L’opération AnnounceFailureBulkDataExchange prend une requête d’échec d’annonce et la traite ce qui a pour résultat que le système source correspondant à la requête est retiré du mode bloc et le dossier correspondant dans base de données qui englobe tous les renseignements requis pour la tâche globale est réglé à l’état Annulé.

Flux de traitement : announceFailureBulkDataExchange

Lorsqu’une requête AnnounceFailureBulkDataExchange du LIS est reçue, D2L obtient l’ID de transaction de la requête et enregistre le code de défaillance au journal et sa description s’ils sont fournis. Un traducteur insérable séparé n’est pas utilisé pour cette opération.
Une fois la requête traduite, les gestionnaires de la plateforme IPSIS configurés pour IBulkFileReadyRequestHandler servent à enregistrer la requête.
La réponse du LIS est ensuite générée depuis le gestionnaire de réponse.

Exemple de requête announceFailureBulkDataExchange

<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>

champs d’en-tête et de corps de requête announceBulkDataExchange

Champs de l’en-tête de la requête

Pour plus d’information, se reporter à la grille d'évaluation En-têtes de requête et de réponse.

Champs du corps de la requête

L’adaptateur accepte les champs suivants dans la requête :

Propriété	Mise en correspondance de requête LIS	Requise
TransactionId	request.transactionId	Oui
Code d’erreur	request.FailureReportType.failureCode	Non
Description de l’erreur	request.FailureReportType.failureDescription	Non

Exemple de réponse announceFailureBulkDataExchange

<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>

            &ltimsx_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>

champs d’en-tête et de corps de réponse announceFailureBulkDataExhange

Champs de l’en-tête de réponse

Pour plus d’information, se reporter à la grille d'évaluation En-têtes de requête et de réponse.

Champs du corps de l’objet de réponse

Aucun champ n’est retourné dans le corps de la réponse.

À propos de l’opération ignoreBulkDataExchange

L’adaptateur LIS d’IPSIS appelle l’opération IgnoreBulkDataExchange qui est mise en œuvre par le SIS. L’appel est mis en œuvre dans un gestionnaire IBulkCancelRequestHandler et il est configuré pour être exécuté lorsqu’une requête d’omission est lancée quelque part dans la plateforme IPSIS.

Flux de traitement : ignoreBulkDataExchange

Lorsqu’une requête d’omission de traitement en bloc est lancée (généralement par l’interface d’administration), le BulkManager demande au gestionnaire configuré d’exécuter IBulkCancelRequestHandler. Pour les systèmes utilisant LIS, c’est le gestionnaire agréé IgnoreBulkDataExchange qui lance une requête au SIS.

Exemple de requête ignoreBulkDataExhange

<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">

<transactionId>testRequest1</transactionId>

</ignoreBulkDataExchangeRequest>

</s:Body>

</s:Envelope>

champs d’en-tête et de corps de requête ignoreBulkDataExchange

Champs de l’en-tête de la requête

Pour plus d’information, se reporter à la grille d'évaluation En-têtes de requête et de réponse.

Champs du corps de la requête

Propriété	Description
transactionId	L’identificateur unique attribué à cette transaction par la requête précédente d’échange de données en bloc du consommateur de service.

Exemple de réponse ignoreBulkDataExchange

<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>

champs d’en-tête et de corps de réponse ignoreBulkDataExchange

Champs de l’en-tête de réponse

La réponse est générée par le fournisseur de services (p. ex., Oracle) et ensuite renvoyée à D2L en fonction de l’envoi de la requête qui précède.

Champ	Retour	Value
imsx_syncResponseHeaderInfo.imsx_version	Le fournisseur de service renvoie la valeur « V1.0 », indépendamment de la valeur dans l’en-tête de requête.
imsx_syncResponseHeaderInfo.imsx_statusInfo.imsx_codeMajor	Le fournisseur de service renvoie le code d’état principal tel que défini par IMS.	success – Lorsque la requête d’omission est bien reçue par le fournisseur de services. failure – Lorsque la requête d’omission n’est pas reçue par le fournisseur de services.
imsx_syncResponseHeaderInfo.imsx_statusInfo.imsx_severity	Le fournisseur de service renvoie le code de sévérité tel que défini par IMS.	status
imsx_syncResponseHeaderInfo.imsx_statusInfo.imsx_messageRefIdentifier	Le fournisseur de services renvoie la valeur de l’imsx_syncRequestHeaderInfo.imsx_messageIdentifier
imsx_syncResponseHeaderInfo.imsx_statusInfo.imsx_codeMinor.imsx_codeMinorField.imsx_codeMinorFieldValue	Le fournisseur de service renvoie la valeur au champ du code d’état mineur tel que défini par IMS.	full success (succès total) – Lorsque la requête d’omission est bien reçue par le fournisseur de services. invalidtransactionid – Lorsque l’ID de transaction retourné par le consommateur de services est inconnu du fournisseur de service. Une situation d’erreur est journalisée chez le fournisseur de services, mais aucun autre traitement n’est entrepris.

Champs du corps de réponse

Aucun.

À propos de l’opération cancelBulkDataExhange

L’opération CancelBulkDataExchange est utilisé pour envoyer une requête d’annulation au SIS.

Flux de traitement : cancelBulkDataExchange

Générer et envoyer une requête.
En cas d’annulation d’une tâche globale, le Bulk Manager repose sur le gestionnaire configuré IBulkCancelRequestHandler.
Pour les systèmes utilisant LIS, c’est le gestionnaire agréé CancelBulkDataExchange qui lance une requête au SIS.

Exemple de requête cancelBulkDataExchange

<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>

champs d’en-tête et de corps de requête cancelBulkDataExchange

Champs de l’en-tête de la requête

Pour plus d’information, se reporter à la grille d'évaluation En-têtes de requête et de réponse.

Champs du corps de la requête

Propriété	Description
transactionId	L’identificateur unique attribué à cette transaction par la requête précédente d’échange de données en bloc du consommateur de service.

Exemple de réponse cancelBulkDataExchange

<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>

champs d’en-tête et de corps de réponse cancelBulkDataExchange

Champs de l’en-tête de réponse

La réponse est générée par le fournisseur de services (p. ex., Oracle) et renvoyée à D2L en fonction de l’envoi de la requête.

En-tête	Retour	Value
imsx_syncResponseHeaderInfo.imsx_version	Le fournisseur de service renvoie la valeur « V1.0 », indépendamment de la valeur dans l’en-tête de requête.
imsx_syncResponseHeaderInfo.imsx_statusInfo.imsx_codeMajor	Le fournisseur de service renvoie le code d’état principal tel que défini par IMS.	success – Lorsque la requête d’omission est bien reçue par le fournisseur de services. failure – Lorsque la requête d’omission n’est pas reçue par le fournisseur de services.
imsx_syncResponseHeaderInfo.imsx_statusInfo.imsx_severity	Le fournisseur de service renvoie le code de sévérité tel que défini par IMS.	status
imsx_syncResponseHeaderInfo.imsx_statusInfo.imsx_messageRefIdentifier	Le fournisseur de services renvoie la valeur de l’imsx_syncRequestHeaderInfo.imsx_messageIdentifier
imsx_syncResponseHeaderInfo.imsx_statusInfo.imsx_codeMinor.imsx_codeMinorField.imsx_codeMinorFieldValue	Le fournisseur de service renvoie la valeur au champ du code d’état mineur tel que défini par IMS.	fullsuccess (succès total) – Lorsque la requête d’omission est bien reçue par le fournisseur de services. invalidtransactionid – Lorsque l’ID de transaction retourné par le consommateur de services est inconnu du fournisseur de service. Une situation d’erreur est journalisée chez le fournisseur de services, mais aucun autre traitement n’est entrepris.

Champs du corps de réponse

Aucun.

À propos de l’opération reportBulkDataExchange

L’adaptateur LIS d’IPSIS ne prend pas en charge l’opération ReportBulkDataExchange, mais appelle plutôt cette opération sur SIS lorsqu’un échange de données en bloc est terminé.

Flux de traitement : reportBulkDataExchange

Traiter et envoyer une requête. À l’achèvement d’une tâche globale, le Bulk Manager repose sur le gestionnaire configuré IBulkSendReportHandler. Pour les systèmes utilisant LIS, c’est le gestionnaire agréé ReportBulkDataExchange qui lance une requête au SIS.

Exemple de requête reportBulkDataExchange

<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&gt;

                                                <transactionFailStatus>unknownvocabulary</transactionFailStatus>

                                        </transactionReport>

                                </transactionReportList>

                        </bulkBlockReport>

                </reportBulkDataExchangeRequest>

        </s:Body>

</s:Envelope>

champs d’en-tête et de corps de requête reportBulkDataExchange

Champs de l’en-tête de la requête

Pour plus d’information, se reporter à la grille d'évaluation En-têtes de requête et de réponse.

Champs du corps de la requête

Propriété	Description
transactionId	L’ID de transaction correspondant à la requête d’annonce transmise.
reportSummary	Fait la liste du nombre total de transactions comprises dans la requête d’annonce et l’état de chacune. Contient l’interface interfaceSummaryReports.
interfaceSummaryReport	Le conteneur de l’information sommaire au sujet du traitement des fichiers de données en bloc par le consommateur de services pour une interface de service précise.
transactionReport	Le conteneur pour les rapports sur l’état de toutes les transactions au sein du fichier de données en bloc dont le consommateur de services a échoué l’achèvement. Si aucun rapport n’est contenu, la requête announceBulkDataExchange a bien été complétée.
reportFailureDetail	Le conteneur pour l’ensemble des rapports qui décrivent les transactions qui ont entraîné la génération de codes d’état Échec.

Exemple de réponse reportBulkDataExchange

<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>

champs d’en-tête et de corps de réponse reportBulkDataExchange

La réponse est générée par le fournisseur de services (p. ex., Oracle) et renvoyée à D2L en fonction de l’envoi de la requête.

Champs de l’en-tête de réponse

En-tête	Retour	Value
imsx_syncResponseHeaderInfo.imsx_version	Le fournisseur de service renvoie la valeur « V1.0 », indépendamment de la valeur dans l’en-tête de requête.
imsx_syncResponseHeaderInfo.imsx_statusInfo.imsx_codeMajor	Le fournisseur de service renvoie le code d’état principal tel que défini par IMS.	success – Lorsque la requête d’omission est bien reçue par le fournisseur de services. failure – Lorsque la requête d’omission n’est pas reçue par le fournisseur de services.
imsx_syncResponseHeaderInfo.imsx_statusInfo.imsx_severity	Le fournisseur de service renvoie le code de sévérité tel que défini par IMS.	status
imsx_syncResponseHeaderInfo.imsx_statusInfo.imsx_messageRefIdentifier	Le fournisseur de services renvoie la valeur de l’imsx_syncRequestHeaderInfo.imsx_messageIdentifier
imsx_syncResponseHeaderInfo.imsx_statusInfo.imsx_codeMinor.imsx_codeMinorField.imsx_codeMinorFieldValue	Le fournisseur de service renvoie la valeur au champ du code d’état mineur tel que défini par IMS.	full success (succès total) – Lorsque le rapport est bien reçu par le fournisseur de services et que les données fournies sont valides. invalidtransactionid – Lorsque l’ID de transaction retourné par le consommateur de services est inconnu du fournisseur de service. Une situation d’erreur est journalisée chez le fournisseur de services, mais aucun autre traitement n’est entrepris. incompletedata – Lorsqu’un élément obligatoire de l’objet BulkBlockReport a été détecté comme manquant par le fournisseur de services. invaliddata – Lorsqu’une partie de l’objet BulkBlockReport n’est pas valide. expireddata – Lorsque le fichier de données en bloc expiryDate montre que le fichier n’est plus valide.

Champs du corps de réponse

Aucun.

À propos de l’opération requestBulkDataExchange

L’adaptateur LIS d’IPSIS appelle l’opération RequestBulkDataExchange qui est mise en œuvre par le SIS. L’appel est mis en œuvre dans un gestionnaire IBulkRequestDataHandler et il est configuré pour être exécuté lorsqu’une requête est lancée dans la plateforme IPSIS.

Flux de traitement : requestBulkDataExchange

Traiter et envoyer une requête. Lorsqu’une requête de traitement en bloc est lancée (généralement par l’interface d’administration), le BulkManager demande au gestionnaire configuré d’exécuter IBulkRequestDataHandler.

Exemple de requête requestBulkDataExchange

<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 or more repetitions:-->

            <ims1:filterRule>

               <ims1:filterTypeVocabulary>http://www.imsglobal.org/lis/bdemsv1p0/filtertypevocabularyv1p0</ims1:filterTypeVocabulary&gt;

               <ims1:filterType>object</ims1:filterType>

               <!--Optional:-->

               <ims1:filterValueVocabulary>http://www.imsglobal.org/lis/bdemsv1p0/filtervalueobjectvocabularyv1p0</ims1:filterValueVocabulary&gt;

               <ims1:filterValue>All</ims1:filterValue>

            </ims1:filterRule>

         </ims1:filter>

      </ims1:requestBulkDataExchangeRequest>

   </soapenv:Body<

</soapenv:Envelope>

champs d’en-tête et de corps de requête requestBulkDataExchange

Champs de l’en-tête de la requête

Pour plus d’information, se reporter à la grille d'évaluation En-têtes de requête et de réponse.

Champs du corps de la requête

Propriété	Description
transactionId	L’identificateur unique attribué à cette transaction par la requête précédente d’échange de données en bloc du consommateur de service.

Exemple de réponse requestBulkDataExchange

<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>

champs d’en-tête et de corps de réponse requestBulkDataExchange

Champs de l’en-tête de réponse

La réponse est générée par le fournisseur de services (p. ex., Oracle) et renvoyée à D2L en fonction de l’envoi de la requête.

En-tête	Retour	Value
imsx_syncResponseHeaderInfo.imsx_version	Le fournisseur de service renvoie la valeur « V1.0 », indépendamment de la valeur dans l’en-tête de requête.
imsx_syncResponseHeaderInfo.imsx_statusInfo.imsx_codeMajor	Le fournisseur de service renvoie le code d’état principal tel que défini par IMS.	success – Lorsque la requête d’omission est bien reçue par le fournisseur de services. failure – Lorsque la requête d’omission n’est pas reçue par le fournisseur de services.
imsx_syncResponseHeaderInfo.imsx_statusInfo.imsx_severity	Le fournisseur de service renvoie le code de sévérité tel que défini par IMS.	status
imsx_syncResponseHeaderInfo.imsx_statusInfo.imsx_messageRefIdentifier	Le fournisseur de services renvoie la valeur de l’imsx_syncRequestHeaderInfo.imsx_messageIdentifier.
imsx_syncResponseHeaderInfo.imsx_statusInfo.imsx_codeMinor.imsx_codeMinorField.imsx_codeMinorFieldValue	Le fournisseur de service renvoie la valeur au champ du code d’état mineur tel que défini par IMS.	full success (succès total) – Lorsque la requête a bien été reçue et que la cible sera en mesure de satisfaire la requête. invaliddata – Lorsque les types de données de l’objet ne sont pas connus du fournisseur de services. savepointerror – Lorsqu’une erreur s’est produite pendant le traitement de l’information d’identification du point d’enregistrement, rendant impossible de lire les objets de la base de données. savepointsyncerror – Lorsque la valeur du point d’enregistrement renvoyée par la source est ultérieure à celle du système cible. Aucune synchronisation de données ne sera disponible.

Champs du corps de réponse

Le corps de la réponse comprend une liste des services pris en charge qui peut comprendre n’importe lequel des éléments suivants :

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