MANUAL DOS RECURSOS DE INTEGRAÇÃO

Transcrição

MANUAL DOS
RECURSOS
DE INTEGRAÇÃO
Publicação: Janeiro / 2014
Versão Oficial: 8.00.00
Revisão: 00
Cópia Oficial
Manual de recursos de Integração - Todos os direitos reservados à Constat
Uso autorizado mediante licenciamento do Qualitor
Sumário
NOTAS SOBRE A VERSÃO DO MANUAL .................................................................. 11
REVISÃO DO MANUAL ............................................................................................... 12
CAPÍTULO 1 - VISÃO GERAL ...................................................................................... 14
1.1 OBJETIVOS .................................................................................................................................. 14
1.2 CONCEITO ................................................................................................................................... 14
1.3 RECURSOS DE INTEGRAÇÃO .................................................................................................... 15
1.3.1 Passivo ............................................................................................................................... 16
1.3.2 Ativo .................................................................................................................................... 17
CAPÍTULO 2 - WEBSERVICES ................................................................................... 18
2.1 DEFINIÇÃO .................................................................................................................................. 18
2.1.1 WSDL ................................................................................................................................. 19
2.2 WEBSERVICES NO QUALITOR .................................................................................................. 20
2.3 ARQUIVOS WSDL ........................................................................................................................ 21
2.3.1 Webservices disponíveis no Qualitor .................................................................................... 22
2.3.1.1 WebService Inventory ................................................................................................
2.3.1.2 WebService Tasks ....................................................................................................
2.3.1.3 WebService Meetings ................................................................................................
2.3.1.4 WebService Tickets ..................................................................................................
2.3.1.5 WebService General ..................................................................................................
22
22
22
23
23
2.4 CONFIGURAR UMA CONTA DE USUÁRIO ................................................................................... 23
2.5 PROGRAMAR O ACESSO AO WSDL: ......................................................................................... 24
CAPÍTULO 3 - AUTENTICAÇÃO LEGADA .................................................................. 31
3.1 VISÃO GERAL ............................................................................................................................. 31
Versão do Qualitor: 8.00.00
Revisão do Manual: 00
Cópia Oficial
página: 2 de 359
Manual de Recursos de Integração - Todos os direitos reservados à Constat
3.2 UTILIZAÇÃO DO RECURSO ......................................................................................................... 34
3.2.1 Pontos de autenticação: ...................................................................................................... 34
3.2.1.1 Autenticação Legada para Web Atendente: ............................................................... 35
3.2.1.2 Autenticação Legada para Web Solicitante: ............................................................... 37
3.2.1.3 Exemplo ..................................................................................................................... 39
CAPÍTULO 4 - GATEWAYS .......................................................................................... 42
4.1 EXEMPLOS DE USO ................................................................................................................... 42
4.2 APLICAÇÕES PRÁTICAS ............................................................................................................. 43
4.3 GATEWAY NO QUALITOR ........................................................................................................... 44
4.3.1 Momentos de Execução ...................................................................................................... 45
4.3.2 Utilização dos momentos de execução ............................................................................... 46
CAPÍTULO 5 - GATILHOS PERSONALIZADOS .......................................................... 53
5.1 VISÃO GERAL ............................................................................................................................. 53
5.2 O USO DE GATILHOS PERSONALIZADOS ................................................................................. 54
5.2.1 Get e Post ........................................................................................................................... 56
5.2.1.1 Get ............................................................................................................................ 57
5.2.1.2 Post ........................................................................................................................... 59
5.2.2 Publicando e habilitando gatilhos personalizados ................................................................ 60
CAPÍTULO 6 - WEBSERVICES ................................................................................... 65
6.1 AUTENTICAÇÃO DE USUÁRIO .................................................................................................... 65
6.1.1 Entrada de Dados ................................................................................................................ 66
6.1.2 Saída de Dados ................................................................................................................... 67
6.2 GERAÇÃO DE LOG PARA OS WEBSERVICES .......................................................................... 68
6.2.A Webservices disponíveis no Qualitor ................................................................................... 69
6.2.1 Webservice Task ................................................................................................................. 70
6.2.1.1 Operação Add Task ...................................................................................................
6.2.1.2 Operação Delete Task ...............................................................................................
6.2.1.3 Operação Get Task ....................................................................................................
6.2.1.4 Operação Get Task History ........................................................................................
6.2.1.5 Operação Get Task Attachments ...............................................................................
6.2.1.6 Operação Add Task Responsable ..............................................................................
6.2.1.7 Operação Add Task Attachments ..............................................................................
6.2.1.8 Operação Add Task History .......................................................................................
Cópia Oficial
70
72
74
76
78
79
81
82
página: 3 de 359
6.2.1.9 Operação Extend Task .............................................................................................. 83
6.2.1.10 Operação Cancel Task ............................................................................................. 85
6.2.1.11 Operação Start Task ................................................................................................ 86
6.2.2 Webservice Ticket ............................................................................................................... 88
6.2.2.1 Operação addTicketByData ....................................................................................... 88
6.2.2.2 Operação startTicket ................................................................................................. 91
6.2.2.3 Operação addTicketByTemplate ................................................................................ 93
6.2.2.4 Operação sendTicketVerification ............................................................................... 94
6.2.2.5 Operação closeTicket ................................................................................................ 96
6.2.2.6 Operação extendTicket .............................................................................................. 97
6.2.2.7 Operação sendTicketThirdPartner .............................................................................. 98
6.2.2.8 Operação receiveTicketThirdPartner ......................................................................... 100
6.2.2.9 Operação openSubTicket ......................................................................................... 101
6.2.2.10 Operação suspendTicket ........................................................................................ 103
6.2.2.11 Operação captureTicket .......................................................................................... 104
6.2.2.12 Operação addTicketHistory ..................................................................................... 106
6.2.2.13 Operação transferTicketResponsible ...................................................................... 107
6.2.2.14 Operação transferTicketTeam ................................................................................. 109
6.2.2.15 Operação generateTicketExpense .......................................................................... 110
6.2.2.16 Operação addTicketExpenseItem ........................................................................... 112
6.2.2.17 Operação deleteTicketExpenseItem ....................................................................... 114
6.2.2.18 Operação highLightTicket ....................................................................................... 115
6.2.2.19 Operação changeTicketSeverity .............................................................................. 117
6.2.2.20 Operação changeTicketCategory ............................................................................ 118
6.2.2.21 Operação changeTicketOpeningData ...................................................................... 119
6.2.2.22 Operação getTicketTemplate .................................................................................. 120
6.2.2.23 Operação getTicketTemplateData ........................................................................... 122
6.2.2.24 Operação addTicketComponent .............................................................................. 125
6.2.2.25 Operação addTicketSoftware .................................................................................. 126
6.2.2.26 Operação addTicketAdditionalContact .................................................................... 128
6.2.2.27 Operação getTicketHistoryData .............................................................................. 129
6.2.2.28 Operação changeTicketAdditionalInfo ..................................................................... 131
6.2.2.29 Operação approveTicket ......................................................................................... 132
6.2.2.30 Operação cancelTicket ........................................................................................... 134
6.2.2.31 Operação updateTicketCause ................................................................................. 135
6.2.2.32 Operação addAttachment ........................................................................................ 136
6.2.2.33 Operação getTicket ................................................................................................ 138
6.2.2.34 Operação getTicketData ......................................................................................... 140
6.2.2.35 Operação addTicketImpactedService ...................................................................... 142
6.2.2.36 Operação addTicketRequestedService ................................................................... 144
6.2.2.37 Operação getAttachment ........................................................................................ 145
6.2.2.38 Operação getAttachmentList ................................................................................... 147
6.2.2.39 Operação getTicketTag ........................................................................................... 148
6.2.2.40 Operação getTicketTag ........................................................................................... 149
6.2.2.41 Operação escalateNextTeam .................................................................................. 151
6.2.2.42 Operação setTicketPlanningData ............................................................................ 152
6.2.2.43 Operação getTicketStep ......................................................................................... 153
6.2.2.44 Operação getTicketNextSteps ................................................................................ 154
6.2.2.45 Operação setTicketStep ......................................................................................... 157
6.2.3 Webservice Product ........................................................................................................... 158
6.2.3.1 Operação addProduct e updateProduct ..................................................................... 158
6.2.3.2 Operação deleteProduct ............................................................................................ 160
6.2.3.3 Operação getProduct ................................................................................................ 161
6.2.3.4 Operação getProductData ......................................................................................... 163
6.2.4 WebService TypeOfRegister ............................................................................................... 165
Cópia Oficial
página: 4 de 359
6.2.4.1 Operação addTypeOfRegister e updateTypeOfRegister ............................................. 165
6.2.4.2 Operação deleteTypeOfRegister ................................................................................ 166
6.2.4.3 Operação getTypeOfRegister .................................................................................... 168
6.2.4.4 Operação getTypeOfRegisterData ............................................................................. 169
6.2.5 WebService Ic .................................................................................................................... 170
6.2.5.1 Operação addIc e updateIc ....................................................................................... 171
6.2.5.2 Operação deleteIc ..................................................................................................... 172
6.2.5.3 Operação getIc ......................................................................................................... 174
6.2.5.4 Operação getIcData .................................................................................................. 175
6.2.5.5 Operação addAttribute e updateAttribute .................................................................. 177
6.2.5.6 Operação deleteAttribute .......................................................................................... 179
6.2.5.7 Operação getAttribute ............................................................................................... 180
6.2.5.8 Operação getAttributeData ........................................................................................ 182
6.2.6 WebService Inventory ......................................................................................................... 183
6.2.6.1 Operação addComponent e updateComponent .......................................................... 183
6.2.6.2 Operação deleteComponent ...................................................................................... 185
6.2.6.3 Operação getComponent .......................................................................................... 187
6.2.6.4 Operação getComponentData ................................................................................... 188
6.2.6.5 Operação addComponentSupplier ............................................................................. 189
6.2.6.6 Operação addSoftware e updateSoftware .................................................................. 191
6.2.6.7 Operação deleteSoftware .......................................................................................... 192
6.2.6.8 Operação getSoftware ............................................................................................... 194
6.2.6.9 Operação getSoftwareData ........................................................................................ 195
6.2.6.10 Operação addEquipment e updateEquipment .......................................................... 197
6.2.6.11 Operação deleteEquipment ..................................................................................... 198
6.2.6.12 Operação getEquipment .......................................................................................... 200
6.2.6.13 Operação getEquipmentData .................................................................................. 201
6.2.7 WebService KnowledgeBase .............................................................................................. 204
6.2.7.1 Operação getKBDocuments ...................................................................................... 204
6.2.7.2 Operação getKBDocumentsData .............................................................................. 205
6.2.8 WebService Cause ............................................................................................................. 208
6.2.8.1 Operação addCause e updateCause ......................................................................... 208
6.2.8.2 Operação deleteCause .............................................................................................. 209
6.2.8.3 Operação getCause .................................................................................................. 211
6.2.8.4 Operação getCauseData ........................................................................................... 212
6.2.9 WebService Charts ............................................................................................................. 213
6.2.9.1 Operação getCharts .................................................................................................. 214
6.2.9.2 Operação getChartsData ........................................................................................... 215
6.2.10 WebService Chat .............................................................................................................. 217
6.2.10.1Operação getChannelStatus ..................................................................................... 218
6.2.10.1.1 VISITANTE ......................................................................................................... 218
6.2.10.1.2 CLIENTE ........................................................................................................... 219
6.2.11 WebService General ......................................................................................................... 221
6.2.11.1 Operação addCustomer e UpdateCustomer ............................................................. 221
6.2.11.2 Operação addCustomerContact e updateCustomerContact ..................................... 224
6.2.11.3 Operação getCustomer ............................................................................................ 227
Cópia Oficial
página: 5 de 359
6.2.11.4 Operação getCustomerData .................................................................................... 229
6.2.11.5 Operação getCustomerContact ................................................................................ 232
6.2.11.6 Operação getCustomerContactData ........................................................................ 233
6.2.11.7 Operação addCity e updateCity ................................................................................ 237
6.2.11.8 Operação deleteCity ................................................................................................ 238
6.2.11.9 Operação getCity ..................................................................................................... 239
6.2.11.10 Operação getCityData ............................................................................................ 241
6.2.11.11 Operação addState e updateState ......................................................................... 242
6.2.11.12 Operação deleteState ............................................................................................ 243
6.2.11.13 Operação getState ................................................................................................ 245
6.2.11.14 Operação getStateData ......................................................................................... 246
6.2.11.15 Operação addCountry e updateCountry .................................................................. 247
6.2.11.16 Operação deleteCountry ........................................................................................ 248
6.2.11.17 Operação getCountry ............................................................................................. 250
6.2.11.18 Operação getCountryData ...................................................................................... 251
6.2.11.19 Operação addContinent e updateContinent ............................................................ 252
6.2.11.20 Operação deleteContinent ..................................................................................... 253
6.2.11.21 Operação getContinent .......................................................................................... 255
6.2.11.22 Operação getContinentData ................................................................................... 256
6.2.11.23 Operação getLanguage .......................................................................................... 257
6.2.11.24 Operação getLanguageData .................................................................................. 257
6.2.11.25 Operação addProfession e updateProfession ........................................................ 259
6.2.11.26 Operação deleteProfession .................................................................................... 260
6.2.11.27 Operação getProfession ........................................................................................ 261
6.2.11.28 Operação getProfessionData ................................................................................. 262
6.2.11.29 Operação addJobTitle e updateJobTitle ................................................................ 264
6.2.11.30 Operação deleteJobTitle ........................................................................................ 265
6.2.11.31 Operação getJobTitle ............................................................................................ 266
6.2.11.32 Operação getJobTitleData ..................................................................................... 267
6.2.11.33 Operação addDepartment e updateDepartment ...................................................... 269
6.2.11.34 Operação deleteDepartment .................................................................................. 270
6.2.11.35 Operação getDepartment ....................................................................................... 272
6.2.11.36 Operação getDepartmentData ................................................................................ 273
6.2.11.37 Operação addCostCenter e updateCostCenter ....................................................... 274
6.2.11.38 Operação deleteCostCenter ................................................................................... 275
6.2.11.39 Operação getCostCenter ....................................................................................... 277
6.2.11.40 Operação getCostCenterData ................................................................................ 278
6.2.11.41 Operação addSupplier e updateSupplier ................................................................ 279
6.2.11.42 Operação deleteSupplier ........................................................................................ 281
6.2.11.43 Operação getSupplier ............................................................................................ 282
6.2.11.44 Operação getSupplierData ..................................................................................... 284
6.2.11.45 Operação addTechnicalAssistence e updateTechnicalAssistence ......................... 285
6.2.11.46 Operação deleteTechnicalAssistence .................................................................... 287
6.2.11.47 Operação getTechnicalAssistence ......................................................................... 289
6.2.11.48 Operação getTechnicalAssistenceData ................................................................. 290
6.2.11.49 Operação addReseller e updateReseller ................................................................ 291
6.2.11.50 Operação deleteReseller ........................................................................................ 293
6.2.11.51 Operação getReseller ............................................................................................ 295
6.2.11.52 Operação getResellerData ..................................................................................... 296
6.2.11.53 Operação getAuthToken e getAuthTokenContact .................................................. 298
6.2.11.54 Operação addLoginMessage e updateLoginMessage ............................................. 300
6.2.11.55 Operação deleteLoginMessage .............................................................................. 302
6.2.11.56 Operação getLoginMessage .................................................................................. 304
CAPÍTULO 7 - GATEWAYS ........................................................................................ 306
7.1 CONCEITO .................................................................................................................................. 306
Cópia Oficial
página: 6 de 359
7.2 PADRÕES DE DESENVOLVIMENTO .......................................................................................... 306
7.2.1 Exemplo de um Gateway ................................................................................................... 307
7.2.2 Parâmetros dos métodos ................................................................................................... 308
7.2.3 Exemplo da declaração de um método: .............................................................................. 308
7.3 GATEWAY CHANGE ................................................................................................................... 309
7.3.1 Gateway GTWApproveChange ............................................................................................ 309
7.3.1.1 checkBeforeApproveChange/checkAfterApproveChange .......................................... 310
7.3.2 Gateway GTWCloseChange ............................................................................................... 310
7.3.2.1 checkBeforeCloseChange/checkAfterCloseChange .................................................. 311
7.3.3 Gateway GTWConfirmChange ............................................................................................ 311
7.3.3.1checkBeforeConfirmChange/checkAfterConfirmChange ............................................ 312
7.3.4 Gateway GTWNewChangeRequest .................................................................................... 312
7.3.4.1 checkBeforeNewChangeRequest/checkAfterNewChangeRequest ............................. 313
7.3.5 Gateway GTWNewReplanChange ...................................................................................... 313
7.3.5.1 checkBeforeReplanChange/checkAfterReplanChange .............................................. 313
7.3.6 Gateway GTWUpdateChangeRequest ................................................................................ 314
7.3.6.1 checkBeforeUpdateChangeRequest/checkAfterUpdateChangeRequest .................... 314
7.3.7 Gateway GTWVerifyChange ............................................................................................... 315
7.3.7.1 checkBeforeVerifyChange/checkAfterVerifyChange .................................................. 315
7.3.8 Gateway GTWStartChange ................................................................................................. 316
7.3.8.1 checkBeforeStartChange/ checkAfterStartChange ................................................... 316
7.4 COMPONENT .............................................................................................................................. 317
7.4.1 Gateway GTWAddComponent ............................................................................................ 317
7.4.1.1 checkBeforeAddComponent/checkAfterAddComponent ........................................... 318
7.4.2 Gateway GTWDeleteComponent ........................................................................................ 318
7.4.2.1 checkBeforeDeleteComponent/checkAfterDeleteComponent .................................... 319
7.4.3 Gateway GTWUpdateComponent ....................................................................................... 319
7.4.3.1 checkBeforeUpdateComponent/checkAfterUpdateComponent .................................. 320
7.5 CUSTOMER ................................................................................................................................ 320
7.5.1 Gateway GTWAddCustomerContact .................................................................................. 320
7.5.1.1 checkBeforeAddCustomerContact/checkAfterAddCustomerContact ......................... 321
Cópia Oficial
página: 7 de 359
7.5.2 Gateway GTWDeleteCustomer ........................................................................................... 321
7.5.2.1OperaçãocheckBeforeDeleteCustomer/checkAfterDeleteCustomer ........................... 322
7.5.3 Gateway GTWDeleteCustomerContact ............................................................................... 322
7.5.3.1 checkBeforeDeleteCustomerContact/checkAfterDeleteCustomerContact ................. 323
7.5.4 Gateway GTWAddCustomer ............................................................................................... 323
7.5.4.1 Operação checkBeforeAddCustomer/checkAfterAddCustomer ................................. 324
7.5.5 Gateway GTWUpdateCustomer .......................................................................................... 324
7.5.5.1 Operação checkBeforeUpdateCustomer/checkAfterUpdateCustomer ....................... 325
7.5.6 Gateway GTWDeleteContact .............................................................................................. 325
7.5.6.1 checkBeforeDeleteContact/checkAfterDeleteContact ............................................... 326
7.5.7 Gateway GTWUpdateContact ............................................................................................. 326
7.5.7.1 checkBeforeUpdateContact/checkAfterUpdateContact ............................................. 327
7.5.8 Gateway GTWAddContact ................................................................................................. 327
7.5.8.1 checkBeforeAddContact/checkAfterAddContact ....................................................... 327
7.6 EQUIPMENT ............................................................................................................................... 328
7.6.1 Gateway GTWAddEquipmentComponent ........................................................................... 328
7.6.1.1checkBeforeAddEquipmentComponent/checkAfterAddEquipmentComponent ........... 329
7.6.2 Gateway GTWDeleteEquipmentComponent ....................................................................... 329
7.6.2.1checkBeforeDeleteEquipmentComponent/checkAfterDeleteEquipmentComponent .... 330
7.6.3 Gateway GTWAddEquipmentSoftware ................................................................................ 330
7.6.3.1 checkBeforeAddEquipmentSoftware/checkAfterAddEquipmentSoftware ................... 331
7.6.4 Gateway GTWDeleteEquipmentSoftware ............................................................................ 331
7.6.4.1checkBeforeDeleteEquipmentSoftware/checkAfterDeleteEquipmentSoftware ............ 332
7.6.5 Gateway GTWAddEquipment ............................................................................................. 332
7.6.5.1 checkBeforeAddEquipment/checkAfterAddEquipment ............................................. 333
7.6.6 Gateway GTWDeleteEquipment ......................................................................................... 333
7.6.6.1 checkBeforeDeleteEquipment/checkAfterDeleteEquipment ...................................... 334
7.6.7 Gateway GTWUpdateEquipment ........................................................................................ 334
7.6.7.1 checkBeforeUpdateEquipment/checkAfterUpdateEquipment .................................... 335
7.7 PRODUCT ................................................................................................................................... 335
Cópia Oficial
página: 8 de 359
7.7.1 Gateway GTWAddProduct ................................................................................................. 335
7.7.1.1 checkBeforeAddProduct/checkAfterAddProduct ....................................................... 336
7.7.2 Gateway GTWDeleteProduct .............................................................................................. 336
7.7.2.1 checkBeforeDeleteProduct/checkAfterDeleteProduct ............................................... 337
7.7.3 Gateway GTWUpdateProduct ............................................................................................. 337
7.7.3.1 checkBeforeUpdateProduct/checkAfterUpdateProduct ............................................. 337
7.9 SOFTWARE ................................................................................................................................ 338
7.9.1 Gateway GTWAddSoftware ................................................................................................ 338
7.9.1.1 checkBeforeAddSoftware/checkAfterAddSoftware .................................................... 339
7.9.2 Gateway GTWDeleteSoftware ............................................................................................ 339
7.9.2.1 checkBeforeDeleteSoftware/checkAfterDeleteSoftware ............................................ 339
7.9.3 Gateway GTWUpdateSoftware ........................................................................................... 340
7.9.3.1 checkBeforeUpdateSoftware/checkAfterUpdateSoftware .......................................... 340
7.9 TASK ........................................................................................................................................... 341
7.9.1 Gateway GTWNewTask ...................................................................................................... 341
7.9.1.1 Operação checkBeforeNewTask ............................................................................... 341
7.9.1.2 Operação checkAfterNewTask .................................................................................. 342
7.9.2 Gateway GTWStartTask ..................................................................................................... 343
7.9.2.1 Operação checkBeforeStartTask .............................................................................. 343
7.9.2.2 Operação checkAfterStartTask ................................................................................. 343
7.9.3 Gateway GTWFinishTask ................................................................................................... 344
7.9.3.1 Operação checkBeforeFinishTask ............................................................................ 344
7.9.3.2 Operação checkAfterFinishTask ............................................................................... 345
7.9.4 Gateway GTWProrrogueTask ............................................................................................. 345
7.9.4.1 Operação checkBeforeProrrogueTask ...................................................................... 346
7.9.4.2 Operação checkAfterProrrogueTask ......................................................................... 346
7.9.5 Gateway GTWAddUserTask ............................................................................................... 347
7.9.5.1 Operação checkBeforeAddUserTask ........................................................................ 347
7.9.5.2 Operação checkAfterAddUserTask ........................................................................... 347
7.9.6 Gateway GTWCancelTask .................................................................................................. 348
7.9.6.1 Operação checkBeforeCancelTask ........................................................................... 348
7.9.6.2 Operação checkAfterCancelTask ............................................................................. 349
7.9.7 Gateway GTWAddHistoryTask ........................................................................................... 350
Cópia Oficial
página: 9 de 359
7.9.7.1 Operação checkBeforeAddHistoryTask ..................................................................... 350
7.9.7.2 Operação checkAfterAddHistoryTask ....................................................................... 350
7.10 TICKET ...................................................................................................................................... 351
7.10.1 Gateway GTWNewTicket (Qualitor atendente) .................................................................. 351
7.10.1.1 Operação checkBeforeNewTicket ........................................................................... 351
7.10.1.2 Operação checkAfterNewTicket .............................................................................. 352
7.10.2 Gateway GTWAddTicket (Qualitor solicitante) .................................................................. 353
7.10.2.1 Operação checkBeforeAddTicket ........................................................................... 353
7.10.2.2 Operação checkAfterAddTicket .............................................................................. 353
7.10.3 Gateway GTWStartTicket ................................................................................................. 354
7.10.3.1 Operação checkBeforeStartTicket .......................................................................... 354
7.10.3.2 Operação checkAfterStartTicket ............................................................................. 355
7.10.3.3 Operação checkBeforeFinishTicket ........................................................................ 355
7.10.3.4 Operação checkAfterFinishTicket ........................................................................... 356
7.10.4 Gateway GTWProrrogueTicket ......................................................................................... 357
7.10.4.1 Operação checkBeforeProrrogueTicket .................................................................. 357
7.10.4.2 Operação checkAfterProrrogueTicket ..................................................................... 357
7.10.5 Gateway GTWTransferTechnicianTicket ............................................................................ 358
7.10.5.1 Operação checkBeforeTransferTechnicianTicket .................................................... 358
7.10.5.2 Operação checkAfterTransferTechnicianTicket ....................................................... 359
7.10.6 Gateway GTWCancelTicket .............................................................................................. 360
7.10.6.1 Operação checkAfterCancelTicket ......................................................................... 360
7.10.7 Gateway GTWAddRegisterTicket ..................................................................................... 361
7.10.7.1 Operação checkBeforeAddRegisterTicket .............................................................. 361
7.10.7.2 Operação checkAfterAddRegisterTicket ................................................................. 362
7.10.8 Gateway GTWAnswerQuestion ........................................................................................ 363
7.10.8.1 Operação checkBeforeAnswerQuestion .................................................................. 363
7.10.8.2 Operação checkAfterAnswerQuestion ..................................................................... 363
7.10.9 Gateway GTWHistoryChange ........................................................................................... 364
7.10.9.1Operação checkBeforeHistoryChange ...................................................................... 364
7.10.9.2 Operação checkAfterHistoryChange ....................................................................... 365
Cópia Oficial
página: 10 de 359
NOTAS SOBRE A VERSÃO DO MANUAL
Esse manual foi desenvolvido a partir do Manual de Recursos de Integração
no idioma português, da versão 7.00 revisão 02. Foram somadas a este as
implementações geradas na versão 8.00.
Abaixo seguem as modificações realizadas neste manual:
Foram implementadas informações sobre novos Webservices de chamados
relativos ao fluxo de atendimento. São eles: “getTicketStep”, “getTicketNextSteps” e
“setTicketStep”.
Cópia Oficial
página: 11 de 359
REVISÃO DO MANUAL
Revisão 02:
Foi alterado o item 6.2 WEBSERVICES DISPONÍVEIS NO QUALITOR para
6.2.A;
Nos itens 7.10.7 Gateway GTWAddHistoryTicket, 7.10.7.1 Operação
checkBeforeAddHistoryTicket e 7.10.7.2 Operação checkAfterAddHistoryTicket, foram
alterados a nomenclatura “History” para “Register”;
Foi inserida a página referente a revisão do manual.
Cópia Oficial
página: 12 de 359
PARTE 1 - CONCEITUAL
Cópia Oficial
página: 13 de 359
CAPÍTULO 1 - VISÃO GERAL
___________________________________________________
Nesse capítulo iremos abordar os conceitos básicos sobre Integração.
1.1 OBJETIVOS
Os recursos de integração são utilizados para permitir que o Qualitor e outros
sistemas envolvidos em um mesmo ambiente possam se comunicar, viabilizando
operações em conjunto. A seguir, alguns exemplos de Integração:
• necessidade de geração de uma ordem de serviço no SAP sempre que um
chamado com determinado “Tipo” e “Categoria” for registrado;
• necessidade que o portal de intranet do cliente gere um chamado para o
Qualitor sempre que o usuário tentar por 3 vezes consecutivas a senha, e bloquear a
mesma.
1.2 CONCEITO
Os recursos de integração do Qualitor devem permitir, ao cliente integrador ou
desenvolvedor, realizar as seguintes operações:
• Interagir com os recursos do Qualitor: abrir chamados, buscar
informações, etc. a partir de outras aplicações;
• Fazer com que o Qualitor acesse outras aplicações: buscando dados,
realizando validações ou operações;
Cópia Oficial
página: 14 de 359
Os recursos de integração possibilitam a integração entre o Qualitor e outros
sistemas, em plataformas diferentes ou não, onde são executados comandos
disponibilizados para serviços específicos. O Qualitor atende à área de atendimento,
mas pode ser integrado com outros tipos de softwares que controlam áreas diferentes.
Exemplo: Qualitor Atendimento Vs. Sistemas de SAP - ERP da empresa “x”.
Caso típico: o cadastramento de novo funcionário, por exemplo, atividade
inerente a área de Recursos Humanos (cadastro de funcionairos, demissões, horas
extras e etc). O departamento de RH necessita que, sempre que um novo funcionário
for adicionado ao ERP, sistema de RH, deverá se adicionado também ao Qualitor.
Dessa forma, as opeações entre os sistemas dependerão da comunicação entre os
dois sistemas, o Qualitor e o sistema de ERP da empresa “x”.
• Autenticação integrada entre dois sistemas. Por exemplo, o usuário
conecta em outro sistema com seu login e senha, e a partir deste, acessa o Qualitor
sem informar um novo login e senha;
• Publicação de “Gatilhos Personalizados”: recurso distribuído pelo
sistema, para que o atendente tenha acesso, a partir do Qualitor, à recursos de
integração do seu ambiente.
1.3 RECURSOS DE INTEGRAÇÃO
A integração no Qualitor pode ocorrer de duas formas:
• Integração Passiva: outros sistemas buscam e fazem operações no
Qualitor
• Integração Ativa: Qualitor indo a outros sistemas e realizando operações.
Cópia Oficial
página: 15 de 359
1.3.1 Passivo
Temos como “Integração Passiva”, os recursos de “WebServices” e
“Autenticação Legada”.
Cópia Oficial
página: 16 de 359
1.3.2 Ativo
Temos como “Integração Ativa”, os recursos de “Gateways” e “Gatilhos
Personalizados”.
Cópia Oficial
página: 17 de 359
CAPÍTULO 2 - WEBSERVICES
__________________________________________________
2.1 DEFINIÇÃO
Web Service é uma solução utilizada na integração de sistemas e na
comunicação entre aplicações diferentes. Com esta tecnologia é possível que novas
aplicações possam interagir com aquelas que já existem e que sistemas desenvolvidos
em plataformas diferentes sejam compatíveis.
Os Web Services são componentes que permitem as aplicações enviar e
receber dados em formato XML. Cada aplicação pode ter a sua própria “linguagem”,
que é traduzida para uma linguagem universal, o formato XML.
Na ilustração a seguir, há um exemplo de webservice:
As operações que o usuário realiza, nesse caso, compreendem: abastecer
carrinho de compras, informar número do cartão e efetuar pagamento. O que a loja
virtual faz no momento em que cliente efetua o pagamento: é acessar a administradora
de cartão de crédito via WebService, acionar o serviço de autenticação, validar o
cartão de crédito do cliente e debitar dinheiro do cartão de crédito do cliente.
Cópia Oficial
página: 18 de 359
2.1.1 WSDL
O WSDL (Web Services Definition Language) é uma linguagem baseada em
XML utilizada para descrever Web Services. Trata-se de um documento escrito em
XML que, além de descrever o serviço, especifica como acessá-lo e quais as
operações ou métodos disponíveis.
O WSDL é um arquivo que existe em todo servidor que provê WebServices.
Ele é o “cardápio” que mostra para a aplicação que está acessando, quais serviços ela
pode utilizar, e como ela pode utilizar estes serviços.
O canário a seguir ilustra essa relação:
1) Autenticação Legada pergunta ao WSDL do Qualitor: o que há disponível
para ser utilizado?
2) WSDL do Qualitor responde: Você pode:
- Abrir chamados
- Abrir chamados utilizando perfil
- Pesquisar chamados
- Gerar ações
- Pesquisar base de conhecimento
3) Autenticação Legada utiliza algum destes serviços.
Cópia Oficial
página: 19 de 359
O Qualitor possui vários arquivos WSDL disponíveis. Cada arquivo WSDL
corresponde a um grupo de WebServices disponíveis para serem executados.
Veja abaixo os arquivos WSDL disponíveis no Qualitor:
ws/services/Charts/WSCharts.wsdl
ws/services/Chat/WSChat.wsdl
ws/services/General/WSGeneral.wsdl
ws/services/Inventory/WSInventory.wsdl
ws/services/KnowledgeBase/WSKnowledgeBase.wsdl
ws/services/Product/WSProduct.wsdl
ws/services/Task/WSTask.wsdl
ws/services/Ticket/WSTicket.wsdl
2.2 WEBSERVICES NO QUALITOR
Os WebServices são recursos utilizados por integradores / desenvolvedores ou
clientes que desejam utilizar serviços disponíveis no produto, para fins de integração
entre sistemas.
O sistema de WebServices do Qualitor utiliza o padrão SOAP de comunicação.
A sua execução é PASSIVA, ou seja, é necessário acionar um serviço para executar
determinada operação e obter resposta.
Cópia Oficial
página: 20 de 359
O idioma das classes e objetos utilizados no WebServices utiliza o idioma
INGLÊS em sua estrutura, para fins de internacionalização. Existem vários WebSevices
disponíveis no Qualitor. Todos eles possuem o mesmo padrão e formato, e estão
disponíveis para que possamos efetuar várias operações no Qualitor a partir de outros
sistemas.
NOTA: Para utilizar qualquer classe do WebServices do Qualitor, é
necessário possuir licença para uso de WebServices, no Qualitor.
2.3 ARQUIVOS WSDL
Os arquivos WSDL são, por definição do W3C, arquivos estáticos. Cada
servidor possui o seu conjunto de arquivos, e estes possuem, internamente, endereços
indicando onde os serviços estão localizados.
Cada cliente “coloca” o Qualitor em diretórios diferentes, com endereços IP’s e
endereços de rede diferentes. Então, os arquivos WSDL são diferentes para cada
cliente. Por isso, é necessário que eles sejam “gerados” a cada ATUALIZAÇÃO
realizada.
No menu “Administração > Parâmetros Gerais”, na aba Webservices, é
possível gerar aquivos WDSL.
Para gerar um arquivo WDSL, digite o nome do servidor (nome de rede pelo
qual o servidor é reconhecido internamente, ou externamente). Em seguida, clique no
botão “Gerar Arquivos WSDL”.
Cópia Oficial
página: 21 de 359
2.3.1 Webservices disponíveis no Qualitor
Os seguintes WebServices estão disponíveis para o Qualitor:
2.3.1.1 WebService Inventory
“WebService Inventory” é o WebService do módulo Inventário. O descritor
(WSDL) deste WebService encontra em:
/WSInventory.wsdl
2.3.1.2 WebService Tasks
“WebService Tasks” é o WebService do módulo Meu Qualitor – Ações. O
descritor (WSDL) deste WebService encontra em:
/WSTask.wsdl
2.3.1.3 WebService Meetings
“WebService Meetings” é o WebService do módulo Meu Qualitor – Reuniões. O
descritor (WSDL) deste WebService encontra em:
/WSMeeting.wsdl
Cópia Oficial
página: 22 de 359
2.3.1.4 WebService Tickets
“WebService Tickets” é o WebService do módulo Meu Qualitor – Atendimento Chamados. O descritor (WSDL) deste WebService encontra em:
/WSTicket.wsdl
2.3.1.5 WebService General
“WebService General” é o WebService do módulo Meu Qualitor – Cadastros
Gerais. O descritor (WSDL) deste WebService encontra em:
/WSGeneral.wsdl
2.4 CONFIGURAR UMA CONTA DE USUÁRIO
Para que uma aplicação possa trabalhar com WebServices, é necessário que
ela utilize uma conta de usuário para efetuar o Login ao sistema.
Esta conta de usuário deve ser configurada no Qualitor, habilitando para ela,
acesso aos WebServices, e este usuário precisa possuir acesso aos recursos que
estão sendo acessados.
Cópia Oficial
página: 23 de 359
2.5 PROGRAMAR O ACESSO AO WSDL:
Cada linguagem de programação possui seus próprios métodos e estruturas
diferentes para acessar WebServices.
No entanto, praticamente todas as linguagem de última geração possuem
recursos que permitem que este tipo de acesso seja realizado.
Neste manual, utilizaremos o software “Excel 2007” para simular um acesso de
uma aplicação legada ao Qualitor.
• Abrir o Microsoft Excel 2007.
• Habilitar o recurso de desenvolvimento em Excel.
• Criar uma macro que irá abrir um chamado no Qualitor.
Se a aba “Desenvolvedor” não estiver disponível, há um procedimento simples
que pode ser feito para exibi-la.
Cópia Oficial
página: 24 de 359
Clique no botão do “Microsoft Office” e, em seguida, clique em “Opções do
Excel”. Na categoria “Popular”, em “Opções Principais para o Trabalho com Excel”,
marque a caixa de seleção “Mostrar Guia Desenvolvedor na faixa de Opções” e clique
em “Ok”.
Para definir o nível de segurança temporariamente e habilitar todas as macros,
deve-se, na aba “Desenvolvedor”, no grupo “Código”, clique em “Segurança de Macro”,
conforme a imagem a seguir.
Em “Configurações de Macro”, clique em “Habilitar todas as marcas (não
recomendável, códigos possivelmente perigosos podem ser executados)”. Em seguida,
clique em “Ok”.
NOTA: Para ajudar a impedir a execução de códigos potencialmente
perigosos, convém retornar para qualquer uma das configurações que desabilitam
todas as macros depois de terminar de trabalhar com macros.
Para criar a primeira macro no Excel, deve ir na aba “Desenvolvedor”, no
grupo “Código”, clicar em “Visual Basic”.
Cópia Oficial
página: 25 de 359
Se necessário, no Editor do Visual Basic, no menu “Inserir”, clique em
“Módulo”. Vale lembrar que os módulos são criados automaticamente para todas as
planilhas da pasta de trabalho.
Na janela de código do módulo, digite ou copie o código do macro que deseja
usar. Para executar a macro da janela do módulo, pressione “F5”. No menu “Arquivo”,
do editor do Visual Basic, clique em “Fechar e Retornar ao Miscrosoft Excel” quando
terminar de gravar a macro.
Para criar a macro, clique com o botão direito na pasta “Microsoft Excel
Objects”, clique em “Inserir” e selecione a opção “Módulo”. O Módulo irá armazenar as
macros criadas.
Agora, crie uma macro começando pela instrução “Sub”, e o nome da macro,
conforme o exemplo a seguir:
Cópia Oficial
página: 26 de 359
Aqui, dentro da Macro “AbreChamado”, iremos codificar a instrução que irá
abrir um chamado no Qualitor. As instruções a seguir são de conhecimento específico
de cada desenvolvedor, de acordo com a tecnologia com o qual ele trabalha. No
exemplo a seguir, as seguintes etapas serão executadas:
‘ Declara variáveis
Dim wsConn As New SoapClient 30
Dim wsRetorno As String
Dim wsAuth As String
Dim wsXML As String
‘ Inicializa o SOAP acessando WSDL
wsConn.MSSoapInit “http://ncxs003/6.00.00/ws/services/Ticket/WSTicket.wsdl”
‘Realiza o LOGIN
wsAuth = wsConn.Login(“conexão_ws”, “123”, “1”)
‘Este exemplo irá abrir um chamado, utilizando o perfil de chamdo 40
Cópia Oficial
página: 27 de 359
wsXML = “”
wsXML = wsXML & “<?xml version=””1.0”” enconding=””ISO-8859-1””?>” & vbCrLf
wsXML = wsXML & “<wsqualitor>” & vbCrLf
wsXML = wsXML & “<contents>” & vbCrLf
wsXML = wsXML & “
<data>” & vbCrLf
wsXML = wsXML & “
<cdperfilchamado>40</cdperfilchamado>” & vbCrLf
wsXML = wsXML & “
<cdcliente>1</cdcliente>” & vbCrLf
wsXML = wsXML & “
wsXML = wsXML & “
<cdcontato>2978</cdcontato>” & vbCrLf
<dschamado>Cliente solicta alteração de sua conta no Outlook,
wsXML = wsXML & “para” receber as newsletters.</dschamado> & vbCrLf
wsXML = wsXML & “
</data>” & vbCrLf
wsXML = wsXML & “</contents>” & vbCrLf
wsXML = wsXML & “</wsqualitor>”
‘Aciona o serviço addTicketByTemplate, que realizar abertura de chamados por
perfil
wsRetorno = wsConn.addTicketByTemplate(wsAuth, wsXML)
‘A variável wsRetorno possui a resposta do WebService. Agora é só verificar se
houve erro ou não
If Mid(wsRetorno, Instr(1, wsRetorno, “<status>”) +8, 1) = “1” Then
‘ Se não houve, então, abre chamado.
MsgBox “Chamado: “ & Mid(wsRetorno, Instr(1, wsRetorno, “<cdchamado>”) +11, 5) _
& “ aberto com sucesso.”, vbInformation, “Qualitor Integration Services”
Else|
‘ Se houve, então, exibe o erro.
MsgBox “Ocorreu um erro.” & vbCrLf & wsRetorno
End If
Cópia Oficial
página: 28 de 359
Trata-se do retorno da aplicação. No exemplo acima, está buscando o valor
contido dentro do XML de retorno, no campo “<status>” e verificando se é igual a “1”.
Se for igual a “1”, então a operação foi realizada com sucesso, e exibe uma
mensagem informando o número do chamado aberto. Caso o status seja diferente de
“1”, então, houve algum erro no processamento, e o sistema deve exibir a mensagem
de erro.
Na planilha Excel, é possível criar um botão, na planilha, para acessar a Macro
criada. No menu de desenvolvedor, clique no botão “Inserir”, e selecione a opção
“Botão”. Clique na planilha e arraste para desenhar o botão. Ao soltar o mouse, o botão
irá perguntar “Qual Macro” deseja associar à este botão. Selecione a macro
“AbreChamado” criada.
Pressione “OK” para confirmar e pronto. Sua macro estará associada ao botão.
A partir de agora, sempre que o botão for clicado, a macro será executada,
acionando o Qualitor e registrando um chamado, conforme o exemplo que criamos.
Cópia Oficial
página: 29 de 359
Para testar o acesso ao WSDL, basta clicar no botão que foi adicionado à
planilha. O resultado deve ser o seguinte:
Cópia Oficial
página: 30 de 359
CAPÍTULO 3 - AUTENTICAÇÃO LEGADA
_________________________________________________
Estabelecer uma autenticação legada, significa fazer com que o Qualitor permita o acesso
de um usuário que já está autenticado em outra aplicação (aplicação legada). Este usuário,
por sua vez, irá acessar o Qualitor utilizando as credenciais que ele já forneceu ao acessar
este sistema.
3.1 VISÃO GERAL
Por exemplo, usuário está utilizando a intranet corporativa (portanto, está
logado). Na intranet, existe um link de acesso ao Qualitor. Caso o usuário acesse o
Qualitor pelo link da intranet, ele será automaticamente autenticado, pois a autenticação
feita no acesso a intranet, será transferida para o Qualitor.
A vantagem do uso desse recurso é que, em função do usuário já ter sido
autenticado em outra aplicação não será necessário informar novamente o seu
“usuário” e “senha” de acesso. Usuários ”de fora” executam através de seus sistemas,
funcionalidades no Qualitor. Por exemplo: funcionalidade do Qualitor de abertura de
chamado - a autenticação legada torna possível a extração do Qualitor de parte do
arquivo que possibilita a abertura de chamados, disponibilizando uma parte do arquivo
num servidor web.
Cópia Oficial
página: 31 de 359
Webservice é uma solução utilizada nas funcionalidades definidas no Qualitor
para que sejam executados através da webservice. Um exemplo disso é a abertura de
chamado do Qualitor. Dentro do Qualitor tem-se encapsulado a estrutura de dados
para a abertura de chamados (funcionalidade do Qualitor).
• Sistema SAP —— desenvolvido em Oracle —— acesso ao banco de dados
pelo Oracle.
• Webservice interpreta os arquivos
• Qualitor —— desenvolvido em SQL Server —— acesso ao BD por SQL.
Os arquivos em formato XML contém os dados de cada operação do Qualitor.
O formato XML permite a interpretação de dados entre sistemas diferentes,
desenvolvidos em plataformas diferentes. Um servidor receberá as informações de
entrada e executará os serviços disponibilizados pelo Qualitor. Os seviços
disponibilizados pelo Qualitor estarão em arquivos em formato WSDL. O WSDL é o
“cardápio” onde estão contidas todas as funções que o webservice possibilita para a
execução de comandos no Qualitor. Os arquivos de configuração do Webservice são
criados no Qualitor com a informação do nome do servidor, conforme o exemplo
abaixo. O acesso pode ser realizado através do menu “Administração > Parâmetros
Gerais > Webservice”.
Cópia Oficial
página: 32 de 359
NOTA: a lista de serviços disponíves pode ser solicitada ao Suporte Técnico.
Geralmente servidores SOAP são implementados utilizando-se servidores HTTP,
embora isto não seja uma restrição para funcionamento do protocolo. As mensagens
SOAP são documentos XML que aderem a uma especificação fornecida pelo órgão
W3C.
• W3C: W3C desenvolve padrões para a criação e a interpretação dos
conteúdos para a Web. Sites desenvolvidos segundo esses padrões podem ser
acessados e visualizados por qualquer pessoa ou tecnologia, independente de
hardware ou software utilizados, como celulares (em Portugal, telemóvel), PDAs, de
maneira rápida e compatível com os novos padrões e tecnologias que possam surgir
com a evolução da internet.
Para alcançar seus objetivos, a W3C possui diversos comitês que estudam as
tecnologias existentes para a apresentação de conteúdo na Internet e criam padrões
de recomendação para utilizar essas tecnologias. Com a padronização, os programas
conseguem acessar facilmente os códigos e entender onde deve ser aplicado cada
conhecimento expresso no documento.
• SOAP: originado do acrônimo inglês Simple Object Access Protocol é um
protocolo para troca de informações estruturadas em uma plataforma descentralizada e
distribuída, utilizando tecnologias baseadas em XML. Sua especificação define um
framework que provê maneiras para se construir mensagens que podem trafegar
através de diversos protocolos e que foi especificado de forma a ser independente de
qualquer modelo de programação ou outra implementação específica. Por não se tratar
de um protocolo de acesso a objetos, o acrônimo não é mais utilizado.
NOTA: o conceito de Autenticação Legada está relacionado com a idéia de
que se um usuário já está logado em um sistema “x”, não necessitará informar os
dados de autenticação para acessar o Qualitor.
Cópia Oficial
página: 33 de 359
3.2 UTILIZAÇÃO DO RECURSO
Este processo de integração de autenticação entre aplicações exige que seja
realizado uma programação no sistema onde desejamos criar um “ponto de acesso” ao
Qualitor. Neste sistema, é necessário criar um código que irá acionar o “WebService
do Qualitor”, para obter um “Token” de autenticação. Este “token” de autenticação será
utilizado para que o usuário consiga acessar o Qualitor sem informar “usuário” e
“senha”. O canário a seguir ilustra essa situação:
3.2.1 PONTOS DE AUTENTICAÇÃO:
Ao criar os pontos de autenticação na aplicação, podemos optar por dois
tipos de integração legada:
• Integração com a autenticação para Web Solicitante
• Integração com a autenticação para Web Atendente
NOTA: O token de autenticação do Qualitor é válido por 60 segundos, ou
seja, a aplicação que recebe o token de autenticação têm 60 segundos para usá-lo,
senão ele não será mais válido.
Cópia Oficial
página: 34 de 359
3.2.1.1 Autenticação Legada para Web Atendente:
O “WSGeneral.wsdl” possui um serviço chamado: getAuthToken. Este serviço
solicita que seja informada a autenticação normal, e um XML contendo o usuário
(atendente) e empresa (Qualitor Advanced “Multiempresa”) no qual deseja efetuar o
“logon” ao sistema:
<?xml version=”1.0" encoding=”ISO-8859-1"?>
<wsqualitor>
<contents>
<data>
<nmusuario>loginuser</nmusuario>
<cdempresa>1</cdempresa>
</data>
</contents>
</wsqualitor>
As etapas deste processo são as seguintes:
•
Conexão ao WSDL
•
Autenticação “Login”
•
Aciona serviço getAuthToken
O serviço getAuthToken irá retornar um XML contendo:
<wsqualitor>
<response_status>
<status>1</status>
Cópia Oficial
página: 35 de 359
<error_code></error_code>
<msg></msg>
</response_status>
<response_data>
<dataitem>
<token>99t5xcBix32WNWiW58Wdtls58BetlAHBYxdWHtctdWdsltd</
token>
</dataitem>
</response_data>
</wsqualitor>
Feito isso, será necessário abrir o Qualitor passando o Token de autenticação
na URL:
h
t
t
p
:
/
/
s
e
r
v
i
d
o
r
/
q
u
a
l
i
t
o
r
/
login.php?authws=99t5xcBix32WNWiW58Wdtls58BetlAHBYxdWHtctdWdsltd
Realizando este processo, o Qualitor irá realizar um logon automático no
sistema. Há alguns pontos a serem observados:
• Os usuários da rede, que irão utilizar este recurso, não precisam ter o
parâmetro “Habilitar acesso via WebServices” ativo, pois, o Login WS ao Qualitor
pode ser realizado por apenas 1 usuário.
• Os usuários da rede não precisam ter “senha” cadastrada no Qualitor, uma
vez que a mesma é gerenciada pelo sistema legado, portanto, basta solicitar o Token.
• Quem solicita o token é o usuário com permissão para acesso via
WebService.
Cópia Oficial
página: 36 de 359
3.2.1.2 Autenticação Legada para Web Solicitante:
O WSGeneral.wsdl possui um serviço chamado: getAuthTokenContact. Este
serviço solicita que seja informada a autenticação normal, e um XML contendo o
usuário (solicitante) e cliente, no qual deseja efetuar o “logon” ao sistema:
<wsqualitor>
<contents>
<data>
<cdcliente>1</cdcliente>
</data>
</contents>
</wsqualitor>
O processo tem as seguintes etapas:
• Conexão ao WSDL
• Autenticação “Login”
• Usar getAuthTokenSolicitante
O serviço getAuthTokenSolicitante irá retornar um XML contendo:
<wsqualitor>
<response_status>
<status>1</status>
Cópia Oficial
página: 37 de 359
<msg></msg>
</response_status>
<response_data>
<dataitem>
<token>99t5xcBix32WNWiW58Wdtls58BetlAHBYxdWHtctdWdsltd</
token>
</dataitem>
</response_data>
</wsqualitor>
eito isso, será necessário abrir o Qualitor passando o Token de autenticação
na URL:
h
t
t
p
:
/
/
s
e
r
v
i
d
o
r
/
q
u
a
l
i
t
o
r
/
loginSolicitante.php?authws=95cBix32WNWiW58Wdtls58BetlAHBYxdWWdsltd
Realizando este processo, o Qualitor irá realizar um logon automático no
sistema.
Há alguns pontos a serem observados:
• Solicitantes não possuem o o parâmetro “Habilitar acesso via WebServices”,
pois, o Login WS ao Qualito será realizado por apenas 1 usuário atendente.
• Os usuários da rede não precisam ter “senha” cadastrada no Qualitor, uma
vez que a mesma é gerenciada pelo sistema legado, portanto, basta solicitar o Token
• Quem solicita o token é o usuário com permissão para acesso via
WebService.
Cópia Oficial
página: 38 de 359
3.2.1.3 Exemplo
Continuando com o uso do Excel nas demonstrações, veja abaixo um exemplo,
em excel, que permite o acesso à Atendentes e Solicitantes, de forma integrada:
O primeiro quadro aciona macro: AcessaQualitor(). O segundo quadro, por sua
vez aciona macro: AcessaQualitorSolicitante().
Sub AcessaQualitor ( )
‘ Declara variáveis
Dim wsConn As New SoapClient30
Dim wsRetorno As String
Dim wsAuth As String
Dim wsXML As String
Dim wsToken As String
‘ Inicializa o SOAP acessando o WSDL
wsConn.MSSoapInit ““http://ncxs003/6.00.00/ws/services/General/WSGeneral.wsdl”
Cópia Oficial
página: 39 de 359
‘ Realiza o Login
wsAuth = wsConn.Login(“conexao ws”, “123”, “1”)
‘ Este exemplo irá buscar um Token de autenticação, para o usário
“adair_fernandes” na empresa 1.
wsXML = “”
wsXML = wsXML & “<?xml version=””1.0”” enconding=””ISO-8859-1””?>”
wsXML = wsXML & “<wsqualitor>”
wsXML = wsXML & “<contents>”
wsXML = wsXML & “
wsXML = wsXML & “
<data>”
<nmusuario>” & ActiveSheet.Cells(3,4). Value & “</
nmusuario>”
wsXML = wsXML & “
<cdempresa> & ActiveSheet.Cells(3,4). Value & “</
cdempresa>”
wsXML = wsXML & “
</data>”
wsXML = wsXML & “</contents>”
wsXML = wsXML & “</wsqualitor>”
‘ Busca Token de autenticação
wsRetorno = wsConn.GetAuthToken(wsAuth, wsXML)
If Mid(wsRetorno, Instr(1, wsRetorno, “<status>”) +8, 1) = “1” Then
‘ Se houve sucesso na operação, separa o token do retorno:
wsToken = Mid(wsRetorno, InStr(1, wsRetorno, ”<token>”) +7, Len(wsRetorno) 54 - InStr(1, wsRetorno, “<token>”)
Cópia Oficial
página: 40 de 359
‘ Aciona a URL do Qualitor
ShellExecute 0, “open”, ““http://ncxs003/6.00.00/login.php?authws=” & wsToken,
vbNullString, vbNullString, 3
Else
MsgBox wsRetorno, vbCritical, “Qualitor Integration Services”
End If
Cópia Oficial
página: 41 de 359
CAPÍTULO 4 - GATEWAYS
____________________________________________________
Os gateways visam estabelecer uma forma de permitir a um programador / integrador,
criar uma “interceptação” dentro do Qualitor para realizar uma operação em algum sistema,
em determinado momento.
4.1 EXEMPLOS DE USO
O cliente precisa fazer com que, todo (ou alguns) chamado(s) aberto(s) no
Qualitor, realize(m) imediatamente o registro de uma Ordem de Serviço no SAP,
conforme ilustra a figura a seguir:
O benefício de usar um gateway está no fato de que o usuário final não vê uma
ordem de serviço sendo gerada, nem precisa abrir o chamado no Qualitor, e depois, ir
ao SAP e registrar a Ordem de Serviço, por exemplo. A própria operação de abertura
de chamado no Qualitor já faz esse registro.
Também pode ser usado para criar algumas regras de “exceção”, impedindo
que algumas operações sejam realizadas no Qualitor, “se” determinada condição não
for satisfatória.
Cópia Oficial
página: 42 de 359
O cliente precisa que o Qualitor só permita abertura de chamados para clientes
em que a situação financeira estiver OK com o sistema financeiro da empresa. Porém,
o cliente não quer que o operador tenha que abrir o sistema e consultar os dados
antes de abrir o chamado. O próprio Qualitor deve consultar o sistema antes de
proceder com a abertura de chamado, e caso o cliente esteja com “Pendências”,
então, o Qualitor deverá impedir a abertura de chamados, informando as parcelas que
estão em aberto.
4.2 APLICAÇÕES PRÁTICAS
Na prática, o recurso de Gateways são uma série de funções que o Qualitor
“chama” e verifica o que elas respondem. Vale lembrar que essas funções não existem
no Qualitor. Essas funções devem ser criadas por integradores e programadores que
desejam interceptar “momentos” do Qualitor, para implementar integrações ativas, ou
seja, integrações que irão partir “do Qualitor” para outras aplicações.
Funções são recursos de programação que possuem a finalidade de realizar
uma operação, e retornar um resultado, por exemplo, veja abaixo um exemplo, uma
função chamada SOMAR. A função somar é utilizada para somar 2 números que são
informados à ela.
> Executar função: SOMAR(1, 2)
> Resultado: 3
Cópia Oficial
página: 43 de 359
Um exemplo mais prático ainda:
Veja, por exemplo, o EXCEL.
O Excel possui uma série de funções, veja o exemplo de uma delas, abaixo:
Dentro da função “Soma”, há uma série de comandos, linhas de código de
desenvolvimento, atividades com “variáveis” e outras funções, que fazem a mesma
funcionar, e retornar o resultado esperado, que é a soma dos valores informados.
4.3 GATEWAY NO QUALITOR
Para criar Gateways no Qualitor, faremos o sentido inverso. Ao invés de utilizar
as funções que o Qualitor proporciona, iremos CRIAR as funções necessárias de
integração, e o Qualitor irá UTILIZAR estas funções. Para criar funções no Qualitor,
precisamos utilizar a mesma linguagem de programação que o Qualitor foi
desenvolvido, ou seja “PHP 5.2”.
Utilizando esta linguagem de programação, precisaremos criar as funções, e da
mesma forma que o Qualitor, armazená-las em arquivos. As funções precisam ter
nomes que o Qualitor compreenda (ou melhor, funções com nomes que o Qualitor está
preparado para compreender).
Cópia Oficial
página: 44 de 359
Então, vale lembrar que para ter um completo domínio deste recurso, é
necessário ter conhecimento na linguagem de programação PHP. Este recurso foi
criado especialmente para programadores e integradores com conhecimento nesta
linguagem de programação.
4.3.1 Momentos de Execução
O Qualitor está preparado para compreender funções criadas com a finalidade
de interceptar dois momentos de operações dentro do sistema: o momento “Before” e
o momento “After”. O momento “Before” ocorre antes da execução da operação em
questão, por exemplo:
-
Antes de abrir o chamado
-
Antes de cadastrar a ação
-
Antes de cadastrar um cliente
-
Antes de cadastrar um produto
-
Antes de cadastrar um contato
-
Antes de cadastrar um equipamento
O momento “After”, por sua vez, ocorre após a execução da operação em
questão, por exemplo:
-
Após abrir o chamado
-
Após cadastrar a ação
-
Após cadastrar um cliente
-
Após cadastrar um produto
-
Após cadastrar um contato
-
Após cadastrar um equipamento
Cópia Oficial
página: 45 de 359
Cada “Momento de Execução” tem uma indicação apropriada. Utiliza-se o
“Momento Before” quando precisamos realizar operações antes do registro ser
efetuado. Em algumas situações, isso pode, talvez, até impedir o registro. Por
exemplo, para cadastrar um equipamento no Qualitor, é necessário que o mesmo já
esteja cadastrado no sistema de patrimônio, caso contrário, o sistema deve bloquear o
cadastro.
Utiliza-se o “Momento After” quando precisamos realizar operações antes do
registro ser efetuado. Quando precisamos realizar operações após a efetivação do
registro. Por exemplo, sempre que um contato for cadastrado no Qualitor, o mesmo
deve ser replicado para o sistema de RH. Sempre que um chamado for aberto, o
sistema deve gravar alguns dados em uma planilha e disponibilizar em uma área de
FTP, para consulta por outro sistema.
4.3.2 Utilização dos momentos de execução
Na abertura de um chamado, o Qualitor procede da seguinte forma:
1) O usuário clica no botão “Processar” para registrar um chamado;
2) O Qualitor valida os campos preenchidos, parâmetros e regras de negócio
necessárias para abrir um chamado
3) Quando o Qualitor estiver pronto para abrir o chamado:
3.1) O Qualitor verifica a existência da pasta /gtw/modules/hd
3.2) O Qualitor verifica a existência do arquivo GTWNewTicket.class.php
3.3) O Qualitor verifica a existência de uma função dentro do arquivo:
checkBeforeNewTicket.
3.4) O Qualitor executa a função e verifica o retorno. Dependendo do retorno,
ele prossegue com a abertura do chamado.
Para o Qualitor compreender o retorno de uma função, no momento “Before” de
uma operação, é necessário retornar para o Qualitor um dos seguintes valores:
Cópia Oficial
página: 46 de 359
• OK: Informa ao Qualitor que o mesmo deve exibir uma janela de
“Informação” com um botão de “OK” para o usuário clicar e continuar o processo da
operação. Pode acompanhar uma mensagem a ser exibida na janela.
• ERROR: Informa ao Qualitor que o mesmo deve exibir uma janela de “Erro”
com um botão de “OK” para o usuário clicar e cancelar o processo da operação. Pode
acompanhar uma mensagem a ser exibida.
• QUESTION: Informa ao Qualitor que o mesmo deve exibir uma janela de
“Pergunta”, com um botão de “Sim” e outro botão de “Não”. Se o usuário clicar em
“Sim”, irá continuar o processo, se o usuário clicar em “Não”, irá cancelar o processo.
Pode acompanhar uma mensagem a ser exibida na janela.
• CONTINUE: Apenas prossegue com a operação. Não há mensagem.
• POPUP: Exibe uma POPUP com uma URL especificada, após executar a
operação. Por exemplo, quando é necessário abrir uma página para preenchimento de
dados adicionais a serem alimentados em outros sistemas, sempre que um chamado
for aberto.
Na figura abaixo, temos um exemplo de retorno.
Para visualizá-lo, devemos abrir o arquivo PHP. A seguinte imagem será
exibida:
Cópia Oficial
página: 47 de 359
Detendo-se no código:
public function checkBeforeNewTicket($conn, $arrayData, $arrayInfo,
$idContext)
{
return array(‘txt’ => ‘O REGISTRO DO CHAMADO SERÁ EFETUADO...’, ‘flow’
=> ‘ok’);
}
É possível destacar que “checkBeforeNewTicket” corresponde à criação da
função “Before” para o registro de Chamados.
O código ($conn, $arrayData, $arrayInfo, $idContext), corresponde à área de
argumentos, padrão das funções de GTW do Qualitor.
A parte do código que diz respeito à “return”, é um comando que retorna uma
informação. Na função, estamos colocando um comando que irá retornar um “Array”
(Matriz) contendo as informações necessárias para o Qualitor. O Qualitor espera
receber uma Matriz das funções, contendo a seguinte estrutura:
Cópia Oficial
página: 48 de 359
O FLOW contém a identificação do retorno, para o Qualitor, informando qual
fluxo ele deve tomar, na sua execução, e o TXT contém a mensagem a ser utilizada
junto com este retorno.
O resultado final disso tudo no Qualitor é demonstrado no esquema a seguir:
1) Usuário clica no botão “Processar”.
2) O chamado então, não é aberto.
3) Uma mensagem é exibida, o que prova que o retorno do gateway está ok.
4) Após clicar no botão “Ok”, o chamado continuará a ser aberto.
O gateway para execução após a abertura de chamados é o seguinte:
/qualitor/gtw/modules/hd/GTWNewTicket.class.php
Os dois “momentos” ficam no mesmo arquivo de gateway.
Cópia Oficial
página: 49 de 359
Declaração do gateway para o momento “After” é igual ao momento “Before”.
<?php
class GTWNewTicket
{
function __construct()
{
;
}
$idContext)
{
return array(‘txt’ => ‘MENSAGEM A EXIBIR AO USUÁRIO!!’, ‘flow’ =>
‘ok’);
}
public function checkAfterNewTicket($conn, $arrayData, $arrayInfo,
$idContext)
{
return array(‘flow’ => ‘popup’, ‘url’ => ‘http://www.google.com’);
}
}
?>
Cópia Oficial
página: 50 de 359
Detendo-se no código:
public function checkAfterNewTicket($conn, $arrayData, $arrayInfo, $idContext)
{
return array(‘flow’ => ‘popup’, ‘url’ => ‘http://www.google.com’);
}
É possível destacar que “checkAfterNewTicket” corresponde à criação da
função “After” para o registro de Chamados.
O código ($conn, $arrayData, $arrayInfo, $idContext), corresponde à área de
argumentos, padrão das funções de GTW do Qualitor.
A parte do código que diz respeito à “return”, é um comando que retorna uma
informação. Na função, estamos colocando um comando que irá retornar um “Array”
(Matriz) contendo as informações necessárias para o Qualitor. O Qualitor espera
receber uma Matriz das funções, contendo a seguinte estrutura:
O FLOW contém a identificação do retorno, para o Qualitor, informando qual
fluxo ele deve tomar, na sua execução, e o URL contém o link a ser utilizado junto com
este retorno.
O resultado final disso tudo no Qualitor é demonstrado no esquema a seguir:
1) Usuário clica no botão “Processar”.
2) O chamado é aberto.
3) O retorno do gateway é a abertura de uma nova janela com o link.
Cópia Oficial
página: 51 de 359
Cópia Oficial
página: 52 de 359
CAPÍTULO 5 - GATILHOS PERSONALIZADOS
_________________________________________________________
Gatilhos Personalizados compõem o recurso que permite acionar sistemas legados a
partir do Qualitor. Por exemplo, na tela do chamado, habilitar uma opção para o atendente
acessar um outro sistema a partir do Qualitor.
5.1 VISÃO GERAL
O Qualitor executa em sistemas diferentes, possibilitando que clientes ou
revendas do Qualitor possam personalizar o comportamento do Qualitor em algumas
situações. Estabelecer uma forma de permitir que um programador ou integrador crie
uma interceptação dentro do Qualitor para realizar alguma operação em algum sistema
em um determinado momento com comando acionado no Qualitor. Exemplos:
• sempre que for aberto um chamado no Qualitor, abra um chamado em outra
aplicação de Help-Desk.
• Sempre que se abra um chamado com determinada categoria e determinado
tipo de chamado, no Qualitor, que se abra um registro de Problema em outro programa
de Gerenciamento de Problemas.
• Sempre que se abra um chamado no Qualitor, que seja gerado uma Ordem
se Seviço - O.S em outro aplicativo.
• Criar regras de exceção impedindo operações de serem realizadas se uma
determinada condição não for satisfeita. Ex: uma abertura de chamados somente será
possível para cliente que estiver com “situação fiscal regular” com a empresa X.
Em uma outra definição, os gatilhos são determinados “locais”, que da mesma
forma como os Webservices, devem estar documentados, ou seja, prédefinidos como
um espaço em que se possa inserir “funções” a serem utilizadas através do Qualitor.
Cópia Oficial
página: 53 de 359
Permitem que clientes realizem serviços que o Qualitor não realiza por si, em
outra aplicação ou dentro do próprio Qualitor. As funções devem ser desenvolvidas pelo
cliente, revenda ou integrador já que as funções não preexistem no Qualitor.
Ao contrário do Webservice que utiliza funções criadas e disponibilizadas pelo
Qualitor, nos arquivos WSDL, nos Gateways o Qualitor utilizará funções desenvolvidas
por terceiros de acordo com suas necessidades, mas respeitando os espaços
disponibilizados pelo Qualitor para determinados eventos (after/ before). Ou seja, um
evento/ função, somente poderá ser criada antes de se abrir um chamado, ou somente
depois de se encerrar um chamado.
NOTA: para se criar funções no Qualitor, deverá ser utilizada a mesma
linguagem em que o Qualitor foi desenvolvido, ou seja, em PHP. Por tanto é
necessário um conhecimento na linguagem PHP, para poder utilizar esse recurso por
completo.
5.2 O USO DE GATILHOS PERSONALIZADOS
O cenário a seguir ilustra uma situação mais específica: atendimento assinatura
de revistas. O usuário está utilizando o Qualitor, e a partir dele, pode acessar um
sistema externo, que irá realizar alguma operação ou atividade, com base nos dados
informados pelo Qualitor. O passo a passo desse tipo de processo seria:
1) Atendente abre um chamado
2) Atendente preenche ficha de cadastro financeiro do cliente no SAP
3) Atendente preenche ficha de assinatura de nova revista no sistema de
assinaturas
4) Atendente realizar o débito do cartão de crédito do cliente
5) Atendente encerra o chamado.
Cópia Oficial
página: 54 de 359
O benefício trazido pelo uso de gatilhos personalizados consiste no fato de que
o usuário não precisa sair do Qualitor para acessar outro sistema, navegar em suas
telas, até achar a informação que precisa, refletindo em automatização de processo.
Para habilitar esse recurso, utilize o menu: “Administração > Ferramentas >
Gatilhos Personalizados”.
O sistema irá exibir os gatilhos personalizados cadastrados. Para exibir o
cadastro de um gatilho específico, basta clicar no icone
:
Uma nova janela será exibida, conforme exemplo a seguir:
Cópia Oficial
página: 55 de 359
No cadastro de gatilhos personalizados, temos a opção de informar a URL de
destino, ou seja, a URL que possui a aplicação que será invocada pelo Qualitor.
Também podemos definir a forma que os dados serão transferidos do Qualitor
para a aplicação, através de GET ou POST.
5.2.1 Get e Post
GET e POST são formas de transferência de dados entre aplicações web.
Uma aplicação WEB é composta por páginas: vários arquivos que compõem
um site precisam conversar uns com os outros. A comunicação entre essas páginas é
feita através de um dos dois métodos citados.
Quando estamos no Qualitor, e acessamos o portal do Qualitor, uma página
WEB está mostrando uma informação: “Há 1 chamado em atendimento”.
Quando clicamos sobre o ícone
, outra página é acionada. Quando esta
página é acionada, o Qualitor passa informação para ela que o usuário quer ver os
seus chamados em atendimento.
Cópia Oficial
página: 56 de 359
5.2.1.1 Get
Quando acionamos uma página, e passamos para ela informações via GET
(exemplo abaixo), as informações são transferidas diretamente na URL que foi
acionada pelo gatilho personalizado:
No exemplo acima, a página “chamados.php” foi acionada, sendo que, para
ela, foi informado um valor “3” para um nome, chamado “situacao”.
Ou seja, a página “chamados.php”, na forma que foi desenvolvida, sabe que, se
receber um valor para “situacao”, deve exibir apenas os chamados com esta situação.
O ponto de interrogação “?” indica para a página que, a partir deste momento,
os próximos valores serão informações a serem passadas pelo método GET.
O método de transferência de dados via GET utiliza a própria URL de
acionamento, para passar as informações entre as páginas.
É possível passar vários valores, utilizando este método, por exemplo:
h t t p : / / s e r v i d o r / a p l i c a c a o /
pagina.php?usuario=claudio&empresa=constat&cadastro=998877
A página “pagina.php”, é executada, sabendo que:
USUARIO: claudio
EMPRESA: constat
CADASTRO: 998877
O “&” separa os valores do GET, quando são passados vários valores para a
página.
Cópia Oficial
página: 57 de 359
É bastante simples trabalhar com transferências de dados via método GET,
uma vez que o método torna a transferência e os dados visíveis para os usuários (isso
pode causar algumas discussões sobre segurança, porém, não é do escopo deste
treinamento conversar sobre isso), porém, a quantidade de informações transferidas
para uma página, via este método, é limitada. Cada browser possui sua limitação
(2000 caracteres, 3000 caracteres, etc...). Então, para transferência de grandes
quantidades de informações, em alguns momentos é mais seguro utilizar o método
POST. O método POST transfere os dados para o servidor WEB antes de chamar a
página. A transferência é feita “por baixo dos panos”, ou seja, visivelmente é mais
seguro, e a quantidade de informações sendo transferida é ilimitada.
O site do google foi acionado. O usuário clica para pesquisar o que deseja e
outra página é acionada, passando várias informações via GET.
Cópia Oficial
página: 58 de 359
5.2.1.2 Post
No caso do POST, a transferência das informações ocorre separadamente,
antes de chamar a página, para exibir os resultados relativos às informações passadas.
Os valores são passados antes, por exemplo:
usuario=claudio
empresa=constat
cadastro=998877
E a página é executada, sem maiores informações na URL:
http://servidor/aplicacao/pagina.php
A página “pagina.php”, é executada, sabendo que:
USUARIO: claudio
EMPRESA: constat
CADASTRO: 998877
Quando um gatilho personalizado é acionado, os dados são transferidos do
local de onde ele foi acionado. Por exemplo, se o gatilho for acionado a partir do
chamado, então, todos os dados possíveis de serem transferidos da tela do chamado,
serão, para o gatilho acionado.
Cópia Oficial
página: 59 de 359
O mesmo para documentos de base de conhecimento, mudanças, problemas,
etc.
5.2.2 Publicando e habilitando gatilhos personalizados
Agora que gatilho personalizado foi criado, informando seu nome, URL de
destino e seu método de transferência de dados, precisamos informar o local onde
este gatilho será publicado. Para isso, basta marcar o parâmetro correspondente ao
local, conforme exemplo a seguir:
Cópia Oficial
página: 60 de 359
Depois de publicados, precisamos definir quem terá acesso a esses gatilhos
personalizados. Este cadastro de permissões segue as mesmas regras de negócio
das demais definições de permissividade do Qualitor.
Antes de testar o gatilho publicado, verifica-se o que há na página de exemplo
que foi criada para este teste:
O arquivo acima mostra uma página, programada em PHP, que, quando é
acionada, direciona o seu acesso à outra URL. Ou seja, quando esta página é
chamada, a mesma irá executar o link em questão, exibido no código-fonte acima.
Cópia Oficial
página: 61 de 359
O usuário aciona um gatilho personalizado que chama a página
pesquisa_google.php. A página pesquisa_google.php chama o google, passando a
informação. Por fim, o usuário recebe o resultado da página. Na prática, os passos
são os seguintes:
• Passo 1: Preencher o chamado.
• Passo 2: Executar o gatilho personalizado.
O gatilho personalizado é exibido no menu “Ações” dos cadastros onde foi
publicado. No exemplo acima, podemos ver o gatilho “Pesquisar no GOOGLE”
publicado no menu “Ações” do chamado.
Se houvesse mais gatilhos publicados, todos estariam empilhados no menu,
abaixo de “Pesquisar no GOOGLE”.
Cópia Oficial
página: 62 de 359
• Passo 3: Ver o resultado.
O título informado no chamado dará origem à uma pesquisa no Google.
Cópia Oficial
página: 63 de 359
PARTE 2 - REGRAS DE NEGÓCIO
Cópia Oficial
página: 64 de 359
CAPÍTULO 6 - WEBSERVICES
___________________________________________
6.1 AUTENTICAÇÃO DE USUÁRIO
Os desenvolvedores deverão utilizar a autenticação do Webservice do Qualitor
para poder utilizar os recursos disponíveis. Este procedimento é realizado da seguinte
maneira:
- Efetuar Login com o usuário que possua permissão de uso de WebServices.
[CHAMADO: 65439]
- Após a validação do usuário o WS irá gerar uma chave de autenticação que
o cliente deverá utilizá-la para realizar as operações no Qualitor
A autenticação é realizada através do método Login(). Este método recebe
como argumentos o código da empresa, o usuário e a senha. Após a validação do
usuário, o método irá retornar a chave gerada.
Para realizar as operações do WS será necessário informar como argumento
a chave que foi gerada pelo método Login().
Ao acionar o WebService “Login”, é necessário informar, à ele, 3 argumentos:
-> EMPRESA: Código da empresa do usuário que está conectando
-> USUÁRIO: Login de rede, ou endereço de e-mail, do usuário.
-> SENHA: Senha do usuário
Cópia Oficial
página: 65 de 359
O WebService devolver para a aplicação uma string contendo o “token” de
autenticação. Esse token deverá ser utilizado junto com os demais WebServices sendo
utilizados, para informar ao Qualitor quem é que está solicitando.
Após a validação do usuário, o método irá retornar a chave gerada. Podemos
observar este procedimento na linha 7 da figura acima.
Para realizar as operações do WS será necessário informar como argumento
a chave que foi gerada pelo método Login(). Isto pode ser observado na linha 8 da
figura acima.
No caso da linguagem JAVA, é imprescindível que seja configurada a
persistência de sessão do cliente WebService (Aplicação Java).
6.1.1 Entrada de Dados
Ao trabalhar com uma camada WebService, é necessário observar alguns
padrões que esta camada possui. No caso do Qualitor, por exemplo, todas as entradas
de informações devem seguir o seguinte padrão:
<wsqualitor>
<contents>
<data>
... (demais dados de acordo com a respectiva classe sendo utilizada)
</data>
... (demais dados de acordo com a respectiva classe sendo utilizada)
</contents>
</wsqualitor>
Cópia Oficial
página: 66 de 359
Todo conteúdo TEXTO enviado nas tags XML para o WebService, devem ser
codificados no formato URLENCODE.
Os formatos de DATA devem ser transferidos e serão recebidos, no Qualitor,
sempre no formato:
YYYY-MM-DD HH:MM
Os formatos numéricos, devem utilizar PONTO como separador de “Decimais”,
no formato:
####.##
6.1.2 Saída de Dados
A saída para as classes do WebServices seguem o padrão:
<wsqualitor>
<response status>
<status>1</status>
Retorna 1 para OK ou 0 para ERRO
Se ocorrer erro na operação, o
código do erro será retornado
<msg></msg>
Mensagem de retorno da operação
</response status>
<response data>
<dataitem>
... (demais dados de acordo com a respectiva classe sendo
utilizada)
</dataitem>
</response data>
</wsqualitor>
Cópia Oficial
página: 67 de 359
Quando ocorrerem erros de exceção (erros de operação em banco de dados,
erros de código-fonte e demais erros genéricos), o Qualitor irá gravar os erros na
tabela ws_historico, no banco de dados, a fim de manter o registro dos erros que
ocorrem durante as operações de WebServices.
6.2 GERAÇÃO DE LOG PARA OS WEBSERVICES
O Qualitor disponibiliza uma ferramenta de geração de log de chamadas de
webservices. Nesse log, ficam gravados todos os acessos aos webservices do Qualitor,
assim como a resposta a todas essas requisições.
Abaixo demonstra-se os procedimentos a serem adotados para utilização
deste.
Cópia Oficial
página: 68 de 359
6.2.A WEBSERVICES DISPONÍVEIS NO QUALITOR
Os seguintes WebServices estão disponíveis para o Qualitor:
• WebService Inventory
WebService do módulo Inventário.
• WebService Tasks
WebService do módulo Meu Qualitor – Ações.
• WebService Meetings
WebService do módulo Meu Qualitor – Reuniões.
• WebService Tickets
WebService do módulo Meu Qualitor – Atendimento - Chamados.
• WebService General
WebService do módulo Meu Qualitor – Cadastros Gerais.
Cópia Oficial
página: 69 de 359
6.2.1 Webservice Task
Para utilizar qualquer operação de WebServices do Qualitor, é necessário
possuir licença para uso de WebServices, no Qualitor. As seguintes operações estão
disponíveis para o WebService Tasks.
6.2.1.1 Operação Add Task
Essa operação permite adicionar uma Ação na base do Qualitor. Permissão
necessária: Acesso ao menu “Nova ação”, nas permissões de usuário e grupo, do
Qualitor.

XML de entrada:
NOTA: Informações em vermelho são obrigatórias.
<wsqualitor>
<contents>
<data>
<nmtitulo>Title</nmtitulo>
<cdtipoacao>5</cdtipoacao>
<dtprevisaoinicio>1900-05-23 10:15</dtprevisaoinicio>
<dtprevisatermino>1900-05-23 12:00</dtprevisatermino>
<dsacao>Description...</dsacao>
<cdacaosuperior></cdacaosuperior>
<dsobjetivo>Goals Description...</dsobjetivo>
<vlcustoprevisto>0.00</vlcustoprevisto>
Assume 0,00 quando
não informado
Cópia Oficial
página: 70 de 359
<vlcustorealizado>0.00</vlcustorealizado> Assume
0,00
quando
não
informado
<idrestrito>N</idrestrito>
Assume “N” quando não
<idmelhoria>N</idmelhoria>
Assume “N” quando não
informado
informado
<dscausaproblema></dscausaproblema>
Obrigatório quando idmelhoria=Y
</data>
<depends>
<depends_on>6</depends_on>
</depends>
<attachments>
<attach name=”new_12.gif”>97W116xNWdsH </attach>
…
</attachments>
</contents>
</wsqualitor>
NOTA: A tag <attach> deverá conter o arquivo codificado utilizando
base64_encode.

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
Se ocorrer erro na operação, o código
do erro será retornado
Cópia Oficial
página: 71 de 359
<msg></msg>
</response status>
<response data>
<dataitem>
<cdacao>999</cdacao>
Código da ação criada
<cdsituacao>1</cdsituacao>
Status da ação criada
<dtacao>1900-01-13 11:42</dtacao> Data de criação da ação
</dataitem>
</response data>
</wsqualitor>
6.2.1.2 Operação Delete Task
Essa operação exclui uma ou mais Ações da base do Qualitor. Permissão
necessária: Acesso ao menu “Nova ação”, nas permissões de usuário e grupo, do
Qualitor.

XML de entrada:
(Informações em vermelho são obrigatórias)
<contents>
<data>
<cdacao>33</cdacao>
<cdacao>44</cdacao>
...
</data>
</contents>
</wsqualitor
Cópia Oficial
página: 72 de 359

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
</response status>
<response data>
<dataitem>
<cdacao>33</cdacao>
Retorna o código da ação
excluída
<dtacao>1900-01-13 11:42</dtacao>Retorna a data de exclusão
da ação
</dataitem>
<dataitem>
<cdacao>44</cdacao>
<dtacao>1900-01-13 11:42</dtacao>
</dataitem>
</response data>
</wsqualitor>
Nota: A exclusão é atômica, então, ou ela ocorre com sucesso em todos os
registros, ou, caso o Qualitor detecte algum problema de validação de regra de negócio
para excluir determinadas ações, o mesmo irá retornar erro sobre este, ou mais
problemas encontrados, e não irá proceder qualquer exclusão.
Cópia Oficial
página: 73 de 359
6.2.1.3 Operação Get Task
Essa operação retorna os dados de uma ou mais Ações da base do Qualitor.
Permissão necessária: Acesso ao menu “Nova ação”, nas permissões de usuário e
grupo do Qualitor.

XML de entrada:
<wsqualitor>
<contents>
<data>
</data>
</contents>
</wsqualitor

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
Cópia Oficial
página: 74 de 359
<msg></msg>
</response status>
<response data>
<dataitem>
<cdacao>33</cdacao>
Código da ação
<dtabertura>1900-01-13 11:42</dtabertura>
Data de registro
Empresa que registrou
<cdoperador>22</cdoperador>
Usuário que registrou
Situação da ação
<dtprevisaoinicio></dtprevisaoinicio>
Data de previsão de
início
<dtinicio>1900-01-13 11:43</dtinicio>
Data de início da
<dtprevisaotermino></dtprevisaotermino>
Data de previsão
ação
de término
<dttermino></dttermino>
Data de término
<dstitulo></dttermino>
Título da ação
<dsacao></dttermino>
Descrição da ação
<idrestrito></idrestrito>
Ação restrita (“Y”, “N”)
<idmelhoria>N</idmelhoria>
Melhoria (“Y”, “N”)
<dscausaproblema></dscausaproblema>
<vlcustoprevisto>0,00</vlcustoprevisto>
Disposição
Custo previsto
<vlcustorealizado>0,00</vlcustorealizado>
Custo realizado
<dsobjetivo>Goals...</dsobjetivo>
Objetivo
<depends>
Ações
que
dependem
do
encerramento desta.
<cdacao>44</cdacao>
<cdacao>55</cdacao>
</depends>
<cdacaosuperior>22</ cdacaosuperior>
Cópia Oficial
Ação pendente à esta
página: 75 de 359
</dataitem>
<dataitem>
...
</dataitem>
</response data>
</wsqualitor>
6.2.1.4 Operação Get Task History
Essa operação retorna os dados do histórico de uma Ação da base do
Qualitor. Permissão necessária: Acesso ao menu “Nova ação”, nas permissões de
usuário e grupo, do Qualitor.

XML de entrada:
<wsqualitor>
<contents>
<data>
</data>
</contents>
</wsqualitor>
Cópia Oficial
página: 76 de 359

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
</response status>
<response data>
<dataitem>
<cdacao>33</cdacao>
Código da ação
<nrsequencia>1</nrsequencia>
Valor sequencial
<cdresponsavel>1</cdresponsavel>
Código do responsável
<nmresponsavel>22</nmresponsavel >
Nome
do
<dthistorico>1900-01-13 11:43</dthistorico>
Data de registro
responsável
<dsregistro></dsregistro>
Descrição do registro
</dataitem>
<dataitem>
...
</dataitem>
</response data>
</wsqualitor>
Cópia Oficial
página: 77 de 359
6.2.1.5 Operação Get Task Attachments
A operação “getTaskAttachments” retorna os anexos de uma Ação da base do
Qualitor. Permissão necessária: Acesso ao menu “Nova ação”, nas permissões de
usuário e grupo, do Qualitor.

XML de entrada:
<wsqualitor>
<contents>
<data>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
Cópia Oficial
página: 78 de 359
</response status>
<response data>
<dataitem>
<cdacao>33</cdacao>
Código da ação
Valor sequencial
<nmarquivol> new_12.gif</nmarquivo >
<attach>97W116xNWdsH </ attach>
Nome do arquivo
Conteúdo do arquivo
</dataitem>
<dataitem>
...
</dataitem>
</response data>
</wsqualitor>
NOTA: A tag <attach> contém o conteúdo do arquivo que foi codificado
utilizando base64_encode. Para transformar esta string em bytes[] basta realizar a
operação inversa base64_decode.
6.2.1.6 Operação Add Task Responsable
Essa operação adiciona responsáveis a uma Ação da base do Qualitor.
Permissão necessária: acesso ao menu “Nova ação”, nas permissões de usuário e
grupo do Qualitor.

XML de entrada:
Cópia Oficial
página: 79 de 359
<wsqualitor>
<contents>
<data>
<responsable>
....
</responsable>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
</response status>
<response data></response data>
</wsqualitor>
Cópia Oficial
página: 80 de 359
6.2.1.7 Operação Add Task Attachments
Essa operação adiciona anexos a uma Ação da base do Qualitor. Permissão
necessária: Acesso ao menu “Nova ação”, nas permissões de usuário e grupo do
Qualitor.

XML de entrada:
<wsqualitor>
<contents>
<data>
<attachments>
<attach name=”new_12.gif”>XwSxzXreDFCZX</attach>
….
</attachments>
</data>
</contents>
</wsqualitor>
NOTA: A tag <attach> deverá conter o arquivo codificado utilizando
base64_encode.
Cópia Oficial
página: 81 de 359

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
</response status>
<response data></response data>
</wsqualitor>
6.2.1.8 Operação Add Task History
Essa operação adiciona dados ao histórico de uma Ação da base do Qualitor.
Permissão necessária: Acesso ao menu “Nova ação”, nas permissões de usuário e
grupo do Qualitor.

XML de entrada:
<wsqualitor>
<contents>
<data>
<dsregistro>texto</dsregistro>
</data>
</contents>
</wsqualitor>
Cópia Oficial
página: 82 de 359

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<error_code></error_code> Se ocorrer erro na operação, o código do erro
será retornado
<msg></msg>
</response status>
<response_data>
<dataitem>
<dthistorico>yyyy-mm-dd</dthistorico>
<dsregistro>text</dsregistro>
</dataitem>
</response_data>
</wsqualitor>
6.2.1.9 Operação Extend Task
Essa operação prorroga uma Ação da base do Qualitor. Permissão
Qualitor.
Cópia Oficial
página: 83 de 359

XML de entrada:
<wsqualitor>
<contents>
<data>
<dtprevisaoinicio> yyyy-mm-dd hh:mm</dtprevisaoinicio>
<dtprevisaotermino> yyyy-mm-dd hh:mm</dtprevisaotermino>
<cdmotivoprorrogacaoacao>3</cdmotivoprorrogacaoacao>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
</response status>
<response_data></response_data>
</wsqualitor>
Cópia Oficial
página: 84 de 359
6.2.1.10 Operação Cancel Task
Essa operação cancela uma Ação da base do Qualitor. Permissão
Qualitor.

XML de entrada:
<wsqualitor>
<contents>
<data>
<idreply>Y</ idreply>
</data>
</contents>
</wsqualitor>
NOTA: <idreply>Y</ idreply>
O valor pode ser Y ou N (default). Se for Y, cancela as ações que são
dependentes dessa. Se for N, cancela apenas a ação informada.
Cópia Oficial
página: 85 de 359

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
</response status>
</wsqualitor>
6.2.1.11 Operação Start Task
Essa operação inicia uma Ação da base do Qualitor. Permissão necessária:
Acesso ao menu “Nova ação”, nas permissões de usuário e grupo do Qualitor.

XML de entrada:
Cópia Oficial
página: 86 de 359
<wsqualitor>
<contents>
<data>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
</response status>
</wsqualitor>
Cópia Oficial
página: 87 de 359
6.2.2 Webservice Ticket
possuir licença para uso de WebServices, no Qualitor. Para utilizar o WebService
Tickets, a licença do Qualitor deve contemplar o módulo de ATENDIMENTO. As
seguintes operações estão disponíveis para o WebService Tickets:
6.2.2.1 Operação addTicketByData
Abre um chamado na base do Qualitor. Essa operação irá abrir um chamado
no Qualitor, sendo passado por parâmetro todos os valores necessários para abertura
de um novo chamado. Permissão necessária: Acesso ao menu “Novo chamado”, nas
permissões de usuário e grupo, do Qualitor.

XML de entrada:
<wsqualitor>
<contents>
<data>
<cdcliente>A120</cdcliente>
<cdcontato>2</cdcontato>
<idchamado>1</idchamado>
<nmtitulochamado>Title</nmtitulochamado>
<cdtipochamado>5</cdtipochamado>
<cdcategoria>32</cdcategoria>
<cdlocalidade>4</cdlocalidade>
Cópia Oficial
página: 88 de 359
<cdseveridade>2</cdseveridade>
<dschamado>texto</dschamado>
<dspalavrachave></dspalavrachave>
<cdorigem></cdorigem>
<cdcomplexidade></cdcomplexidade>
<cdanimo></cdanimo>
<idfca></idfca>
<faturamento>
<idtipofaturamento>2</idtipofaturamento>
<avulso>
<vlabertura>250.00</vlabertura>
<vlhora>67.00</vlhora>
</avulso>
<contrato>
<cdcontrato>45</cdcontrato>
<nrhorasconsumidas>22:00</nrhorasconsumidas>
</contrato>
<pacote>
<dataitem>
<nrdias></nrdias>
<vlparcela></vlparcela>
<dssituacao></dssituacao>
</dataitem>
... +
</pacote>
</faturamento>
<vlcustoprevisto>0.00</vlcustoprevisto>
Assume 0,00 quando
não informado
<vlcustorealizado>0.00</vlcustorealizado> Assume 0,00 quando
não informado
Cópia Oficial
página: 89 de 359
<cdperfilchamado></cdperfilchamado>
<cddocumento></cddocumento>
<cdchamadosuperior></cdchamadosuperior>
<idprontoatendimento></idprontoatendimento>
<cdprojeto></cdprojeto>
<cdfase></cdfase>
<cdproblema></cdproblema>
<produto>
<cdproduto></cdproduto>
<dtnotafiscal></dtnotafiscal>
<dtfabricacao></dtfabricacao>
<dtvalidade></dtvalidade>
</produto>
<cdequipamento></cdequipamento>
</data>
<depends>
<depends_on>6</depends_on>
</depends>
<attachments>
Ver addAttachment
</attachments>
<informacoesadicionais>
<vlinformacaoadicional1>3</vlinformacaoadicional1>
....
</informacoesadicionais>
</contents>
</wsqualitor>
Cópia Oficial
página: 90 de 359

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
</response status>
<response data>
<dataitem>
<cdchamado>999</cdchamado>
Códigodo chamado
Situação do chamado
<nmsituacao>atendimento</nmsituacao>
Nome da situação
<dtchamado>1900-01-13 11:42</dtchamado>
Data de criação
</dataitem>
</response data>
<wsqualitor>
6.2.2.2 Operação startTicket
Essa operação Inicializa o atendimento de um chamado.

XML de entrada:
Cópia Oficial
página: 91 de 359
<wsqualitor>
<contents>
<data>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
</response status>
<response data>
<dataitem>
<dtoperacao>2009-05-14 15:13:27</dtoperacao>
</dataitem>
</response data>
</wsqualitor>
Cópia Oficial
página: 92 de 359
6.2.2.3 Operação addTicketByTemplate
Essa operação abre um chamado através de um perfil.

XML de entrada:
<wsqualitor>
<contents>
<data>
<cdperfilchamado>59</cdperfilchamado>
<dschamado></dschamado>
</data>
<vlinformacaoadicional4>0.002020101</vlinformacaoadicional4>
</contents>
</wsqualitor>
Cópia Oficial
página: 93 de 359

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
</response status>
<response data>
<dataitem>
Código do chamado
Nome da situação
Data de criação
</dataitem>
</response data>
</wsqualitor>
6.2.2.4 Operação sendTicketVerification
Essa operação envia um chamado para verificação.

XML de entrada:
Cópia Oficial
página: 94 de 359
<wsqualitor>
<contents>
<data>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
</response status>
<response data>
<dataitem>
</dataitem>
</response data>
</wsqualitor>
Cópia Oficial
página: 95 de 359
6.2.2.5 Operação closeTicket
Essa operação encerra um chamado.

XML de entrada:
<wsqualitor>
<contents>
<data>
<idfecharrelacionados>Y</idfecharrelacionados> Y – sim e N - não
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
</response status>
<response data>
Cópia Oficial
página: 96 de 359
<dataitem>
</dataitem>
</response data>
</wsqualitor>
6.2.2.6 Operação extendTicket
Essa operação prorroga um chamado.

XML de entrada: (Informações em vermelho são obrigatórias)
<wsqualitor>
<contents>
<data>
<cdmotivoprorrogado>1</cdmotivoprorrogado>
<dtlimiteatendimentoprorrogacao>2009-01-12</
dtlimiteatendimentoprorrogacao>
<dtprorrogacao>2009-01-02 22:12</dtprorrogacao>
</data>
</contents>
</wsqualitor>
NOTA: O campo dtlimiteatendimentoprorrogacao possui o formato yyyy-mm-dd
(não tem a hora).
Cópia Oficial
página: 97 de 359

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
</response status>
<response data>
<dataitem>
</dataitem>
</response data>
</wsqualitor>
6.2.2.7 Operação sendTicketThirdPartner
Essa operação encaminha chamado para terceiro.

<wsqualitor>
<contents>
<data>
Cópia Oficial
página: 98 de 359
<cdfornecedor></cdfornecedor>
<cdassistenciatecnica></cdassistenciatecnica>
<dsterceiro>f fgrgreg reg4 erhg45g r5</dsterceiro>
<dtprevisaoretorno>2009-10-20 12:12</dtprevisaoretorno>
</data>
</contents>
</wsqualitor>
NOTA: Deverá ser informado o cdfornecedor ou o cdassistenciatecnica.

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
</response status>
<response data>
<dataitem>
</dataitem>
</response data>
</wsqualitor>
Cópia Oficial
página: 99 de 359
6.2.2.8 Operação receiveTicketThirdPartner
Essa operação retorna o chamado de terceiro.

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
</response status>
<response data>
<dataitem>
Cópia Oficial
página: 100 de 359
</dataitem>
</response data>
</wsqualitor>
6.2.2.9 Operação openSubTicket
Essa operação abre um sub-chamado.

<wsqualitor>
<contents>
<data>
<cdchamadosuperior>1008</cdchamadosuperior>
<cdecliente></cdecliente>
<cdcontato></cdcontato>
<cdequipamento></cdequipamento>
<cdtipochamado></cdtipochamado>
<cdlocalidade></cdlocalidade>
<cdseveridade></cdseveridade>
<cdcategoria1></cdcategoria1>
<cdcategoria></cdcategoria>
<cdcomplexidade></cdcomplexidade>
<cdanimo></cdanimo>
<cdorigem></cdorigem>
Cópia Oficial
página: 101 de 359
<nmtitulochamado></nmtitulochamado>
<dschamado></dschamado>
<vlinformacaoadicional1></vlinformacaoadicional1>
....
</data>
</contents>
</wsqualitor>
NOTA: O sub-chamado possuirá as mesmas configurações do chamado
superior. Contanto, se algum valor não obrigatório for informado, este terá preferência e
irá sobrepor o valor do chamado superior.

XML de retorno:
O XML de retorno é o mesmo retornado pela operação addTicketByTemplate.
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
</response status>
<response data>
<dataitem>
Código do chamado
Cópia Oficial
página: 102 de 359
Nome da situação
Data de criação
</dataitem>
</response data>
</wsqualitor>
6.2.2.10 Operação suspendTicket
Essa operação suspende um chamado.

XML de entrada:
<wsqualitor>
<contents>
<data>
<cdmotivosuspenso>1</cdmotivosuspenso>
</data>
</contents>
</wsqualitor>
Cópia Oficial
página: 103 de 359

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
</response status>
<response data>
<dataitem>
</dataitem>
</response data>
</wsqualitor>
6.2.2.11 Operação captureTicket
Essa operação captura um chamado.

XML de entrada:
Cópia Oficial
página: 104 de 359
<wsqualitor>
<contents>
<data>
<cdresponsavel></cdresponsavel>
</data>
</contents>
</wsqualitor>
NOTA: Se o cdresponsavel não for informado, o Qualitor irá buscar o código do
usuário logado no WS.

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
</response status>
<response data>
<dataitem>
</dataitem>
</response data>
</wsqualitor>
Cópia Oficial
página: 105 de 359
6.2.2.12 Operação addTicketHistory
Adiciona um registro no chamado.

XML de entrada:
<wsqualitor>
<contents>
<data>
<cdtipoacompanhamento>10</cdtipoacompanhamento>
<dsacompanhamento>teste 43</dsacompanhamento>
<idprivado></idprivado>
Y – sim, N – não, default N
<idsolucao></idsolucao>
Y – sim, N – não, default N
<fgabonado></fgabonado>
1 – sim, 0 – não, default 0
<hrduracao></hrduracao>
<hrprevisaohoras></hrprevisaohoras>
default 000:00
default 00:00
<dsacaocorretiva></dsacaocorretiva>
<dtinicioacompanhamento></dtinicioacompanhamento>
yyy-mm-dd
<dtterminoacompanhamento></dtterminoacompanhamento>
yyy-mm-dd
hh:mm
hh:mm
</data>
</contents>
</wsqualitor>
Cópia Oficial
página: 106 de 359

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
</response status>
<response data>
<dataitem>
</dataitem>
</response data>
</wsqualitor>
6.2.2.13 Operação transferTicketResponsible
Altera o responsável do chamado.

XML de entrada:
Cópia Oficial
página: 107 de 359
<wsqualitor>
<contents>
<data>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
</response status>
<response data>
<dataitem>
</dataitem>
</response data>
</wsqualitor>
Cópia Oficial
página: 108 de 359
6.2.2.14 Operação transferTicketTeam
Essa operação altera a equipe do chamado.

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
</response status>
<response data>
Cópia Oficial
página: 109 de 359
<dataitem>
</dataitem>
</response data>
</wsqualitor>
6.2.2.15 Operação generateTicketExpense
Essa operação gerar despesas do chamado

XML de entrada:
<wsqualitor>
<contents>
<data>
<dtcadastro>2009-02-25</dtcadastro>
<nrdistanciakm>76</nrdistanciakm>
<vlvalorkm>7</vlvalorkm>
<nrdistanciakmcliente>7</nrdistanciakmcliente>
<vladiantamento>7</vladiantamento>
</data>
</contents>
</wsqualitor>
Cópia Oficial
página: 110 de 359

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
</response status>
<response data>
<dataitem>
<cdacompanhamento>60</cdacompanhamento>
<cdusuario>8</cdusuario>
<idfaturadespesa>N</idfaturadespesa>
<cdusuarioaprovado></cdusuarioaprovado>
<cdusuariopago></cdusuariopago>
<idpermissao>Y</idpermissao>
<cdcategoriachamado>4</cdcategoriachamado>
<dtcadastro> 2009-02-25</dtcadastro>
<dtaprovado></dtaprovado>
<dtpago></dtpago>
<nmusuariopagamento></nmusuariopagamento>
<nmempresa>CONSTAT CAXIAS</nmempresa>
<nmusuario>Inacio Klassmann</nmusuario>
Cópia Oficial
página: 111 de 359
<dsobservacao> </dsobservacao>
<nmusuarioaprovacao></nmusuarioaprovacao>
<vlvalorkm>7,00</vlvalorkm>
<vldespesakm>0,00</vldespesakm>
<vldespesakm2>532,00</vldespesakm2>
<vladiantamento>7,00</vladiantamento>
<vltotaldespesa>0,00</vltotaldespesa>
<vltotal>525,00</vltotal>
</dataitem>
</response data>
</wsqualitor>
6.2.2.16 Operação addTicketExpenseItem
Adiciona um item de despesa ao chamado.

<wsqualitor>
<contents>
<data>
<cdtipodespesa>2</cdtipodespesa>
<vldespesa>7</vldespesa>
</data>
</contents>
</wsqualitor>
Cópia Oficial
página: 112 de 359

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
</response status>
<response data>
<dataitem>
<idfaturadespesa>Y</idfaturadespesa>
<cdusuarioaprovado></cdusuarioaprovado>
<cdusuariopago></cdusuariopago>
<idpermissao>Y</idpermissao>
<cdcategoriachamado>4</cdcategoriachamado>
<dtcadastro>25/02/2009</dtcadastro>
<dtaprovado></dtaprovado>
<dtpago></dtpago>
<nmusuariopagamento></nmusuariopagamento>
Cópia Oficial
página: 113 de 359
<dsobservacao>dfv fdv34v</dsobservacao>
<nmusuarioaprovacao></nmusuarioaprovacao>
<vlvalorkm>7,00</vlvalorkm>
<vldespesakm>0,00</vldespesakm>
<vldespesakm2>532,00</vldespesakm2>
<vladiantamento>7,00</vladiantamento>
<vltotaldespesa>19,00</vltotaldespesa>
<vltotal>544,00</vltotal>
</dataitem>
</response data>
</wsqualitor>
6.2.2.17 Operação deleteTicketExpenseItem
Essa operação remove um item de despesa do chamado.

XML de entrada:
<wsqualitor>
<contents>
<data>
<nrordem>2</nrordem>
</data>
</contents>
</wsqualitor>
Cópia Oficial
página: 114 de 359

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
</response status>
<response data>
<dataitem>
<nrordem>2</nrordem>
</dataitem>
</response data>
</wsqualitor>
6.2.2.18 Operação highLightTicket
Essa operação coloca ou remove um chamado em destaque.

XML de entrada:
Cópia Oficial
página: 115 de 359

<wsqualitor>
<contents>
<data>
<iddestaque>Y</iddestaque>
Y – coloca em destaque, N – remove
destaque
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
</response status>
<response data>
<dataitem>
</dataitem>
</response data>
</wsqualitor>
Cópia Oficial
página: 116 de 359
6.2.2.19 Operação changeTicketSeverity
Altera a severidade do chamado

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
</response status>
<response data>
<dataitem>
Cópia Oficial
página: 117 de 359
</dataitem>
</response data>
</wsqualitor>
6.2.2.20 Operação changeTicketCategory
Essa operação altera a categoria do chamado

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
Cópia Oficial
página: 118 de 359
<msg></msg>
</response status>
<response data>
<dataitem>
</dataitem>
</response data>
</wsqualitor>
6.2.2.21 Operação changeTicketOpeningData
Essa operação altera os dados de abertura do chamado.

<wsqualitor>
<contents>
<data>
<cdmotivoalteracao>4</cdmotivoalteracao>
<dtabertura>2009-06-12 12:34</dtabertura>
</data>
</contents>
</wsqualitor>
Cópia Oficial
página: 119 de 359
NOTA: Somente os campos informados serão alterados, os demais
permanecerão iguais.

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
</response status>
<response data>
<dataitem>
</dataitem>
</response data>
</wsqualitor>
6.2.2.22 Operação getTicketTemplate
Essa operação retorna a lista de perfis de chamado.

<wsqualitor>
<contents>
Cópia Oficial
página: 120 de 359
<data>
<nmperfilchamdao>perfil 1</nmperfilchamdo>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
</response status>
<response data>
<dataitem>
<nmperfilchamado>Perfil com informação adicional</nmperfilchamado>
</dataitem>
<dataitem>
<nmperfilchamado>Perfil com informação adicional (digitável)</
nmperfilchamado>
</dataitem>
........
</response data>
</wsqualitor>
Cópia Oficial
página: 121 de 359
6.2.2.23 Operação getTicketTemplateData
Essa operação retorna os dados de um perfil de chamado.

XML de entrada:
<wsqualitor>
<contents>
<data>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
</response status>
<response data>
<dataitem>
Cópia Oficial
página: 122 de 359
<cdequipamento>1</cdequipamento>
<idagendado>1</idagendado>
<nrperiodicidadedias>1</nrperiodicidadedias>
<idsla>0</idsla>
<nrtemporesposta></nrtemporesposta>
<nrtemposervico></nrtemposervico>
<idtipoperiodo>D</idtipoperiodo>
<idsemseg>0</idsemseg>
<idsemter>0</idsemter>
<idsemqua>0</idsemqua>
<idsemqui>0</idsemqui>
<idsemsex>0</idsemsex>
<nrdiames></nrdiames>
<idmesjan>0</idmesjan>
<idmesfev>0</idmesfev>
<idmesmar>0</idmesmar>
<idmesabr>0</idmesabr>
<idmesmai>0</idmesmai>
<idmesjun>0</idmesjun>
<idmesjul>0</idmesjul>
<idmesago>0</idmesago>
<idmesset>1</idmesset>
Cópia Oficial
página: 123 de 359
<idmesout>0</idmesout>
<idmesnov>0</idmesnov><idmesout>0</idmesout>
<idmesnov>0</idmesnov>
<idmesdez>0</idmesdez>
<idsemsab>0</idsemsab>
<idsemdom>0</idsemdom>
<cdresponsavel></cdresponsavel>
<cdcategoria1>5</cdcategoria1>
<idweb>Y</idweb>
<cdcomplexidade>3</cdcomplexidade>
<cdanimo>2</cdanimo>
<cdorigem>1</cdorigem>
<nmresponsavel></nmresponsavel>
<nmequipamento>TESTE</nmequipamento>
<nmperfilchamado>Perfil com informação adicional</nmperfilchamado>
<nmcliente>CONSTAT CAXIAS</nmcliente>
<nmcontato>Donald Reis</nmcontato>
<nmtitulochamado>TÍTULO</nmtitulochamado>
<dschamado>PERFIL DE CHAMADO</dschamado>
<dspalavrachave>TESTE</dspalavrachave>
<nmusuario>Marcos Vinicius Fofonka</nmusuario>
<dsacompanhamento>TESTE</dsacompanhamento>
<dtultchamadoaberto>01/01/1900</dtultchamadoaberto>
<nrhorarioinicial>13/11/2008</nrhorarioinicial>
<nrhorarioinicial>10:45</nrhorarioinicial>
<nrduracaoacompanhamento>05:25</nrduracaoacompanhamento>
Cópia Oficial
página: 124 de 359
<nrprevisaohoras>00:00</nrprevisaohoras>
<vlprevisaocusto>0,00</vlprevisaocusto>
</dataitem>
</response data>
</wsqualitor>
6.2.2.24 Operação addTicketComponent
Essa operação adiciona componente ao chamado. Esta operação será possível
somente se o chamado for de equipamento.

<wsqualitor>
<contents>
<data>
<cdcomponente>1</cdcomponente>
<vlcomponente></vlcomponente>
<nrquantidade></nrquantidade>
<dsobservacao></dsobservacao>
</data>
</contents>
</wsqualitor>
Cópia Oficial
página: 125 de 359

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
</response status>
<response data>
<dataitem>
</dataitem>
</response data>
</wsqualitor>
6.2.2.25 Operação addTicketSoftware
Adiciona software ao chamado. Esta operação será possível somente se o
chamado for de equipamento.

<wsqualitor>
<contents>
Cópia Oficial
página: 126 de 359
<data>
<cdsoftware>4</cdsoftware>
<vlsoftware></vlsoftware>
<nrversao></nrversao>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
</response status>
<response data>
<dataitem>
</dataitem>
</response data>
</wsqualitor>
Cópia Oficial
página: 127 de 359
6.2.2.26 Operação addTicketAdditionalContact
Essa operação vincula contatos adicionais ao chamado.

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
Cópia Oficial
página: 128 de 359
</response status>
<response data>
<dataitem>
</dataitem>
</response data>
</wsqualitor>
6.2.2.27 Operação getTicketHistoryData
Retorna a lista de acompanhamentos do chamado.

XML de entrada:
<wsqualitor>
<contents>
<data>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
Cópia Oficial
página: 129 de 359
<response status>
<status>1</status>
<msg></msg>
</response status>
<response data>
<dataitem>
<nmtipoacompanhamento></nmtipoacompanhamento>
<dsacompanhamento>Dados de abertura alterados</dsacompanhamento>
<nmusuario>Operador 12</nmusuario>
<dtacompanhamento>2009-06-03 11:48</dtacompanhamento>
<idsolicitante>N</idsolicitante>
<idemail>60</idemail>
<idsolucao>N</idsolucao>
<idprivado>Y</idprivado>
<nmsubsituacao>Aguardando analise</nmsubsituacao>
<nriteracao>1</nriteracao>
<dtinicioacompanhamento>2009-06-03 11:48</dtinicioacompanhamento>
<dtterminoacompanhamento>2009-06-03 11:48</dtterminoacompanhamento>
<nrduracao>10:00</nrduracao>
</dataitem>
.........
</response data>
</wsqualitor>
Cópia Oficial
página: 130 de 359
6.2.2.28 Operação changeTicketAdditionalInfo
Altera as informações adicionais do chamado.

XML de entrada:
<wsqualitor>
<contents>
<data>
<vlinformacaoadicional9>3.2</vlinformacaoadicional9>
........
</data>
</contents>
</wsqualitor>
NOTA: para apagar o valor de uma informação adicional do chamado é
necessário colocar a string ‘(NULL)’ na tag desejada. EX:
<vlinformacaoadicional9>(NULL)</vlinformacaoadicional9>
Cópia Oficial
página: 131 de 359

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
</response status>
<response data>
<dataitem>
</dataitem>
</response data>
</wsqualitor>
6.2.2.29 Operação approveTicket
Altera as informações adicionais do chamado.

<wsqualitor>
<contents>
<data>
Cópia Oficial
página: 132 de 359
<dsaprovacao>aprovado</dsaprovacao>
<cdpersonagem></cdpersonagem>
<cdaprovador></cdaprovador>
</data>
</contents>
</wsqualitor>
NOTA: se não for definido um próximo aprovador, o chamado irá para a
situação “Aguardando atendimento”, caso contrário, permanecerá em “Aguardando
aprovação”.

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
</response status>
<response data>
<dataitem>
</dataitem>
</response data>
</wsqualitor>
Cópia Oficial
página: 133 de 359
6.2.2.30 Operação cancelTicket
Essa operação cancela um chamado.

XML de entrada:
<wsqualitor>
<contents>
<data>
<dsacompanhamento>aprovado</dsacompanhamento>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
</response status>
<response data>
<dataitem>
Cópia Oficial
página: 134 de 359
</dataitem>
</response data>
</wsqualitor>
6.2.2.31 Operação updateTicketCause
Essa operação altera a causa de um chamado.

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
Cópia Oficial
página: 135 de 359
será retornado
<msg></msg>
</response status>
<response data>
<dataitem>
</dataitem>
</response data>
</wsqualitor>
6.2.2.32 Operação addAttachment
Adiciona um anexo ao chamado.

<wsqualitor>
<contents>
<data>
<nmanexo>logo_qualitor.jpg</nmanexo>
<idprivado>Y</idprivado>
<attachment>/9j/4AAQSkZJRgABAgAAZABkAAD/
7 A A R R H V j a 3 k A A Q A E A A A A PA A A / + 4 A D k F k b 2 J l A G TA A A A A A f /
bAIQABgQEBAUEBgUFBgkGBQYJCwgGBggLDAoKCwoKDBAMDAwMDAwQDA4PEA8ODBMTFBQTE
xwbGxscHx8fHx8fHx8fHwEHBwcNDA0YEBAYGhURFRof</attachment>
Cópia Oficial
página: 136 de 359
</data>
</contents>
</wsqualitor>
NOTA: No Qualitor 5.20 não é necessário informar a tag <idprivado> será
descartada, e a tag <attachment> deverá conter o arquivo codificado utilizando
base64_encode.

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
</response status>
<response data>
<dataitem>
</dataitem>
</response data>
</wsqualitor>
Cópia Oficial
página: 137 de 359
6.2.2.33 Operação getTicket
Essa operação realiza a busca de chamados. Os filtros de pesquisa seguem
abaixo:
· cdsituacao: código da situação do chamado.
· nmsituacao: nome da situação do chamado.
· dtperiodo e dtperiodo2: intervalo de datas (deve ser utilizado em conjunto
com o filtro idtipoperiodo).
· Idtipoperiodo: indica qual período de datas que será filtrado. Os possíveis
valores são:
1- data de abertura.
2- data de término.
3- data de previsão de resposta.
4- data de previsão de término.
· dschamado: texto da descrição do chamado.
· nmtitulochamado: texto do título do chamado.
· dspalavrachave: texto da palavra-chave.
· nmcategoriacompleta: texto da categoria completa do chamado.
· nmequipe: texto da equipe do responsável.
· nmtipochamado: texto do tipo de chamado.
· nmlocalidade: texto da localidade do chamado.
· nmseveridade: texto da severidade do chamado.
· nmoperador: nome do operador do chamado.
· nmresponsavel: nome do responsável do chamado.
· nmcliente: nome do cliente do chamado.
· nmcontato: nome do contato do chamado.
· Busca por informação adicional: filtro por informação adicional do
chamado.
EX: <informacao codigo=”3" operador=”3">200</informacao>
Cópia Oficial
página: 138 de 359
Caso o atributo operador não seja informado, o valor default será 1. Os
possíveis valores poderão ser:
1 – operador igual (=).
2 – operador maior ou igual (>=).
3 – operador menor ou igual (<=).
Se o tipo da informação adicional for texto será utilizado o LIKE do SQL para
realizar o filtro.
· Busca por códigos em geral: os campos apresentados abaixo filtram
chamados possibilitando informar múltiplos registros de um único campo. Esses
registros devem ser informados com o separador ‘vírgula’. EX: <cdlocalidade>34, 56,
78</cdlocalidade>.
Campos de múltiplo registro: cdlocalidade, cdorigem, cdtipochamado,
cdresponsavel, cdcomplexidade, cdseveridade, cdequipe, cddepartamento,
cdtipoequipe,
cdcategoria,
cdcliente,
cdusuario,
cdequipamento,
cdequiperesponsavel, cdchamado.

XML de entrada:
<wsqualitor>
<contents>
<data>
<nmtitulochamado>problemas</nmtitulochamado>
</data>
</contents>
</wsqualitor>
Cópia Oficial
página: 139 de 359

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
</response status>
<response data>
<dataitem>
<nmtitulochamado>problemas de login</nmtitulochamado>
<nmsituacao>Aguardando atendimento</nmsituacao>
</dataitem>
</response data>
</wsqualitor>
6.2.2.34 Operação getTicketData
Busca as informações de apenas um chamado. Os campos padrão de retorno
do WebService são: cdchamado, nmtitulochamado, nmsituacao, nmtipochamado,
nmcategoriacompleta, nmequipe, dspalavrachave, dschamado, nmlocalidade,
nmseveridade, nmoperador, nmresponsavel, nmcliente, nmcontato.
No XML de entrada é possível informar os campos que deverão ser
retornados pelo WebService, segue a lista de campos disponíveis além dos citados
acima:
Cópia Oficial
página: 140 de 359
dtchamado, dtprevisaoresposta, dtresposta, dtprevisaotermino, dttermino,
dtlimiteatendimento, dataultimoacompanhamento, dtfabricacao, dtvalidade,
dtnotafiscal, dtlimiteespecificacao, nrtemporesposta, nrtempototal, nrtotalhoras,
nrduracaochamado,
nrprevisaohoras,
nrhorasrestantes,
vlservicos,
vlcustomaodeobra, vlcustoequipamento, cdchamado, cdchamadosuperior,
dtchamado, dtprevisaotermino, dttermino, dtprevisaoresposta, dtresposta,
dataultimoacompanhamento, dtlimiteatendimento, dtprevisaoretornoterceiro,
dtenviadoterceiro, nmequiperesponsavel, nmmotivosuspenso, iddestaque,
cdempresa, nmempresa, cdjornada, cdsituacao, cdtipochamado, cdcategoria,
nmcategoria, cdequipe, nmequipe, cdlocalidade, cdseveridade, cdoperador,
cdresponsavel,
cddepartamento,
nmdepartamento,
cdcomplexidade,
nmcomplexidade, cdanimo, nmanimo, cdorigem, nmorigem, cdcategoria1,
nmcategoria1, cdcategoria2, nmcategoria2, cdcategoria3, nmcategoria3,
cdcausa01, nmcausa01, cdcausa02, nmcausa02, cdcausa03, nmcausa03,
nmcausacompleta, cdcliente, cdcontato, cdequipamento, vlproduto,
cdtipoproduto, nrquantidadeproduto, cdcontrato, nmcontrato.

XML de entrada:
<wsqualitor>
<contents>
<data>
<campos>cdchamado, nmresponsavel, nmcliente, nmcontato</campos>
</data>
</contents>
</wsqualitor>
Cópia Oficial
página: 141 de 359
XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
</response status>
<response data>
<dataitem>
<nmresponsavel>Atendente 2</nmresponsavel>
<nmcliente>Sys Client</nmcliente>
<nmcontato>João Pedro</nmcontato>
</dataitem>
</response data>
</wsqualitor>
6.2.2.35 Operação addTicketImpactedService
Essa operação adiciona serviço impactado ao chamado.

XML de entrada:
Cópia Oficial
página: 142 de 359
<wsqualitor>
<contents>
<data>
<cdservico>20</cdservico>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
</response status>
<response data>
<dataitem>
<cdservico>20, 21</cdservico>
</dataitem>
</response data>
</wsqualitor>
Cópia Oficial
página: 143 de 359
6.2.2.36 Operação addTicketRequestedService
Essa operação adiciona serviço requisitado ao chamado.

<wsqualitor>
<contents>
<data>
<nrquantidade>2</ nrquantidade>
Assume valor 1 caso não for
informado
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
</response status>
Cópia Oficial
página: 144 de 359
<response data>
<dataitem>
<nrquantidade>2</nrquantidade>
<vlservico>223,98</vlservico>
</dataitem>
</response data>
</wsqualitor>
6.2.2.37 Operação getAttachment
Busca os dados de um anexo do chamado.

<wsqualitor>
<contents>
<data>
</data>
</contents>
</wsqualitor>
Cópia Oficial
página: 145 de 359

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
</response status>
<response data>
<dataitem>
<nmanexo>teste.txt</nmanexo>
<dsanexo>jo2LERKIE1pa2UgTGxhbWEgLSBMbGFtYSBXaGlwcGluJyBJb=</
dsanexo>
<dtanexo>03/09/2010 - 10:12</dtanexo>
<nmusuario>Nome</nmusuario>
<vltamanho>0.01KB</vltamanho>
<idanexoprivado>Y</idanexoprivado>
<cdclassificacao></cdclassificacao>
<nmclassificacao></nmclassificacao>
</dataitem>
</response data>
</wsqualitor>
NOTA: a tag <dsanexo> contém o arquivo em codificação base64.
Cópia Oficial
página: 146 de 359
6.2.2.38 Operação getAttachmentList
Essa operação busca os anexos do chamado.

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
</response status>
<response data>
<dataitem>
<nmanexo>all.m3u</nmanexo>
Cópia Oficial
página: 147 de 359
<dtanexo>03/09/2010 - 10:12</dtanexo>
<nmusuario>Inácio Gomes Klassmann</nmusuario>
<vltamanho>261.01KB</vltamanho>
<idanexoprivado></idanexoprivado>
<cdclassificacao></cdclassificacao>
<nmclassificacao></nmclassificacao>
</dataitem>
.......
</response data>
</wsqualitor>
6.2.2.39 Operação getTicketTag
Essa operação retorna a tag do chamado.

<wsqualitor>
<contents>
<data>
</data>
</contents>
</wsqualitor>
Cópia Oficial
página: 148 de 359

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
</response status>
<response data>
<dataitem>
<dstag>contato, nome, telefone</dstag>
</dataitem>
</response data>
</wsqualitor>
6.2.2.40 Operação getTicketTag
Altera a tag do chamado.

XML de entrada:
Cópia Oficial
página: 149 de 359
<wsqualitor>
<contents>
<data>
<dstag>web, ajax, site, host, protocolo</dstag>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
</response status>
<response data>
<dataitem>
<dtoperacao>06-09-2010 13:47</dtoperacao>
</dataitem>
</response data>
</wsqualitor>
Cópia Oficial
página: 150 de 359
6.2.2.41 Operação escalateNextTeam
Essa operação realiza o escalonamento de próxima equipe do chamado.

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
</response status>
<response data>
<dataitem>
Cópia Oficial
página: 151 de 359
</dataitem>
</response data>
</wsqualitor>
6.2.2.42 Operação setTicketPlanningData
Essa operação altera os dados de planejamento do chamado (aba
Planejamento -> Planejamento).

<wsqualitor>
<contents>
<data>
<hmprevisaohoras>205:45</hmprevisaohoras>
<vlprevisaocusto>23.10</vlprevisaocusto>
<dtlimiteatendimento>2001-10-01</dtlimiteatendimento>
<cdtipodatalimiteatendimento>1</cdtipodatalimiteatendimento>
<dsdatalimiteatendimento>teste</dsdatalimiteatendimento>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<response status>
Cópia Oficial
página: 152 de 359
<status>1</status>
<msg></msg>
</response status>
<response data>
<dataitem>
</dataitem>
</response data>
</wsqualitor>
6.2.2.43 Operação getTicketStep
Essa operação retorna a etapa atual do chamado dentro do fluxo de
atendimento.

XML de entrada:
<wsqualitor>
<contents>
<data>
</data>
</contents>
</wsqualitor>
Cópia Oficial
página: 153 de 359

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
</response status>
<response data>
<dataitem>
Código do chamado
<cdsubsituacao>1023</cdsubsituacao>
Etapa do chamado
<nmsubsituacao> Aprovação de dados </nmsubsituacao>
Nome da etapa
<nmidentificador>APRV001</nmidentificador >
Identificador da etapa
Data da
operação
</dataitem>
</response data>
<wsqualitor>
6.2.2.44 Operação getTicketNextSteps
Essa operação retorna as próximas etapas possíveis do chamado dentro do
fluxo de atendimento.
Cópia Oficial
página: 154 de 359

XML de entrada:
<wsqualitor>
<contents>
<data>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
</response status>
<response data>
<dataitem>
Código do
Código da
chamado
situação
<nmsituacao>Em atendimento</cdsituacao>
Nome
da situação
Cópia Oficial
página: 155 de 359
<cdetapa>1024</cdetapa>
Código da etapa
<nmetapa>Confirmar aprovação</nmetapa>
Nome
da etapa
Data da
operação
</dataitem>
<dataitem>
Código do
Código da
chamado
situação
<nmsituacao>Em atendimento</cdsituacao>
Nome
da situação
Código da
<nmetapa>Reprovar dados</nmetapa>
Nome da
etapa
etapa
Data da
operação
</dataitem>
</response data>
<wsqualitor>
Cópia Oficial
página: 156 de 359
6.2.2.45 Operação setTicketStep
Essa operação altera a etapa do chamado dentro do fluxo de atendimento.

XML de entrada:
<wsqualitor>
<contents>
<data>
<nmidentificador>reject</nmidentificador>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
</response status>
<response data>
<dataitem>
Cópia Oficial
página: 157 de 359
Código do chamado
<cdestrutura>21</cdestrutura> Código do fluxo
<cdsubsituacao>44</cdsubsituacao>
Código da situação
Código da etapa
</dataitem>
</response data>
<wsqualitor>
6.2.3 Webservice Product
possuir licença para uso de WebServices, no Qualitor.
As seguintes operações estão disponíveis para o WebService Product:
6.2.3.1 Operação addProduct e updateProduct
Operações para cadastrar e atualizar respectivamente um produto na base do
Qualitor.

XML de entrada:
Cópia Oficial
página: 158 de 359
<wsqualitor>
<contents>
<data>
<cdproduto></cdproduto> Informe esta tag para atualizar o registro
<nmproduto>dddd</nmproduto>
<cdtipoproduto>4</cdtipoproduto>
<vlproduto>43</vlproduto>
<dsunidade></dsunidade>
<nrpeso></nrpeso>
<nrdiasvalidade></nrdiasvalidade>
<nrproduto></nrproduto>
<cdfabricante></cdfabricante>
<dscodbarras></dscodbarras>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
Cópia Oficial
página: 159 de 359
</responsestatus>
<responsedata>
<dataitem>
<cdproduto>12</cdproduto>
</dataitem>
</responsedata>
<wsqualitor>
6.2.3.2 Operação deleteProduct
Operação que exclui produtos na base do Qualitor.

XML de entrada:
<wsqualitor>
<contents>
<data>
</data>
</contents>
</wsqualitor>
Cópia Oficial
página: 160 de 359

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
<dataitem>
</dataitem>
</response_data>
<wsqualitor>
6.2.3.3 Operação getProduct
Essa operação realiza busca de produtos.

<wsqualitor>
<contents>
<data>
<nmproduto></nmproduto>
Cópia Oficial
página: 161 de 359
<cdtipoproduto></cdtipoproduto>
<nmtipoproduto></nmtipoproduto>
<idativo></idativo>
<dscodbarras></dscodbarras>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
<dataitem>3</dataitem>
</response_data>
<wsqualitor>
Cópia Oficial
página: 162 de 359
6.2.3.4 Operação getProductData
Essa operação retorna os dados de um produto.

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
<dataitem>
<nmproduto>teste</nmproduto>
Cópia Oficial
página: 163 de 359
<dsmoeda></dsmoeda>
<dsunidade></dsunidade>
<vlprecoicms>0,00</vlprecoicms>
<vlpercicms>0,00</vlpercicms>
<vlproduto>0,00</vlproduto>
<nrpeso>0,00</nrpeso>
<dsimagem></dsimagem>
<dscodbarras> </dscodbarras>
<cdtipoproduto>1</cdtipoproduto>
<idtiporegistro></idtiporegistro>
<idativo>N</idativo>
<nrdiasvalidade></nrdiasvalidade>
<nmcategoria></nmcategoria>
<nmcategoriacompletaproduto></nmcategoriacompletaproduto>
<nmfabricante></nmfabricante>
<nmtipoproduto>SOFTWARE</nmtipoproduto>
</response_data>
Cópia Oficial
página: 164 de 359
6.2.4 WebService TypeOfRegister
As seguintes Operações estão disponíveis para o WebService TypeOfRegister:
6.2.4.1 Operação addTypeOfRegister e updateTypeOfRegister
Operações para cadastrar e atualizar respectivamente um tipo de
acompanhamento na base do Qualitor.

<wsqualitor>
<contents>
<data>
<nmtipoacompanhamento></nmtipoacompanhamento> Informe esta tag para
atualizar o registro
<vlcoefhoras>12.32</vlcoefhoras>
</data>
</contents>
</wsqualitor>
Cópia Oficial
página: 165 de 359

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<responsedata>
<dataitem>
</dataitem>
</responsedata>
<wsqualitor>
6.2.4.2 Operação deleteTypeOfRegister
Operação que exclui tipos de acompanhamento na base do Qualitor.

XML de entrada:
Cópia Oficial
página: 166 de 359
<wsqualitor>
<contents>
<data>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
<dataitem>
</dataitem>
</response_data>
<wsqualitor>
Cópia Oficial
página: 167 de 359
6.2.4.3 Operação getTypeOfRegister
Essa operação realiza busca de tipos de acompanhamento.

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
<dataitem>
Cópia Oficial
página: 168 de 359
<nmtipoacompanhamento>Atendimento 1</nmtipoacompanhamento>
</dataitem>
<dataitem>
<nmtipoacompanhamento>Atendimento 2</nmtipoacompanhamento>
</dataitem>
</response_data>
<wsqualitor>
6.2.4.4 Operação getTypeOfRegisterData
Essa operação retorna os dados de um tipo de acompanhamento.

XML de entrada:
<wsqualitor>
<contents>
<data>
</data>
</contents>
</wsqualitor>
Cópia Oficial
página: 169 de 359

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
<dataitem>
<nmtipoacompanhamento>Atendimento do NOC</nmtipoacompanhamento>
<nrcoefhoras>1,00</nrcoefhoras>
<dataitem>
</response_data>
6.2.5 WebService Ic
As seguintes operações estão disponíveis para o WebService Ic:
Cópia Oficial
página: 170 de 359
6.2.5.1 Operação addIc e updateIc
Operações para cadastrar e atualizar respectivamente um IC na base do
Qualitor.

<wsqualitor>
<contents>
<data>
<cdic>4</cdic>
Informe esta tag para atualizar o registro
<nmic>dddd</nmic>
<dtaquisicao>2010-02-10</dtaquisicao>
<dtvalidade>2010-04-20</dtvalidade>
<cdcentrocusto>1</cdcentrocusto>
<dsidic>345w3g3 1257</dsidic>
</data>
</contents>
</wsqualitor>
Cópia Oficial
página: 171 de 359

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<responsedata>
<dataitem>
<cdic>4</cdic>
</dataitem>
</responsedata>
<wsqualitor>
6.2.5.2 Operação deleteIc
Operação que exclui ICs na base do Qualitor.

XML de entrada:
Cópia Oficial
página: 172 de 359
<wsqualitor>
<contents>
<data>
<cdic>3</cdic>
<cdic>4</cdic>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
<dataitem>
</dataitem>
</response_data>
<wsqualitor>
Cópia Oficial
página: 173 de 359
6.2.5.3 Operação getIc
Essa operação realiza busca de ICs.

<wsqualitor>
<contents>
<data>
<nmic> meu ic</nmic>
<dtaquisicao2>2010-06-07</dtaquisicao2>
<dtvalidade2>2012-06-07</dtvalidade2>
<idvencido>Y</idvencido>
</data>
</contents>
</wsqualitor>
Cópia Oficial
página: 174 de 359

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
<dataitem>
<cdic>5</cdic>
<nmic>meu ic</nmic>
<nridic>gfdg43</nridic>
</dataitem>
.....
</response_data>
<wsqualitor>
6.2.5.4 Operação getIcData
Essa operação retorna os dados de um IC.

XML de entrada:
Cópia Oficial
página: 175 de 359
<wsqualitor>
<contents>
<data>
<cdic>17</cdic>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
<dataitem>
<cdic>17</cdic>
<cdicrelacionado>17</cdicrelacionado>
<nmic>dvdv d45</nmic>
<nmicrelacionado>dvdv d45</nmicrelacionado>
<nridic>345w3g3 1257</nridic>
<nmresponsavel>Daiane Silva</nmresponsavel>
Cópia Oficial
página: 176 de 359
<cdcategoria1>1</cdcategoria1>
<nmcentrocusto>SUPORTE QUALITOR</nmcentrocusto>
<dsobservacoes></dsobservacoes>
<nmcliente>IPIRANGA CANOAS</nmcliente>
<nmempresa>CONSTAT SERVIÇOS EM INFORMÁTICA LTDA</nmempresa>
<nmequipe>NOC</nmequipe>
</dataitem>
</response_data>
6.2.5.5 Operação addAttribute e updateAttribute
Operações para cadastrar e atualizar respectivamente um atributo de IC na
base do Qualitor.

XML de entrada:
Cópia Oficial
página: 177 de 359
<wsqualitor>
<contents>
<data>
<cdic>4</cdic>
<cdatributo>3</cdatributo>
<nrsequencia>2</nrsequencia> Informe esta tag para atualizar o
registro
<dsvalor>2010</dsvalor>
Informe esta tag para atualizar o
registro
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<responsedata>
<dataitem>
<cdic>4</cdic>
Cópia Oficial
página: 178 de 359
</dataitem>
</responsedata>
<wsqualitor>
6.2.5.6 Operação deleteAttribute
Operação que exclui atributos de IC na base do Qualitor.

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
Cópia Oficial
página: 179 de 359
<msg></msg>
</responsestatus>
<response_data>
<dataitem>
</dataitem>
</response_data>
<wsqualitor>
6.2.5.7 Operação getAttribute
Essa operação realiza busca de atributos de IC.

XML de entrada:
<wsqualitor>
<contents>
<data>
<cdic> 4</cdic>
</data>
</contents>
</wsqualitor>
Cópia Oficial
página: 180 de 359

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
<dataitem>
<cdic>4</cdic>
<nmatributo>cara de c</nmatributo>
<cdtipoatributo>2</cdtipoatributo>
<nmtipoatributo>pqp </nmtipoatributo>
<nmunidade></nmunidade>
<dsvalor>2,0000</dsvalor>
</dataitem>
......
</response_data>
<wsqualitor>
Cópia Oficial
página: 181 de 359
6.2.5.8 Operação getAttributeData
Operação retorna os dados de um atributo de IC.

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
<dataitem>
<cdic>4</cdic>
Cópia Oficial
página: 182 de 359
<nmatributo>cara de c</nmatributo>
<cdtipoatributo>2</cdtipoatributo>
<nmtipoatributo>pqp</nmtipoatributo>
<nmunidade></nmunidade>
<idtipoatributo>N</idtipoatributo>
<idmanual>N</idmanual>
<idvalorunico>N</idvalorunico>
<dsvalor>2,0000</dsvalor>
</dataitem>
</response_data>
6.2.6 WebService Inventory
As seguintes Operações estão disponíveis para o WebService Inventory:
6.2.6.1 Operação addComponent e updateComponent
Operações para cadastrar e atualizar respectivamente um componente na base
do Qualitor.
Cópia Oficial
página: 183 de 359

XML de entrada:
<wsqualitor>
<contents>
<data>
<cdcomponente></cdcomponente> Informe esta tag para atualizar o
registro
<nmcomponente>Beerland</nmcomponente>
<cdtipocomponente>2</cdtipocomponente>
<cdfabricante>1</cdfabricante>
<dspartnumber>Beerland</dspartnumber>
<vlcomponente>34</vlcomponente>
<dscomponente>54 sfdg sdfg ff346</dscomponente>
<fornecedores>
<cdfornecedor>4</cdfornecedor>
</fornecedores>
</data>
</contents>
</wsqualitor>
Cópia Oficial
página: 184 de 359

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<responsedata>
<dataitem>
</dataitem>
</responsedata>
<wsqualitor>
6.2.6.2 Operação deleteComponent
Operação que exclui componentes na base do Qualitor.

XML de entrada:
Cópia Oficial
página: 185 de 359
<wsqualitor>
<contents>
<data>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
<dataitem>
</dataitem>
</response_data>
<wsqualitor>
Cópia Oficial
página: 186 de 359
6.2.6.3 Operação getComponent
Realiza busca de componentes.

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
Cópia Oficial
página: 187 de 359
</response_data>
<wsqualitor>
6.2.6.4 Operação getComponentData
Operação retorna os dados de um componente.

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
Cópia Oficial
página: 188 de 359
<msg></msg>
</responsestatus>
<response_data>
<dataitem>
<nmcomponente>Beerland2</nmcomponente>
<cdtipocomponente>4</cdtipocomponente>
<cdfabricante>1</cdfabricante>
<cdcontrato></cdcontrato>
<dspartnumber>Beerland2</dspartnumber>
<vlcomponente>3,00</vlcomponente>
<dscomponente>54 sfdg sdfg ff34 fg gh ghghghg h ghgh gh6</
dscomponente>
<dtultimaatualizacao>2009-05-04</dtultimaatualizacao>
<dtatualizacaovalor></dtatualizacaovalor>
<fornecedores>
</fornecedores>
</response_data>
6.2.6.5 Operação addComponentSupplier
Essa operação adiciona revendedores ao componente.
Cópia Oficial
página: 189 de 359

XML de entrada:
<wsqualitor>
<contents>
<data>
<fornecedores>
</fornecedores>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
<dataitem>
Cópia Oficial
página: 190 de 359
</dataitem>
</response_data>
<wsqualitor>
6.2.6.6 Operação addSoftware e updateSoftware
Operações para cadastrar e atualizar respectivamente um software na base do
Qualitor.

XML de entrada:
<wsqualitor>
<contents>
<data>
<cdsoftware></cdsoftware> Informe esta tag para atualizar o registro
<nmsoftware>Beerland</nmsoftware>
<cdtiposoftware></cdtiposoftware>
<cdsituacaosoftware></cdsituacaosoftware>
<idverificalicenca></idverificalicenca>
</data>
</contents>
</wsqualitor>
Cópia Oficial
página: 191 de 359

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<responsedata>
<dataitem>
</dataitem>
</responsedata>
<wsqualitor>
6.2.6.7 Operação deleteSoftware
Operação que exclui software na base do Qualitor.

XML de entrada:
Cópia Oficial
página: 192 de 359
<wsqualitor>
<contents>
<data>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
<dataitem>
</dataitem>
</response_data>
<wsqualitor>
Cópia Oficial
página: 193 de 359
6.2.6.8 Operação getSoftware
Essa operação realiza busca de softwares.

XML de entrada:
<wsqualitor>
<contents>
<data>
<cdsoftware></cdsoftware>
<nmsoftware></nmsoftware>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
será retornado
<msg></msg>
</responsestatus>
<response_data>
Cópia Oficial
página: 194 de 359
</response_data>
<wsqualitor>
6.2.6.9 Operação getSoftwareData

XML de entrada:
<wsqualitor>
<contents>
<data>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<responsestatus>
Cópia Oficial
página: 195 de 359
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
<dataitem>
<nmsoftware>Beerland</nmsoftware>
<nmtiposoftware></nmtiposoftware>
<cdsituacaosoftware></cdsituacaosoftware>
<nrversao></nrversao>
<nrnotafiscal>0,00</nrnotafiscal>
<nrcontrole>0,00</nrcontrole>
<nrchaveinstalacao>0,00</nrchaveinstalacao>
<nrpreco>0,00</nrpreco>
<cddepartamento></cddepartamento>
<fgpacote>0</fgpacote>
<cdcliente></cdcliente>
<nmcliente></nmcliente>
<cdtiposoftware></cdtiposoftware>
<nmcontato></nmcontato>
<cdsituacao></cdsituacao>
</response_data>
Cópia Oficial
página: 196 de 359
6.2.6.10 Operação addEquipment e updateEquipment
Operações para cadastrar e atualizar respectivamente um equipamento na base
do Qualitor.

XML de entrada:
<wsqualitor>
<contents>
<data>
<cdconjunto></cdconjunto> Informe esta tag para atualizar o registro
<nmconjunto>Beerland</nmconjunto>
<cdcontato3></cdcontato>
<dschaveidentificacao></dschaveidentificacao>
<cdtipoconjunto></cdtipoconjunto>
<idexpediente></idexpediente>
<idvip></idvip>
<idnaoalteraresponsavel></idnaoalteraresponsavel>
<dsconjunto></dsconjunto>
<cdcidade></cdcidade>
</data>
</contents>
</wsqualitor>
Cópia Oficial
página: 197 de 359

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<responsedata>
<dataitem>
<cdconjunto>12</cdconjunto>
</dataitem>
</responsedata>
<wsqualitor>
6.2.6.11 Operação deleteEquipment
Operação que exclui equipamentos na base do Qualitor.

XML de entrada:
Cópia Oficial
página: 198 de 359
<wsqualitor>
<contents>
<data>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
<dataitem>
</dataitem>
</response_data>
<wsqualitor>
Cópia Oficial
página: 199 de 359
6.2.6.12 Operação getEquipment
Essa operação realiza busca de equipamentos.

XML de entrada:
<wsqualitor>
<contents>
<data>
<cdconjunto></cdconjunto>
<nmconjunto></nmconjunto>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
Cópia Oficial
página: 200 de 359
</response_data>
<wsqualitor>
6.2.6.13 Operação getEquipmentData

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
Cópia Oficial
página: 201 de 359
<msg></msg>
</responsestatus>
<response_data>
<dataitem>
<nmconjunto>E0100030</nmconjunto>
<dsconjunto>THUNDER</dsconjunto>
<nmusuariorede></nmusuariorede>
<cdtipoconjunto></cdtipoconjunto>
<nrserie></nrserie>
<nrnotafiscal></nrnotafiscal>
<dtnotafiscal></dtnotafiscal>
<nrpatrimonio></nrpatrimonio>
<dtfabricacao></dtfabricacao>
<dtinstalacao></dtinstalacao>
<dtgarantia></dtgarantia>
<idgarantiavencida></idgarantiavencida>
<cdsituacao></cdsituacao>
<cdconjuntosuperior></cdconjuntosuperior>
<idestoque></idestoque>
<idativo></idativo>
Cópia Oficial
página: 202 de 359
<idvip></idvip>
<nrchaveidentificacao></nrchaveidentificacao>
<idtag></idtag>
<idnaoalteraresponsavel></idnaoalteraresponsavel>
<dtultatualizacao></dtultatualizacao>
<idwmi></idwmi>
<idexpediente></idexpediente>
<idonline></idonline>
<nmlogin></nmlogin>
<dssenha></dssenha>
<nmdominio></nmdominio>
<nmpatrimonio></nmpatrimonio>
<nmcidade></nmcidade>
<cduf></cduf>
<nmuf></nmuf>
<nmsowmi></nmsowmi>
<nrserialsowmi></nrserialsowmi>
<nripwmi></nripwmi>
<nrmacaddresswmi></nrmacaddresswmi>
<dstamanhodiscowmi></dstamanhodiscowmi>
<dsperclivrewmi></dsperclivrewmi>
<dscpuwmi></dscpuwmi>
<nrclockatualwmi></nrclockatualwmi>
<nmcategoriacompleta> nmcategoriacompleta>
<nmtipoconjunto></nmtipoconjunto>
Cópia Oficial
página: 203 de 359
<cdcentrocusto></cdcentrocusto>
<nmcentrocusto></nmcentrocusto>
<sguf></sguf>
</dataitem>
</response_data>
6.2.7 WebService KnowledgeBase
As seguintes Operações estão disponíveis para o WebService
KnowledgeBase:
6.2.7.1 Operação getKBDocuments
Busca os documentos da base de conhecimento do Qualitor.

XML de entrada: (Informações em vermelho são obrigatórios)
<wsqualitor>
<contents>
<data>
<nmtitulo></nmtitulo>
<dsdocumento></dsdocumento>
<dsconteudo></dsconteudo>
<idfca></idfca>
Cópia Oficial
página: 204 de 359
Y – busca os chamados com a guia FCA preenchida.
Caso não for informado, buscará somente os documentos.
</data>
</contents>
</wsqualitor>

XML de retorno:
<?xml version=”1.0" encoding=” ISO-8859-1"?>
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<responsedata>
<dataitem>
<cddocumento>1</cddocumento>
<nmtitulo>DOCUMENTO DE TESTE</nmtitulo>
</dataitem>
.......
</responsedata>
<wsqualitor>
6.2.7.2 Operação getKBDocumentsData
Essa operação retorna os dados de um gráfico da base de dados do Qualitor.
Cópia Oficial
página: 205 de 359

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</response status>
<responsedata>
<dataitem>
<nmtitulo>Balrog - senhor dos aneis</nmtitulo>
<dsdocumento>o mago Cinzento na mesma cidade.</dsdocumento>
Cópia Oficial
página: 206 de 359
<cdaprovador></cdaprovador>
<nmaprovador></nmaprovador>
<dsdocumentortf><p>o mago Cinzento na mesma cidade.</p></
dsdocumentortf>
<dtdocumento>2009-01-29 15:06</dtdocumento>
<dtultimaatualizacao></dtultimaatualizacao>
<dspalavrachave>senhor dos aneis</dspalavrachave>
<dtvalidade></dtvalidade>
<nmsituacao>Documento armazenado</nmsituacao>
<cdtipodocumento>2</cdtipodocumento>
<nmtipodocumento>DOCUMENTO LEGAL</nmtipodocumento>
<idrestritocliente>N</idrestritocliente>
<idfavorito>Y</idfavorito>
<dslink>http://pt.wikipedia.org/wiki/Balrog</dslink>
<cdpasta>3</cdpasta>
<nmpasta>wwwroot</nmpasta>
<nmpastacompleta>Início/C:/Inetpub/wwwroot</nmpastacompleta>
<cdperfilchamado></cdperfilchamado>
<cdusuarioultimaatualizacao></cdusuarioultimaatualizacao>
<nmusuarioultimaatualizacao>Inacio
nmusuarioultimaatualizacao>
Klassmann</
</dataitem>
</responsedata>
<wsqualitor>
Cópia Oficial
página: 207 de 359
6.2.8 WebService Cause
possuir licença para uso de WebServices, no Qualitor. As seguintes operações estão
disponíveis para o WebService Cause:
6.2.8.1 Operação addCause e updateCause
Operações para cadastrar e atualizar respectivamente uma causa na base do
Qualitor.

XML de entrada:
<wsqualitor>
<contents>
<data>
<cdcausa></cdcausa>
<nmcausa>dddd</nmcausa>
<cdcausasuperior>43</cdcausasuperior>
</data>
</contents>
</wsqualitor>
Cópia Oficial
página: 208 de 359

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<responsedata>
<dataitem>
</dataitem>
</responsedata>
<wsqualitor>
6.2.8.2 Operação deleteCause
Operação que exclui causas na base do Qualitor.

XML de entrada:
Cópia Oficial
página: 209 de 359
<wsqualitor>
<contents>
<data>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
<dataitem>
</dataitem>
</response_data>
<wsqualitor>
Cópia Oficial
página: 210 de 359
6.2.8.3 Operação getCause
Realiza busca de causas.

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
<dataitem>
Cópia Oficial
página: 211 de 359
<nmcausa>a</nmcausa>
<nmcausacompleta>c/b/a</nmcausacompleta>
</dataitem>
<dataitem>
<nmcausa>b</nmcausa>
<nmcausacompleta>c/b</nmcausacompleta>
</dataitem>
</response_data>
<wsqualitor>
6.2.8.4 Operação getCauseData
Operação retorna os dados de uma causa.

<wsqualitor>
<contents>
<data>
</data>
</contents>
</wsqualitor>
Cópia Oficial
página: 212 de 359

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
<dataitem>
<nmcausa>b</nmcausa>
<nmcausacompleta>c/b</nmcausacompleta>
</dataitem>
</response_data>
6.2.9 WebService Charts
Para utilizar o WS Charts, é necessário ter licença para o QMonitor.
As seguintes Operações estão disponíveis para o WebService Charts:
Cópia Oficial
página: 213 de 359
6.2.9.1 Operação getCharts
Essa operação busca gráficos da base de dados do Qualitor.

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
será retornado
<msg></msg>
</responsestatus>
Cópia Oficial
página: 214 de 359
<responsedata>
<dataitem>
<cdgraficosql>14</cdgraficosql>
<nmgraficosql>Chamados abertos e fechados por responsavel</
nmgraficosql>
</dataitem>
.......
</responsedata>
<wsqualitor>
6.2.9.2 Operação getChartsData
Essa operação retorna os dados de um gráfico da base de dados do Qualitor.

XML de entrada:
(Informações em vermelho são obrigatórios)
<wsqualitor>
<contents>
<data>
</data>
</contents>
</wsqualitor>
Cópia Oficial
página: 215 de 359

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</response status>
<responsedata>
<dataitem>
<nmgraficosql>Porcentagem de chamados abertos</nmgraficosql>
<idtipografico>18</idtipografico>
<nmcampolabel> </nmcampolabel>
<nmcampovalor>val1</nmcampovalor>
<nmlabelx> </nmlabelx>
<nmlabely>Valor</nmlabely>
<iddefault>N</iddefault>
<idcor>C3D9FF</idcor>
<idorientacao>H</idorientacao>
<idlegenda>Y</idlegenda>
<idpublicar>Y</idpublicar>
<vlmarcacao>10.0000</vlmarcacao>
<nmcolunaserie2> </nmcolunaserie2>
<nmtextoserie2> </nmtextoserie2>
<idcorserie1>EEEEEE</idcorserie1>
<iddelete>N</iddelete>
<queryresult>
Cópia Oficial
página: 216 de 359
<row>
<val1>34</val1>
</row>
.........
</queryresult>
<queryinterval>
<interval>
<vlintervalo>50,00</vlintervalo>
<vlcor>006E2E</vlcor>
</interval>
........
</queryinterval>
</dataitem>
</responsedata>
<wsqualitor>
6.2.10 WebService Chat
Para utilizar o WS Chat, é necessário ter licença para o módulo de
Atendimento On-line.
As seguintes Operações estão disponíveis para o WebService Chat:
Cópia Oficial
página: 217 de 359
6.2.10.1Operação getChannelStatus
Retorna a informação de que o canal está ativo, ou não. Esta operação pode
ser realizada por dois tipos de usuários, visitante ou cliente. Permissão necessária: não
há permissão necessária no Qualitor para esta operação.
6.2.10.1.1 Visitante

XML de entrada para Visitante: (Informações em vermelho são
obrigatórios)
<wsqualitor>
<contents>
<data>
<idtipousuario>2</idtipousuario>
<cdcanalatendimento>20</cdcanalatendimento>
</data>
</contents>
</wsqualitor>

XML de retorno para Visitante:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
Cópia Oficial
página: 218 de 359
</response status>
<response data>
<dataitem>
<idhabilitado>Y</idhabilitado> Pode retornar Y ou N
</dataitem>
</response data>
<wsqualitor>
6.2.10.1.2 Cliente

XML de entrada para Cliente:
(Informações em vermelho são obrigatórios)
<wsqualitor>
<contents>
<data>
</data>
</contents>
</wsqualitor>
Cópia Oficial
página: 219 de 359

XML de retorno para Cliente:
<wsqualitor>
<response status>
<status>1</status>
<msg></msg>
</response status>
<response data>
<dataitem>
<idhabilitado>N</idhabilitado> Pode retornar Y ou N
</dataitem>
</response data>
<wsqualitor>
NOTA: O sistema pode retornar um erro, nesta operação, indicando que o
código do cliente informado não existe.
Cópia Oficial
página: 220 de 359
6.2.11 WebService General
As seguintes Operações estão disponíveis para o WebService General:
6.2.11.1 Operação addCustomer e UpdateCustomer
Essa operação permite adicionar ou atualizar um Cliente na base do Qualitor.
Permissão necessária: Acesso ao menu “Cadastros Gerais > Clientes >
Clientes”, nas permissões de usuário e grupo, do Qualitor.
Verificar parâmetro: “Somente administradores podem editar ou adicionar
clientes e contatos” em Atendimento -> Parâmetros. Caso este parâmetro esteja ativo,
o usuário do WebService deve ser administrador para executar esta operação.
NOTA: Caso não seja passado o cdcliente no XML de entrada, é gerado o
cdcliente auto-increment.

<wsqualitor>
<contents>
<data>
<nmcliente>Customer Name...</nmcliente>
<cdcliente>COD002</cdcliente>
<nrcpfcnpj>00000000000</nrcpfcnpj>
<nrie>00000000000</nrie>
<dsendereco>Address...</dsendereco>
Cópia Oficial
página: 221 de 359
<nrcep>00000000</nrcep>
<dscomplemento>...</dscomplemento>
<dsemail >[email protected]</dsemail>
<nmbairro></nmbairro>
<cdmodeloemail></cdmodeloemail>
<nrpaistelefone></nrpaistelefone>
<nrareatelefone></nrareatelefone>
<nrtelefone></nrtelefone>
<nrpaiscelular></nrpaiscelular>
<nrareacelular></nrareacelular>
<nrcelular></nrcelular>
<nrpaisfax></nrpaisfax>
<nrareafax></nrareafax>
<nrfax></nrfax>
<nrpadraokm></nrpadraokm>
<idfaturadespesa></idfaturadespesa>
<idativo></idativo>
</data>
<responsibles>
<technicians>
<cdusuario></cdusuario>
Código
dos
usuários
responsáveis
<cdusuario></cdusuario>
…
</technicians>
</responsibles>
<attributes>
<cdatributo1></cdatributo1>
valor do atribuído
Cópia Oficial
idem
página: 222 de 359
idem
idem
idem
idem
idem
</attributes>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<responsedata>
<dataitem>
Código do cliente criado
<dtoperacao>1900-01-13 11:42</dtoperacao> Data de criação
do cliente
</dataitem>
</responsedata>
<wsqualitor>
Cópia Oficial
página: 223 de 359
NOTAS:
· O sistema pode retornar um erro, nesta operação, indicando que o código
de cliente informado já existe.
· Ao cadastrar um cliente, por padrão, o sistema irá cadastrá-lo como ATIVO,
caso não seja informada tag IDATIVO no XML.
· Pode ocorrer erro em caso de falha de permissões
· Pode ocorrer erro em caso de informar um código de um registro de vínculo
(exemplo: cidade) que não exista.
6.2.11.2 Operação addCustomerContact e updateCustomerContact
Estas operações adicionam e atualizam (respectivamente) um contato dentro de
um cliente.
Permissão
necessária:
Acesso
ao
menu
“Cadastros
Gerais
> Clientes > Clientes”, nas permissões de usuário e grupo, do Qualitor.
Verificar parâmetro: “Somente administradores podem editar ou adicionar
clientes e contatos” em “Atendimento > Parâmetros”. Caso este parâmetro esteja ativo,
o usuário do WebService deve ser administrador para executar esta operação.

XML de entrada:
Cópia Oficial
página: 224 de 359
<wsqualitor>
<contents>
<data>
<nmcontato>3</nmcontato>
<cdcontato>1</cdcontato> Informe a tag para atualizar o contato
<dsemail>[email protected]</dsemail>
<cddepartamento>8</cddepartamento>
<nmloginweb>usuario</nmloginweb>
<cdsenhaweb>123</cdsenhaweb>
<cdcargo></cdcargo>
<idjuridica></idjuridica>
Y ou N
<cdlingua></cdlingua>
O default é o idioma do usuário
<idativo></idativo>
Y ou N
<idbloqueado></idbloqueado>
Y ou N
<cdcontatosuperior></cdcontatosuperior>
<nrpaistelefonecontato>1</nrpaistelefonecontato>
<nrareatelefonecontato>51</nrareatelefonecontato>
<nrtelefonecontato>33331234</nrtelefonecontato>
<dsendereco></dsendereco>
<dscomplemento></dscomplemento>
Cópia Oficial
página: 225 de 359
<nrfax></nrfax>
<idvip></idvip>
Y ou N
<idmaterialpublicitario></idmaterialpublicitario>
Y ou N
<nrcep></nrcep>
<idgenero></idgenero>
M – masculino, F - feminino
<cdprofissao></cdprofissao>
<dtnascimento></dtnascimento>
<nmmatricula></nmmatricula>
</data>
<attributes>
valor do atribuído
idem
idem
idem
idem
idem
idem
</attributes>
</contents>
</wsqualitor
Cópia Oficial
página: 226 de 359

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<responsedata>
<dataitem>
Código do cliente
Código do contato cadastrado
<dtoperacao>1900-01-13 11:42</dtoperacao> Data da operação
</dataitem>
</responsedata>
<wsqualitor>
6.2.11.3 Operação getCustomer
Esta operação retorna os códigos dos clientes encontrados, de acordo com os
critérios de pesquisa.
Permissão necessária: Permissão de acesso à pesquisa de clientes.
Cópia Oficial
página: 227 de 359

XML de entrada:
<wsqualitor>
<contents>
<data>
<nmcliente>AJAX</nmcliente>
<cduf></cduf>
<sguf></sguf>
<idativo></idativo>
<nrcpfcnpj></nrcpfcnpj>
<cdempresa></cdempresa>
</data>
</contents>
</wsqualitor>
Cópia Oficial
página: 228 de 359

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<responsedata>
</responsedata>
<wsqualitor>
6.2.11.4 Operação getCustomerData
Esta operação retorna os dados dos códigos de clientes informados na
operação.

XML de entrada:
<wsqualitor>
<contents>
<data>
</data>
</contents>
</wsqualitor>
Cópia Oficial
página: 229 de 359

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<responsedata>
<dataitem>
<nrfax></nrfax>
<nrcep></nrcep>
<dsemail></dsemail>
Cópia Oficial
página: 230 de 359
<cdmodeloemail></cdmodeloemail>
<nmmodeloemail></nmmodeloemail>
<nrpadraokm></nrpadraokm>
<idtag></idtag>
<idfaturadespesa></idfaturadespesa>
<nrie></nrie>
<cdclientesap></cdclientesap>
<idativo></idativo>
<idcookie></idcookie>
<nmuf></nmuf>
<nmpais> </nmpais>
<nrtelefonecompleto></nrtelefonecompleto>
<nmempresa></nmempresa>
<iddelete></iddelete>
</dataitem>
</responsedata>
<wsqualitor>
Cópia Oficial
página: 231 de 359
6.2.11.5 Operação getCustomerContact
Esta operação retorna os códigos dos clientes e contatos encontrados, de
acordo com os critérios de pesquisa.
Permissão necessária: Permissão de acesso à pesquisa de contatos.

<wsqualitor>
<contents>
<data>
<nmmatricula></nmmatricula>
<nmloginweb></nmloginweb>
<dsemail></dsemail>
<idativo></idativo>
<idvip></idvip>
<cduf></cduf>
<nrcep></nrcep>
</data>
</contents>
</wsqualitor>
Cópia Oficial
página: 232 de 359

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<responsedata>
<dataitem>
</dataitem>
<dataitem>
</dataitem>
</responsedata>
<wsqualitor>
6.2.11.6 Operação getCustomerContactData
Esta operação retorna os dados do contato de um cliente.
Permissão necessária: Permissão de acesso à pesquisa de contatos.
Cópia Oficial
página: 233 de 359

XML de entrada:
<wsqualitor>
<contents>
<data>
</data>
</contents>
</wsqualitor>
XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<responsedata>
<dataitem>
<cdcliente> </cdcliente>
<nmcliente> </nmcliente>
<nmdepartamento></nmdepartamento>
Cópia Oficial
página: 234 de 359
<dsemail></dsemail>
<cdloginweb></cdloginweb>
<cdsenhaweb> </cdsenhaweb>
<idvip></idvip>
<cdlingua></cdlingua>
<cddicionario></cddicionario>
<cdcargo></cdcargo>
<nmcargo></nmcargo>
<cdcontatosuperior></cdcontatosuperior>
<nmcontatosuperior></nmcontatosuperior>
<idativo></idativo>
<sguf></sguf>
<nrcep></nrcep>
<dtnascimento></dtnascimento>
Cópia Oficial
página: 235 de 359
<idgenero></idgenero>
<nrfax></nrfax>
<idjuridica></idjuridica>
<idmaterialpublicitario></idmaterialpublicitario>
<dsprofissao></dsprofissao>
<idbloqueado></idbloqueado>
<nrmatricula></nrmatricula>
<nmlingua></nmlingua>
<idlingua>pt-br</idlingua>
<nmlocalidade></nmlocalidade>
<idresponsavelcliente></idresponsavelcliente>
<nrtelefonecompleto></nrtelefonecompleto>
<nrcelularcompleto></nrcelularcompleto>
<iddelete></iddelete>
</dataitem>
</responsedata>
<wsqualitor>
Cópia Oficial
página: 236 de 359
6.2.11.7 Operação addCity e updateCity
Operações para cadastrar e atualizar respectivamente uma cidade na base do
Qualitor.

<wsqualitor>
<contents>
<data>
Informe esta tag para atualizar a cidade
<cduf></cduf>
<nrddd></nrddd>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
Cópia Oficial
página: 237 de 359
</responsestatus>
<responsedata>
<dataitem>
<cdcidade>1020</cdcidade>
</dataitem>
</responsedata>
<wsqualitor>
6.2.11.8 Operação deleteCity
Operação que exclui cidades na base do Qualitor.

XML de entrada:
<wsqualitor>
<contents>
<data>
</data>
</contents>
</wsqualitor>
Cópia Oficial
página: 238 de 359

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
<dataitem>
</dataitem>
</response_data>
<wsqualitor
6.2.11.9 Operação getCity
Essa operação realiza busca de cidades.

XML de entrada:
Cópia Oficial
página: 239 de 359
<wsqualitor>
<contents>
<data>
<cduf></cduf>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
</response_data>
<wsqualitor>
Cópia Oficial
página: 240 de 359
6.2.11.10 Operação getCityData
Operação retorna os dados de uma cidade.

XML de entrada:
<wsqualitor>
<contents>
<data>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
<dataitem>
Cópia Oficial
página: 241 de 359
<nmcidade>ALAGOAS</nmcidade>
<cduf>3</cduf>
<nmuf>AL</nmuf>
<nrddd></nrddd>
</dataitem>
</response_data>
<wsqualitor>
6.2.11.11 Operação addState e updateState
Operações para cadastrar e atualizar respectivamente um estado na base do
Qualitor.

XML de entrada:
<wsqualitor>
<contents>
<data>
<cduf></cduf>
Informe esta tag para atualizar o estado
<nmuf>Tangamandapio</nmuf>
<sguf>TM</sguf>
<cdpais>3</cdpais>
</data>
</contents>
</wsqualitor>
Cópia Oficial
página: 242 de 359

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<responsedata>
<dataitem>
<cduf>12</cduf>
</dataitem>
</responsedata>
<wsqualitor>
6.2.11.12 Operação deleteState
Operação que exclui estados na base do Qualitor.

XML de entrada:
Cópia Oficial
página: 243 de 359
<wsqualitor>
<contents>
<data>
<cduf>3</cduf>
<cduf>4</cduf>
<cduf>5</cduf>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
<dataitem>
</dataitem>
</response_data>
<wsqualitor>
Cópia Oficial
página: 244 de 359
6.2.11.13 Operação getState
Essa operação realiza busca de cidades.

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
Cópia Oficial
página: 245 de 359
</response_data>
<wsqualitor>
6.2.11.14 Operação getStateData
Operação retorna os dados de uma estado.

XML de entrada:(Informações em vermelho são obrigatórias)
<wsqualitor>
<contents>
<data>
<cduf>13</cduf>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
Cópia Oficial
página: 246 de 359
<msg></msg>
</responsestatus>
<response_data>
<dataitem>
<cduf>13</cduf>
<sguf>AL</sguf>
<nmuf>Alagoas</nmuf>
<cdpais>3</cdpais>
<nmpais>Brasil</nmpais>
</dataitem>
</response_data>
<wsqualitor>
6.2.11.15 Operação addCountry e updateCountry
Operações para cadastrar e atualizar respectivamente um país na base do
Qualitor.

<wsqualitor>
<contents>
<data>
<cdpais></cdpais>
Informe esta tag para atualizar o estado
<sgpais>BR</sgpais>
<cdcontinente>3</cdcontinente>
</data>
Cópia Oficial
página: 247 de 359
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<responsedata>
<dataitem>
<cdpais>12</cdpais>
</dataitem>
</responsedata>
<wsqualitor>
6.2.11.16 Operação deleteCountry
Operação que exclui países na base do Qualitor.

XML de entrada:
Cópia Oficial
página: 248 de 359
<wsqualitor>
<contents>
<data>
<cdpais>3</cdpais>
<cdpais>4</cdpais>
<cdpais>5</cdpais>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
<dataitem>
</dataitem>
</response_data>
<wsqualitor>
Cópia Oficial
página: 249 de 359
6.2.11.17 Operação getCountry
Essa operação realiza busca de países.

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
Cópia Oficial
página: 250 de 359
</response_data>
<wsqualitor>
6.2.11.18 Operação getCountryData
Operação retorna os dados de um país.

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
Cópia Oficial
página: 251 de 359
<msg></msg>
</responsestatus>
<response_data>
<dataitem>
<cdpais>13</cdpais>
<sgpais>BR</sgpais>
</dataitem>
</response_data>
<wsqualitor>
6.2.11.19 Operação addContinent e updateContinent
Operações para cadastrar e atualizar respectivamente um continente na base
do Qualitor.

<wsqualitor>
<contents>
<data>
<cdcontinente></cdcontinente> Informe esta tag para atualizar o estado
<nmcontinente>Africa</nmcontinente>
</data>
</contents>
</wsqualitor>
Cópia Oficial
página: 252 de 359

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<responsedata>
<dataitem>
</dataitem>
</responsedata>
<wsqualitor>
6.2.11.20 Operação deleteContinent
Operação que exclui continentes na base do Qualitor.

<wsqualitor>
<contents>
<data>
Cópia Oficial
página: 253 de 359
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
<dataitem>
</dataitem>
</response_data>
<wsqualitor>
Cópia Oficial
página: 254 de 359
6.2.11.21 Operação getContinent
Essa operação realiza busca de continente.

XML de entrada:
<wsqualitor>
<contents>
<data>
<cdcontinente></cdcontinente>
<nmcontinente></nmcontinente>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
Cópia Oficial
página: 255 de 359
</response_data>
<wsqualitor>
6.2.11.22 Operação getContinentData
Operação retorna os dados de um continente.

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
Cópia Oficial
página: 256 de 359
<msg></msg>
</responsestatus>
<response_data>
<dataitem>
<nmcontiente>Brasil</nmcontinente>
</dataitem>
</response_data>
<wsqualitor>
6.2.11.23 Operação getLanguage
Retorna os idiomas contidos na base do Qualitor. Este método não necessita
de dados provindos de um XML, portanto o único argumento a ser utilizado é o de
autenticação.
Declaração do método:
public String getLanguage(String $auth);
6.2.11.24 Operação getLanguageData
Operação retorna os dados de um continente.

XML de entrada:
Cópia Oficial
página: 257 de 359
<wsqualitor>
<contents>
<data>
<cdlingua>13</cdlingua>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
<dataitem>
<nmlingua>Português</nmlingua>
<dssigla>pt-br</dssigla>
<cdmodelo></cdmodelo>
<nmmodelo></nmmodelo>
<dssiglamodelo></dssiglamodelo>
</dataitem>
</response_data>
<wsqualitor>
Cópia Oficial
página: 258 de 359
6.2.11.25 Operação addProfession e updateProfession
Operações para cadastrar e atualizar respectivamente uma profissão na base
do Qualitor.

<wsqualitor>
<contents>
<data>
registro
<nmprofissao>Catador</nmprofissao>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
Cópia Oficial
página: 259 de 359
</responsestatus>
<responsedata>
<dataitem>
<cdprofissao>12</cdprofissao>
</dataitem>
</responsedata>
<wsqualitor>
6.2.11.26 Operação deleteProfession
Operação que exclui profissões na base do Qualitor.

XML de entrada:
<wsqualitor>
<contents>
<data>
</data>
</contents>
</wsqualitor>
Cópia Oficial
página: 260 de 359

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
<dataitem>
</dataitem>
</response_data>
<wsqualitor>
6.2.11.27 Operação getProfession
Essa operação realiza busca de profissão.

<wsqualitor>
<contents>
<data>
<nmprofissao></nmprofissao>
Cópia Oficial
página: 261 de 359
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
</response_data>
<wsqualitor>
6.2.11.28 Operação getProfessionData
Operação retorna os dados de uma profissão.

XML de entrada:
Cópia Oficial
página: 262 de 359
<wsqualitor>
<contents>
<data>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
<dataitem>
<nmprofissao>Catador</nmprofissao>
</dataitem>
</response_data>
<wsqualitor>
Cópia Oficial
página: 263 de 359
6.2.11.29 Operação addJobTitle e updateJobTitle
Operações para cadastrar e atualizar respectivamente um cargo na base do
Qualitor.

<wsqualitor>
<contents>
<data>
<cdcargo></cdcargo>
<nmcargo>Catador</nmcargo>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<responsedata>
<dataitem>
Cópia Oficial
página: 264 de 359
<cdcargo>12</cdcargo>
</dataitem>
</responsedata>
<wsqualitor>
6.2.11.30 Operação deleteJobTitle
Operação que exclui cargos na base do Qualitor.

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
Cópia Oficial
página: 265 de 359
será retornado
<msg></msg>
</responsestatus>
<response_data>
<dataitem>
</dataitem>
</response_data>
<wsqualitor>
6.2.11.31 Operação getJobTitle
Essa operação realiza busca de profissão.

XML de entrada:
<wsqualitor>
<contents>
<data>
<cdcargo></cdcargo>
<nmcargo></nmcargo>
</data>
</contents>
</wsqualitor>
Cópia Oficial
página: 266 de 359

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
</response_data>
<wsqualitor>
6.2.11.32 Operação getJobTitleData
Operação retorna os dados de um cargo.

XML de entrada:
Cópia Oficial
página: 267 de 359
<wsqualitor>
<contents>
<data>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
<dataitem>
<nmcargp>Catador</nmcargo>
</dataitem>
</response_data>
<wsqualitor>
Cópia Oficial
página: 268 de 359
6.2.11.33 Operação addDepartment e updateDepartment
Operações para cadastrar e atualizar respectivamente um departamento na
base do Qualitor.

XML de entrada:
<wsqualitor>
<contents>
<data>
<cddepartamento></cddepartamento> Informe a tag para atualizar o
registro
<nmdepartamento>Catador</nmdepartamento>
<idativo>Y</idativo>
</data>
</contents>
</wsqualitor>
NOTAS:
· O sistema pode retornar um erro, nesta operação, indicando que o código
do centro de custo informado não existe.
· Por padrão, o departamento será criado com o valor da tag idativo igual a Y.
Cópia Oficial
página: 269 de 359

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<responsedata>
<dataitem>
</dataitem>
</responsedata>
<wsqualitor>
6.2.11.34 Operação deleteDepartment
Operação que exclui departamentos na base do Qualitor.

XML de entrada:
<wsqualitor>
<contents>
<data>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
<dataitem>
</dataitem>
</response_data>
<wsqualitor>
6.2.11.35 Operação getDepartment
Essa operação realiza busca de departamento.

XML de entrada:
<wsqualitor>
<contents>
<data>
<nmdepartamento></nmdepartamento>
<idativo></idativo>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
Cópia Oficial
página: 272 de 359
</responsestatus>
<response_data>
</response_data>
<wsqualitor>
6.2.11.36 Operação getDepartmentData
Operação retorna os dados de um departamento.

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
Cópia Oficial
página: 273 de 359
será retornado
<msg></msg>
</responsestatus>
<response_data>
<dataitem>
<nmdepartamento>Catador</nmdepartamento>
<idativo></idativo>
</dataitem>
</response_data>
<wsqualitor>
6.2.11.37 Operação addCostCenter e updateCostCenter
Operações para cadastrar e atualizar respectivamente um centro de custo na
base do Qualitor.
<wsqualitor>
<contents>
<data>
registro
<nmcentrocusto>Catador</nmcentrocusto>
Cópia Oficial
página: 274 de 359
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<responsedata>
<dataitem>
</dataitem>
</responsedata>
<wsqualitor>
6.2.11.38 Operação deleteCostCenter
Operação que exclui centro de custos na base do Qualitor.

XML de entrada:
Cópia Oficial
página: 275 de 359
<wsqualitor>
<contents>
<data>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
<dataitem>
</dataitem>
</response_data>
<wsqualitor>
Cópia Oficial
página: 276 de 359
6.2.11.39 Operação getCostCenter
Essa operação realiza busca de departamento.

XML de entrada:
<wsqualitor>
<contents>
<data>
<idativo></idativo>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
Cópia Oficial
página: 277 de 359
</response_data>
<wsqualitor>
6.2.11.40 Operação getCostCenterData
Operação retorna os dados de um centro de custo.

XML de entrada:
<wsqualitor>
<contents>
<data>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
Cópia Oficial
página: 278 de 359
será retornado
<msg></msg>
</responsestatus>
<response_data>
<dataitem>
<nmcentrocusto>Catador</nmcentrocusto>
<idativo></idativo>
</dataitem>
</response_data>
<wsqualitor>
6.2.11.41 Operação addSupplier e updateSupplier
Operações para cadastrar e atualizar respectivamente um fornecedor na base
do Qualitor.

<wsqualitor>
<contents>
<data>
registro
<nmfornecedor>Beerland</nmfornecedor>
Cópia Oficial
página: 279 de 359
<nrie>433423</nrie>
<dsemail>Beerland</dsemail>
<nrtelefone>3452346</nrtelefone>
<nrcelular>45326</nrcelular>
<nrfax>546346</nrfax>
<dsobservacao>Beerland</dsobservacao>
<dsendereco>Beerland</dsendereco>
<nmbairro>Beerland</nmbairro>
<dscomplemento>Beerland</dscomplemento>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<responsedata>
<dataitem>
Cópia Oficial
página: 280 de 359
</dataitem>
</responsedata>
<wsqualitor>
6.2.11.42 Operação deleteSupplier
Operação que exclui fornecedores na base do Qualitor.

XML de entrada:
<wsqualitor>
<contents>
<data>
</data>
</contents>
</wsqualitor>
Cópia Oficial
página: 281 de 359

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
<dataitem>
</dataitem>
</response_data>
<wsqualitor>
6.2.11.43 Operação getSupplier
Essa operação realiza busca de fornecedor.

XML de entrada:
Cópia Oficial
página: 282 de 359
<wsqualitor>
<contents>
<data>
<nmfornecedor></nmfornecedor>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
</response_data>
<wsqualitor>
Cópia Oficial
página: 283 de 359
6.2.11.44 Operação getSupplierData
Operação retorna os dados de um fornecedor.

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
<dataitem>
<nmfornecedor>Beerland</nmfornecedor>
Cópia Oficial
página: 284 de 359
<nrie>433423</nrie>
<nmcidade>CANOAS</nmcidade>
<nmuf>Rio Grande do Sul</nmuf>
<sguf>RS</sguf> </dataitem>
</response_data>
<wsqualitor>
6.2.11.45 Operação addTechnicalAssistence e updateTechnicalAssistence
Operações para cadastrar e atualizar respectivamente uma assistência técnica
na base do Qualitor.

XML de entrada:
Cópia Oficial
página: 285 de 359
Informe
esta
tag
para
atualizar o registro
<wsqualitor>
<contents>
<data>
<nmassistenciatecnica>Beerland</nmassistenciatecnica>
<nrie>433423</nrie>
</data>
</contents>
</wsqualitor>
Cópia Oficial
página: 286 de 359

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<responsedata>
<dataitem>
<cdassistenciatecnica>12</cdassistenciatecnica>
</dataitem>
</responsedata>
<wsqualitor>
6.2.11.46 Operação deleteTechnicalAssistence
Operação que exclui assistências técnicas na base do Qualitor.

XML de entrada:
<wsqualitor>
<contents>
<data>
Cópia Oficial
página: 287 de 359
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
<dataitem>
</dataitem>
</response_data>
<wsqualitor>
Cópia Oficial
página: 288 de 359
6.2.11.47 Operação getTechnicalAssistence
Essa operação realiza busca de assistências técnicas.

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
Cópia Oficial
página: 289 de 359
</response_data>
<wsqualitor>
6.2.11.48 Operação getTechnicalAssistenceData
Operação retorna os dados de uma assistência técnica.

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
será retornado
<msg></msg>
Cópia Oficial
página: 290 de 359
</responsestatus>
<response_data>
<dataitem>
<nmassistenciatecnica>Beerland</nmassistenciatecnica>
<nrie>433423</nrie>
<nmcidade>CANOAS</nmcidade>
<nmuf>Rio Grande do Sul</nmuf>
<sguf>RS</sguf> </dataitem>
</response_data>
<wsqualitor>
6.2.11.49 Operação addReseller e updateReseller
Operações para cadastrar e atualizar respectivamente um revendedor na base
do Qualitor.
Cópia Oficial
página: 291 de 359

<wsqualitor>
<contents>
<data>
<cdrevendedor></cdrevendedor>
registro
<nmrevendedor>Beerland</nmrevendedor>
<cdtiporevendedor >4</cdtiporevendedor>
<nrie>433423</nrie>
</data>
</contents>
</wsqualitor>
Cópia Oficial
página: 292 de 359

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<responsedata>
<dataitem>
<cdrevendedor>12</cdrevendedor>
</dataitem>
</responsedata>
<wsqualitor>
6.2.11.50 Operação deleteReseller
Operação que exclui revendedores na base do Qualitor.

XML de entrada:
Cópia Oficial
página: 293 de 359
<wsqualitor>
<contents>
<data>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
<dataitem>
</dataitem>
</response_data>
<wsqualitor>
Cópia Oficial
página: 294 de 359
6.2.11.51 Operação getReseller
Essa operação realiza busca de revendedores.

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</
<nmrevendedor>Beerland</nmrevendedor>
<nrie></nrie>
<nmuf></nmuf>
Cópia Oficial
página: 295 de 359
<nmpais></nmpais> >
<msg></msg>
</responsestatus>
<response_data>
</response_data>
<wsqualitor>
6.2.11.52 Operação getResellerData
Operação retorna os dados de um revendedor.

XML de entrada:
<wsqualitor>
<contents>
<data>
</data>
</contents>
</wsqualitor>
Cópia Oficial
página: 296 de 359

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
<dataitem>
<nmrevendedor>REVENDA 01</nmrevendedor>
<dsendereco>Av. Rubem Bento Alves</dsendereco>
<nrfax></nrfax>
<nrcep>95041-410</nrcep>
<nrie>blah</nrie>
<nmbairro>Universitário</nmbairro>
<dscomplemento>Nr. 2101 - 503</dscomplemento>
<dsobservacao>bleh</dsobservacao>
<dsemail>[email protected]</dsemail>
<nmcidade>CAXIAS DO SUL</nmcidade>
<sguf>RS</sguf>
<cdtiporevendedor>1</cdtiporevendedor>
</response_data>
</wsqualitor>
Cópia Oficial
página: 297 de 359
6.2.11.53 Operação getAuthToken e getAuthTokenContact
Operações para gerar token de autenticação para atendente e solicitante
respectivamente. Através destas operações será possível obter um token contendo
informações codificadas para acessar o Qualitor sem precisar realizar login. O token
gerado permanecerá valido por 60 segundos, caso contrário, terá sua validade
expirada. Após gerar o token, deve-se montar a URL de acesso passando como
parâmetro a variável ‘authws’.
EX1 (acesso para o Qualitor atendente):
HTTP://localhost/qualitor_versao/login.php?authws=01t109t112t114t101x115t97
EX2 (acesso para o Qualitor solicitante):
H T T P : / / l o c a l h o s t / q u a l i t o r _ v e r s a o /
loginSolicitante.php?authws=01t109t112t114t101x115t97

XML de entrada para getAuthToken: (Informações em vermelho são
obrigatórias)
<wsqualitor>
<contents>
<data>
<cdempresa>1</cdclient>
</data>
</contents>
</wsqualitor>
NOTA: O campo cdempresa não é obrigatório, contudo se o usuário estiver
vinculado com mais de uma empresa, o campo cdempresa deverá ser informado.
Cópia Oficial
página: 298 de 359

XML de retorno de getAuthToken:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
<dataitem>
<token>99x100t101g109W112g114x101W115x97t61gNz99s100g117g115</
token>
</dataitem>
</response_data>
<wsqualitor>

XML de entrada para getAuthTokenContact: (Informações em vermelho
são obrigatórias)
<wsqualitor>
<contents>
<data>
</data>
</contents>
</wsqualitor>
Cópia Oficial
página: 299 de 359

XML de retorno de getAuthTokenContact:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
<dataitem>
<token>99x100t101g109W112g114x101W115x97t61gNz99s100g117g115</
token>
</dataitem>
</response_data>
<wsqualitor>
6.2.11.54 Operação addLoginMessage e updateLoginMessage
Operações para cadastrar e atualizar respectivamente uma mensagem de login
na base de dados do Qualitor.
<wsqualitor>
<contents>
<data>
Cópia Oficial
página: 300 de 359
<cdmensagem></mensagem>
<nmmensagem>Título da mensagem</nmmensagem>
<dsmensagem>HTML da mensagem</dsmensagem> Quando idtipo = T
Informe código da empresa. Apenas para
exibição portal
<cdoperador></cdoperador> Código do operador que efetuou a operacao
<idsolicitante>Y</idsolicitante>
<idatendente>Y</idatendente>
<idportal>N</idportal>
<idlogin>Y</idlogin>
<idtipo>T</idtipo>
D=>Documento / T=>dsmensagem
<nrordem></nrordem>
Quando idtipo = D
<dtmensagem></dtmensagem>
<idiomas>
</idiomas>
</data>
</contents>
</wsqualitor>
Cópia Oficial
página: 301 de 359

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<responsedata>
<dataitem>
<cdmensagem>12</cdmensagem>
</dataitem>
</responsedata>
<wsqualitor>
6.2.11.55 Operação deleteLoginMessage
Operação que exclui mensagens de login na base de dados do Qualitor.

XML de entrada:
Cópia Oficial
página: 302 de 359
<wsqualitor>
<contents>
<data>
</data>
</contents>
</wsqualitor>

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
<dataitem>
</dataitem>
</response_data>
<wsqualitor>
Cópia Oficial
página: 303 de 359
6.2.11.56 Operação getLoginMessage
Essa operação realiza busca de mensagens de login.

XML de retorno:
<wsqualitor>
<responsestatus>
<status>1</status>
<msg></msg>
</responsestatus>
<response_data>
<cdmensagem></mensagem>
<nmmensagem>Título da mensagem</nmmensagem>
Cópia Oficial
página: 304 de 359
<dsmensagem>HTML da mensagem</dsmensagem>
<cdoperador></cdoperador>
<idsolicitante>Y</idsolicitante>
<idatendente>Y</idatendente>
<idportal>N</idportal>
<idlogin>Y</idlogin>
<idtipo>T</idtipo>
<nrordem></nrordem>
<dtmensagem></dtmensagem>
<idiomas>
<nmlingua>Tangamandápiano</nmlingua>
</idiomas>
<idiomas>
<nmlingua>caciquês</nmlingua>
</idiomas>
</response_data>
<wsqualitor>
Cópia Oficial
página: 305 de 359
CAPÍTULO 7 - GATEWAYS
________________________________________________________
7.1 CONCEITO
Os Gateways são recursos utilizados por integradores / parceiros /
desenvolvedores ou clientes que desejam executar procedimentos integrados as
operações realizadas no Qualitor.
O idioma das classes e objetos utilizados nos Gateways utiliza o idioma
INGLÊS em sua estrutura, para fins de internacionalização.
NOTA: É necessário possuir licença de Gateways para poder utilizá-los no
Qualitor.
7.2 PADRÕES DE DESENVOLVIMENTO
Os Gateways estão localizados no diretório gtw/modules/[módulo]. Cada
cliente poderá criar seu próprio Gateway, basta criar um arquivo no diretório
especificado para cada operação. Cada arquivo passará por uma validação de
padronização e de periculosidade, se o Qualitor identificar que o arquivo possui
conteúdo malicioso, o Gateway não será executado.
Sabendo-se que o código fonte do Qualitor é orientado a objetos, os Gateways
também seguirão esta prática.
Cópia Oficial
página: 306 de 359
7.2.1 Exemplo de um Gateway
O Qualitor está disponibilizando um Gateway para abertura de chamados. Este
será executado antes e depois de abrir um chamado. Para seguindo o exemplo acima,
será necessário criar um arquivo dentro do módulo de chamados.
GTWNewTicket.class.php
Todos os nomes do arquivo começarão pelo prefixo ‘GTW’, seguido do nome
do Gateway mais o sufixo ‘.class.php’. A classe contida no arquivo se chamará
GTWNewTicket e deverá conter os métodos que implementam as operações do
Gateway, nesse caso o checkBerofeNewTicket e checkAfterNewTicket.
class GTWNewTicket {
function __construct() {
....
}
public function checkBeforeNewTicket(....) {
....
return array(...);
}
public function checkAfterNewTicket(....) {
....
return array(....);
}
}
Cópia Oficial
página: 307 de 359
7.2.2 Parâmetros dos métodos
Todos os métodos receberão os mesmos parâmetros pois cada operação de
um Gateway será executada individualmente e em contextos diferentes. Segue abaixo a
descrição de cada parâmetro respectivamente:
$arrayData: é um array associativo que contém dados provindos do formulário.
$arrayInfo: é um array associativo que contém informações do usuário logado.
$idContext: é um valor inteiro que define o contexto da aplicação.
$conn: é um objeto de conexão com o banco de dados do qualitor.
7.2.3 Exemplo da declaração de um método:
$idContext)
Retorno de valores:
Os valores retornados pelos métodos deverão seguir um padrão definido para
que o Qualitor possa processá-los. Os métodos sempre deverão retornar um array
associativo.
Ex: return array(‘txt’ => ‘Mensagem’, ‘flow’ => ‘question’);
O índice ‘txt’ referencia a mensagem de retorno e o índice ‘flow’ representa o
tipo de retorno, ou seja, como que o Qualitor deverá proceder. O índice ‘flow’ pode
conter os seguintes valores:
Cópia Oficial
página: 308 de 359
ok
Se existir o texto, a mensagem será apresentada com
apenas um botão de confirmação e o procedimento continuará adiante, se o texto não
existir, o procedimento segue adiante sem mostrar mensagem.
error
Mostra a mensagem de erro e o procedimento será
cancelado.(disponível apenas para os eventos BEFORE)
question
Significa que a mensagem de retorno apresentará uma
pergunta na tela do Qualitor. Esta pergunta conterá as opções de Sim e Não, se sim,
dá-se seqüência ao procedimento, se não, cancela o procedimento. (disponível
apenas para os eventos BEFORE)
continue
Não exibe mensagem e o procedimento seguirá adiante.
popup
O Qualitor irá abrir um popup passando como argumento a
url que o Gateway retornar. Se existir o texto, uma mensagem será apresentada na tela
e após clicar em ok, o popup será executado, caso contrário, o popup será executado
automaticamente.Ex de retorno: return array(‘txt’ => ‘’, ‘flow’ => ‘popup’, ‘url’ => ‘http://
www.url.com’);(disponível apenas para os eventos AFTER).
7.3 GATEWAY CHANGE
Os seguintes gateways relacionados à Change estão disponíveis:
7.3.1 Gateway GTWApproveChange
Nome do arquivo: GTWApproveChange.class.php
Nome da classe: GTWApproveChange
Cópia Oficial
página: 309 de 359
As
seguintes
Operações
estão
disponíveis
para
o
Gateway
GTWApproveChange:
7.3.1.1 checkBeforeApproveChange/checkAfterApproveChange
Executa as operações antes e/ou depois de aprovar uma mudança na base do
Qualitor.
/**
* @param Object mssql - objeto de conexão com o banco de dados do
Qualitor
* @param array $arrayData - dados do formulário
* @param array $arrayInfo - informações do usuário logado no Qualitor
* @param int $idContext - id de contexto
* @return array
*/
public function checkBeforeApproveChange($conn, $arrayData, $arrayInfo,
$idContext)
public function checkAfterApproveChange($conn, $arrayData, $arrayInfo,
$idContext)
7.3.2 Gateway GTWCloseChange
Nome do arquivo: GTWCloseChange.class.php
Nome da classe: GTWCloseChange
As
seguintes
Operações
estão
disponíveis
para
o
Gateway
GTWCloseChange:
Cópia Oficial
página: 310 de 359
7.3.2.1 checkBeforeCloseChange/checkAfterCloseChange
Executa as operações antes e/ou depois de encerrar uma mudança na base
do Qualitor.
/**
Qualitor
* @return array
*/
public function checkBeforeCloseChange($conn, $arrayData, $arrayInfo,
$idContext)
public function checkAfterCloseChange($conn, $arrayData, $arrayInfo,
$idContext)
7.3.3 Gateway GTWConfirmChange
Nome do arquivo: GTWConfirmChange.class.php
Nome da classe: GTWConfirmChange
As
seguintes
Operações
estão
disponíveis
para
o
Gateway
GTWConfirmChange:
Cópia Oficial
página: 311 de 359
7.3.3.1checkBeforeConfirmChange/checkAfterConfirmChange
Executa as operações antes e/ou depois de confirmar o planejamento da
mudança na base do Qualitor.
/**
Qualitor
* @return array
*/
public function checkBeforeConfirmChange($conn, $arrayData, $arrayInfo,
$idContext)
public function checkAfterConfirmChange($conn, $arrayData, $arrayInfo,
$idContext)
7.3.4 Gateway GTWNewChangeRequest
Nome do arquivo: GTWNewChangeRequest.class.php
Nome da classe: GTWNewChangeRequest
As
seguintes
Operações
estão
disponíveis
para
o
Gateway
GTWNewChangeRequest:
Cópia Oficial
página: 312 de 359
7.3.4.1 checkBeforeNewChangeRequest/checkAfterNewChangeRequest
Executa as operações antes e/ou depois de cadastrar nova mudança na base
do Qualitor.
/**
Qualitor
* @return array
*/
public function checkBeforeNewChangeRequest($conn, $arrayData, $arrayInfo,
$idContext)
public function checkAfterNewChangeRequest($conn, $arrayData, $arrayInfo,
$idContext)
7.3.5 Gateway GTWNewReplanChange
Nome do arquivo: GTWReplanChange.class.php
Nome da classe: GTWReplanChange
As
seguintes
Operações
estão
disponíveis
para
o
Gateway
GTWReplanChange:
7.3.5.1 checkBeforeReplanChange/checkAfterReplanChange
Executa as operações antes e/ou depois de replanejar a mudança na base do
Qualitor.
Cópia Oficial
página: 313 de 359
/**
Qualitor
* @return array
*/
public function checkBeforeReplanChange($conn, $arrayData, $arrayInfo,
$idContext)
public function checkAfterReplanChange($conn, $arrayData, $arrayInfo,
$idContext)
7.3.6 Gateway GTWUpdateChangeRequest
Nome do arquivo: GTWUpdateChangeRequest.class.php
Nome da classe: GTWUpdateChangeRequest
As
seguintes
Operações
estão
disponíveis
para
o
Gateway
GTWUpdateChangeRequest:
7.3.6.1 checkBeforeUpdateChangeRequest/checkAfterUpdateChangeRequest
Executa as operações antes e/ou depois de alterar a mudança na base do
Qualitor.
Cópia Oficial
página: 314 de 359
/**
Qualitor
* @return array
*/
public function checkBeforeUpdateChangeRequest($conn, $arrayData,
$arrayInfo,$idContext)
public function checkAfterUpdateChangeRequest($conn, $arrayData,
$arrayInfo, $idContext)
7.3.7 Gateway GTWVerifyChange
Nome do arquivo: GTWVerifyChange.class.php
Nome da classe: GTWVerifyChange
As seguintes Operações estão disponíveis para o Gateway GTWVerifyChange:
7.3.7.1 checkBeforeVerifyChange/checkAfterVerifyChange
Executa as operações antes e/ou depois de enviar a mudança para verificação
Cópia Oficial
página: 315 de 359
/**
Qualitor
* @return array
*/
public function checkBeforeVerifyChange($conn, $arrayData, $arrayInfo,
$idContext)
public function checkAfterVerifyChange($conn, $arrayData, $arrayInfo,
$idContext)
7.3.8 Gateway GTWStartChange
Nome do arquivo: GTWStartChange.class.php
Nome da classe: GTWStartChange
As seguintes Operações estão disponíveis para o Gateway GTWStartChange:
7.3.8.1 checkBeforeStartChange/ checkAfterStartChange
Executa as operações antes e/ou depois de se iniciar a execução da mudança
Cópia Oficial
página: 316 de 359
/**
Qualitor
* @return array
*/
public function checkBeforeStartChange ($conn, $arrayData, $arrayInfo,
$idContext)
public function checkAfterStartChange ($conn, $arrayData, $arrayInfo,
$idContext)
7.4 COMPONENT
Os seguintes gateways relacionados a component estão disponíveis:
7.4.1 Gateway GTWAddComponent
Nome do arquivo: GTWAddComponent.class.php
Nome da classe: GTWAddComponentt
As
seguintes
Operações
estão
disponíveis
para
o
Gateway
GTWAddComponent:
Cópia Oficial
página: 317 de 359
7.4.1.1 checkBeforeAddComponent/checkAfterAddComponent
Executa as operações antes e/ou depois de adicionar um componente na base
do Qualitor.
/**
Qualitor
* @return array
*/
public function checkBeforeAddComponent($conn, $arrayData, $arrayInfo,
$idContext)
public function checkAfterAddComponent($conn, $arrayData, $arrayInfo,
$idContext)
7.4.2 Gateway GTWDeleteComponent
Nome do arquivo: GTWDeleteComponent.class.php
Nome da classe: GTWDeleteComponent
As
seguintes
Operações
estão
disponíveis
para
o
Gateway
GTWDeleteComponent:
Cópia Oficial
página: 318 de 359
7.4.2.1 checkBeforeDeleteComponent/checkAfterDeleteComponent
Executa as operações antes e/ou depois de excluir um componente na base do
Qualitor.
/**
Qualitor
* @return array
*/
public function checkBeforeDeleteComponent($conn, $arrayData, $arrayInfo,
$idContext)
public function checkAfterDeleteComponent($conn, $arrayData, $arrayInfo,
$idContext)
7.4.3 Gateway GTWUpdateComponent
Nome do arquivo: GTWUpdateComponent.class.php
Nome da classe: GTWUpdateComponentt
As
seguintes
Operações
estão
disponíveis
para
o
Gateway
GTWUpdateComponent:
Cópia Oficial
página: 319 de 359
7.4.3.1 checkBeforeUpdateComponent/checkAfterUpdateComponent
Executa as operações antes e/ou depois de atualizar um componente na base
do Qualitor.
/**
Qualitor
* @return array
*/
public function checkBeforeUpdateComponent($conn, $arrayData, $arrayInfo,
$idContext)
public function checkAfterUpdateComponent($conn, $arrayData, $arrayInfo,
$idContext)
7.5 CUSTOMER
OS seguintes gateways estão disponíveis relacionados a Customer.
7.5.1 Gateway GTWAddCustomerContact
Nome do arquivo: GTWAddCustomerContact.class.php
Nome da classe: GTWAddCustomerContact
As
seguintes
Operações
estão
disponíveis
para
o
Gateway
GTWAddCustomerContact:
Cópia Oficial
página: 320 de 359
7.5.1.1 checkBeforeAddCustomerContact/checkAfterAddCustomerContact
Executa as operações antes e/ou depois de adicionar um contato na base do
Qualitor.
/**
Qualitor
* @return array
*/
public function checkBeforeAddCustomerContact($conn, $arrayData,
public function checkAfterAddCustomerContact($conn, $arrayData, $arrayInfo,
$idContext)
7.5.2 Gateway GTWDeleteCustomer
Nome do arquivo: GTWDeleteCustomer.class.php
Nome da classe: GTWDeleteCustomer
As
seguintes
Operações
estão
disponíveis
para
o
Gateway
GTWDeleteCustomer:
Cópia Oficial
página: 321 de 359
7.5.2.1OperaçãocheckBeforeDeleteCustomer/checkAfterDeleteCustomer
Executa as operações antes e/ou depois de excluir um cliente na base do
Qualitor.
/**
Qualitor
* @return array
*/
public function checkBeforeDeleteCustomer($conn, $arrayData, $arrayInfo,
$idContext)
public function checkAfterDeleteCustomer($conn, $arrayData, $arrayInfo,
$idContext)
7.5.3 Gateway GTWDeleteCustomerContact
Nome do arquivo: GTWDeleteCustomerContact.class.php
Nome da classe: GTWDeleteCustomerContact
As
seguintes
Operações
estão
disponíveis
para
o
Gateway
GTWDeleteCustomerContact:
Cópia Oficial
página: 322 de 359
7.5.3.1 checkBeforeDeleteCustomerContact/checkAfterDeleteCustomerContact
Executa as operações antes e/ou depois de excluir um contato na base do
Qualitor.
/**
Qualitor
* @return array
*/
public function checkBeforeDeleteCustomerContact($conn, $arrayData,
public function checkAfterDeleteCustomerContact($conn, $arrayData,
7.5.4 Gateway GTWAddCustomer
Nome do arquivo: GTWAddCustomer.class.php
Nome da classe: GTWAddCustomer
As
seguintes
Operações
estão
disponíveis
para
o
Gateway
GTWAddCustomer:
Cópia Oficial
página: 323 de 359
7.5.4.1 Operação checkBeforeAddCustomer/checkAfterAddCustomer
Executa as operações antes e/ou depois de adicionar um cliente na base do
Qualitor.
/**
Qualitor
* @return array
*/
public function checkBeforeAddCustomer($conn, $arrayData, $arrayInfo,
$idContext)
public function checkAfterAddCustomer($conn, $arrayData, $arrayInfo,
$idContext)
7.5.5 Gateway GTWUpdateCustomer
Nome do arquivo: GTWUpdateCustomer.class.php
Nome da classe: GTWUpdateCustomer
As
seguintes
Operações
estão
disponíveis
para
o
Gateway
GTWUpdateCustomer:
Cópia Oficial
página: 324 de 359
7.5.5.1 Operação checkBeforeUpdateCustomer/checkAfterUpdateCustomer
Executa as operações antes e/ou depois de atualizar um cliente na base do
Qualitor.
/**
Qualitor
* @return array
*/
public function checkBeforeUpdateCustomer($conn, $arrayData, $arrayInfo,
$idContext)
public function checkAfterUpdateCustomer($conn, $arrayData, $arrayInfo,
$idContext)
7.5.6 Gateway GTWDeleteContact
Nome do arquivo: GTWDeleteContact.class.php
Nome da classe: GTWDeleteContact
As
seguintes
Operações
estão
disponíveis
para
o
Gateway
GTWDeleteContact:
Cópia Oficial
página: 325 de 359
7.5.6.1 checkBeforeDeleteContact/checkAfterDeleteContact
Executa as operações antes e/ou depois de excluir um contato na base do
Qualitor.
/**
Qualitor
* @return array
*/
public function checkBeforeDeleteContact($conn, $arrayData, $arrayInfo,
$idContext)
public function checkAfterDeleteContact($conn, $arrayData, $arrayInfo,
$idContext)
7.5.7 Gateway GTWUpdateContact
Nome do arquivo: GTWUpdateContact.class.php
Nome da classe: GTWUpdateContact
As
seguintes
Operações
estão
disponíveis
para
o
Gateway
GTWUpdateContact:
Cópia Oficial
página: 326 de 359
7.5.7.1 checkBeforeUpdateContact/checkAfterUpdateContact
Executa as operações antes e/ou depois de atualizar um contato na base do
Qualitor.
/**
Qualitor
* @return array
*/
public function checkBeforeUpdateContact($conn, $arrayData, $arrayInfo,
$idContext)
public function checkAfterUpdateContact($conn, $arrayData, $arrayInfo,
$idContext)
7.5.8 Gateway GTWAddContact
Nome do arquivo: GTWAddContact.class.php
Nome da classe: GTWAddContact
As seguintes Operações estão disponíveis para o Gateway GTWAddContact:
7.5.8.1 checkBeforeAddContact/checkAfterAddContact
Executa as operações antes e/ou depois de adicionar um contato na base do
Qualitor.
Cópia Oficial
página: 327 de 359
/**
Qualitor
* @return array
*/
public function checkBeforeAddContact($conn, $arrayData, $arrayInfo,
$idContext)
public function checkAfterAddContact($conn, $arrayData, $arrayInfo,
$idContext)
7.6 EQUIPMENT
Os seguintes gateways relacionados a Equipment estão disponíveis:
7.6.1 Gateway GTWAddEquipmentComponent
Nome do arquivo: GTWAddEquipmentComponent.class.php
Nome da classe: GTWAddEquipmentComponent
As
seguintes
Operações
estão
disponíveis
para
o
Gateway
GTWAddEquipmentComponent:
Cópia Oficial
página: 328 de 359
7.6.1.1checkBeforeAddEquipmentComponent/checkAfterAddEquipmentComponent
Executa as operações antes e/ou depois de adicionar um componente ao
equipamento na base do Qualitor.
/**
Qualitor
* @return array
*/
public function checkBeforeAddEquipmentComponent($conn, $arrayData,
public function checkAfterAddEquipmentComponent($conn, $arrayData,
7.6.2 Gateway GTWDeleteEquipmentComponent
Nome do arquivo: GTWDeleteEquipmentComponent.class.php
Nome da classe: GTWDeleteEquipmentComponent
As
seguintes
Operações
estão
disponíveis
para
o
Gateway
GTWDeleteEquipmentComponent:
Cópia Oficial
página: 329 de 359
7.6.2.1checkBeforeDeleteEquipmentComponent/
checkAfterDeleteEquipmentComponent
Executa as operações antes e/ou depois de excluir um componente do
/**
Qualitor
* @return array
*/
public function checkBeforeDeleteEquipmentComponent($conn, $arrayData,
public function checkAfterDeleteEquipmentComponent($conn, $arrayData,
7.6.3 Gateway GTWAddEquipmentSoftware
Nome do arquivo: GTWAddEquipmentSoftware.class.php
Nome da classe: GTWAddEquipmentSoftware
As
seguintes
Operações
estão
disponíveis
para
o
Gateway
GTWAddEquipmentSoftware:
Cópia Oficial
página: 330 de 359
7.6.3.1 checkBeforeAddEquipmentSoftware/checkAfterAddEquipmentSoftware
Executa as operações antes e/ou depois de adicionar um software ao
/**
Qualitor
* @return array
*/
public function checkBeforeAddEquipmentSoftware($conn, $arrayData,
public function checkAfterAddEquipmentSoftware($conn, $arrayData,
7.6.4 Gateway GTWDeleteEquipmentSoftware
Nome do arquivo: GTWDeleteEquipmentSoftware.class.php
Nome da classe: GTWDeleteEquipmentSoftware
As
seguintes
Operações
estão
disponíveis
para
o
Gateway
GTWDeleteEquipmentSoftware:
Cópia Oficial
página: 331 de 359
7.6.4.1checkBeforeDeleteEquipmentSoftware/checkAfterDeleteEquipmentSoftware
Executa as operações antes e/ou depois de excluir um software do
/**
Qualitor
* @return array
*/
public function checkBeforeDeleteEquipmentSoftware($conn, $arrayData,
public function checkAfterDeleteEquipmentSoftware($conn, $arrayData,
7.6.5 Gateway GTWAddEquipment
Nome do arquivo: GTWAddEquipment.class.php
Nome da classe: GTWAddEquipment
As
seguintes
Operações
estão
disponíveis
para
o
Gateway
GTWAddEquipment:
Cópia Oficial
página: 332 de 359
7.6.5.1 checkBeforeAddEquipment/checkAfterAddEquipment
Executa as operações antes e/ou depois de adicionar um equipamento na
base do Qualitor.
/**
Qualitor
* @return array
*/
public function checkBeforeAddEquipment($conn, $arrayData, $arrayInfo,
$idContext)
public function checkAfterAddEquipment($conn, $arrayData, $arrayInfo,
$idContext)
7.6.6 Gateway GTWDeleteEquipment
Nome do arquivo: GTWDeleteEquipment.class.php
Nome da classe: GTWDeleteEquipment
As
seguintes
Operações
estão
disponíveis
para
o
Gateway
GTWDeleteEquipment:
Cópia Oficial
página: 333 de 359
7.6.6.1 checkBeforeDeleteEquipment/checkAfterDeleteEquipment
Executa as operações antes e/ou depois de excluir um equipamento na base
do Qualitor.
/**
Qualitor
* @return array
*/
public function checkBeforeDeleteEquipment($conn, $arrayData, $arrayInfo,
$idContext)
public function checkAfterDeleteEquipment($conn, $arrayData, $arrayInfo,
$idContext)
7.6.7 Gateway GTWUpdateEquipment
Nome do arquivo: GTWUpdateEquipment.class.php
Nome da classe: GTWUpdateEquipment
As
seguintes
Operações
estão
disponíveis
para
o
Gateway
GTWUpdateEquipment:
Cópia Oficial
página: 334 de 359
7.6.7.1 checkBeforeUpdateEquipment/checkAfterUpdateEquipment
Executa as operações antes e/ou depois de atualizar um equipamento na base
do Qualitor.
/**
Qualitor
* @return array
*/
public function checkBeforeUpdateEquipment($conn, $arrayData, $arrayInfo,
$idContext)
public function checkAfterUpdateEquipment($conn, $arrayData, $arrayInfo,
$idContext)
7.7 PRODUCT
Os seguintes gateways relacionados a Product estão disponíveis:
7.7.1 Gateway GTWAddProduct
Nome do arquivo: GTWAddProduct.class.php
Nome da classe: GTWAddProduct
As seguintes Operações estão disponíveis para o Gateway GTWAddProduct:
Cópia Oficial
página: 335 de 359
7.7.1.1 checkBeforeAddProduct/checkAfterAddProduct
Executa as operações antes e/ou depois de adicionar um produto na base do
Qualitor.
/**
Qualitor
* @return array
*/
public function checkBeforeAddProduct($conn, $arrayData, $arrayInfo,
$idContext)
public function checkAfterAddProduct($conn, $arrayData, $arrayInfo,
$idContext)
7.7.2 Gateway GTWDeleteProduct
Nome do arquivo: GTWDeleteProduct.class.php
Nome da classe: GTWDeleteProduct
As
seguintes
Operações
estão
disponíveis
para
o
Gateway
GTWDeleteProduct:
Cópia Oficial
página: 336 de 359
7.7.2.1 checkBeforeDeleteProduct/checkAfterDeleteProduct
Executa as operações antes e/ou depois de excluir um produto na base do
Qualitor.
/**
Qualitor
* @return array
*/
public function checkBeforeDeleteProduct($conn, $arrayData, $arrayInfo,
$idContext)
public function checkAfterDeleteProduct($conn, $arrayData, $arrayInfo,
$idContext)
7.7.3 Gateway GTWUpdateProduct
Nome do arquivo: GTWUpdateProduct.class.php
Nome da classe: GTWUpdateProduct
As
seguintes
Operações
estão
disponíveis
para
o
Gateway
GTWUpdateProduct:
7.7.3.1 checkBeforeUpdateProduct/checkAfterUpdateProduct
Executa as operações antes e/ou depois de atualizar um produto na base do
Qualitor.
Cópia Oficial
página: 337 de 359
/**
Qualitor
* @return array
*/
public function checkBeforeUpdateProduct($conn, $arrayData, $arrayInfo,
$idContext)
public function checkAfterUpdateProduct($conn, $arrayData, $arrayInfo,
$idContext)
7.9 SOFTWARE
Os seguintes gateways relacionados a software estão disponíveis:
7.9.1 Gateway GTWAddSoftware
Nome do arquivo: GTWAddSoftware.class.php
Nome da classe: GTWAddSoftware
As seguintes Operações estão disponíveis para o Gateway GTWAddSoftware:
Cópia Oficial
página: 338 de 359
7.9.1.1 checkBeforeAddSoftware/checkAfterAddSoftware
Executa as operações antes e/ou depois de adicionar um software na base do
Qualitor.
/**
Qualitor
* @return array
*/
public function checkBeforeAddSoftware($conn, $arrayData, $arrayInfo,
$idContext)
public function checkAfterAddSoftware($conn, $arrayData, $arrayInfo,
$idContext)
7.9.2 Gateway GTWDeleteSoftware
Nome do arquivo: GTWDeleteSoftware.class.php
Nome da classe: GTWDeleteSoftware
As
seguintes
Operações
estão
disponíveis
para
o
Gateway
GTWDeleteSoftware:
7.9.2.1 checkBeforeDeleteSoftware/checkAfterDeleteSoftware
Executa as operações antes e/ou depois de excluir um software na base do
Qualitor.
Cópia Oficial
página: 339 de 359
/**
Qualitor
* @return array
*/
public function checkBeforeDelteSoftware($conn, $arrayData, $arrayInfo,
$idContext)
public function checkAfterDeleteSoftware($conn, $arrayData, $arrayInfo,
$idContext)
7.9.3 Gateway GTWUpdateSoftware
Nome do arquivo: GTWUpdateSoftware.class.php
Nome da classe: GTWUpdateSoftware
As
seguintes
Operações
estão
disponíveis
para
o
Gateway
GTWUpdateSoftware:
7.9.3.1 checkBeforeUpdateSoftware/checkAfterUpdateSoftware
Executa as operações antes e/ou depois de atualizar um software na base do
Qualitor.
Cópia Oficial
página: 340 de 359
/**
Qualitor
* @return array
*/
public function checkBeforeUpdateSoftware($conn, $arrayData, $arrayInfo,
$idContext)
public function checkAfterUpdateSoftware($conn, $arrayData, $arrayInfo,
$idContext)
7.9 TASK
Os seguintes gateways relacionados a Task estão disponíveis:
7.9.1 Gateway GTWNewTask
Nome do arquivo: GTWNewTask.class.php
Nome da classe: GTWNewTask
As seguintes Operações estão disponíveis para o Gateway GTWNewTask:
7.9.1.1 Operação checkBeforeNewTask
Executa esta operação antes de adicionar uma Ação na base do Qualitor.
Cópia Oficial
página: 341 de 359
/**
Qualitor
* @return array
*/
public function checkBeforeNewTask($conn, $arrayData, $arrayInfo,
$idContext)
7.9.1.2 Operação checkAfterNewTask
Executa esta operação depois de adicionar uma Ação na base do Qualitor.
/**
Qualitor
* @return array
*/
public function checkAfterNewTask($conn, $arrayData, $arrayInfo, $idContext)
Cópia Oficial
página: 342 de 359
7.9.2 Gateway GTWStartTask
Nome do arquivo: GTWStartTask.class.php
Nome da classe: GTWStartTask
As seguintes Operações estão disponíveis para o Gateway GTWStartTask:
7.9.2.1 Operação checkBeforeStartTask
Executa esta operação antes de iniciar uma Ação na base do Qualitor.
/**
Qualitor
* @return array
*/
public function checkBeforeStartTask($conn, $arrayData, $arrayInfo,
$idContext)
7.9.2.2 Operação checkAfterStartTask
Executa esta operação depois de iniciar uma Ação na base do Qualitor.
Cópia Oficial
página: 343 de 359
/**
Qualitor
* @return array
*/
public function checkAfterStartTask($conn, $arrayData, $arrayInfo, $idContext)
7.9.3 Gateway GTWFinishTask
Nome do arquivo: GTWFinishTask.class.php
Nome da classe: GTWFinishTask
As seguintes Operações estão disponíveis para o Gateway GTWFinishTask:
7.9.3.1 Operação checkBeforeFinishTask
Executa esta operação antes de encerrar uma Ação na base do Qualitor.
/**
Qualitor
Cópia Oficial
página: 344 de 359
* @return array
*/
public function checkBeforeFinishTask($conn, $arrayData, $arrayInfo,
$idContext)
7.9.3.2 Operação checkAfterFinishTask
Executa esta operação depois de encerrar uma Ação na base do Qualitor.
/**
Qualitor
* @return array
*/
public function checkAfterFinishTask($conn, $arrayData, $arrayInfo, $idContext)
7.9.4 Gateway GTWProrrogueTask
Nome do arquivo: GTWProrrogueTask.class.php
Nome da classe: GTWProrrogueTask
As
seguintes
Operações
estão
disponíveis
para
o
Gateway
GTWProrrogueTask:
Cópia Oficial
página: 345 de 359
7.9.4.1 Operação checkBeforeProrrogueTask
Executa esta operação antes de prorrogar uma Ação na base do Qualitor.
/**
Qualitor
* @return array
*/
public function checkBeforeProrrogueTask($conn, $arrayData, $arrayInfo,
$idContext)
7.9.4.2 Operação checkAfterProrrogueTask
Executa esta operação depois de prorrogar uma Ação na base do Qualitor.
/**
Qualitor
* @return array
*/
public function checkAfterProrrogueTask($conn, $arrayData, $arrayInfo,
$idContext)
Cópia Oficial
página: 346 de 359
7.9.5 Gateway GTWAddUserTask
Nome do arquivo: GTWAddUserTask.class.php
Nome da classe: GTWAddUserTask
As seguintes Operações estão disponíveis para o Gateway GTWAddUserTask:
7.9.5.1 Operação checkBeforeAddUserTask
Executa esta operação antes de vincular um usuário a uma Ação na base do
Qualitor.
/**
Qualitor
* @return array
*/
public function checkBeforeAddUserTask($conn, $arrayData, $arrayInfo,
$idContext)
7.9.5.2 Operação checkAfterAddUserTask
Executa esta operação depois de vincular um usuário a uma Ação na base do
Qualitor.
Cópia Oficial
página: 347 de 359
/**
Qualitor
* @return array
*/
public function checkAfterAddUserTask($conn, $arrayData, $arrayInfo,
$idContext)
7.9.6 Gateway GTWCancelTask
Nome do arquivo: GTWCancelTask.class.php
Nome da classe: GTWCancelTask
As seguintes Operações estão disponíveis para o Gateway GTWCancelTask:
7.9.6.1 Operação checkBeforeCancelTask
Executa esta operação antes de cancelar uma Ação na base do Qualitor.
Cópia Oficial
página: 348 de 359
/**
Qualitor
* @return array
*/
public function checkBeforeCancelTask($conn, $arrayData, $arrayInfo,
$idContext)
7.9.6.2 Operação checkAfterCancelTask
Executa esta operação depois de cancelar uma Ação na base do Qualitor.
/**
Qualitor
* @return array
*/
public function checkAfterCancelarTask($conn, $arrayData, $arrayInfo,
$idContext)
Cópia Oficial
página: 349 de 359
7.9.7 Gateway GTWAddHistoryTask
Nome do arquivo: GTWAddHistoryTask.class.php
Nome da classe: GTWAddHistoryTask
As
seguintes
Operações
estão
disponíveis
para
o
Gateway
GTWAddHistoryTask:
7.9.7.1 Operação checkBeforeAddHistoryTask
Executa esta operação antes de adicionar manualmente um registro de histórico
na Ação da base do Qualitor.
/**
Qualitor
* @return array
*/
public function checkBeforeAddHistoryTask($conn, $arrayData, $arrayInfo,
$idContext)
7.9.7.2 Operação checkAfterAddHistoryTask
Executa esta operação depois de adicionar manualmente um registro de
histórico na Ação na base do Qualitor.
Cópia Oficial
página: 350 de 359
/**
Qualitor
* @return array
*/
public function checkAfterAddHistoryTask($conn, $arrayData, $arrayInfo,
$idContext)
7.10 TICKET
Os seguintes gateways relacionados a Ticket estão disponíveis:
7.10.1 Gateway GTWNewTicket (Qualitor atendente)
Nome do arquivo: GTWNewTicket.class.php
Nome da classe: GTWNewTicket
As seguintes Operações estão disponíveis para o Gateway GTWNewTicket:
7.10.1.1 Operação checkBeforeNewTicket
Executa esta operação antes de adicionar um Chamado na base do Qualitor.
Cópia Oficial
página: 351 de 359
/**
Qualitor
* @return array
*/
$idContext)
7.10.1.2 Operação checkAfterNewTicket
Executa esta operação depois de adicionar um Chamado na base do Qualitor.
/**
Qualitor
* @return array
*/
public function checkAfterNewTicket($conn, $arrayData, $arrayInfo, $idContext)
Cópia Oficial
página: 352 de 359
7.10.2 Gateway GTWAddTicket (Qualitor solicitante)
Nome do arquivo: GTWAddTicket.class.php
Nome da classe: GTWAddTicket
As seguintes Operações estão disponíveis para o Gateway GTWAddTicket:
7.10.2.1 Operação checkBeforeAddTicket
Executa esta operação antes de adicionar um Chamado na base do Qualitor.
/**
Qualitor
* @return array
*/
public function checkBeforeAddTicket($conn, $arrayData, $arrayInfo,
$idContext)
7.10.2.2 Operação checkAfterAddTicket
Executa esta operação depois de adicionar um Chamado na base do Qualitor.
Cópia Oficial
página: 353 de 359
/**
Qualitor
* @return array
*/
public function checkAfterAddTicket($conn, $arrayData, $arrayInfo, $idContext)
7.10.3 Gateway GTWStartTicket
Nome do arquivo: GTWStartTicket.class.php
Nome da classe: GTWStartTicket
As seguintes Operações estão disponíveis para o Gateway GTWStartTicket:
7.10.3.1 Operação checkBeforeStartTicket
Executa esta operação antes de iniciar um Chamado na base do Qualitor.
/**
Qualitor
* @return array
Cópia Oficial
página: 354 de 359
*/
public function checkBeforeStartTicket($conn, $arrayData, $arrayInfo,
$idContext)
7.10.3.2 Operação checkAfterStartTicket
Executa esta operação depois de iniciar um Chamado na base do Qualitor.
/**
Qualitor
* @return array
*/
public function checkAfterStartTicket ($conn, $arrayData, $arrayInfo,
$idContext)
7.10.3.3 Operação checkBeforeFinishTicket
Executa esta operação antes de encerrar um Chamado na base do Qualitor.
Cópia Oficial
página: 355 de 359
/**
Qualitor
* @return array
*/
public function checkBeforeFinishTicket($conn, $arrayData, $arrayInfo,
$idContext)
7.10.3.4 Operação checkAfterFinishTicket
Executa esta operação depois de encerrar um Chamado na base do Qualitor.
/**
Qualitor
* @return array
*/
public function checkAfterFinishTicket($conn, $arrayData, $arrayInfo,
$idContext)
Cópia Oficial
página: 356 de 359
7.10.4 Gateway GTWProrrogueTicket
Nome do arquivo: GTWProrrogueTicket.class.php
Nome da classe: GTWProrrogueTicket
As
seguintes
Operações
estão
disponíveis
para
o
Gateway
GTWProrrogueTicket:
7.10.4.1 Operação checkBeforeProrrogueTicket
Executa esta operação antes de prorrogar um Chamado na base do Qualitor.
/**
Qualitor
* @return array
*/
public function checkBeforeProrrogueTicket($conn, $arrayData, $arrayInfo,
$idContext)
7.10.4.2 Operação checkAfterProrrogueTicket
Executa esta operação depois de prorrogar um Chamado na base do Qualitor.
Cópia Oficial
página: 357 de 359
/**
Qualitor
* @return array
*/
public function checkAfterProrrogueTicket($conn, $arrayData, $arrayInfo,
$idContext)
7.10.5 Gateway GTWTransferTechnicianTicket
Nome do arquivo: GTWTransferTechnicianTicket.class.php
Nome da classe: GTWTransferTechnicianTicket
As
seguintes
Operações
estão
disponíveis
para
o
Gateway
GTWTransferTechnicianTicket:
7.10.5.1 Operação checkBeforeTransferTechnicianTicket
Executa esta operação antes de vincular um usuário a um Chamado na base do
Qualitor.
Cópia Oficial
página: 358 de 359
/**
Qualitor
* @return array
*/
public function checkBeforeAddUserTicket($conn, $arrayData, $arrayInfo,
$idContext)
7.10.5.2 Operação checkAfterTransferTechnicianTicket
Executa esta operação depois de vincular um usuário a um Chamado na base
do Qualitor.
/**
Qualitor
* @return array
*/
public function checkAfterAddUserTicket($conn, $arrayData, $arrayInfo,
$idContext)
Cópia Oficial
página: 359 de 359
7.10.6 Gateway GTWCancelTicket
Nome do arquivo: GTWCancelTicket.class.php
Nome da classe: GTWCancelTicket
As seguintes Operações estão disponíveis para o Gateway GTWCancelTicket:
Operação checkBeforeCancelTicket
Executa esta operação antes de cancelar um Chamadona base do Qualitor.
/**
Qualitor
* @return array
*/
public function checkBeforeCancelTicket($conn, $arrayData, $arrayInfo,
$idContext)
7.10.6.1 Operação checkAfterCancelTicket
Executa esta operação depois de cancelar um Chamado na base do Qualitor.
Cópia Oficial
página: 360 de 359
/**
Qualitor
* @return array
*/
public function checkAfterCancelarTicket($conn, $arrayData, $arrayInfo,
$idContext)
7.10.7 Gateway GTWAddRegisterTicket
Nome do arquivo: GTWAddRegisterTicket.class.php
Nome da classe: GTWAddRegisterTicket
As
seguintes
Operações
estão
disponíveis
para
o
Gateway
GTWAddRegisterTicket:
7.10.7.1 Operação checkBeforeAddRegisterTicket
Executa esta operação antes de adicionar manualmente um registro de
atividade o Chamado da base do Qualitor.
Cópia Oficial
página: 361 de 359
/**
Qualitor
* @return array
*/
public function checkBeforeAddRegisterTicket($conn, $arrayData, $arrayInfo,
$idContext)
7.10.7.2 Operação checkAfterAddRegisterTicket
Executa esta operação depois de adicionar manualmente um registro de
atividade no Chamado na base do Qualitor.
/**
Qualitor
* @return array
*/
public function checkAfterAddRegisterTicket($conn, $arrayData, $arrayInfo,
$idContext)
Cópia Oficial
página: 362 de 359
7.10.8 Gateway GTWAnswerQuestion
Nome do arquivo: GTWAnswerQuestion.class.php
Nome da classe: GTWAnswerQuestion
As
seguintes
Operações
estão
disponíveis
para
o
Gateway
GTWAnswerQuestion:
7.10.8.1 Operação checkBeforeAnswerQuestion
Executa esta operação antes responder uma pergunta do script de
atendimento.
/**
Qualitor
* @return array
*/
public function checkBeforeAnswerQuestion($conn, $arrayData, $arrayInfo,
$idContext)
7.10.8.2 Operação checkAfterAnswerQuestion
Executa esta operação depois de responder um pergunta do script de
atendimento.
Cópia Oficial
página: 363 de 359
/**
Qualitor
* @return array
*/
public function checkAfterAnswerQuestion($conn, $arrayData, $arrayInfo,
$idContext)
7.10.9 Gateway GTWHistoryChange
Nome do arquivo: GTWHistoryChange.class.php
Nome da classe: GTWHistoryChange
As
seguintes
Operações
estão
disponíveis
para
o
Gateway
GTWHistoryChange:
7.10.9.1Operação checkBeforeHistoryChange
Executa esta operação antes de editar um acompanhamento no histórico do
chamado.
Cópia Oficial
página: 364 de 359
/**
Qualitor
* @return array
*/
public function checkBeforeHistoryChange ($conn, $arrayData, $arrayInfo,
$idContext)
7.10.9.2 Operação checkAfterHistoryChange
Executa esta operação antes de editar um acompanhamento no histórico do
chamado.
/**
Qualitor
* @return array
*/
public function checkBeforeHistoryChange ($conn, $arrayData, $arrayInfo,
$idContext)
Cópia Oficial
página: 365 de 359