Histórico da Página
Visão Geral dos processos WebSevices da Turma
O objetivo deste dataserver DataServer é possibilitar a busca, inclusão, alteração e exclusão de turmas através de webserviceWebService. Tudo o que for realizado, poderá ser visualizado no cadastro de turma no TOTVS Gestão Educacional.
Através do dataserver "EduTurmaData" e por meio dos métodos ReadRecord, SaveRecord e DeleteRecord, é possível realizar busca, inclusão, manutenção e exclusão das informações das Turmas no TOTVS Gestão Educacional.
...
Os serviços WebService identificarão a base de dados a ser utilizada através da tag DefaultDB, que informa o Alias que será utilizado no acesso. Essa tag deve existir no arquivo de configuração do Host (RM.Host.Service.exe.config ou RM.Host.exe.config):
<add key=”DefaultDB” value=”<ALIAS_DO_BANCO_RM>
A variável <ALIAS_DO_BANCO_RM> deverá ser substituída pelo nome do alias cadastrado para acesso ao banco de dados.
Exemplo:
| Bloco de código | ||
|---|---|---|
| ||
<?xml version="1.0"?>
<configuration>
<appSettings>
<add key="JobServer3Camadas" value="false" />
<add key="Port" value="12120" />
<add key="ActionsPath" value="C:\totvs\CorporeRM\RM.Net;" />
<add key="LibPath" value="C:\totvs\CorporeRM\RM.Net" />
<add key="EnableDynamicLocalization" value="false" />
<add key="EnableCompression" value="false" />
<add key="LocalizationLanguage" value="pt-BR" />
<add key="HttpPort" value="8051" />
<add key="DefaultDB" value="CorporeRM" />
</appSettings>
<runtime>
<NetFx40_LegacySecurityPolicy enabled="true" />
<generatePublisherEvidence enabled="false" />
</runtime>
<startup useLegacyV2RuntimeActivationPolicy="true">
<supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.0" />
</startup>
</configuration> |
A porta 8051 é padrão no sistema e caso seja alterada na tag HttpPort no arquivo de configuração do Host, precisa ser alterada no link acima.
| Aviso | ||
|---|---|---|
| ||
Caso o Host utilizado seja o RM.Host.Service.exe é necessário a execução do comando, abaixo, para liberação da porta configurada na tag HttpPort, via prompt de comando:
netsh http add urlacl url=http://+:8051/ user=NetworkService
netsh http delete urlacl url=http://+:8051/
netsh http show urlacl |
...
Para que o sistema carregue corretamente os parâmetros do sistema no momento de utilização do WebService, é necessário que sejam inclusas as informações do contexto: Coligada, Filial, Tipo de curso e Código do Sistema.
...
Se necessário clique aqui para obter ajuda na configuração do Host.
| Expandir | ||||
|---|---|---|---|---|
| ||||
|
Método ReadRecord
Este método realiza a consulta de uma turma. Algumas informações são obrigatórias e devem ser informadas: o código da coligada, o código da filial, o id do período letivo, o código da turma.
O sistema irá realizar a consulta de uma turma caso as informações passadas estejam de acordo com alguma turma já existente no sistema.
Consulta da turma
Para realizar a consulta de uma turma, deve ser utilizado a operação de ReadRecord.
...
Caso a chave informada não retorne registro, o resultado será o nome do datasetDataSet. Caso contrário, a mesma terá suas informações exibidas através de um XML.
...
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
| ||||||
<tot:ReadRecord>
<!--Optional:-->
<tot:DataServerName>EduTurmaData</tot:DataServerName>
<!--Optional:-->
<tot:PrimaryKey>1;1;98;Turma B</tot:PrimaryKey>
<!--Optional:-->
<tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=3;CODSISTEMA=S;</tot:Contexto>
</tot:ReadRecord> |
...
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
| ||||||
<ReadRecordResult><EduTurma /></ReadRecordResult> |
Método SaveRecord
Este método realiza a inclusão ou alteração de uma turma. Algumas informações são obrigatórias e devem ser informadas: o código da coligada, o código da filial, o id do período letivo, o código da turma, além dos outros campos que estão configurados como obrigatórios no sistema.
...
Observação: Caso sejam passadas para o dataserver informações para campos complementares, devem ser utilizados os mesmos códigos obrigatórios para que o sistema consiga entender que se referem à turma que se deseja alterar.
Inclusão da turma
Para realizar inclusão de uma turma, deve ser utilizado a operação de SaveRecord.
...
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
| ||||||
<tot:SaveRecord>
<!--Optional:-->
<tot:DataServerName>EduTurmaData</tot:DataServerName>
<!--Optional:-->
<tot:XML><![CDATA[<EduTurma>
<STurma>
<CODCOLIGADA>1</CODCOLIGADA>
<CODFILIAL>1</CODFILIAL>
<IDPERLET>98</IDPERLET>
<CODTURMA>Turma B</CODTURMA>
<IDHABILITACAOFILIAL>403</IDHABILITACAOFILIAL>
<NOMERED>ADS-A</NOMERED>
<NOME>Análise e Desenvolvimento de Sofware - Turma A</NOME>
<MAXALUNOS>100</MAXALUNOS>
<DTINICIAL>2018-01-01T00:00:00</DTINICIAL>
<DTFINAL>2018-12-31T00:00:00</DTFINAL>
<CODTIPOCURSO>3</CODTIPOCURSO>
<CODCURSO>ADS</CODCURSO>
<CODHABILITACAO>1</CODHABILITACAO>
<CODGRADE>1</CODGRADE>
<CODPERLET>2018/01</CODPERLET>
<DTINICIOPLETIVO>2017-01-01T00:00:00</DTINICIOPLETIVO>
<NOMECURSO>Análise e Desenvolvimento de Software</NOMECURSO>
<NOMEHABILITACAO>Bacharelado</NOMEHABILITACAO>
<DESCGRADE>Tecnologia da Informação</DESCGRADE>
<TURNO>Matutino</TURNO>
<CONTROLEVAGAS>0</CONTROLEVAGAS>
</STurma>
<STURMACOMPL>
<CODCOLIGADA>1</CODCOLIGADA>
<CODFILIAL>1</CODFILIAL>
<IDPERLET>98</IDPERLET>
<CODTURMA>Turma B</CODTURMA>
</STURMACOMPL>
</EduTurma>]]></tot:XML>
<!--Optional:-->
<tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=3;CODSISTEMA=S;</tot:Contexto>
</tot:SaveRecord>
|
...
| Informações |
|---|
Caso a inclusão seja realizada com sucesso, será mostrado o código da coligada, o código da filial, o id do período letivo e o código da turma inserido no item SaveRecordResult. |
Alteração de Turmas
Para realizar alteração de uma turma, deve ser utilizado a operação de SaveRecord.
...
| Informações |
|---|
Caso a alteração seja realizada com sucesso, será mostrado o código da coligada e o código do professor no item SaveRecordResult. |
Método DeleteRecord
Este método realiza a exclusão de uma turma. Algumas informações são obrigatórias e devem ser informadas: o código da coligada, o código da filial, o id do período letivo, o código da turma, além dos outros campos que estão configurados como obrigatórios no sistema.
O sistema irá realizar a exclusão de uma turma caso encontre o registro.
Exclusão da turma
Para realizar exclusão de uma turma, deve ser utilizado a operação de DeleteRecord.
...
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
| ||||||
<tot:DeleteRecord>
<!--Optional:-->
<tot:DataServerName>EduTurmaData</tot:DataServerName>
<!--Optional:-->
<tot:XML><![CDATA[<EduTurma>
<STurma>
<CODCOLIGADA>1</CODCOLIGADA>
<CODFILIAL>1</CODFILIAL>
<IDPERLET>98</IDPERLET>
<CODTURMA>Turma B</CODTURMA>
<IDHABILITACAOFILIAL>403</IDHABILITACAOFILIAL>
<NOMERED>ADS-A</NOMERED>
<NOME>Análise e Desenvolvimento de Sofware - Turma A</NOME>
<MAXALUNOS>100</MAXALUNOS>
<DTINICIAL>2018-01-01T00:00:00</DTINICIAL>
<DTFINAL>2018-12-31T00:00:00</DTFINAL>
<CODTIPOCURSO>3</CODTIPOCURSO>
<CODCURSO>ADS</CODCURSO>
<CODHABILITACAO>1</CODHABILITACAO>
<CODGRADE>1</CODGRADE>
<CODPERLET>2018/01</CODPERLET>
<DTINICIOPLETIVO>2017-01-01T00:00:00</DTINICIOPLETIVO>
<NOMECURSO>Análise e Desenvolvimento de Software</NOMECURSO>
<NOMEHABILITACAO>Bacharelado</NOMEHABILITACAO>
<DESCGRADE>Tecnologia da Informação</DESCGRADE>
<TURNO>Matutino</TURNO>
<CONTROLEVAGAS>0</CONTROLEVAGAS>
</STurma>
<STURMACOMPL>
<CODCOLIGADA>1</CODCOLIGADA>
<CODFILIAL>1</CODFILIAL>
<IDPERLET>98</IDPERLET>
<CODTURMA>Turma B</CODTURMA>
</STURMACOMPL>
</EduTurma>]]></tot:XML>
<!--Optional:-->
<tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=3;CODSISTEMA=S;</tot:Contexto>
</tot:DeleteRecord>
|
...
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas