Documentação de integrações

Serviço de gestão de troca de dados em lote (BDES)

Esse serviço é usado para iniciar e relatar o processamento da Integração do SIS em lote.

Operações implementadas

announceBulkDataExchangeasynchronously.
announceFailureBulkDataExchange

Operações chamadas

ignoreBulkDataExchange
cancelBulkDataExchange
reportBulkDataExchange
requestBulkDataExchange

Sobre a operação announceBulkDataExchange

A operação announceBulkDataExchange é chamada por um Sistema de informações do aluno quando ele deseja iniciar um processo de integração em lote. Essa chamada resulta em uma resposta imediata do sistema para indicar se a solicitação foi recebida com sucesso ou não, e o processamento em lote continua de forma assíncrona.

Fluxo do processo: announceBulkDataExchange

Quando uma solicitação do LIS announceBulkDataExchange é recebida, a D2L traduz a solicitação usando os tradutores do LIS configurados para ITranslateAnnounceBulkDataExchange, para transformar a solicitação em um formato que a Plataforma IPSIS possa entender.
Uma vez que a solicitação foi traduzida, os manipuladores de plataforma IPSIS configurados para IBulkFileReadyRequestHandler são usados para registrar a solicitação em lote no IPSIS.
A resposta do LIS é então gerada a partir da resposta do manipulador. A resposta inclui uma lista dos serviços suportados da implementação usando o tradutor ITranslateSupportedServices configurado.
O Processamento em lote ocorre de forma assíncrona após a solicitação de anúncio ter sido recebida e respondida. Os Serviços em segundo plano de trabalho em lote do IPSIS move o trabalho em lote pelas seguintes etapas: os arquivos são recuperados usando IBulkFileRetriever, os arquivos são processados usando IBulkFileProcessor e uma resposta é gerada usando IBulkSendReportHandler, que usa reportBulkDataExchange para notificar o SIS dos resultados.

Amostra da solicitação 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>

Campos de cabeçalho e corpo da solicitação announceBulkDataExchange

Campos de cabeçalho da solicitação

Para obter mais informações, consulte Cabeçalhos de solicitação e resposta.

Campos de corpo da solicitação

A Configuração do tradutor do modelo processa os seguintes campos na solicitação:

Propriedade	Mapeamento da solicitação do LIS	Obrigatório
JobId	request.bulkBlockManifestId	Sim
Expiry DateTime	request.expiryDate	Sim
RemoteFileUrl(s)	request.bulkBlockDataFile[*].url	Sim
FileSize(s)	request.bulkBlockDataFile[*].totalSize	Sim
CheckSum(s)	request.bulkBlockDataFile[*].checkSum	Sim
Savepoint(s)	request.bulkBlockDataFile[*].savePoint	Sim
Tipo(s) de entidade	request.bulkBlockDataFile[].serviceSet.serviceRecord[].interfaceName	Sim

Amostra da resposta annouceBulkDataExchange

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

Campos de cabeçalho e corpo da resposta announceBulkDataExchange

Campos de cabeçalho da resposta

Para obter mais informações, consulte Cabeçalhos de solicitação e resposta.

Campos de corpo da resposta

A Configuração do tradutor do modelo processa os seguintes campos na solicitação:

Propriedade	Mapeamento de resposta do LIS	Obrigatório
JobId	request.bulkBlockManifestId	Sim
Expiry DateTime	request.expiryDate	Sim
RemoteFileUrl(s)	request.bulkBlockDataFile[*].url	Sim
FileSize(s)	request.bulkBlockDataFile[*].totalSize	Sim
CheckSum(s)	request.bulkBlockDataFile[*].checkSum	Sim
Savepoint(s)	request.bulkBlockDataFile[*].savePoint	Sim
Tipo(s) de entidade	request.bulkBlockDataFile[].serviceSet.serviceRecord[].interfaceName	Sim

Sobre a operação announceFailureBulkDataExchange

A operação AnnounceFailureBulkDataExchange processa uma solicitação de falha de anúncio, com o resultado final sendo que o sistema de origem correspondente à solicitação é retirado do modo em lote e o registro correspondente no banco de dados que encapsula todas as informações necessárias para o trabalho em lote tem seu status Cancelado.

Fluxo do processo: announceFailureBulkDataExchange

Quando uma solicitação do LIS AnnounceFailureBulkDataExchange é recebida, a D2L obtém o transactionId da solicitação e registra o código de falha e descrição se eles forem fornecidos. Um tradutor plugável separado não é utilizado para essa operação.
Uma vez que a solicitação for traduzida, os manipuladores de plataforma IPSIS configurados para IBulkAnnounceFailureRequestHandler são usados para processar a solicitação.
A resposta do LIS é gerada a partir da resposta do manipulador.

Amostra da solicitação 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>

Campos de cabeçalho e corpo da solicitação announceFailureBulkDataExhange

Campos de cabeçalho da solicitação

Para obter mais informações, consulte Cabeçalhos de solicitação e resposta.

Campos de corpo da solicitação

O adaptador aceita os seguintes campos na solicitação:

Propriedade	Mapeamento da solicitação do LIS	Obrigatório
TransactionId	request.transactionId	Sim
Failure Code	request.FailureReportType.failureCode	Não
Failure Description	request.FailureReportType.failureDescription	Não

Amostra da resposta 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>

Campos de cabeçalho e corpo da resposta announceFailureBulkDataExchange

Campos de cabeçalho da resposta

Para obter mais informações, consulte Cabeçalhos de solicitação e resposta.

Campos de corpo do objeto de resposta

Nenhum campo é retornado no corpo da resposta.

Sobre a operação ignoreBulkDataExchange

O adaptador do IPSIS LIS chama a operação IgnoreBulkDataExchange implementada pelo SIS. A chamada é implementada dentro de um manipulador que implementa IBulkCancelRequestHandler e está configurado para ser executado quando uma solicitação Ignore for iniciada em algum lugar dentro da plataforma IPSIS.

Fluxo do processo: ignoreBulkDataExchange

Quando uma solicitação ignore bulk é iniciada (normalmente na interface de administração), o BulkManager chama o manipulador configurado, implementando IBulkCancelRequestHandler. Para os sistemas que usam o LIS, o manipulador registrado inicia uma solicitação IgnoreBulkDataExchange para o SIS.

Solicitação ignoreBulkDataExhange de amostra

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

Campos de cabeçalho e corpo da solicitação ignoreBulkDataExchange

Campos de cabeçalho da solicitação

Para obter mais informações, consulte Cabeçalhos de solicitação e resposta.

Campos de corpo da solicitação

Propriedade	Descrição
transactionId	O identificador exclusivo atribuído a essa transação pela solicitação anterior de troca de dados em lote do consumidor do serviço.

Amostra da resposta 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>

Campos de cabeçalho e corpo da resposta ignoreBulkDataExchange

Campos de cabeçalho da resposta

A resposta é gerada pelo provedor de serviços (por exemplo, Oracle) e retornada para a D2L com base no nosso envio da solicitação acima.

Campo	Retornar	Valor
imsx_syncResponseHeaderInfo.imsx_version	O provedor de serviços retorna "V1.0" independentemente do valor no cabeçalho da solicitação.
imsx_syncResponseHeaderInfo.imsx_statusInfo.imsx_codeMajor	O provedor de serviços retorna o Código de status principal definido pelo IMS.	sucesso - Quando a solicitação ignore é recebida com sucesso no provedor de serviços. falha - Quando a solicitação ignore não é recebida no provedor de serviços.
imsx_syncResponseHeaderInfo.imsx_statusInfo.imsx_severity	O provedor de serviços retorna a gravidade definida pelo IMS.	status
imsx_syncResponseHeaderInfo.imsx_statusInfo.imsx_messageRefIdentifier	O provedor de serviços retorna o valor de imsx_syncRequestHeaderInfo.imsx_messageIdentifier
imsx_syncResponseHeaderInfo.imsx_statusInfo.imsx_codeMinor.imsx_codeMinorField.imsx_codeMinorFieldValue	O provedor de serviços retorna o Valor do campo do código de status secundário definido pelo IMS.	sucesso total - Quando a solicitação ignore foi recebida com sucesso no provedor de serviços. invalidtransactionid - Quando o transactionId retornado pelo consumidor do serviço é desconhecido no provedor de serviços. Uma condição de erro é registrada no provedor de serviços, mas nenhum processamento adicional é realizado.

Campos de corpo da resposta

Nenhum.

Sobre a operação cancelBulkDataExhange

A operação CancelBulkDataExchange é usado para enviar uma solicitação de cancelamento para o SIS.

Fluxo do processo: cancelBulkDataExchange

Gerar e enviar uma solicitação.
Após o cancelamento de um trabalho em lote, o Bulk Manager depende do IBulkCancelRequestHandler configurado.
Para os sistemas que usam o LIS, o manipulador registrado inicia uma solicitação CancelBulkDataExchange para o SIS.

Amostra da solicitação 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>

Campos de cabeçalho e corpo da solicitação cancelBulkDataExchange

Campos de cabeçalho da solicitação

Para obter mais informações, consulte Cabeçalhos de solicitação e resposta.

Campos de corpo da solicitação

Propriedade	Descrição
transactionId	O identificador exclusivo atribuído a essa transação pela solicitação anterior de troca de dados em lote do consumidor do serviço.

Amostra da resposta 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>

Campos de cabeçalho e corpo da resposta cancelBulkDataExchange

Campos de cabeçalho da resposta

A resposta é gerada pelo provedor de serviços (por exemplo, Oracle) e retornada para a D2L com base no nosso envio da solicitação.

Cabeçalho	Retornar	Valor
imsx_syncResponseHeaderInfo.imsx_version	O provedor de serviços retorna "V1.0" independentemente do valor no cabeçalho da solicitação.
imsx_syncResponseHeaderInfo.imsx_statusInfo.imsx_codeMajor	O provedor de serviços retornará o Código de status principal definido pelo IMS.	sucesso - Quando a solicitação ignore é recebida com sucesso no provedor de serviços. falha - Quando a solicitação ignore não é recebida no provedor de serviços.
imsx_syncResponseHeaderInfo.imsx_statusInfo.imsx_severity	O provedor de serviços retorna a gravidade definida pelo IMS.	status
imsx_syncResponseHeaderInfo.imsx_statusInfo.imsx_messageRefIdentifier	O provedor de serviços retorna o valor de imsx_syncRequestHeaderInfo.imsx_messageIdentifier
imsx_syncResponseHeaderInfo.imsx_statusInfo.imsx_codeMinor.imsx_codeMinorField.imsx_codeMinorFieldValue	O provedor de serviços retorna o Valor do campo do código de status secundário definido pelo IMS.	fullsuccess - Quando a solicitação ignore é recebida com sucesso no provedor de serviços. invalidtransactionid - Quando o transactionId retornado pelo consumidor do serviço é desconhecido no provedor de serviços. Uma condição de erro é registrada no provedor de serviços, mas nenhum processamento adicional é realizado.

Campos de corpo da resposta

Nenhum.

Sobre a operação reportBulkDataExchange

O adaptador do IPSIS LIS não suporta a operação ReportBulkDataExchange, mas chama essa operação no lado do SIS quando um processo de Troca de dados em lote foi concluído.

Fluxo do processo: reportBulkDataExchange

Processar e enviar solicitação. Após a conclusão de um trabalho em lote, o Bulk Manager depende dos manipuladores IBulkSendReportHandler configurados. Para os sistemas que usam o LIS, o manipulador registrado inicia uma solicitação ReportBulkDataExchange para o SIS.

Amostra da solicitação 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>

Campos de cabeçalho e corpo da solicitação reportBulkDataExchange

Campos de cabeçalho da solicitação

Para obter mais informações, consulte Cabeçalhos de solicitação e resposta.

Campos de corpo da solicitação

Propriedade	Descrição
transactionId	O transactionId correspondente à solicitação de anúncio que foi enviada.
reportSummary	Lista o número total de transações incluídas na solicitação de anúncio e o status de cada uma. Contém o interfaceSummaryReports.
interfaceSummaryReport	O recipiente para as informações de resumo sobre o processamento dos arquivos de dados em lote pelo consumidor de serviços para uma interface de serviço específica.
transactionReport	O recipiente para os relatórios de status de todas as transações dentro do arquivo de dados em lote que foram concluídas sem sucesso pelo consumidor do serviço. Se nenhum relatório estiver contido, a solicitação announceBulkDataExchange foi concluída com sucesso.
reportFailureDetail	O recipiente do conjunto de relatórios que descrevem as transações que resultaram na geração de códigos de status de falha.

Amostra da resposta 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>

Campos de cabeçalho e corpo da resposta reportBulkDataExchange

A resposta é gerada pelo provedor de serviços (por exemplo, Oracle) e retornada para a D2L com base no nosso envio da solicitação.

Campos de cabeçalho da resposta

Cabeçalho	Retornar	Valor
imsx_syncResponseHeaderInfo.imsx_version	O provedor de serviços retorna "V1.0" independentemente do valor no cabeçalho da solicitação.
imsx_syncResponseHeaderInfo.imsx_statusInfo.imsx_codeMajor	O provedor de serviços retorna o Código de status principal definido pelo IMS.	sucesso - Quando a solicitação ignore é recebida com sucesso no provedor de serviços. falha - Quando a solicitação ignore não é recebida no provedor de serviços.
imsx_syncResponseHeaderInfo.imsx_statusInfo.imsx_severity	O provedor de serviços retorna a gravidade definida pelo IMS.	status
imsx_syncResponseHeaderInfo.imsx_statusInfo.imsx_messageRefIdentifier	O provedor de serviços retorna o valor de imsx_syncRequestHeaderInfo.imsx_messageIdentifier
imsx_syncResponseHeaderInfo.imsx_statusInfo.imsx_codeMinor.imsx_codeMinorField.imsx_codeMinorFieldValue	O provedor de serviços retorna o Valor do campo do código de status secundário definido pelo IMS.	fullsuccess - Quando o relatório é recebido com sucesso no provedor de serviços e os dados fornecidos são válidos. invalidtransactionid - Quando o transactionId retornado pelo consumidor do serviço é desconhecido no provedor de serviços. Uma condição de erro é registrada no provedor de serviços, mas nenhum processamento adicional é realizado. incompletedata - Quando uma parte obrigatória do objeto BulkBlockReport foi detectada como ausente pelo provedor de serviços. invaliddata - Quando uma parte do objeto BulkBlockReport é inválida. expireddata - Quando o arquivo de dados em lote expiryDate mostra que a validade do arquivo expirou.

Campos de corpo da resposta

Nenhum.

Sobre a operação requestBulkDataExchange

O adaptador do IPSIS LIS chama a operação RequestBulkDataExchange implementada pelo SIS. A chamada é implementada dentro de um manipulador que implementa IBulkRequestDataHandler e está configurado para ser executado quando uma solicitação for iniciada em algum lugar dentro da plataforma IPSIS.

Fluxo do processo: requestBulkDataExchange

Processar e enviar solicitação. Quando uma solicitação request bulk data exchange é iniciada (normalmente na Interface de administração), o BulkManager chama o manipulador configurado, implementando IBulkRequestDataHandler.

Amostra da solicitação 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>

Campos de cabeçalho e corpo da solicitação requestBulkDataExchange

Campos de cabeçalho da solicitação

Para obter mais informações, consulte Cabeçalhos de solicitação e resposta.

Campos de corpo da solicitação

Propriedade	Descrição
transactionId	O identificador exclusivo atribuído a essa transação pela solicitação anterior de troca de dados em lote do consumidor do serviço.

Amostra da resposta 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>

Campos de cabeçalho e corpo da resposta requestBulkDataExchange

Campos de cabeçalho da resposta

A resposta é gerada pelo provedor de serviços (por exemplo, Oracle) e retornada para a D2L com base no nosso envio da solicitação.

Cabeçalho	Retornar	Valor
imsx_syncResponseHeaderInfo.imsx_version	O provedor de serviços retorna "V1.0" independentemente do valor no cabeçalho da solicitação.
imsx_syncResponseHeaderInfo.imsx_statusInfo.imsx_codeMajor	O provedor de serviços retorna o Código de status principal definido pelo IMS.	sucesso - Quando a solicitação ignore é recebida com sucesso no provedor de serviços. falha - Quando a solicitação ignore não é recebida no provedor de serviços.
imsx_syncResponseHeaderInfo.imsx_statusInfo.imsx_severity	O provedor de serviços retornará a gravidade definida pelo IMS.	status
imsx_syncResponseHeaderInfo.imsx_statusInfo.imsx_messageRefIdentifier	O provedor de serviços retorna o valor de imsx_syncRequestHeaderInfo.imsx_messageIdentifier.
imsx_syncResponseHeaderInfo.imsx_statusInfo.imsx_codeMinor.imsx_codeMinorField.imsx_codeMinorFieldValue	O provedor de serviços retorna o Valor do campo do código de status secundário definido pelo IMS.	fullsuccess - Quando a solicitação foi recebida com sucesso e o destino será capaz de cumprir a solicitação. invaliddata - Quando os tipos de dados do objeto identificado forem desconhecidos no provedor de serviços. savepointerror - Quando ocorreu um erro no processamento das informações do identificador de ponto de salvamento, impossibilitando a leitura dos objetos corretos do banco de dados. savepointsyncerror - Quando o valor da referência do ponto de salvamento da origem foi posterior ao do sistema de destino. Não serão disponibilizados dados de sincronização.

Campos de corpo da resposta

O corpo da resposta inclui uma lista dos serviços suportados, que podem incluir qualquer um dos seguintes:

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