CA Process Automation
Referência do Criador de Conteúdo
Release 04.2.00
A presente documentação, que inclui os sistemas de ajuda incorporados e os materiais distribuídos eletronicamente (doravante
denominada Documentação), destina-se apenas a fins informativos e está sujeita a alterações ou remoção por parte da CA a
qualquer momento. Esta Documentação contém informações proprietárias da CA e não pode ser copiada, transferida,
reproduzida, divulgada, modificada nem duplicada, parcial ou completamente, sem o prévio consentimento por escrito da CA.
Se o Cliente for um usuário licenciado do(s) produto(s) de software referido(s) na Documentação, é permitido que ele imprima
ou, de outro modo, disponibilize uma quantidade razoável de cópias da Documentação para uso interno seu e de seus
funcionários envolvidos com o software em questão, contanto que todos os avisos de direitos autorais e legendas da CA
estejam presentes em cada cópia reproduzida.
O direito à impressão ou, de outro modo, à disponibilidade de cópias da Documentação está limitado ao período em que a
licença aplicável ao referido software permanecer em pleno vigor e efeito. Em caso de término da licença, por qualquer motivo,
fica o usuário responsável por garantir à CA, por escrito, que todas as cópias, parciais ou integrais, da Documentação sejam
devolvidas à CA ou destruídas.
NA MEDIDA EM QUE PERMITIDO PELA LEI APLICÁVEL, A CA FORNECE ESTA DOCUMENTAÇÃO "NO ESTADO EM QUE SE
ENCONTRA", SEM NENHUM TIPO DE GARANTIA, INCLUINDO, ENTRE OUTROS, QUAISQUER GARANTIAS IMPLÍCITAS DE
COMERCIABILIDADE, ADEQUAÇÃO A UM DETERMINADO FIM OU NÃO VIOLAÇÃO. EM NENHUMA OCASIÃO, A CA SERÁ
RESPONSÁVEL PERANTE O USUÁRIO OU TERCEIROS POR QUAISQUER PERDAS OU DANOS, DIRETOS OU INDIRETOS,
RESULTANTES DO USO DA DOCUMENTAÇÃO, INCLUINDO, ENTRE OUTROS, LUCROS CESSANTES, PERDA DE INVESTIMENTO,
INTERRUPÇÃO DOS NEGÓCIOS, FUNDO DE COMÉRCIO OU PERDA DE DADOS, MESMO QUE A CA TENHA SIDO EXPRESSAMENTE
ADVERTIDA SOBRE A POSSIBILIDADE DE TAIS PERDAS E DANOS.
O uso de qualquer software mencionado na Documentação é regido pelo contrato de licença aplicável, e tal contrato não deve
ser modificado de nenhum modo pelos termos deste aviso.
O fabricante desta Documentação é a CA.
Fornecida com “Direitos restritos”. O uso, duplicação ou divulgação pelo governo dos Estados Unidos está sujeita às restrições
descritas no FAR, seções 12.212, 52.227-14 e 52.227-19(c)(1) - (2) e DFARS, seção 252.227-7014(b)(3), conforme aplicável, ou
sucessores.
Copyright © 2010 CA. Todos os direitos reservados. Todas as marcas comerciais, nomes de marcas, marcas de serviço e
logotipos aqui mencionados pertencem às suas respectivas empresas.
Referências a produtos da CA Technologies
Este documento faz referência aos seguintes produtos da CA Technologies:
■
CA Catalyst para o CA Service Desk Manager (CA Catalyst Conector do CA SDM)
■
CA Client Automation (anteriormente CA IT Client Manager)
■
CA Configuration Automation (anteriormente, CA Cohesion® Application
Configuration Manager)
■
CA CMDB
■
CA eHealth®
■
CA EEM (Embedded Entitlements Manager)
■
CA Infrastructure Insight (anteriormente Bundle: CA Spectrum IM & CA NetQoS
Reporter Analyzer combinados)
■
CA NSM
■
CA Process Automation (anteriormente, CA IT Process Automation Manager)
■
CA Service Catalog
■
CA SDM (CA Service Desk Manager)
■
CA Service Operations Insight (CA SOI) (anteriormente CA Spectrum® Service
Assurance)
■
CA SiteMinder®
■
CA Workload Automation AE
Entrar em contato com o Suporte técnico
Para assistência técnica online e uma lista completa dos locais, principais horários de
atendimento e números de telefone, entre em contato com o Suporte técnico pelo
endereço http://www.ca.com/worldwide.
Alterações na documentação
Foram feitas as seguintes atualizações de documentação desde a última release desta
documentação:
■
[Nome do tópico]-[Descrição do novo capítulo, tópico ou descrição de alterações
em um tópico existente].
■
[Nome do tópico]-[Descrição do novo capítulo, tópico ou descrição de alterações
em um tópico existente].
Índice
Capítulo 1: Introdução aos operadores
19
Visão geral do operador ............................................................................................................................................. 19
Quando os operadores Não Executar ........................................................................................................................ 21
Propriedades comuns de todos os operadores .......................................................................................................... 27
Configurações de execução (todos os Operadores) ............................................................................................ 27
Propriedades comuns de operadores em processos ................................................................................................. 33
Grupo de processamento.................................................................................................................................... 34
Propriedades da simulação ................................................................................................................................. 36
Propriedades de informações ............................................................................................................................. 38
Propriedades comuns de operadores em Agendas ................................................................................................... 39
Configurações do Calendário .............................................................................................................................. 40
Datas incluídas manualmente ............................................................................................................................. 41
Datas excluídas manualmente ............................................................................................................................ 41
Nome da tarefa ................................................................................................................................................... 42
Parâmetros de saída comuns a todos os operadores ................................................................................................ 42
Capítulo 2: Operadores padrão.
43
Operador Iniciar ......................................................................................................................................................... 43
Parâmetros de entrada ....................................................................................................................................... 43
Operador Comentário ................................................................................................................................................ 44
Parâmetros de entrada ....................................................................................................................................... 44
Operador Interrupção bem-sucedida......................................................................................................................... 45
Parâmetros de entrada ....................................................................................................................................... 45
Operador Interrupção com falha ............................................................................................................................... 46
Parâmetros de entrada ....................................................................................................................................... 47
Operador do andamento do processo ....................................................................................................................... 47
Parâmetros de entrada ....................................................................................................................................... 48
Saída .................................................................................................................................................................... 48
operador e .................................................................................................................................................................. 48
Operador Ou .............................................................................................................................................................. 49
Operador redefinir ..................................................................................................................................................... 50
Parâmetros de entrada ....................................................................................................................................... 50
Como o operador Redefinir funciona com o operador Loop .............................................................................. 51
Operador Loop ........................................................................................................................................................... 52
Parâmetros de entrada ....................................................................................................................................... 53
Parâmetros de saída ........................................................................................................................................... 56
Índice 5
Redefinir manualmente o operador Loop em um processo ............................................................................... 56
Operador Alterar a rota.............................................................................................................................................. 56
Parâmetros de entrada ....................................................................................................................................... 56
Operador de exceção ................................................................................................................................................. 57
Parâmetros de entrada ....................................................................................................................................... 57
Links............................................................................................................................................................................ 57
Propriedades do link ........................................................................................................................................... 58
Capítulo 3: Catalyst
59
Operadores USM genéricos ....................................................................................................................................... 59
Operador Criar .................................................................................................................................................... 59
Operador Excluir ................................................................................................................................................. 61
Operador Executar .............................................................................................................................................. 62
Operador Get ...................................................................................................................................................... 69
Operador Inscrever-se para receber alterações ................................................................................................. 70
Operadores de USM não genéricos............................................................................................................................ 74
Parâmetros de segurança do Catalyst ........................................................................................................................ 77
Capítulo 4: Execução de comando
79
Operador Executar programa .................................................................................................................................... 79
Parâmetros de entrada ....................................................................................................................................... 80
Parâmetros de saída ........................................................................................................................................... 83
Operador Executar o script ........................................................................................................................................ 84
Parâmetros de entrada ....................................................................................................................................... 84
Parâmetros de saída ........................................................................................................................................... 90
Operador Executar comando de SSH ......................................................................................................................... 91
Parâmetros de entrada ....................................................................................................................................... 91
Parâmetros de saída ........................................................................................................................................... 99
Portas do operador ........................................................................................................................................... 101
Exemplo............................................................................................................................................................. 103
Operador Executar o script SSH ............................................................................................................................... 104
Parâmetros de entrada ..................................................................................................................................... 105
Parâmetros de saída ......................................................................................................................................... 114
Portas do operador ........................................................................................................................................... 115
Exemplo............................................................................................................................................................. 117
Operador Executar comando de Telnet ................................................................................................................... 121
Parâmetros de entrada ..................................................................................................................................... 121
Parâmetros de saída ......................................................................................................................................... 128
Portas do operador ........................................................................................................................................... 131
Exemplo: ........................................................................................................................................................... 132
Operador Executar script de Telnet ......................................................................................................................... 134
6 Referência do Criador de Conteúdo
Parâmetros de entrada ..................................................................................................................................... 135
Parâmetros de saída ......................................................................................................................................... 141
Portas do operador ........................................................................................................................................... 142
Exemplo: ........................................................................................................................................................... 143
Capítulo 5: Bancos de dados
149
Parâmetros do Oracle .............................................................................................................................................. 149
Parâmetros do Servidor MSSQL ............................................................................................................................... 151
Parâmetros do MySQL.............................................................................................................................................. 152
Parâmetros do Sybase .............................................................................................................................................. 152
Propriedades de nível do operador.......................................................................................................................... 153
Parâmetros de logon do servidor de banco de dados ...................................................................................... 154
Operador Inserção em massa no banco de dados ................................................................................................... 159
Parâmetros de entrada ..................................................................................................................................... 159
Parâmetros de saída ......................................................................................................................................... 160
Operador Excluir do banco de dados ....................................................................................................................... 160
Parâmetros de entrada ..................................................................................................................................... 161
Parâmetros de saída ......................................................................................................................................... 161
Operador Obter esquema de banco de dados ......................................................................................................... 163
Parâmetros de entrada ..................................................................................................................................... 163
Parâmetros de saída ......................................................................................................................................... 163
Operador Obter espaço livre .................................................................................................................................... 164
Parâmetros de entrada ..................................................................................................................................... 164
Parâmetros de saída ......................................................................................................................................... 164
Operador Obter o procedimento armazenado ........................................................................................................ 165
Parâmetros de entrada ..................................................................................................................................... 166
Parâmetros de saída ......................................................................................................................................... 166
Operador Obter tabela ............................................................................................................................................. 167
Parâmetros de entrada ..................................................................................................................................... 168
Parâmetros de saída ......................................................................................................................................... 168
Operador Obter o espaço usado .............................................................................................................................. 169
Parâmetros de entrada ..................................................................................................................................... 170
Parâmetros de saída ......................................................................................................................................... 170
Operador Obter versão ............................................................................................................................................ 171
Parâmetros de entrada ..................................................................................................................................... 172
Parâmetros de saída ......................................................................................................................................... 172
Operador Obter exibição .......................................................................................................................................... 172
Parâmetros de entrada ..................................................................................................................................... 173
Parâmetros de saída ......................................................................................................................................... 173
Operador Inserir no banco de dados ....................................................................................................................... 174
Parâmetros de entrada ..................................................................................................................................... 175
Índice 7
Parâmetros de saída ......................................................................................................................................... 175
Operador Consultar o banco de dados .................................................................................................................... 177
Parâmetros de entrada ..................................................................................................................................... 177
Parâmetros de saída ......................................................................................................................................... 178
Executar um procedimento armazenado .......................................................................................................... 181
Operador Selecionar do banco de dados ................................................................................................................. 183
Parâmetros de entrada ..................................................................................................................................... 183
Parâmetros de saída ......................................................................................................................................... 185
Operador Atualizar no banco de dados ................................................................................................................... 186
Parâmetros de entrada ..................................................................................................................................... 186
Parâmetros de saída ......................................................................................................................................... 187
Capítulo 6: Data e hora
189
Operador Verificar o calendário ............................................................................................................................... 189
Parâmetros de entrada ..................................................................................................................................... 189
Parâmetros de saída ......................................................................................................................................... 191
Operador Verificar data e hora ................................................................................................................................ 191
Parâmetros de entrada ..................................................................................................................................... 192
Parâmetros de saída ......................................................................................................................................... 193
Capítulo 7: Serviços de diretório
195
Parâmetros de logon do LDAP.................................................................................................................................. 195
Operador Adicionar computador ao domínio .......................................................................................................... 196
Parâmetros de entrada ..................................................................................................................................... 196
Parâmetros de saída ......................................................................................................................................... 196
Exemplo: ........................................................................................................................................................... 196
Falha do operador ............................................................................................................................................. 197
Operador Adicionar usuário ao grupo ...................................................................................................................... 197
Parâmetros de entrada ..................................................................................................................................... 197
Parâmetros de saída ......................................................................................................................................... 198
Exemplo: ........................................................................................................................................................... 198
Falha do operador ............................................................................................................................................. 198
Operador Criar grupo ............................................................................................................................................... 199
Parâmetros de entrada ..................................................................................................................................... 199
Parâmetros de saída ......................................................................................................................................... 201
Exemplo: ........................................................................................................................................................... 202
Falha do operador ............................................................................................................................................. 202
Operador Criar objeto .............................................................................................................................................. 203
Parâmetros de entrada ..................................................................................................................................... 203
Parâmetros de saída ......................................................................................................................................... 206
Exemplo: ........................................................................................................................................................... 206
8 Referência do Criador de Conteúdo
Falha do operador ............................................................................................................................................. 207
Operador Criar unidade organizacional ................................................................................................................... 208
Parâmetros de entrada ..................................................................................................................................... 208
Parâmetros de saída ......................................................................................................................................... 208
Exemplo: ........................................................................................................................................................... 208
Falha do operador ............................................................................................................................................. 209
Operador Criar usuário............................................................................................................................................. 209
Parâmetros de entrada ..................................................................................................................................... 209
Parâmetros de saída ......................................................................................................................................... 212
Exemplo: ........................................................................................................................................................... 213
Falha do operador ............................................................................................................................................. 213
Operador Excluir objeto ........................................................................................................................................... 214
Parâmetros de entrada ..................................................................................................................................... 214
Parâmetros de saída ......................................................................................................................................... 215
Exemplos ........................................................................................................................................................... 216
Operador Obter controlador de domínio ................................................................................................................. 221
Parâmetros de entrada ..................................................................................................................................... 221
Parâmetros de saída ......................................................................................................................................... 222
Exemplo: ........................................................................................................................................................... 223
Falha do operador ............................................................................................................................................. 223
Operador Obter conta inativa .................................................................................................................................. 224
Parâmetros de entrada ..................................................................................................................................... 224
Parâmetros de saída ......................................................................................................................................... 225
Operador Obter o objeto ......................................................................................................................................... 227
Parâmetros de entrada ..................................................................................................................................... 227
Parâmetros de saída ......................................................................................................................................... 234
Exemplos ........................................................................................................................................................... 236
Falha do operador ............................................................................................................................................. 242
Operador Obter usuário ........................................................................................................................................... 242
Parâmetros de entrada ..................................................................................................................................... 242
Parâmetros de saída ......................................................................................................................................... 245
Exemplos ........................................................................................................................................................... 247
Falha do operador ............................................................................................................................................. 249
Operador Mover o objeto ........................................................................................................................................ 250
Parâmetros de entrada ..................................................................................................................................... 250
Parâmetros de saída ......................................................................................................................................... 250
Exemplo: ........................................................................................................................................................... 250
Falha do operador ............................................................................................................................................. 251
Operador Remover usuário do grupo ...................................................................................................................... 251
Parâmetros de entrada ..................................................................................................................................... 251
Parâmetros de saída ......................................................................................................................................... 251
Exemplo: ........................................................................................................................................................... 252
Índice 9
Falha do operador ............................................................................................................................................. 252
Operador Atualizar atributos de objeto ................................................................................................................... 252
Parâmetros de entrada ..................................................................................................................................... 253
Parâmetros de saída ......................................................................................................................................... 256
Falha do operador ............................................................................................................................................. 257
Operador Atualizar o diretório inicial do usuário ..................................................................................................... 257
Parâmetros de entrada ..................................................................................................................................... 257
Parâmetros de saída ......................................................................................................................................... 258
Exemplo: ........................................................................................................................................................... 258
Falha do operador ............................................................................................................................................. 258
Adicionar um certificado SSL ao CA Process Automation ........................................................................................ 259
Capítulo 8: Email
261
Parâmetros de operadores comuns de email .......................................................................................................... 261
Critérios de filtro de mensagem........................................................................................................................ 262
Parâmetros de logon do servidor de e-mail ...................................................................................................... 264
Operador Criar pasta ................................................................................................................................................ 265
Parâmetros de entrada ..................................................................................................................................... 265
Parâmetros de saída ......................................................................................................................................... 265
Operador Excluir email ............................................................................................................................................. 266
Parâmetros de entrada ..................................................................................................................................... 266
Parâmetros de saída ......................................................................................................................................... 267
Operador Excluir pasta ............................................................................................................................................. 267
Parâmetros de entrada ..................................................................................................................................... 267
Parâmetros de saída ......................................................................................................................................... 268
Exemplo: ........................................................................................................................................................... 268
Operador Obter o conteúdo do email ...................................................................................................................... 269
Parâmetros de entrada ..................................................................................................................................... 269
Parâmetros de saída ......................................................................................................................................... 271
Operador Obter contagem de emails ...................................................................................................................... 272
Parâmetros de entrada ..................................................................................................................................... 272
Parâmetros de saída ......................................................................................................................................... 273
Operador Obter envelope de email ......................................................................................................................... 273
Parâmetros de entrada ..................................................................................................................................... 274
Parâmetros de saída ......................................................................................................................................... 275
Operador Obter lista de emails ................................................................................................................................ 276
Parâmetros de entrada ..................................................................................................................................... 276
Parâmetros de saída ......................................................................................................................................... 276
Operador Mover email ............................................................................................................................................. 278
Parâmetros de entrada ..................................................................................................................................... 278
Parâmetros de saída ......................................................................................................................................... 279
10 Referência do Criador de Conteúdo
Operador Limpar pasta ............................................................................................................................................ 279
Parâmetros de entrada ..................................................................................................................................... 279
Parâmetros de saída ......................................................................................................................................... 280
Operador Renomear pasta ....................................................................................................................................... 280
Parâmetros de entrada ..................................................................................................................................... 280
Parâmetros de saída ......................................................................................................................................... 281
Operador Enviar email ............................................................................................................................................. 281
Parâmetros de entrada ..................................................................................................................................... 282
Parâmetros de saída ......................................................................................................................................... 283
Capítulo 9: Gerenciamento de arquivos
285
Operador Compactar arquivo .................................................................................................................................. 285
Parâmetros de entrada ..................................................................................................................................... 286
Parâmetros de saída ......................................................................................................................................... 286
Operador Copiar arquivo.......................................................................................................................................... 287
Parâmetros de entrada ..................................................................................................................................... 287
Parâmetros de saída ......................................................................................................................................... 288
Operador Criar pasta ................................................................................................................................................ 288
Parâmetros de entrada ..................................................................................................................................... 288
Parâmetros de saída ......................................................................................................................................... 289
Operador Descompactar arquivo ............................................................................................................................. 289
Parâmetros de entrada ..................................................................................................................................... 289
Parâmetros de saída ......................................................................................................................................... 290
Operador Excluir arquivo ......................................................................................................................................... 290
Parâmetros de entrada ..................................................................................................................................... 290
Parâmetros de saída ......................................................................................................................................... 291
Operador Obter o conteúdo do diretório ................................................................................................................ 291
Parâmetros de entrada ..................................................................................................................................... 291
Parâmetros de saída ......................................................................................................................................... 292
Operador Obter atributos de arquivo ...................................................................................................................... 293
Parâmetros de entrada ..................................................................................................................................... 293
Parâmetros de saída ......................................................................................................................................... 294
Exemplo: ........................................................................................................................................................... 295
Operador Monitorar arquivo ................................................................................................................................... 296
Parâmetros de entrada ..................................................................................................................................... 296
Parâmetros de saída ......................................................................................................................................... 298
Exemplo: ........................................................................................................................................................... 299
Operador Ler a partir do arquivo ............................................................................................................................. 299
Parâmetros de entrada ..................................................................................................................................... 299
Parâmetros de saída ......................................................................................................................................... 300
Exemplo (Operador Ler a partir do arquivo) ..................................................................................................... 301
Índice 11
Operador Renomear arquivo ................................................................................................................................... 304
Parâmetros de entrada ..................................................................................................................................... 304
Parâmetros de saída ......................................................................................................................................... 304
Operador Pesquisar conteúdo de arquivo ............................................................................................................... 305
Parâmetros de entrada ..................................................................................................................................... 305
Parâmetros de saída ......................................................................................................................................... 307
Operador Atualizar a propriedade do arquivo ......................................................................................................... 308
Parâmetros de entrada ..................................................................................................................................... 308
Parâmetros de saída ......................................................................................................................................... 309
Operador Atualizar as permissões do arquivo ......................................................................................................... 309
Parâmetros de entrada ..................................................................................................................................... 309
Parâmetros de saída ......................................................................................................................................... 310
Operador Atualizar o carimbo de data e hora do arquivo ....................................................................................... 310
Parâmetros de entrada ..................................................................................................................................... 310
Parâmetros de saída ......................................................................................................................................... 312
Operador Gravar arquivo ......................................................................................................................................... 312
Parâmetros de entrada ..................................................................................................................................... 312
Parâmetros de saída ......................................................................................................................................... 313
Capítulo 10: Transferência de arquivo
315
Operador Criar diretório .......................................................................................................................................... 315
Parâmetros de entrada ..................................................................................................................................... 316
Parâmetros de saída ......................................................................................................................................... 317
Operador Excluir diretório ....................................................................................................................................... 317
Propriedades da opção Excluir diretório remoto .............................................................................................. 318
Parâmetros de saída ......................................................................................................................................... 319
Operador Excluir arquivo ......................................................................................................................................... 319
Parâmetros de entrada ..................................................................................................................................... 319
Parâmetros de saída ......................................................................................................................................... 320
Operador Fazer download de arquivo ..................................................................................................................... 321
Propriedades da opção Obter arquivo remoto ................................................................................................. 321
Parâmetros de saída ......................................................................................................................................... 323
Operador Obter informações do arquivo ................................................................................................................. 323
Parâmetros de entrada ..................................................................................................................................... 324
Parâmetros de saída ......................................................................................................................................... 326
Operador Mover arquivo ......................................................................................................................................... 327
Parâmetros de entrada ..................................................................................................................................... 327
Parâmetros de saída ......................................................................................................................................... 328
Operador Arquivo para download por TFTP ............................................................................................................ 329
Parâmetros de entrada ..................................................................................................................................... 329
Parâmetros de saída ......................................................................................................................................... 330
12 Referência do Criador de Conteúdo
Portas do operador ........................................................................................................................................... 331
Operador Arquivo para upload por TFTP ................................................................................................................. 331
Parâmetros de entrada ..................................................................................................................................... 332
Parâmetros de saída ......................................................................................................................................... 333
Portas do operador ........................................................................................................................................... 333
Operador Fazer upload de arquivo .......................................................................................................................... 334
Parâmetros de entrada ..................................................................................................................................... 334
Parâmetros de saída ......................................................................................................................................... 336
Capítulo 11: Gerenciamento de Java
337
Parâmetros de logon do JMX ................................................................................................................................... 337
Operador Obter atributos MBean ............................................................................................................................ 338
Parâmetros de entrada ..................................................................................................................................... 338
Parâmetros de saída ......................................................................................................................................... 339
Exemplo: ........................................................................................................................................................... 340
Operador Chamar método MBean........................................................................................................................... 341
Parâmetros de entrada ..................................................................................................................................... 341
Parâmetros de saída ......................................................................................................................................... 342
Exemplo: ........................................................................................................................................................... 343
Operador Atualizar atributos MBean ....................................................................................................................... 344
Parâmetros de entrada ..................................................................................................................................... 344
Parâmetros de saída ......................................................................................................................................... 345
Exemplo: ........................................................................................................................................................... 346
Capítulo 12: Utilitários de rede
349
Operador Obter interfaces de rede local ................................................................................................................. 349
Parâmetros de entrada ..................................................................................................................................... 349
Parâmetros de saída ......................................................................................................................................... 350
Portas do operador ........................................................................................................................................... 351
Exemplo: ........................................................................................................................................................... 352
Operador Obter status do serviço de rede .............................................................................................................. 352
Parâmetros de entrada ..................................................................................................................................... 353
Parâmetros de saída ......................................................................................................................................... 356
Portas do operador ........................................................................................................................................... 357
Operador Obter variável SNMP................................................................................................................................ 359
Parâmetros de entrada ..................................................................................................................................... 360
Parâmetros de saída ......................................................................................................................................... 361
Operador Monitorar a variável do SNMP ................................................................................................................ 362
Parâmetros de entrada ..................................................................................................................................... 362
Parâmetros de saída ......................................................................................................................................... 365
Operador Executar ping para o host ........................................................................................................................ 366
Índice 13
Parâmetros de entrada ..................................................................................................................................... 366
Parâmetros de saída ......................................................................................................................................... 368
Portas do operador ........................................................................................................................................... 370
Operador Enviar interceptação de SNMP ................................................................................................................ 370
Parâmetros de entrada ..................................................................................................................................... 371
Parâmetros de saída ......................................................................................................................................... 372
Operador Atualizar variável de SNMP ...................................................................................................................... 373
Parâmetros de entrada ..................................................................................................................................... 373
Parâmetros de saída ......................................................................................................................................... 374
Capítulo 13: Controle de processo
375
Operador Atribuir tarefa de usuário ........................................................................................................................ 375
Parâmetros de entrada ..................................................................................................................................... 377
Parâmetros de saída ......................................................................................................................................... 380
Exemplo: ........................................................................................................................................................... 380
Operador Avaliar expressão ..................................................................................................................................... 383
Parâmetros de entrada ..................................................................................................................................... 383
Parâmetros de saída ......................................................................................................................................... 384
Operador Gerenciar recursos ................................................................................................................................... 384
Parâmetros de entrada ..................................................................................................................................... 385
Parâmetros de saída ......................................................................................................................................... 388
Operadores de evento ............................................................................................................................................. 388
Operador Monitorar eventos ............................................................................................................................ 389
Operador Enviar evento .................................................................................................................................... 391
Os padrões de uso para eventos ....................................................................................................................... 392
Iniciar operador de processos .................................................................................................................................. 393
Parâmetros de entrada ..................................................................................................................................... 393
Parâmetros de saída ......................................................................................................................................... 395
Capítulo 14: utilitários
397
Operador Aplicar Xpath ............................................................................................................................................ 397
Parâmetros de entrada ..................................................................................................................................... 398
Parâmetros de saída ......................................................................................................................................... 399
Aplicar o operador XSLT ........................................................................................................................................... 399
Parâmetros de entrada ..................................................................................................................................... 400
Parâmetros de saída ......................................................................................................................................... 401
Operador Atraso ....................................................................................................................................................... 402
Parâmetros de entrada ..................................................................................................................................... 402
Parâmetros de saída ......................................................................................................................................... 403
Operador Chamar o Java .......................................................................................................................................... 404
Parâmetros de entrada ..................................................................................................................................... 404
14 Referência do Criador de Conteúdo
Parâmetros de saída ......................................................................................................................................... 416
Exemplo de Java ................................................................................................................................................ 418
Recurso para executar um exemplo do operador Chamar o Java .................................................................... 419
Portas do operador ........................................................................................................................................... 420
Operador Executar o JavaScript ............................................................................................................................... 422
Parâmetros de entrada ..................................................................................................................................... 422
Parâmetros de saída ......................................................................................................................................... 422
Capítulo 15: Web Services
423
Operadores HTTP: parâmetros de entrada comuns ................................................................................................ 423
Informações sobre o URL HTTP ......................................................................................................................... 424
Informações sobre o proxy HTTP ...................................................................................................................... 428
Informações de cabeçalhos HTTP ..................................................................................................................... 432
Informações sobre cookies HTTP ...................................................................................................................... 433
Informações sobre o conteúdo de resposta HTTP ............................................................................................ 433
Informações de configuração HTTP .................................................................................................................. 435
Operadores HTTP: parâmetros de saída comuns ..................................................................................................... 437
Operadores HTTP: portas de saída comuns ............................................................................................................. 441
Operador HTTP Delete ............................................................................................................................................. 443
Parâmetros de entrada ..................................................................................................................................... 444
Parâmetros de saída ......................................................................................................................................... 445
Operador Obter HTTP .............................................................................................................................................. 446
Parâmetros de entrada ..................................................................................................................................... 447
Parâmetros de saída ......................................................................................................................................... 449
Falha do operador ............................................................................................................................................. 450
Operador HTTP Head ............................................................................................................................................... 451
Parâmetros de entrada ..................................................................................................................................... 451
Parâmetros de saída ......................................................................................................................................... 454
Falha do operador ............................................................................................................................................. 456
Operador HTTP Options ........................................................................................................................................... 456
Parâmetros de entrada ..................................................................................................................................... 456
Parâmetros de saída ......................................................................................................................................... 458
Operador HTTP Post ................................................................................................................................................. 460
Parâmetros de entrada ..................................................................................................................................... 460
Parâmetros de saída ......................................................................................................................................... 463
Falha do operador ............................................................................................................................................. 465
Operador Formulário por HTTP Post ........................................................................................................................ 465
Parâmetros de entrada ..................................................................................................................................... 466
Parâmetros de saída ......................................................................................................................................... 471
Falha do operador ............................................................................................................................................. 473
Operador HTTP Put .................................................................................................................................................. 473
Índice 15
Parâmetros de entrada ..................................................................................................................................... 474
Parâmetros de saída ......................................................................................................................................... 477
Operador HTTP Trace ............................................................................................................................................... 479
Parâmetros de entrada ..................................................................................................................................... 479
Parâmetros de saída ......................................................................................................................................... 481
Operador Solicitar método SOAP ............................................................................................................................. 482
Parâmetros de entrada ..................................................................................................................................... 483
Parâmetros de saída ......................................................................................................................................... 502
Operador Chamar método SOAP assíncrono ........................................................................................................... 507
Parâmetros de entrada ..................................................................................................................................... 507
Parâmetros de saída ......................................................................................................................................... 527
Capítulo 16: Funções do sistema do CA Process Automation
533
Tipos de retorno ....................................................................................................................................................... 533
absPath ..................................................................................................................................................................... 534
adjustDate ................................................................................................................................................................ 535
adjustResourceVals .................................................................................................................................................. 536
applyXPath ............................................................................................................................................................... 537
applyXPathToUrl ...................................................................................................................................................... 539
checkCalendarDate .................................................................................................................................................. 541
convertJson .............................................................................................................................................................. 542
convertValueToXml .................................................................................................................................................. 544
convertXml ............................................................................................................................................................... 545
convertXmlURL ......................................................................................................................................................... 546
createHyperLink ....................................................................................................................................................... 546
createResourceObject .............................................................................................................................................. 547
deleteAttachments................................................................................................................................................... 547
deleteObject ............................................................................................................................................................. 548
deleteResource ........................................................................................................................................................ 549
deleteValueMapField ............................................................................................................................................... 549
existsCalendar .......................................................................................................................................................... 550
existsCustomIcon ..................................................................................................................................................... 550
existsCustomOperator ............................................................................................................................................. 551
existsDataset ............................................................................................................................................................ 552
existsFolder .............................................................................................................................................................. 553
existsInteractionRequestForm ................................................................................................................................. 553
existsProcess ............................................................................................................................................................ 554
existsProcessWatch .................................................................................................................................................. 555
existsResource .......................................................................................................................................................... 556
existsSchedule .......................................................................................................................................................... 556
formatDate ............................................................................................................................................................... 557
16 Referência do Criador de Conteúdo
formatString ............................................................................................................................................................. 558
getAllAttachments.................................................................................................................................................... 558
getAttachmentContent ............................................................................................................................................ 559
getCountOfProcessStates ......................................................................................................................................... 560
getEEMArtifactToken ............................................................................................................................................... 560
getEEMArtifactTokenForUser .................................................................................................................................. 561
getEEMCredentialsToken ......................................................................................................................................... 562
getEEMCredentialsTokenForUser ............................................................................................................................ 563
getEnvVar ................................................................................................................................................................. 564
getOrchestratorURL ................................................................................................................................................. 564
getPartialAttachmentContent .................................................................................................................................. 565
getResourceAvail ...................................................................................................................................................... 565
getResourceName .................................................................................................................................................... 566
getResourceTotal ..................................................................................................................................................... 566
getTouchpoints ........................................................................................................................................................ 567
getValueFromValueMapArray() ............................................................................................................................... 568
getValueMapFields ................................................................................................................................................... 569
getValuesFromValueMapArray().............................................................................................................................. 570
hasField .................................................................................................................................................................... 570
incluir........................................................................................................................................................................ 571
isFIPSMode ............................................................................................................................................................... 572
isTouchpointUp ........................................................................................................................................................ 572
carregar .................................................................................................................................................................... 573
lockResource ............................................................................................................................................................ 574
logEvent.................................................................................................................................................................... 574
newValueMap .......................................................................................................................................................... 575
newDataset .............................................................................................................................................................. 576
nextOpenDate .......................................................................................................................................................... 576
agora ........................................................................................................................................................................ 577
parseDate ................................................................................................................................................................. 577
resetResource .......................................................................................................................................................... 578
rolldate ..................................................................................................................................................................... 579
rolltime ..................................................................................................................................................................... 580
saveAttachmentToFile.............................................................................................................................................. 581
setOperatorStatus .................................................................................................................................................... 581
setProcessProgress................................................................................................................................................... 582
setResourceTotal ...................................................................................................................................................... 583
hoje .......................................................................................................................................................................... 584
Índice 17
Capítulo 1: Introdução aos operadores
Esta referência contém informações sobre os operadores que fazem parte do CA
Process Automation. Os operadores são agrupados em categorias. Este guia agrupa as
descrições das informações sobre operador por essas categorias.
A Referência do criador de conteúdo também descreve as funções do sistema. Use as
funções do sistema para gravar JavaScripts personalizados. Esses JavaScripts podem ser
colocados dentro de operadores para manipular os dados usados dentro do CA Process
Automation.
Visão geral do operador
Recipientes de categorias de operadores são representados como pastas na paleta
Operadores do Criador.
O CA Process Automation contém as seguintes categorias de operadores:
Padrão (na página 43)
Os operadores padrão incluem operadores de funcionalidades essenciais para
controlar os fluxos de trabalho nos processos. As funcionalidades simples, como
iniciar, interromper, vincular e inserir comentários, são fornecidas com os
operadores padrão. Você também pode definir opções de loop e de redefinição e
incorporar as alterações de rota usando esses operadores.
Catalyst (na página 59)
Os operadores Catalyst oferecem suporte às interfaces de criação, leitura,
atualização, exclusão (CRUD) e assinatura de eventos do UCF. Esses operadores
exibem os tipos de objeto e as propriedades do Unified Service Model (USM).
Execução de comando (na página 79)
Os operadores Execução de comando executam processos e scripts no ambiente
operacional do host.
Bancos de dados (na página 149)
Os operadores Bancos de dados fornecem uma via de comunicação e execução de
consultas a bancos de dados com diferentes servidores de banco de dados.
Data e hora (na página 189)
Os operadores Data e hora gerenciam a data e a hora para o servidor do CA Process
Automation.
Capítulo 1: Introdução aos operadores 19
Visão geral do operador
Serviços de diretório (na página 195)
Os operadores Serviços de diretório oferecem suporte ao Lightweight Directory
Access Protocol. Todos esses operadores funcionam com diferentes servidores
LDAP, exceto os operadores específicos do Active Directory.
Email (na página 261)
Os operadores Email automatizam as tarefas executadas em emails e pastas em um
servidor de email. Eles leem emails do servidor de email por meio do IMAP/POP3.
Gerenciamento de arquivos (na página 285)
Os operadores Gerenciamento de arquivos monitoram diretórios, arquivos e seu
conteúdo. Eles podem ser executados localmente ou em um sistema remoto. Esses
operadores criam, excluem, renomeiam, compactam e descompactam arquivos
locais e inspecionam arquivos no touchpoint em que a categoria Gerenciamento de
arquivos está sendo executada.
Transferência de arquivo (na página 315)
Os operadores Transferência de arquivos permitem que você use FTP e SFTP.
Gerenciamento Java (na página 337)
Os operadores Gerenciamento de Java fornecem uma interface de gerenciamento
para sistemas que oferecem suporte a JMX.
Utilitários da rede (na página 349)
Os operadores Utilitários de rede permitem que o usuário se comunique com
outros dispositivos de rede por meio do SNMP.
Controle de processo (na página 375)
Os operadores Controle de processo executam, monitoram e controlam os
processos do CA Process Automation.
utilitários (na página 397)
Os operadores Utilitários chamam os JARS externos no CA Process Automation.
Web Services (na página 423)
Os serviços web fornecem vários utilitários de protocolo de rede padrão para os
processos comerciais automatizados possibilitados pelo CA Process Automation.
20 Referência do Criador de Conteúdo
Quando os operadores Não Executar
Quando os operadores Não Executar
Um operador é executado em um orquestrador por padrão, mas você pode especificar
um local específico (destino) em execução.
Destinos pode ser especificado como um touchpoint, touchpoint grupo, ID do agente,
touchpoint do proxy ou um endereço IP ou FQDN. Consulte "Como os destinos para um
operador podem ser especificados" no Guia Criador de Conteúdo para obter uma
descrição de cada um desses itens. Cada destino, por fim, é resolvido para um
orquestrador, um ou mais agentes ou um host remoto com uma conexão SSH a um
agente. Onde o operador é executado é importante porque, em alguns casos, o
processo que está sendo criado deve operar em um host específico. Vários operadores
podem ser executados em um orquestrador ou em agentes. No entanto, determinados
operadores só podem ser executados em orquestradores; outros podem ser executados
somente em agentes. Outros necessitam que o host remoto de destino ofereça suporte
ao acesso de SSH.
É recomendável dedicar um agente para a execução de operadores Chamar o Java. Esse
é o único operador do CA Process Automation que não pode ser executado em um
orquestrador.
Observação: os agentes que atuam como touchpoints do proxy têm diferentes
requisitos de módulo. As operações que têm como destino touchpoints do proxy (ou um
host remoto referenciado por um grupo de hosts) passam pelo SSH.
Categoria
Operador
orquestrador
Agente
Host
remoto
(SSH de
destino)
Catalyst (na página 59)
Todas
x
Executar programa
x
x
x
Executar comando de SSH
x
x
Executar o script SSH
x
x
Executar script
x
x
Executar comando de Telnet
x
x
Executar script de Telnet
x
x
Inserção em massa no banco x
de dados
x
Execução de comando (na
página 79)
x
Bancos de dados (na página 149)
x
Capítulo 1: Introdução aos operadores 21
Quando os operadores Não Executar
Categoria
Operador
orquestrador
Agente
Host
remoto
(SSH de
destino)
Excluir do banco de dados
x
x
x
Obter esquema de banco de
dados
x
x
x
Obter espaço livre
x
x
x
Obter o procedimento
armazenado
x
x
x
Obter tabela
x
x
x
Obter o espaço usado
x
x
x
Obter a versão
x
x
x
Obter exibição
x
x
x
Inserir no banco de dados
x
x
x
Consultar o banco de dados
x
x
x
Selecionar do banco de
dados
x
x
x
Atualizar no banco de dados
x
x
x
Verificar calendário
x
Verificar data e hora
x
Adicionar computador ao
domínio
x
x
Adicionar usuário ao grupo
x
x
Criar grupo
x
x
Criar objeto
x
x
Criar unidade organizacional
x
x
Criar usuário
x
x
Excluir objeto
x
x
Obter controlador de
domínio
x
x
Data e hora (na página 189)
Serviços de diretório (na
página 195)
22 Referência do Criador de Conteúdo
Quando os operadores Não Executar
Categoria
Operador
orquestrador
Agente
Host
remoto
(SSH de
destino)
Obter conta inativa
x
x
Obter o objeto
x
x
Obter usuário
x
x
Mover o objeto
x
x
Remover usuário do grupo
x
x
Atualizar atributos de objeto
x
x
Atualizar o diretório inicial do x
usuário
x
Criar pasta
x
x
Excluir email
x
x
Excluir pasta
x
x
Obter o conteúdo do email
x
x
Obter contagem de emails
x
x
Obter envelope de email
x
x
Obter lista de emails
x
x
Mover email
x
x
Limpar pasta
x
x
Renomear pasta
x
x
Enviar email
x
x
Compactar arquivo
x
x
x
Copiar arquivo
x
x
x
Criar pasta
x
x
x
Descompactar arquivo
x
x
x
Excluir arquivo
x
x
x
Obter o conteúdo do
diretório
x
x
x
Email (na página 261)
Gerenciamento de arquivos (na
página 285)
Capítulo 1: Introdução aos operadores 23
Quando os operadores Não Executar
Categoria
Operador
orquestrador
Agente
Host
remoto
(SSH de
destino)
Obter atributos de arquivo
x
x
x
Arquivo de monitor
x
x
x
Ler a partir do arquivo
x
x
x
Renomear arquivo
x
x
x
Pesquisar conteúdo de
arquivo
x
x
x
Atualizar a propriedade do
arquivo
x
x
x
Atualizar as permissões do
arquivo
x
x
x
Atualizar o carimbo de data e x
hora do arquivo
x
x
Gravar arquivo
x
x
x
Criar diretório
x
x
x
Excluir diretório
x
x
x
Excluir arquivo
x
x
x
Fazer download de arquivo
x
x
x
Obter informações do
arquivo
x
x
x
Mover arquivo
x
x
x
Arquivo para download por
TFTP
x
x
Arquivo para upload por
TFTP
x
x
Fazer upload do arquivo
x
x
Obter atributos MBean
x
x
Chamar método MBean
x
x
Transferência de arquivo (na
página 315)
Gerenciamento Java (na
página 337)
24 Referência do Criador de Conteúdo
x
Quando os operadores Não Executar
Categoria
Operador
orquestrador
Agente
Atualizar atributos MBean
x
x
Obter interfaces de rede
local
x
x
Obter o status dos Serviços
de Rede
x
x
Obter variáveis SNMP
x
x
Monitorar a variável do
SNMP
x
x
Executar ping para o host
x
x
Enviar interceptação de
SNMP
x
x
Atualizar variável de SNMP
x
x
Atribuir tarefa de usuário
x
Avaliar expressão
x
Gerenciar recursos
x
Evento de monitor
x
Enviar evento
x
Iniciar processo
x
Iniciar
x
Comentário
x
Interrupção bem-sucedida
x
Interrupção com falha
x
Andamento do processo
x
E
x
Ou
x
Host
remoto
(SSH de
destino)
Utilitários da rede (na
página 349)
Controle de processo (na
página 375)
Padrão (na página 43)
Capítulo 1: Introdução aos operadores 25
Quando os operadores Não Executar
Categoria
Operador
orquestrador
Redefinir
x
Loop
x
Alterar a rota
x
Exceção
x
Aplicar Xpath
x
Aplicar XSLT
x
Atrasar
x
Agente
utilitários (na página 397)
Chamar o Java
x
Executar o JavaScript
x
HTTP Delete
x
x
Obter HTTP
x
x
HTTP Head
x
x
Opções HTTP
x
x
Registro em HTTP
x
x
Formulário por HTTP Post
x
x
Colocar HTTP
x
x
HTTP Trace
x
x
Chamar método SOAP
x
x
Chamar método SOAP
assíncrono
x
x
Web Services (na página 423)
26 Referência do Criador de Conteúdo
Host
remoto
(SSH de
destino)
Propriedades comuns de todos os operadores
Propriedades comuns de todos os operadores
As opções de configuração do operador são exibidas na janela Propriedades quando
você clica duas vezes em um operador em um objeto de programação ou processo.
A configuração para o operador de categorias é descrita no Guia do Administrador de
conteúdo.
Observação: se as propriedades de um operador não forem exibidas, verifique se a
caixa de seleção Propriedades está marcada. Selecione Exibir, Propriedades no canto
superior direito do Criador e maximize a janela Propriedades na parte inferior da tela. Se
os operadores não forem exibidos, clique em Operadores no menu Exibir.
Configurações de execução (todos os Operadores)
Destino
Especifica o destino no qual deve ser executado o operador. Um destino pode ser
um grupo de touchpoints, ID do agente, touchpoint de proxy, endereço IP ou FQDN.
Certifique-se de ativar a categoria para o operador no touchpoint. Para abrir a caixa
de diálogo Navegador de objetos e selecionar um touchpoint, clique em Selecionar.
O destino é uma expressão calculada
Especifica o destino usando uma expressão. Para especificar um destino
dinamicamente em tempo de execução, use uma expressão calculada. Considere os
seguintes exemplos:
■
Use uma variável do conjunto de dados de sequência de caracteres que
contenha o nome do touchpoint.
■
Use uma variável de conjunto de dados de referência de objeto que aponte
para o touchpoint.
Importante: quando um processo estiver destinado a uma importação de pacote de
conteúdo, especifique o endereço IP ou FQDN em um conjunto de dados. Um
conjunto de dados pode ser modificado no ambiente de importação, mas o campo
Destino não pode.
Capítulo 1: Introdução aos operadores 27
Propriedades comuns de todos os operadores
Coincidir destino somente no Grupo de hosts
Especifica como resolver o nome do destino.
Selecionado
Especifica que o campo Destino contém um nome de host ou endereço IP ao
qual um grupo de hosts faz referência.
Observação: se o campo Destino contiver um touchpoint, um touchpoint do
proxy ou uma ID do agente, a execução falhará.
Desmarcado
Especifica que o campo Destino contém o nome de um touchpoint, um
touchpoint do proxy ou uma ID do agente.
Observação: se o campo Destino contiver uma referência de grupo de hosts
válida, o processamento será bem-sucedido, mas não será otimizado.
Loop
O CA Process Automation permite percorrer ou repetir um operador até que
alguma condição seja atendida. A propriedade Loop especifica o número de vezes
que um operador é repetido.
As condições de saída e os links de conexão do operador que está em execução em
loop são avaliados apenas quando o loop é encerrado.
Observação: para obter informações mais detalhadas sobre o uso de loops no CA
Process Automation, consulte Processar Loops e iterações no Guia do Criador de
Conteúdo.
Contagem de repetição
Especifica a condição de loop. Duas opções estão disponíveis:
■
É possível inserir um número inteiro ou qualquer expressão do CA Process
Automation que retorne um número inteiro no tempo de execução. O
valor padrão 1 executa um loop em um operador uma única vez. Para
executar um loop infinito, clique na caixa de seleção Loop infinito.
■
Especifica uma expressão booleana. A expressão é avaliada após o
operador ser executado. Se a expressão for avaliada como verdadeira, o
loop contínuo. Se a expressão for falsa, o loop seja concluída.
Loop infinito
Quando selecionado, Repetir contagem é ignorado e um loop infinito é criado.
O operador continua a ser repetido até que:
■
O processo seja encerrado.
■
O loop seja interrompido de outra ramificação do processo (processando
um link de comando de interrupção de loop para o operador Loop (na
página 52)).
28 Referência do Criador de Conteúdo
Propriedades comuns de todos os operadores
Atraso entre iterações
Especifica o atraso em segundos entre cada iteração do loop (o valor padrão é
0).
Tempo limite
Permite definir um tempo limite como parte de cada operador. Se o operador não
for concluído no tempo especificado, essa configuração oferecerá uma estratégia
de saída. A opção Tempo limite fornece as opções de:
■
Terminar o operador e seguir o caminho alternativo do tempo limite.
■
Permitir que o operador continue, enquanto é seguido o caminho do tempo
limite.
■
Redefinir o operador (executá-lo novamente).
Sem tempo limite
Especifica que o operador tem nenhum tempo limite. Essa caixa de seleção
está selecionada por padrão.
Tipo
Selecione Duração ou Data de destino.
Duração/data e hora de destino
■
Se você selecionar Duração:
Insira uma duração de tempo limite em segundos.
O formato adequado para esse campo é qualquer coisa que possa ser tratada
como um inteiro/longo ou sequência de caracteres literais (como "10").
O tempo limite é específico para cada iteração de um loop. Portanto, um
tempo limite ocorrerá somente se uma iteração demora mais do que a duração
do tempo limite.
Capítulo 1: Introdução aos operadores 29
Propriedades comuns de todos os operadores
■
Se você selecionar Data de destino:
Digite a data e a hora em que deseja que o operador expire.
Quando um literal de sequência de caracteres é inserido nesse campo, ele pode
estar em um dos seguintes formatos:
■
Formato JVM - o formato de data/hora que o aplicativo Java entende. Esse
formato varia de acordo com a instalação do Java.
■
Se o formato JVM for desconhecido, digite como "MM/dd/aaaa
HH:mm:ss".
■
Qualquer outro formato deve usar um método de biblioteca do CA Process
Automation chamado parseDate. Esse método usa dois parâmetros: (a)
data como literal de sequência de caracteres e (b) formato em que a
sequência de caracteres deve ser analisada. Por exemplo: parseDate
("10/10/2010 10:10:10", "dd/MM/aaaa HH:mm:ss") retorna esta data: 10
de outubro de 2010 10 horas 10 min e 10 segundos.
Se o Destino estiver selecionado como Tipo, a opção Redefinir (em Ação) é
desabilitada.
Observação: não deixe de inserir esses dados no formato adequado, caso
contrário, o operador ignorará essas configurações de tempo limite.
Ação
Observações:
■
Esta opção não está disponível para programações.
■
Se um operador estiver em um loop e um tempo limite estiver
configurado, as opções a seguir se comportarão de maneira diferente.
Consulte os Cenários de loop e tempo limite (na página 31) para saber
quais ações são executadas.
Selecione uma das seguintes ações:
Continuar
Se for selecionado, o processo continuará da seguinte maneira após um
tempo limite:
1. O Operador permanece somente no modo de execução.
2. O caminho do tempo limite é assumido.
3. O código de execução posterior é executado somente quando o
operador é concluído, não quando o caminho do Tempo limite é seguido.
30 Referência do Criador de Conteúdo
Propriedades comuns de todos os operadores
Redefinir
Se for selecionado, o processo continuará da seguinte maneira após um
tempo limite:
1. O operador é redefinido (ou seja, começa a ser executado novamente).
2. O caminho do tempo limite é assumido.
3. O código de execução posterior será executado somente se o operador
for concluído (não quando o operador for redefinido).
Observação: se Redefinir for selecionado, a opção Data de destino será
desativada no menu suspenso Tipo.
Anular
Se for selecionado, o processo continuará da seguinte maneira após um
tempo limite:
1. A execução do operador será anulada.
2. O código de execução posterior é executado.
3. O caminho do tempo limite é assumido.
Abandonar
Se for selecionado, o processo continuará da seguinte maneira após um
tempo limite:
1. O operador expirou.
2. O processo continua a ser executado no modo desvinculado.
Observação: uma instância de um processo iniciado no modo desvinculado
não possui relacionamento de pai com o processo que a iniciou. Uma
instância desvinculada do processo é o processo raiz em qualquer
sequência de chamadas originada desse processo.
3. O código de execução posterior é executado imediatamente.
4. O caminho do tempo limite é assumido.
Cenários de loop e tempo limite
Se um operador estiver em um loop e o tempo limite estiver configurado, os seguintes
cenários acontecerão para as ações selecionadas:
Capítulo 1: Introdução aos operadores 31
Propriedades comuns de todos os operadores
Ação
Selecione uma das seguintes ações:
Continuar
Se for selecionado, o processo continuará da seguinte maneira após um tempo
limite:
1. A próxima iteração é executada.
2. O código de execução posterior será executado somente se a iteração for
concluída.
Usando a variável do conjunto de dados OverallLoopDuration para continuar
o loop de um operador que expire:
No fim da execução, OverallLoopDuration contém o número de segundos
desde o início da primeira iteração até o final da última iteração. Se o operador
expirar, OverallLoopDuration não conterá o número de segundos do início da
primeira iteração até que a hora em que o operador expirar.
Redefinir
Se for selecionado, o processo continuará da seguinte maneira após um tempo
limite:
1. A iteração é redefinida (isto é, começa a executar novamente).
2. O código de execução posterior será executado somente se a iteração for
concluída (não quando a iteração for redefinida).
3. A próxima iteração será executada somente quando a iteração for concluída.
Observação: se Redefinir for selecionado, a opção Data de destino será
desativada no menu suspenso Tipo.
Usando a variável do conjunto de dados OverallLoopDuration para redefinir o
loop de um operador que expire:
Se você definir um operador para realizar um loop com uma ação de tempo
limite de Redefinir, o CA Process Automation verificará a condição de loop
quando se mover de uma iteração para outra. A condição de loop não é
verificada ao ser redefinida uma iteração. Além disso, OverallLoopDuration
contém o número de segundos a partir do início da primeira iteração, inclusive
o tempo gasto em todas as redefinições de interação. As redefinições de
iteração não afetam OverallLoopDuration.
Anular
Se selecionado, o processo continua da seguinte maneira após um tempo
limite:
1. A iteração será anulada.
2. O código de execução posterior é executado.
3. A próxima iteração é executada.
32 Referência do Criador de Conteúdo
Propriedades comuns de operadores em processos
Abandonar
Se for selecionado, o processo continuará da seguinte maneira após um tempo
limite:
1. A iteração continua a ser executada no modo desvinculado.
Observação: uma instância de um processo iniciada no modo desvinculado não
tem nenhum relacionamento de pai com o processo que a iniciou e é o
processo raiz em qualquer sequência de chamadas originada desse processo.
2. O código de execução posterior é executado.
3. A próxima iteração é executada.
Propriedades comuns de operadores em processos
Todos os operadores têm propriedades que configuram sua aparência e seu
comportamento quando adicionados a um processo.
Um processo não tem um limite quanto ao número de operadores que ele pode incluir.
No entanto, a CA Technologies recomenda que um processo contenha
aproximadamente 40-50 operadores para se obter um desempenho máximo. Se um
processo começa a ficar maior do que 40-50 operadores, considere a possibilidade de
dividir o processo em componentes menores.
As propriedades descritas aqui são exibidas nas propriedades de Configurações de
execução, Simulação e Informações somente para um operador em um processo.
Observação: as propriedades específicas do operador substituirão as propriedades
definidas no nível da categoria.
Capítulo 1: Introdução aos operadores 33
Propriedades comuns de operadores em processos
Grupo de processamento
As propriedades a seguir definem condições a serem atendidas antes da execução de
um operador e ações a serem executadas antes e após a execução do operador. É
possível localizar essas propriedades no operador Configurações de execução.
Código de execução anterior
Permite que você adicione o código que é executado antes da execução de um
operador. Você pode executar qualquer código JavaScript. O código JavaScript é
executado antes da execução do operador. O código de execução anterior manipula
o operador e o conjunto de dados do processo de modo que o conjunto de dados
possa ser usado como entrada para o operador. Em outras palavras, é possível
manipular os parâmetros de saída a partir de um conjunto de dados do operador
anterior e usá-los como entrada para outro operador posteriormente.
O código de execução anterior pode executar várias tarefas. Por exemplo, o
seguinte código define uma variável no nível do Processo:
if(Process.username==null)
{
Process.username="testuser";
}
Observação: para obter mais informações sobre a adição de código, consulte
Executar o operador JavaScript (na página 422).
Antes que o código de execução anterior seja concluído e o operador seja
executado, é preciso atingir o código CanExecute = 1. A variável do processo
variável CanExecute é adicionada por padrão no operador. O valor padrão de
CanExecute é 1. Se você não alterar o padrão, o operador será executado. Esse
requisito permite verificar as condições externas e prosseguir somente quando uma
condição esperada for atendida.
Se você alterar o valor Can Execute para 0 (Process.CanExecute = 0), o operador não
será executado. O CA Process Automation aguarda 30 segundos e, em seguida,
executa novamente o código de execução anterior.
Quando não há código de execução anterior, o operador é executado
imediatamente. Por exemplo, você pode usar o código de execução anterior para
configurar variáveis de loop ou outras variáveis a serem usadas como parte do
operador.
34 Referência do Criador de Conteúdo
Propriedades comuns de operadores em processos
Para o código executado no operador, é possível usar a seguinte sintaxe para
acessar o conjunto de dados do operador:
Process[OpName].nome_do_campo
Por exemplo, o seguinte código cria uma variável do conjunto de dados do
operador denominada iNow que contém os seguintes dados:
■
O nome do host
■
A data atual
■
A hora atual em uma única sequência de caracteres
Process[OpName].iNow = System.Host + ":" + System.Date + ":" + System.Time;
Código de execução posterior
Permite que você adicione o código que é executado após a execução de um
operador. Por exemplo, você poderia usar o código de execução posterior para
modificar variáveis de loop ou processar os resultados de um operador.
Para o código executado no operador, é possível usar a seguinte sintaxe para
acessar o conjunto de dados do operador:
Process[OpName].nome_do_campo
Por exemplo, o seguinte código copia o valor da variável do conjunto de dados do
operador denominada Resultado para a variável denominada iResult:
Process.iResult = Process[OpName].Result;
Executar como usuário do chamador
Especifica que o operador em um processo deve ser executado sob a identidade do
usuário autorizado que o iniciou. Esse requisito será true se o processo inteiro
estiver sendo executado como o proprietário ou não. Executar como usuário do
chamador permite que os criadores de processos executem os processos que:
■
Fornecem um objeto de automação autossuficiente (executado como o
proprietário)
■
Solicitem controle de direitos de acesso a partes do processo (como
processos-filho e touchpoints)
Capítulo 1: Introdução aos operadores 35
Propriedades comuns de operadores em processos
Propriedades da simulação
As Propriedades da simulação permitem configurar como simular a execução de um
operador em um processo. A simulação pode ser usada para testar ramificações de um
processo ou permitir que o processamento normal ignore um operador sem excluí-lo
realmente do processo.
Você configura as propriedades da Simulação para um novo processo. Para cada
operador em um processo, é possível especificar para herdar a configuração de Modo
configurada no nível do processo ou especificar uma configuração de Modo diferente.
Clique duas vezes em um operador para exibir o painel de propriedades do operador.
Em seguida, expanda a guia Simulação para exibir as definições a serem configuradas.
Modo
Os modos de Simulação estão disponíveis quando você seleciona a opção Substituir
simulação na caixa de seleção Processo.
Herdar do processo
Especifica o uso da configuração (Desativado, Local ou Distante) configurada
para o processo pai do operador.
Desativado
Desativa a simulação e permite o processamento normal do operador. A
Condição de término estará definida como Concluída, Atrasar estará definido
como 0 e Avaliar código de execução anterior e de execução posterior estará
desmarcado.
Local
Desativa o operador, de modo que ele não seja processado. O CA Process
Automation não chama o operador associado nem monitora os parâmetros do
operador. As verificações do parâmetro incluem a procura de um programa
aplicativo ou a validação do touchpoint de execução para um operador.
Distante
Faz com que o mecanismo chame o operador associado. O operador verifica os
parâmetros antes de retornar o resultado, mas não executa realmente o
operador. Se os parâmetros estiverem incorretos, o operador simulado falhará,
independentemente do resultado especificado. Se os parâmetros estiverem
corretos, o operador retornará o resultado especificado.
Atrasar
Especifica o número de segundos de atraso de um processo para simular o tempo
que o operador usa durante o processamento normal.
36 Referência do Criador de Conteúdo
Propriedades comuns de operadores em processos
Condição de término
Especifica a condição de saída para o operador simulado. É possível usar essa opção
para testar ou solucionar problemas de ramificações diferentes em um processo. O
número real de condições depende do operador.
■
As seguintes condições de término se aplicam quando Modo for Desativado:
Concluído.
■
As seguintes condições de término se aplicam quando Modo for Local:
Concluído, Com falha, Tempo limite.
■
As seguintes condições se aplicam quando Modo for Distante: Concluído, Com
falha, Tempo limite, Resultado personalizado.
concluído
Faz com que o link de saída de resultado padrão de êxito do operador seja
processado. A variável Resultado no conjunto de dados do operador é definida
como 1. Qualquer número inteiro positivo ativa um link de saída padrão de
êxito.
Com falha
Faz com que o link de saída de resultado com falha padrão do operador seja
processado. A variável Resultado no conjunto de dados do operador é definida
como 0. Zero ou qualquer valor negativo inteiro ativa o link padrão de falha ou
anulação.
Tempo limite
Faz o operador assumir o caminho do tempo limite quando o tempo decorrer.
A variável Resultado no conjunto de dados do operador é exibida como o
tempo limite.
Resultado personalizado
Especifica o valor de número inteiro retornado pela variável Resultado no
conjunto de dados do operador. Você pode definir esse parâmetro como
qualquer valor (positivo ou negativo) para ativar um link personalizado que
teste determinado valor.
Essa opção estará disponível somente quando a opção Resultado personalizado
estiver selecionada para Condição de término.
Avaliar código de execução anterior e posterior
Indica se deseja avaliar o código de execução anterior e de execução posterior
durante a simulação de um operador.
Selecionado
Especifica para avaliar o código e evitar os efeitos colaterais de ignorar o
código.
Desmarcado
Especifica para não avaliar o código.
Capítulo 1: Introdução aos operadores 37
Propriedades comuns de operadores em processos
Propriedades de informações
As Propriedades do ícone determinam o nome do operador, bem como sua
representação visual e seus comentários. As configurações padrão (para o processo
inteiro) são definidas por meio da seleção do botão Propriedades na barra de
ferramentas Criador.
Substituir as preferências do objeto
Marque essa caixa de seleção para substituir as configurações de processo padrão e
definir as configurações específicas desse operador.
Ícone
Nome
Especifica o nome de um operador. A propriedade Nome é particularmente
importante na configuração de um operador que será referenciado por outros
operadores. A propriedade Nome é usada na seguinte sintaxe em uma
expressão, para acessar variáveis do conjunto de dados de outro operador em
um processo:
Process.Operator_name.variable_name
Os nomes dos operadores devem ser exclusivos dentro do mesmo processo.
Usar ícone padrão
Se essa opção for marcada, o operador usará o ícone padrão. Desmarque essa
caixa de seleção para usar um objeto de ícone personalizado para o operador,
em vez do padrão.
Procurar
Clique para selecionar o objeto de ícone personalizado que deseja usar para
essa instância do operador.
Exibição do rótulo
Mostrar rótulos
Exibe as informações de ícone do operador inserido no campo Nome. Selecione
uma das seguintes opções:
Truncado
Exibe apenas um valor parcial do campo Nome junto ao ícone do operador.
Número longo
Exibe o comprimento completo do campo Nome junto ao ícone do
operador.
Desativado
Nenhum rótulo é exibido.
38 Referência do Criador de Conteúdo
Propriedades comuns de operadores em Agendas
Origem do rótulo
Nome do objeto
Selecione para exibir o nome do operador como seu rótulo.
Comentários
Selecione para exibir os comentários do operador (que você insere na caixa de
texto Comentários) como seu rótulo.
Cores do rótulo
Clique em Escolher cor para selecionar uma cor para as seguintes partes do rótulo:
■
Cor do texto
■
Cor do plano de fundo
■
Cor da borda
Fonte
Configure as propriedades de fonte do rótulo do ícone do operador: Família da
fonte, Estilo da fonte e Tamanho da fonte.
Observação: selecione fontes que geralmente estejam disponíveis nos
computadores que hospedam o CA Process Automation.
Visualizar
Visualize suas seleções de Fonte para o rótulo do ícone do operador antes de
aplicá-las.
Comentários
Digite os comentários que você deseja exibir para o operador. Se o valor de Origem
do rótulo for Comentários, esse texto será exibido no rótulo junto ao operador.
Propriedades comuns de operadores em Agendas
Os operadores em uma agenda são iniciados de acordo com as condições especificadas
de calendário e tempo. Os grupos de propriedades no painel Propriedades para
qualquer operador adicionado a uma agenda associam regras de calendário e outras
condições de tempo ao operador. Clique no ícone Propriedades no editor de
programações para exibir as propriedades do operador. programando propriedades
gerais são exibidas na guia Geral. As propriedades específicas do Operador são exibidos
na guia específico.
Capítulo 1: Introdução aos operadores 39
Propriedades comuns de operadores em Agendas
Especifique a hora para iniciar o operador no menu suspenso na lista suspensa Iniciar
de. Especificar intervalos repetidos com o Intervalo de repetição (minutos). Marque essa
caixa de seleção para executar o operador em intervalos fixos. Selecione uma hora para
interromper a repetição do operador na lista suspensa de hora de término.
Observação: consulte o Guia do Criador de Conteúdo para obter mais informações sobre
programações.
Configurações do Calendário
As propriedades Configurações do calendário permitem incluir datas de um calendário
predefinido em uma programação.
Incluir Calendário
Clique no ícone de calendário para selecionar um calendário predefinido a ser
incluído na sua programação.
Excluir Calendário
Clique no ícone de calendário para selecionar um calendário predefinido a ser
excluído da sua programação.
Dias por turno
O número de dias para trocar uma data programada quando a data
programada cai em uma data de fechamento. O turno não pode ser negativo
ou zero. Quando esse valor é negativo a data muda para frente. Quando esse
valor for zero, as datas fechadas são simplesmente ignoradas sem reprogramar
a tarefa.
Não há dias excluídos
Marque essa caixa de seleção somente para contar os dias em aberto ao
deslocar uma data programada para evitar uma data fechada.
Mudança máxima
Quando uma data programada cai em um dia fechado e a tarefa é reprogramada, a
nova data também pode cair em uma data fechada. Esse parâmetro define o
número máximo de turnos que são permitidos.
Apenas selecionados manualmente
Quando um calendário não é especificado em uma programação, o CA Process
Automation considera o item programado diariamente. A exceção é quando você
seleciona essa opção. Quando essa opção for selecionada, programe as datas de
execução (na guia Datas incluídas manualmente).
40 Referência do Criador de Conteúdo
Propriedades comuns de operadores em Agendas
Datas incluídas manualmente
As propriedades Datas incluídas manualmente permitem adicionar datas a uma
programação manualmente. Essas propriedades exibem uma lista de datas que são
programadas manualmente. Elas também exibem uma lista de datas que as regras de
calendário especificam. As datas adicionadas aqui substituem os dias fechados
especificados pelas propriedades Datas excluídas manualmente.
Quando uma programação não especificar um calendário, as propriedades Datas
incluídas manualmente podem programar datas. Para isso, marque a caixa de seleção
Apenas seleção manual nas propriedades de Configurações do calendário.
Clique nos botões de opção adequados para adicionar, remover ou reorganizar os itens
da lista.
Adicionar item
Adiciona uma data à lista. Para definir a data, clique na entrada e, em seguida,
clique no ícone de calendário para selecionar as datas a incluir.
Excluir item
Remove uma data selecionada da lista.
Mover para cima
Move uma data selecionada para cima na lista.
Mover para baixo
Move uma data selecionada para baixo na lista.
Datas excluídas manualmente
As propriedades Datas excluídas manualmente permitem remover manualmente as
datas de uma programação. As propriedades de Datas excluídas manualmente listam
datas que não são programadas em nenhuma circunstância, independentemente de
todas as outras regras ou condições.
Clique no botão de opção adequado para adicionar, remover ou reorganizar os itens da
lista.
Adicionar item
Adiciona à lista datas para exclusão. Para definir a data, clique na entrada e, em
seguida, clique no ícone de calendário para selecionar as datas a incluir.
Excluir item
Remove uma data selecionada da lista.
Capítulo 1: Introdução aos operadores 41
Parâmetros de saída comuns a todos os operadores
Mover para cima
Move uma data selecionada para cima na lista.
Mover para baixo
Move uma data selecionada para baixo na lista.
Nome da tarefa
O nome da tarefa especifica o nome da tarefa definida pelo usuário. Ao adicionar um
operador ou processo à programação, é possível especificar o nome personalizado
nesse campo. O nome personalizado da tarefa se aplica às instâncias correspondentes
da tarefa em tempo de execução.
Parâmetros de saída comuns a todos os operadores
Todos os operadores contêm as propriedades de saída a seguir. Parâmetros de saída
extras são especificados para cada operador.
StartTime
A hora em que o operador começou no processo ou na programação.
StartDate
A data em que o operador começou no processo ou na programação.
Motivo
Especifica o motivo, caso haja falha do operador após a execução.
Resultado
Especifica o resultado da execução do operador.
42 Referência do Criador de Conteúdo
Capítulo 2: Operadores padrão.
Use os operadores de módulo Padrão para controlar os fluxos de trabalho em
processos.
Operador Iniciar
Use o operador Iniciar para iniciar um fluxo de trabalho em um processo. O operador
Iniciar é automaticamente incluído em um processo, por padrão.
Você pode adicionar mais de um operador Iniciar a um processo. Cada operador Iniciar
em um processo inicia seu próprio fluxo de trabalho quando um orquestrador inicia o
processo.
Você também pode adicionar um operador Iniciar para encerrar uma sequência cíclica
de operadores. Um operador Iniciar que encerra um fluxo de trabalho reinicializa os
operadores no fluxo de trabalho. O operador executa então um loop no processamento,
de volta ao ícone Iniciar inicial referente à sequência de operadores executados entre os
operadores Iniciar.
Parâmetros de entrada
Clique duas vezes no operador Iniciar para configurar seu nome e sua aparência usando
as propriedades de Informações (na página 38).
Capítulo 2: Operadores padrão. 43
Operador Comentário
Operador Comentário
O operador Comentário adiciona comentários ao processo. Os comentários são
importantes para documentar as etapas de um processo e permitir mais espaço do que
os rótulos.
Siga estas etapas::
1.
Arraste o operador Comentário da pasta Padrão para um local em uma das guias de
editor (principal, manipulador de exceções, manipulador de alteração de rota).
2.
Clique duas vezes no texto de comentário para exibir as propriedades do
comentário.
Parâmetros de entrada
Plano de fundo
Cor da borda
Clique na lista suspensa Escolher cor para selecionar a cor da borda do
comentário.
Cor do plano de fundo
Selecione a cor e a transparência do plano de fundo para o texto do
comentário.
■
Transparente para um plano de fundo transparente
■
Opaco para um plano de fundo colorido. Ao selecionar essa opção, você
também pode alterar a configuração Cor do plano de fundo.
Comentários
Permite inserir ou alterar o texto de um comentário.
■
Configure as propriedades de fonte: fonte, estilo de fonte, tamanho, efeitos
(negrito, itálico e sublinhado), cor e realce.
Selecione fontes que provavelmente estejam instaladas nos computadores que
hospedam o CA Process Automation.
■
Configure o alinhamento: alinhamento horizontal à esquerda, à direita ou no
centro para o texto do comentário. Listas numeradas e com marcadores
também estão disponíveis.
■
Clique em Hiperlink para transformar o texto selecionado em um hiperlink.
■
Clique em Editar origem para alternar para o modo de edição de origem.
44 Referência do Criador de Conteúdo
Operador Interrupção bem-sucedida
Operador Interrupção bem-sucedida
O operador Interrupção bem-sucedida encerra um processo e determina seu valor de
retorno. Um operador Interrupção bem-sucedida pode encerrar um processo:
■
No final de uma sequência de operadores na guia do Editor principal.
■
Em uma exceção na guia Manipulador de exceções.
■
Em uma alteração de rota na guia Manipulador de mudança de rota.
Um operador Interrupção bem-sucedida pode ser configurado como um operador
Interrupção bem-sucedida ou Interrupção com falha (por meio de suas propriedades).
Quando um processo é executado com êxito, o operador de parada define a variável de
Resultado de um operador do conjunto de dados como 1 por padrão. Você pode
substituir o padrão positivo para um número negativo para o sucesso de um operador
de parada para uma falha.
Parâmetros de entrada
Resultado
Especifica um parâmetro de resultado. O parâmetro é uma expressão de inteiro
usada para determinar se o fluxo terminou corretamente (valor positivo) ou
incorretamente (zero ou negativo).
O padrão é 1 quando você seleciona um tipo final de Interrupção bem-sucedida. O
padrão é 1 quando você seleciona Interrupção com falha. Você também pode
inserir outro valor inteiro ou digitar uma expressão que retorne um valor calculado
para o código do resultado no tempo de execução.
O valor de Resultado para o operador Interrupção bem-sucedida, que encerra uma
instância de um processo, é salvo para a variável de Resultado no conjunto de
dados do processo da instância.
Capítulo 2: Operadores padrão. 45
Operador Interrupção com falha
Tipo final
Selecione uma das seguintes opções:
Interrupção bem-sucedida
Processa um término normal para um fluxo de trabalho. Esta opção define o código
Resultado como 1. Se você alterar o valor de Resultado, use um número inteiro
positivo para ser consistente com um término normal.
Interrupção com falha
Executa um término anormal para um fluxo. Esta opção define o código Resultado
como -1. Se você alterar o valor de Resultado, digite 0 ou um número inteiro
negativo para ser consistente com um término anormal.
Interromper loop de chamada
Quando o fluxo for chamado de outro processo, marque essa caixa de seleção para
interromper um loop de chamada. Desmarcar essa caixa de seleção permite a
continuidade de um loop de chamada. Essa caixa de seleção só terá efeito se o fluxo
tiver sido chamado de dentro de um loop em outro processo.
Ignorar tarefas em execução (parada imediata)
Encerra um fluxo imediatamente, sem aguardar o término do processamento de
outros operadores. Desmarque essa caixa de seleção para aguardar o término do
processamento de outros operadores antes de encerrar o fluxo.
Operador Interrupção com falha
O operador Interrupção com falha interrompe um processo e determina uma falha. Um
operador Interrupção com falha pode encerrar um processo:
■
No final de uma sequência de operadores na guia do Editor principal.
■
Em uma exceção na guia Manipulador de exceções.
■
Em uma alteração de rota na guia Manipulador de mudança de rota.
Um operador Interrupção com falha pode ser configurado como um operador
Interrupção bem-sucedida ou Interrupção com falha (por meio de suas propriedades).
Quando um processo é executado, o operador de parada define a variável de Resultado
do conjunto de dados do operador para -1 por padrão. Você pode substituir o padrão
para um inteiro negativo para o operador de parada para o sucesso.
46 Referência do Criador de Conteúdo
Operador do andamento do processo
Parâmetros de entrada
Resultado
Especifica um parâmetro de resultado. O parâmetro é uma expressão de inteiro
usada para determinar se o fluxo terminou corretamente (valor positivo) ou
incorretamente (zero ou negativo).
O padrão é -1 quando você seleciona um tipo final de Interrupção com falha. O
padrão é 1 quando você seleciona Interrupção bem-sucedida. Você também pode
inserir outro valor inteiro ou digitar uma expressão que retorne um valor calculado
para o código do resultado no tempo de execução.
O valor de Resultado para o operador Interrupção com falha, que encerra uma
instância de um processo, é salvo para a variável de Resultado no conjunto de
dados do processo da instância.
Tipo final
Selecione uma das seguintes opções:
Interrupção bem-sucedida
Processa um término normal para um fluxo de trabalho. Esta opção define o código
Resultado como 1. Se você alterar o valor de Resultado, use um número inteiro
positivo para ser consistente com um término normal.
Interrupção com falha
Executa um término anormal para um fluxo. Esta opção define o código Resultado
como -1. Se você alterar o valor de Resultado, digite 0 ou um número inteiro
negativo para ser consistente com um término anormal.
Interromper loop de chamada
Quando o fluxo for chamado de outro processo, marque essa caixa de seleção para
interromper um loop de chamada. Desmarcar essa caixa de seleção permite a
continuidade de um loop de chamada. Essa caixa de seleção só terá efeito se o fluxo
tiver sido chamado de dentro de um loop em outro processo.
Ignorar tarefas em execução (parada imediata)
Encerra um fluxo imediatamente, sem aguardar o término do processamento de
outros operadores. Desmarque essa caixa de seleção para aguardar o término do
processamento de outros operadores antes de encerrar o fluxo.
Operador do andamento do processo
Capítulo 2: Operadores padrão. 47
operador e
O operador Andamento do processo permite definir o andamento em diferentes etapas
de um processo. Os usuários com privilégios podem monitorar o andamento do
processo de qualquer uma das seguintes maneiras:
■
Conjunto de dados do processo
■
Relatórios definidos pelo usuário
■
Tabela Instâncias de processo na guia Operações
Observação: para obter mais informações sobre usuários com privilégios, consulte a
seção Permissões por guia no Guia do Administrador de Conteúdo.
Parâmetros de entrada
Andamento do processo
Especifica o andamento da conclusão de um processo com uma porcentagem no
intervalo de 0 a 100. Se a execução de um processo atingir um operador
Interrupção bem-sucedida, o andamento do processo será 100. Se um processo
falhar após alcançar um andamento de 50%, o Conjunto de dados do processo
exibirá 50.
Saída
Andamento
Exibe a porcentagem de conclusão de um processo sob Andamento (nome da
variável) no Conjunto de dados do processo.
operador e
O operador E define um ponto de sincronização entre todos os links de entrada
vinculados a ele. Os links de saída de um operador E só são ativados depois que todos os
seus links de entrada forem ativados. Use o operador E para sincronizar várias
ramificações de um processo com uma condição lógica E, quando duas ou mais
ramificações separadas de um fluxo precisarem ser concluídas antes de iniciar uma ou
mais ramificações adicionais.
48 Referência do Criador de Conteúdo
Operador Ou
Você pode incluir um operador E em um processo de várias maneiras.
Siga estas etapas::
1.
Arraste o operador E da pasta Padrão até uma das guias do editor (Principal,
Manipulador de exceções, Manipulador de mudança de rota).
2.
Vincule um ou mais operadores de entrada para que o operador E possa
sincronizar.
3.
Vincule um ou mais operadores de saída para seguir a conclusão do operador E.
Parâmetros
O operador E não possui parâmetros.
Operador Ou
O operador Ou define um ponto de sincronização entre todos os links de entrada. Os
links de saída de um operador Ou são ativados quando pelo menos um link de entrada
do operador tiver sido ativado. Pelo menos uma de duas ou mais ramificações
separadas de um fluxo que leva a um operador Ou devem ser concluídas antes de se
iniciar uma ou mais ramificações de saída.
O operador Ou pode ser adicionado a sequências de operadores em um processo em
uma das guias de editor (Principal, Manipulador de exceções, Manipulador de mudança
de rota). Coloque um operador Ou em um processo arrastando-o do módulo Comum
para qualquer um desses três editores. Vincule um ou mais operadores de entrada para
sincronizar com o operador Ou e vincule um ou mais operadores de saída após a
conclusão do operador Ou.
Parâmetros
O operador Ou não possui parâmetros.
Capítulo 2: Operadores padrão. 49
Operador redefinir
Operador redefinir
Use o operador Redefinir para redefinir os operadores selecionados (em geral, um
operador que causou uma exceção) em um processo suspenso para seus estados
iniciais. Esses operadores redefinir atuam como se não houvessem sido executados e o
processo continua.
Esse operador também permite que o usuário ignore uma exceção e continue com um
processo assim mesmo. O operador Redefinir permite que um usuário defina um
operador no modo de simulação e continue o processo com esse operador simulado.
Parâmetros de entrada
Lista de Operadores
Clique em Adicionar para adicionar um operador a ser redefinido. Um menu
suspenso permite selecionar um dos nomes de operador disponíveis no processo
atual. Vários operadores podem ser adicionados e, depois, excluídos, classificados
ou adicionados novamente.
Você também pode inserir uma expressão (em vez de escolher um operador no
menu suspenso) que seja resolvida como uma sequência de caracteres (um nome
de operador) ou ValueArray (uma lista de nomes de operador) no tempo de
execução.
Continuar com resultado
Selecionado
O menu suspenso Condição de término e a caixa de seleção Avaliar código de
execução anterior e posterior se tornam disponíveis.
Desmarcado
Quando uma condição de erro for atendida no tempo de execução, o CA
Process Automation redefinirá os operadores selecionados. Em seguida, o CA
Process Automation continua com o fluxo do processo.
50 Referência do Criador de Conteúdo
Operador redefinir
Condição de término
Quando você seleciona a caixa de seleção Continuar com resultado, o menu
suspenso Condição de término se torna disponível com as seguintes opções:
Com êxito.
O CA Process Automation presume que os operadores selecionados tiveram
êxito se nenhuma condição de erro for atendida no tempo de execução. Em
seguida, o CA Process Automation continua com o restante do fluxo do
processo.
Malsucedido
O CA Process Automation presume que os operadores selecionados falharam
quando uma condição de erro é atendida no tempo de execução. Em seguida, o
CA Process Automation continua com o restante do fluxo do processo.
Avaliar código de execução anterior e posterior
Selecione esta caixa de seleção para avaliar o código pré-execução e pós-execução.
Como o operador Redefinir funciona com o operador Loop
O operador Redefinir funciona com o operador Loop conforme é indicado a seguir.
1.
2.
O operador Redefinir permite que o operador Loop seja redefinido. O operador
Redefinir redefine o operador Loop conforme é indicado a seguir:
■
Redefine todos os operadores dentro do operador Loop.
■
Redefine o operador Loop para a primeira iteração.
Após a redefinição, o operador Loop é reiniciado a partir da primeira iteração.
Observação: o operador Loop não oferece suporte a simulação. O operador Reset
sempre redefine o operador Loop, independentemente dos valores dos campos:
■
Continuar com resultado
■
Condição de término
■
Avaliar código de execução anterior e posterior
Capítulo 2: Operadores padrão. 51
Operador Loop
Operador Loop
O operador Loop executa o loop de uma sequência fechada de operadores em um
processo, por um número de vezes especificado ou indefinidamente. É possível
colocá-lo em um processo e redimensionar a caixa para acomodar qualquer número de
operadores na sequência.
O operador Loop pode incluir uma sequência de operadores em um processo no painel
Editor principal, Manipulador de exceções ou Manipulador de mudança de rota do
Criador de processos.
Para colocar um operador Loop em um processo
1.
Arraste o operador de loop da pasta padrão para um editor.
2.
Arraste um ou mais links de entrada para o portal de entrada, e um ou mais links de
saída do seu portal de saída.
3.
Adicione os operadores em loop dentro da caixa Loop.
4.
Vincule o portal de entrada ao primeiro operador da sequência em loop.
5.
Vincule o último operador da sequência de saída ao portal de saída.
52 Referência do Criador de Conteúdo
Operador Loop
Parâmetros de entrada
Contagem de repetição
Especifica o número de vezes que um operador é repetido. As duas opções
seguintes estão disponíveis:
■
Esse valor pode ser especificado com um número inteiro ou uma expressão do
CA Process Automation que retorna um número inteiro em tempo de
execução. O valor padrão 1 executa um loop em um operador uma única vez
em um fluxo de trabalho. Para executar um loop infinito, clique na caixa de
seleção Loop infinito.
■
Uma expressão booleana também pode ser usada. Enquanto a expressão for
avaliada como verdadeira, um operador em um fluxo de trabalho executará um
loop contínuo. Se a expressão for falsa, o operador será encerrado.
Esse valor também pode ser especificado usando as variáveis de loop no conjunto
de dados do operador Loop:
–
CurrentLoopIteration: um contador de loops que se inicia em 0 durante a
primeira iteração do loop e é incrementado em 1 para cada iteração
adicional. Essa variável é atualizada no início e no fim de cada iteração.
Se o operador for configurado para fazer um loop três vezes, ao final da
execução de todas as iterações, CurrentLoopIteration será igual a:
- 0 na iteração 1
- 1 na iteração 2
Capítulo 2: Operadores padrão. 53
Operador Loop
- 2 na iteração 3
- 3 na última iteração, que não é executada, pois viola a condição de loop.
–
OverallLoopDuration: um contador de loops que especifica o tempo
decorrido (em segundos) desde o início da primeira iteração do loop. Essa
variável é atualizada no início e no fim de cada iteração e inclui qualquer
atraso definido entre as iterações do loop.
Defina Repetir contagem como:
Process[OpName].CurrentLoopIteration < x
onde
x é o número de vezes para executar o operador.
Ou então, defina Repetir contagem como:
Process[OpName].OverallLoopDuration < x
onde
x é o número de vezes para realizar um loop com o operador. O operador não
interrompe no número de segundos especificado quando está no meio de uma
iteração. Em vez disso, se OverallLoopDuration for maior do que o número de
segundos especificado, o operador não executará a próxima iteração.
O CA Process Automation verifica a condição de loop entre as iterações.
Loop infinito
Quando selecionado, Repetir contagem é ignorado e um loop infinito é criado. O
operador continua a ser repetido até que:
■
O processo seja encerrado.
■
O loop seja interrompido de outra ramificação do processo (processando um
link de comando de interrupção de loop para o operador Loop).
54 Referência do Criador de Conteúdo
Operador Loop
Atraso entre iterações
Especifica o atraso em segundos entre cada iteração do loop.
Loop While
Quando selecionado, o operador Loop se comporta como um loop while. Se
desmarcado, o operador Loop não se comporta como um loop do while.
Loop While
Loop while: o operador Loop verifica a condição de loop especificado no campo
Repetir contagem antes de executar qualquer iteração, inclusive a primeira
iteração.
Loop Do while
Loop Do while: o operador Loop verifica a condição de loop especificada no
campo Repetir contagem ao final de cada iteração, assim, é garantido que ele
execute pelo menos a primeira iteração do loop.
Observação: todos os operadores de loop existentes importados do CA Process
Automation antes da v4 têm o campo Loop while desmarcado. Esses operadores
existentes continuam a funcionar como loops Do while, como nas versões
anteriores.
Código de execução anterior e posterior
Use esses campos para executar um código JavaScript juntamente com cada
iteração do loop.
A sequência de processamento de qualquer condição de execução anterior e
posterior depende do tipo de loop. Consulte o Guia do Criador de Conteúdo para
saber mais sobre a sequência lógica de um loop.
Capítulo 2: Operadores padrão. 55
Operador Alterar a rota
Parâmetros de saída
CurrentLoopIteration
Um contador de loops iniciado em 0 durante a primeira iteração do loop e é
incrementado em 1 para cada iteração adicional. Essa variável é atualizada no início
e no fim de cada iteração. Se o operador Loop for configurado para fazer loop três
vezes, ao final da execução de todas as iterações, CurrentLoopIterations será igual
a:
■
0 na iteração 1
■
1 na iteração 2
■
2 na iteração 3
■
3 na última iteração, que não é executada, pois viola a condição do operador
Loop.
OverallLoopDuration
Um contador de loops que especifica o tempo decorrido (em segundos) desde o
início da primeira iteração do loop. Essa variável é atualizada no início e no fim de
cada iteração e inclui qualquer atraso definido entre as iterações do loop.
Redefinir manualmente o operador Loop em um processo
Consulte o Guia do Criador de Conteúdo para obter detalhes sobre como redefinir o
operador Loop manualmente em um processo.
Operador Alterar a rota
O operador Alterar a rota inicia uma série de regras de alteração de rota no painel
Manipulador de mudança de rota do Criador.
Para colocar o operador Alterar a rota em um processo
Arraste o Operador Alteração de rota da pasta padrão em um dos editores.
Parâmetros de entrada
Nome
Essa opção exibe o nome da alteração da rota. É possível alterar o nome editando a
propriedade Nome no grupo de propriedades Informações para a alteração de rota.
56 Referência do Criador de Conteúdo
Operador de exceção
Source
Especifica a rota de origem para a alteração. Selecione Tudo para uma alteração de
rota a partir de qualquer rota.
Destino
Especifica a rota de destino para a alteração. Selecione Tudo para uma alteração de
qualquer rota.
Operador de exceção
Use o operador Exceção para iniciar uma exceção, como uma terminação devido a erros
de sistema ou condições de saída não identificadas. Para colocar o operador Exceção em
um processo, arraste-o da pasta Padrão para o editor Manipulador de exceções.
Parâmetros de entrada
Nome
Exibe o nome da exceção. Para alterar o nome, edite a propriedade Nome sob o
grupo de propriedades de Informações da exceção.
Tipo de exceção
Selecione erro de sistema, resposta não identificada, anulado ou tempo de
execução na lista suspensa para categorizar a exceção.
Links
Os links definem a estrutura de um processo por meio da criação de sequências de
operadores.
Capítulo 2: Operadores padrão. 57
Links
Para criar um link
Clique em um link de saída em um operador e arraste-o para o operador subsequente
na sequência.
Se o link desejado não for exibido, clique com o botão direito do mouse no operador e,
em seguida, clique no tipo de link (como Falha, Concluído ou Personalizado) no menu de
atalho.
Propriedades do link
As propriedades do link são exibidas quando você clica com o botão direito do mouse
em um link em um processo e clica em Propriedades no link.
Weight
Especifica a espessura das linhas entre os operadores.
Cor
Abre a caixa de diálogo Escolher cor do link, na qual é possível alterar a cor dos links
no processo.
Formas
Especifica o formato da linha para links entre os operadores:
Reto
Cria links retos entre os operadores.
Ortogonal
Cria links em ângulo reto entre os operadores.
Tracejado
Clique nesta caixa de seleção para criar um link tracejado (com pontos).
58 Referência do Criador de Conteúdo
Capítulo 3: Catalyst
Os operadores Catalyst incluem operadores para criar, ler, atualizar e excluir, bem como
assinatura de eventos, que podem ser chamados em qualquer conector Catalyst. Todos
os parâmetros do operador podem conter expressões, para oferecer flexibilidade
máxima ao criar conteúdo. Os processos do CA Process Automation podem ser criados
usando qualquer combinação desses operadores para criar integrações entre vários
produtos. Além disso, os operadores do UCF-USM podem ser usados como operadores
de base para criar operadores personalizados para soluções específicas de produtos.
Todos os Conectores Catalyst expor os objetos que estão de acordo com o Modelo de
Serviço Unificado (USM modelo). Este modelo comum facilita integrações.
Os operadores Catalyst contêm operadores que são genéricos para qualquer tipo de
USM. Esses operadores também contêm os operadores que são específicos de cada
USM. Consulte o guia de conector fornecido com o conector Catalyst para obter mais
informações.
Catalyst nós contêm um agente, que é um diretório de conectores. No modo de design,
os operadores Catalyst consulta o agente e o conector MdrProdInstance nomes na lista.
Operadores USM genéricos
Os seguintes operadores são os mais comumente usados que se aplicam a todos os
tipos de USM.
Operador Criar
O operador Criar oferece suporte às operações criar e atualizar do CRUD em qualquer
tipo de USM.
Capítulo 3: Catalyst 59
Operadores USM genéricos
Parâmetros de entrada
UCFBrokerURL
Define o URL do broker do UCF do Catalyst servidor. O padrão é o URL do broker do
UCF na configuração do Catalyst.
Especifique o URL do broker do Catalyst de serviço como:
http://<nome_do_host>:7000/ucf/BrokerService
Quando uso seguro Catalyst comunicações de agente de seguros, especifique o URL
como:
https://<nome_do_host>:7443/ucf/BrokerService
MdrProduct
Identificador exclusivo do produto de conexão.
MdrProdInstance
Identificador exclusivo da instância do produto de conexão, conforme registrado no
broker do UCF. O CA Process Automation consulta o do broker do UCF para a lista
de conectores disponíveis e preencher esse campo. É possível, em seguida,
selecionar o conector na lista suspensa.
Criar
Indica se o operador:
■
Cria um objeto
Ou
■
Atualiza um objeto existente.
Itemtype
Especifica o tipo de USM do objeto que será criado ou atualizado.
Valores:
Alert, ComputerSystem, Router, Service e assim por diante.
Por exemplo:
itemtype=ComputerSystem
Propriedades
Os parâmetros do operador contêm as propriedades de tipo de USM.
60 Referência do Criador de Conteúdo
Operadores USM genéricos
Personalizando as propriedades
O formulário Propriedades de pode ser personalizado com o Nome de arquivo de
configuração da propriedade do produto. Se os valores de MdrProduct e tipodeitem
corresponderem ao Nome do arquivo de configurações da propriedade do produto, o
formulário será exibido de acordo com as seguintes regras:
■
Se a propriedade não estiver definida no tipo de USM, ela é uma propriedade
personalizada, sendo adicionada ao formulário.
■
Se a propriedade estiver definida no tipo de USM, será adicionada ao formulário.
■
Se a propriedade estiver definida no tipo de USM tiver um nome de alias, ela é
adicionada ao formulário usando o nome de alias.
Por exemplo, essa entrada exibe o formulário Alerta, como mostrado.
<!-- SCOM -->
<MdrTypes MdrProduct="CA:00031">
<TypeMap name="Alert">
<Mapping propName="MdrProdInstance" aliasName="siloHost" />
<Mapping propName="MdrElementId" aliasName="Id" />
<Mapping propName="UrlParams" aliasName="" />
<Mapping propName="SeverityTrend" aliasName="" />
<Mapping propName="RelatedAlerts" aliasName="" />
<Mapping propName="AlertedMdrProdInstance" aliasName="siloHost" />
<Mapping propName="AlertedMdrElementID" aliasName="MonitoringObjectId"
/>
<Mapping propName="Summary" aliasName="Name" />
<Mapping propName="Message" aliasName="Description" />
<Mapping propName="Assignee" aliasName="Owner" />
</TypeMap>
</MdrTypes>
A dica de ferramenta de propriedades com nomes de alias indica o nome de
propriedade de USM.
Operador Excluir
O operador Excluir oferece suporte à operação de exclusão do CRUD em qualquer USM.
Os parâmetros identificam o MDR e o objeto a ser excluído.
Capítulo 3: Catalyst 61
Operadores USM genéricos
Parâmetros de entrada
UCFBrokerURL
Define o URL do broker do UCF do Catalyst servidor. O padrão é o URL do broker do
UCF na configuração do Catalyst.
Especifique o URL do broker do Catalyst de serviço como:
http://<nome_do_host>:7000/ucf/BrokerService
Quando uso seguro Catalyst comunicações de agente de seguros, especifique o URL
como:
https://<nome_do_host>:7443/ucf/BrokerService
MdrProduct
Identificador exclusivo do produto de conexão.
MdrProdInstance
Identificador exclusivo da instância do produto de conexão, conforme registrado no
broker do UCF. O CA Process Automation consulta o do broker do UCF para a lista
de conectores disponíveis e preencher esse campo. É possível, em seguida,
selecionar o conector na lista suspensa.
MdrElementID
Identificador exclusivo do objeto no produto que está se conectando.
ClassName
Nome da classe do objeto (Alert, ComputerSystem e assim por diante).
Operador Executar
O operador Executar oferece suporte a operações personalizadas em qualquer Conector
do UCF. Os parâmetros identificam o MDR, a operação e parâmetros da operação.
Parâmetros de entrada
CatalystBrokerURL
Define o URL do broker do UCF do Catalyst servidor. O padrão desse valor é o URL
do Broker do UCF na configuração do Catalyst.
Especifique o URL do broker do Catalyst de serviço como:
"http://nome_do_host:7000/ucf/BrokerService"
Quando uso seguro Catalyst comunicações de agente de seguros, especifique o URL
como:
"https://nome_do_host:7443/ucf/BrokerService"
62 Referência do Criador de Conteúdo
Operadores USM genéricos
MdrProduct
Especifica um identificador exclusivo do produto em conexão.
O CA Process Automation é identificado como:
"CA:00074 (CA Process Automation)"
MdrProdInstance
Especifica um identificador exclusivo da instância do produto em conexão conforme
registrado no Broker do UCF. O CA Process Automation consulta o broker do
Catalyst para obter a lista de conectores e preenche esse campo para que você
possa selecionar o conector na lista suspensa.
O CA Process Automation é identificado como:
"CA:00074:01"
Categoria de operação
Especifica os descritores do conector carregado para os operadores do Catalyst.
Selecione um descritor na lista suspensa.
Operação
Especifica as operações do descritor do conector depois de selecionar uma
Categoria de operação. Selecione um descritor do conectar na lista suspensa.
ParameterExpression
Define um mapa de valores que corresponde à estrutura de parâmetro esperada.
Use esse operador quando o operador Executar for usado como um operador de
base de um operador personalizado e o código de execução anterior criar o valor de
forma dinâmica. É possível usar o conjunto de dados do operador de base Executar
como uma referência para construir o valor.
ParameterNamespaceExpression
Define os espaços para nome usados na expressão de parâmetro.
Use esse operador quando o operador Executar for usado como um operador de
base de um operador personalizado e o código de execução anterior criar o valor de
forma dinâmica. É possível usar o conjunto de dados do operador de base Executar
como uma referência para construir o valor.
Parâmetros
Depois de selecionar uma Operação, clique em Parâmetros para especificar os
parâmetros de entrada para a consulta. Esses campos variam de acordo com a
operação selecionada. Não digite dados neles se você já tiver digitado dados nos
campos Expressão de parâmetro e Expressão de espaço para nome de parâmetro.
Os parâmetros para cada operação podem ser encontrados aqui.
Capítulo 3: Catalyst 63
Operadores USM genéricos
Parâmetros do Operation-Specific
Digite os seguintes dados para especificar informações sobre a operação selecionada.
Observação: não digite dados neles se você já tiver digitado dados nos campos
Expressão de parâmetro e Expressão de espaço para nome de parâmetro.
AbortStartRequest
Instância
Especifica a instância da solicitação inicial para cancelar.
Cancelar
MdrProduct
Especifica o identificador exclusivo do produto em conexão com o qual deseja
cancelar a solicitação.
MdrProdInstance
Especifica o identificador exclusivo da instância do produto em conexão
(conforme registrado no broker do Catalyst) com o qual deseja cancelar a
solicitação.
MdrElementID
DelegateTask
TaskID
Especifica a ID da tarefa que você deseja cancelar.
Exportar
Especifica informações sobre o conteúdo exportado.
ExportRequest
■
Nome da pasta: especifica o nome da pasta que contém o conteúdo
exportado.
■
IsAbsolute:
■
SealModifiableReleaseVersions:
ExportFileName
Especifica
■
ExportLocation
■
OverwriteFile
Filtrar
ObjectTypes: permite filtrar um tipo específico de objeto.
Em espera
64 Referência do Criador de Conteúdo
Operadores USM genéricos
MdrProduct
Especifica o identificador exclusivo do produto em conexão que deseja.
MdrProdInstance
Especifica o identificador exclusivo da instância do produto em conexão
(conforme registrado no broker do Catalyst) que deseja
MdrElementID
Importar
ImportLocation
Especifica o local do arquivo .xml a ser importado.
SourceLocation
OverwriteAction
SetCurrent
MakeAvailable
QueryDatasetNames
PathName
Especifica o caminho que contém o nome do conjunto de dados no qual você
deseja executar uma consulta.
QueryDatasetParameters
PathName
Especifica o caminho que contém o nome do conjunto de dados no qual você
deseja executar uma consulta.
QueryModuleConfigProperties
ModuleName
Especifica o nome das propriedades do módulo do CA Process Automation que
você deseja configurar.
QueryModuleConfigs
(Opcional) ModuleName
Especifica o nome do módulo do CA Process Automation.
(Opcional) O <ModuleType>
Capítulo 3: Catalyst 65
Operadores USM genéricos
Especifica se a configuração do módulo padrão ou do grupo de módulos
personalizados é retornada. Por padrão, o método QueryModuleConfigs
retorna todos os módulos disponíveis. O atributo <ModuleType> usa os
seguintes valores:
Todas
Retorna a configuração de módulos padrão e personalizados.
Padrão
Retorna apenas a configuração de módulos padrão.
Personalizada
Retorna apenas a configuração de módulos personalizados.
QueryStartRequestForms
LookUpPath
Especifica
IsRecursive
Valores
Os valores podem ser um dos seguintes:
■
verdadeiro: especifique verdadeiro para
■
falso: especifique falso para
Palavras-chave
Adicionar um parâmetro a...
QueryStartRequests
Instância
Especifica a instância da solicitação inicial para consulta.
IsArchived
Especifica se a instância da solicitação inicial foi arquivada.
Os valores podem ser um dos seguintes:
■
66 Referência do Criador de Conteúdo
verdadeiro: o CA Process Automation verificará se a instância de
solicitação inicial fornecida está disponível no banco de dados de tabela
arquivado. Se a instância de solicitação inicial não estiver no banco de
dados de tabela arquivado, o nome da instância fornecido retornará todas
as instâncias arquivadas disponíveis do banco de dados.
Operadores USM genéricos
■
falso: o CA Process Automation verificará se a instância de solicitação
inicial fornecida está disponível no banco de dados de tabela atual. Se a
instância de solicitação inicial não estiver no banco de dados de tabela
atual, o nome da instância fornecido retornará todas as instâncias não
arquivadas disponíveis do banco de dados.
QueryTasks
TaskID
Especifica a ID da tarefa que você deseja consultar.
RootUUID
ProcessID
Estado
Release
MdrProduct
Especifica o identificador exclusivo do produto em conexão que deseja.
MdrProdInstance
Especifica o identificador exclusivo da instância do produto em conexão
(conforme registrado no broker do Catalyst) que deseja
MdrElementID
ReplyTask
TaskID
Especifica a ID da tarefa à qual deseja responder.
IsApproved
Especifica a ID da tarefa que você deseja aprovar.
Argumentos
ReturnTask
TaskID
Especifica a ID da tarefa que você deseja retornar.
Iniciar
MdrProduct
Capítulo 3: Catalyst 67
Operadores USM genéricos
Especifica o identificador exclusivo do produto em conexão que deseja.
MdrProdInstance
Especifica o identificador exclusivo da instância do produto em conexão
(conforme registrado no broker do Catalyst) que deseja
MdrElementID
Argumento
SubmitStartRequestForm
Nome
Especifica o nome do formulário de solicitação inicial para enviar.
Caminho
Especifica o caminho do formulário de solicitação inicial para enviar.
Argumentos
StartDate
Especifica a data de início do formulário de solicitação inicial para enviar.
StartTime
Especifica a hora em que o formulário de solicitação inicial a ser enviado foi
iniciado.
Prioridade
Especifica a prioridade do formulário de solicitação inicial que você deseja
enviar.
TakeTask
TaskID
Especifica a ID da tarefa que você deseja
TransferTask
TaskID
Especifica a ID da tarefa que você deseja
Usuários
Grupos
68 Referência do Criador de Conteúdo
Operadores USM genéricos
UpdateDatasetParameters
PathName
Especifica o nome do caminho para o conjunto de dados que contém os
parâmetros que você deseja atualizar.
Parâmetros
Especifica um parâmetro para o conjunto de dados que você deseja atualizar.
?? Isso especifica o novo valor?
Operador Get
O operador Get oferece suporte à operação de leitura do CRUD em qualquer USM. Os
parâmetros identificam os valores de filtro MDR e UCF (entitytype, tipodeitem,
recursiva, id e updatedAfter). Além disso, o parâmetro MaxNumberOfObjects restringe
o número de objetos que o operador retorna.
Parâmetros de entrada
UCFBrokerURL
Define o URL do broker do UCF do Catalyst servidor. O padrão é o URL do broker do
UCF na configuração do Catalyst.
Especifique o URL do broker do Catalyst de serviço como:
http://<nome_do_host>:7000/ucf/BrokerService
Quando uso seguro Catalyst comunicações de agente de seguros, especifique o URL
como:
https://<nome_do_host>:7443/ucf/BrokerService
MdrProduct
Identificador exclusivo do produto de conexão.
Capítulo 3: Catalyst 69
Operadores USM genéricos
MdrProdInstance
Identificador exclusivo da instância do produto de conexão, conforme registrado no
broker do UCF. O CA Process Automation consulta o do broker do UCF para a lista
de conectores disponíveis e preencher esse campo. É possível, em seguida,
selecionar o conector na lista suspensa.
entitytype
Especifica o tipo da entidade. Os valores podem ser Alert, Item ou Relationship.
Por exemplo:
Item entitytype =
itemtype
Especifica o tipo de item. Se não for especificado, todos os tipos serão recuperados.
Por exemplo:
itemtype=ComputerSystem
recursive
Especifica se o conector inclui de maneira recorrente o item e respectivos
relacionamentos e filhos integrantes.
id
Especifica um determinado identificador de objeto (o mesmo que MdrElementID)
updatedAfter
Especifica apenas os objetos que são atualizadas depois de um determinado tempo.
MaxNumberOfObjects
Especifica o número máximo de objetos para recuperar para o operador for
concluído.
Operador Inscrever-se para receber alterações
O operador Inscrever-se para receber alterações oferece suporte a assinaturas de
eventos de qualquer tipo de USM usando filtros do UCF. Os parâmetros identificam os
valores de filtro MDR e UCF (entitytype, tipodeitem, recursiva, id e updatedAfter). Além
disso, o parâmetro MaxNumberOfObjects restringe o número de objetos que o
operador retorna. O parâmetro timeOut especifica o número de segundos após o qual a
assinatura expira. O operador é concluído quando o número de objetos é retornado ou
o tempo limite expira.
70 Referência do Criador de Conteúdo
Operadores USM genéricos
Parâmetros de entrada
Esse operador utiliza os seguintes parâmetros de entrada:
UCFBrokerURL
Define o URL do broker do UCF do Catalyst servidor. O padrão é o URL do broker do
UCF na configuração do Catalyst.
Especifique o URL do broker do Catalyst de serviço como:
http://<nome_do_host>:7000/ucf/BrokerService
Quando uso seguro Catalyst comunicações de agente de seguros, especifique o URL
como:
https://<nome_do_host>:7443/ucf/BrokerService
MdrProduct
Identificador exclusivo do produto de conexão.
MdrProdInstance
Identificador exclusivo da instância do produto de conexão, conforme registrado no
broker do UCF. O CA Process Automation consulta o do broker do UCF para a lista
de conectores disponíveis e preencher esse campo. É possível, em seguida,
selecionar o conector na lista suspensa.
entitytype
Especifica o tipo da entidade. Os valores podem ser Alert, Item ou Relationship.
Por exemplo:
Item entitytype =
itemtype
Especifica o tipo de item. Se não for especificado, todos os tipos serão recuperados.
Por exemplo:
itemtype=ComputerSystem
recursive
Especifica se o conector inclui de maneira recorrente o item e respectivos
relacionamentos e filhos integrantes.
id
Especifica um determinado identificador de objeto (o mesmo que MdrElementID).
updatedAfter
Especifica apenas os objetos que são atualizadas depois de um determinado tempo.
Capítulo 3: Catalyst 71
Operadores USM genéricos
timeOut
Especifica o número de segundos após o qual o período de assinatura termina.
MaxNumberOfObjects
Especifica o número máximo de objetos para recuperar para o operador for
concluído.
Exemplo:
Os operadores Catalyst podem ser usados diretamente em processos para criar
conteúdo genérico. Você também pode usar os operadores como operadores de base
de operadores personalizados para conteúdo específico ao produto.
Este exemplo descreve como criar incidentes do Service Desk com base em alertas
SCOM.
Para criar uma solução simples
1.
Adicione o operador Inscrever-se para receber alterações a um processo.
2.
Selecione o conector do SCOM nas listas de MdrProduct/MdrProdInstance e o
alerta na lista de entitytype.
72 Referência do Criador de Conteúdo
Operadores USM genéricos
3.
Adicione o operador IncidentUpdate ao processo. Marque a caixa de seleção Criar e
o Conector do Service Desk na lista.
4.
Defina os valores das propriedades de incidentes usando as propriedades do objeto
de alerta SCOM como expressões variáveis.
O conteúdo está agora disponível para uso.
Capítulo 3: Catalyst 73
Operadores de USM não genéricos
Operadores de USM não genéricos
Além dos operadores do CRUD genéricos, há operadores de Criar/atualizar específicos
para cada tipo de USM. Os parâmetros do operador são criados com base nas
propriedades dos tipos de USM. Esses operadores são construídos dinamicamente a
partir do esquema do USM durante a inicialização do Catalyst.
Os seguintes operadores são gerados especificamente a partir dos tipos de USM:
■
Atualizar Alerta
■
ApplicationServerUpdate
■
ApplicationSystemUpdate
■
ApplicationUpdate
■
AssetUpdate
■
BackgroundProcessUpdate
■
BinaryRelationshipsUpdate
■
BootSoftwareUpdate
■
BusinessProcessServerUpdate
■
BusinessTransactionUpdate
■
ChangeOrderUpdate
■
ChangePackageUpdate
■
ClusterUpdate
■
CommentUpdate
■
CommunicationServerUpdate
■
ComplianceStatusUpdate
■
ComputerSystemUpdate
■
ConnectorIDUpdate
■
ConnectorUpdate
■
ContractUpdate
■
DatabaseInstanceUpdate
■
DatabaseUpdate
■
DirectoryServerUpdate
■
DiskPartitionUpdate
■
EntityIDUpdate
■
EntityUpdate
■
EnvironmentSensorUpdate
74 Referência do Criador de Conteúdo
Operadores de USM não genéricos
■
ExtensionEntityUpdate
■
ExtensionRunningHardwareUpdate
■
FileUpdate
■
GenericIPDeviceUpdate
■
GroupUpdate
■
HypervisorManagerUpdate
■
IncidentUpdate
■
InterfaceCardUpdate
■
IPConfigUpdate
■
ITActivityProfileUpdate
■
ITActivityTemplateUpdate
■
ITActivityUpdate
■
LatestUsmBuildUpdate
■
LocationUpdate
■
MailServerUpdate
■
ManagedAccesssUpdate
■
ManagementAgentUpdate
■
MediaDriveUpdate
■
MemoryUpdate
■
MessageServerUpdate
■
MultiFunctionEntityUpdate
■
NetworkServerUpdate
■
NetworkUpdate
■
OperatingSystemUpdate
■
OrganizationalEntityUpdate
■
PersonUpdate
■
PhysicalContainerUpdate
■
PortUpdate
■
PowerSupplyUpdate
■
PrinterUpdate
■
PrintServerUpdate
■
ProblemUpdate
■
ProcessorUpdate
Capítulo 3: Catalyst 75
Operadores de USM não genéricos
■
ProjectUpdate
■
ProvisionedSoftwareUpdate
■
RequestUpdate
■
ResourceServerUpdate
■
RouterUpdate
■
RunningHardwareUpdate
■
RunningSoftwareUpdate
■
SecurityServerUpdate
■
ServiceSpecificationUpdate
■
ServiceUpdate
■
SnmpV1AccessUpdate
■
SnmpV3AccessUpdate
■
SoftwareComponentUpdate
■
StorageArrayUpdate
■
StoragePoolUpdate
■
StorageVolumeUpdate
■
SwitchUpdate
■
TablespaceUpdate
■
TransactionContextUpdate
■
TransactionSegmentUpdate
■
TransactionServerUpdate
■
VirtualizationManagerUpdate
■
VirtualSystemUpdate
■
VMDataStoreUpdate
76 Referência do Criador de Conteúdo
Parâmetros de segurança do Catalyst
Parâmetros de segurança do Catalyst
Cada operador do Catalyst inclui parâmetros de segurança do Catalyst. Esses
parâmetros oferecem suporte a autenticações no nível do Catalyst e no nível do
conector.
Após o acesso ser concedido aos nós do Catalyst, você poderá usar requisições para
obter informações de segurança específicas do conector. Para obter informações sobre
reivindicações do conector, consulte o guia Conector fornecido com o conector Catalyst
aplicável.
Nome de usuário
Define a ID do usuário que acessa os nós do Catalyst.
Senha
Especifica a senha associada ao nome de usuário.
Uma vez que a senha é especificada como uma expressão, o texto inserido deverá
ficar visível. Evite o uso de sequências de caracteres literais e especifique uma
expressão que faça referência a uma variável em um conjunto de dados global.
afirma:
Essas declarações não são protegidos por senha.
Clique em Adicionar e digite o nome da primeira reivindicação com seu valor.
Repita essa etapa para cada rota. Use as setas para cima e para baixo para colocar
em sequência ou excluir as requisições, conforme o necessário.
Nome da reivindicação
Define o nome da requisição.
Valor da reivindicação
Define o valor da requisição nomeada.
Requisições de senha
Essas reivindicações estão protegidas por senha. O CA Process Automation
criptografa valores de senha.
Clique em Adicionar e insira o nome da primeira requisição de senha com seu valor.
Repita essa etapa para cada reivindicação de senha. Use as setas para cima e para
baixo para colocar em sequência ou excluir as requisições, conforme o necessário.
Nome da reivindicação
Define o nome da requisição.
Valor da reivindicação
Define o valor da requisição nomeada.
Capítulo 3: Catalyst 77
Capítulo 4: Execução de comando
Os operadores Execução de comando executam processos e scripts no ambiente
operacional do host.
Operador Executar programa
O operador Executar programa inicia e monitora um programa.
Observação: para quase todos os operadores, o Resultado é definido como 1 na
execução bem-sucedida e um número diferente de 1 em uma execução com falha. Para
este operador específico, Resultado é definido como 0 na execução bem-sucedida e um
número diferente de 0 em uma execução com falha.
Capítulo 4: Execução de comando 79
Operador Executar programa
Parâmetros de entrada
Nome do programa
■
touchpoint UNIX: o programa deve ser um arquivo binário ou um script de shell
que obedeça às convenções do UNIX (a primeira linha do arquivo deve ter o
caminho completo do shell, como em #!/bin/ksh).
■
Windows destino: o programa deve ser um arquivo executável ou um script. O
arquivo geralmente é especificado por:
–
O nome do arquivo a ser executado no diretório de trabalho do operador
Ou
–
Em um dos diretórios especificados pela variável de ambiente PATH no
host de destino.
O caminho relativo para o diretório de trabalho especificado para o módulo
Processos do UNIX.
Perfil
UNIX
Especifica uma expressão que retorna um perfil do sistema de host como
"origem" para definir partes do contexto de execução do processo.
Por exemplo:
"/home/username/appli_1_profile"
Se nenhum perfil for especificado aqui, o perfil especificado nas configurações
da propriedade de Execução de comando do UNIX (no nível da categoria) está
sendo usado. Se nenhum perfil for especificado no operador ou nas
configurações do operador, será usado apenas o perfil do usuário que executa
o processo.
Windows
Especifica o caminho para um arquivo em lote (.bat) no Windows que define
variáveis de ambiente a serem executadas pelo processo.
As configurações de variáveis definidas pelo arquivo em lote especificado aqui
complementam as configurações de variáveis definidas para o perfil do usuário
que executa o processo. Se nenhum arquivo for especificado para essa opção, o
operador usará as configurações definidas pelo parâmetro de perfil do Shell
definido para o serviço do processo do Windows.
80 Referência do Criador de Conteúdo
Operador Executar programa
Diretório de trabalho
Em geral, esse campo especifica a pasta que contém o arquivo de programa ou
alguns arquivos relacionados exigidos pelo programa. Qualquer arquivo que é
especificado sem um caminho explícito é criado ou procurado nesse diretório.
O padrão, se você não especificar um diretório de trabalho, é o início ou o diretório
de trabalho para a conta de usuário que executa o operador.
UNIX
Especifica o diretório de trabalho para o operador.
Por exemplo: "/home/user1"
ID do usuário
Especifica uma expressão que retorna o nome de usuário do sistema no qual o
programa é executado. O usuário deve ter permissões de execução no arquivo.
Se você deixar esse campo em branco, o padrão será o usuário padrão especificado
nas definições da configuração do módulo Processos.
Os nomes de usuário e senhas podem ser especificados no nível da categoria ou
armazenados em variáveis de conjunto de dados nomeado, para que possam ser
atualizados de forma centralizada, sem alterar os valores de processo.
Senha
Especifica a senha para o nome do usuário especificado.
Especificar a senha como um valor literal de sequência de caracteres é considerado
uma prática ruim. Um método é muito melhor para a senha mantidas em uma
variável do conjunto de dados de tipo de senha e passar a variável.
Parâmetros
Os parâmetros a serem passados ao script.
Os parâmetros são transmitidos para o processo na mesma ordem em que estão
listados aqui. Use os botões abaixo para adicionar, remover ou reorganizar os
parâmetros.
Os parâmetros de programa são transmitidos individualmente para o programa na
inicialização.
Arquivo de saída padrão
Especifica o arquivo para capturar texto gravado pelo programa em STDOUT.
Por exemplo:
/ tmp / trace.log
É possível especificar o mesmo arquivo para os arquivos de erro padrão e de saída
padrão. No entanto, nenhuma ordem é mantida para os diferentes tipos de saída.
Capítulo 4: Execução de comando 81
Operador Executar programa
Arquivo de erro padrão
Especifica o arquivo para capturar texto gravado pelo programa em STDERR.
Por exemplo:
/ tmp / trace.err
É possível especificar o mesmo arquivo para os arquivos de erro padrão e de saída
padrão. No entanto, nenhuma ordem é mantida para os diferentes tipos de saída.
Registrar saída para logs
Registra a saída do processo para arquivos de log globais.
Saída posterior para variável do conjunto de dados
Copia a saída de uma operação (stdout e stderr) para a variável de conjunto de
dados do operador (processOutput).
Arquivo de log truncado usado para saída padrão
Substitui um arquivo de log existente com o mesmo nome toda vez que uma nova
saída for gravada. Desmarque essa caixa de seleção para anexar a saída a um
arquivo de log de erro existente com o mesmo nome.
Essa caixa de seleção também substitui um arquivo existente, mesmo que ele
também seja usado para o erro padrão e mesmo que a caixa de seleção Arquivo de
log truncado usado para erro padrão não seja marcada.
Arquivo de log truncado usado para erro padrão
Substitui um arquivo de erro existente com o mesmo nome toda vez que a nova
saída é gravada. Desmarque essa caixa de seleção para anexar a saída a um arquivo
de erro existente com o mesmo nome.
Essa caixa de seleção também substitui um arquivo existente, mesmo que ele
também seja usado para a saída padrão e mesmo que a caixa de seleção Arquivo de
log truncado usado para saída padrão não seja marcada.
Carregar o perfil de usuário do sistema operacional
Carrega o perfil do sistema operacional (normalmente o Windows) associado à
conta de usuário. A ID de usuário especifica o perfil (além do perfil especificado por
Perfil, que especifica as variáveis de ambiente). Geralmente, esse perfil não é
usado, exceto para estabelecer associações e construções do Windows
semelhantes com base no Registro para um determinado usuário. Há uma
penalidade de desempenho associada ao download de informações sobre o usuário
de um servidor de domínio.
Cancelar processo no final do fluxo
O processo do sistema operacional que executa o programa especificado é
encerrado (se não estiver já interrompido) assim que o processo do CA Process
Automation é concluído.
82 Referência do Criador de Conteúdo
Operador Executar programa
Parâmetros de saída
programName
profile
workingDir
userID
password
Parâmetros
stdOutFileName
stdErrFileName
isPostToGlobalLog
isPostToOutVar
isTruncateForStdOut
isTruncateForStdErr
isLoadOSProfile
isKillProcessOnFlowEnd
processOutput
ExitCode
PID
Avisos
Capítulo 4: Execução de comando 83
Operador Executar o script
Operador Executar o script
O operador Iniciar script executa um script em um computador host de touchpoint.
Observação: para quase todos os operadores, o Resultado é definido como 1 na
execução bem-sucedida e um número diferente de 1 em uma execução com falha. Para
este operador específico, Resultado é definido como 0 na execução bem-sucedida e um
número diferente de 0 em uma execução com falha.
Parâmetros de entrada
Extensões de script
Para o Windows, especifica a extensão que indica o tipo de script. Selecione uma
opção na lista suspensa ou digite uma extensão.
84 Referência do Criador de Conteúdo
Operador Executar o script
Script embutido
Especifica uma inscrição para o script a ser executado. Clique no botão (...) para
abrir o editor para inserir o script a ser executado.
UNIX
O script deve ser um script que possa ser executado de acordo com os
protocolos do UNIX. A primeira linha do script deve indicar o caminho
completo do shell usado para interpretar o script (por exemplo, #!/bin/sh).
Windows
O script deve ser um script que possa ser executado de acordo com a extensão
do Windows especificada no campo Extensão de script.
Observação: consulte o Guia do criador de conteúdo para obter mais informações
sobre como usar o editor de código do CA Process Automation.
Perfil
UNIX
Especifica um perfil de sistema de host para usar como origem para definir
partes do contexto de processamento do script (por exemplo,
/home/username/appli_1_profile).
Se um perfil não for especificado, o produto usa o perfil especificado nas
configurações da propriedade de categoria da execução de comando. O
produto usa o arquivo do usuário que executa o processo quando as
configurações da propriedade de categoria da execução de comando não
especificarem um perfil.
Windows
Especifica o caminho para um arquivo em lote (.bat) no Windows que define as
variáveis de ambiente do processo a ser executado. As definições da variável
de ambiente no arquivo em lote estão no seguinte formato:
SET SOME_ENV_VAR=/tmp/PAM.exe
SET ANOTHER_ENV_VAR=/tmp/aaaa
As configurações das variáveis que o arquivo em lote especificado define estão
além das configurações definidas para o perfil do usuário que executa o
processo. Se essa opção não especificar um arquivo, o operador usará as
configurações que o valor de parâmetro do perfil do Shell da categoria de
execução de comando define.
Capítulo 4: Execução de comando 85
Operador Executar o script
Diretório de trabalho
UNIX
Especifica o diretório de trabalho do operador (por exemplo, /home/user1).
Normalmente, o diretório de trabalho é a pasta que contém o arquivo de
programa ou os arquivos relacionados que o programa requer. O produto
procura neste diretório por arquivos especificados sem caminhos explícitos.
Se o diretório de trabalho não for especificado, o valor padrão será o diretório
inicial da conta de usuário que está executando o script.
Windows
Especifica o diretório de trabalho para o operador. Normalmente, o diretório
de trabalho é a pasta que contém o arquivo de script ou os arquivos
relacionados que o script requer.
Se um diretório de trabalho não for especificado, o valor usa como padrão o
diretório de trabalho da conta de usuário que está executando o script.
ID do usuário
Especifica uma expressão que retorna o nome do usuário sob o qual executar o
script. A expressão deve ter permissões de execução no arquivo (por exemplo,
Process.Appli_1.User). Se o campo ID de usuário for deixado em branco, o valor
usará como padrão o usuário que a configuração da categoria de execução do
comando especificar.
Os nomes de usuário (e suas senhas associadas) são normalmente armazenados em
variáveis de conjuntos de dados nomeados, de modo que os usuários possam
atualizá-los de forma centralizada, sem alterar os valores de processo.
Senha
Especifica a senha atual associada à ID de usuário especificada. Por exemplo, a
entrada a seguir define a senha como o valor da senha variável do processo:
Process.Password
O produto normalmente avalia a senha em relação às informações do sistema. No
entanto, em casos em que mecanismos de segurança não padrão são definidos no
host de destino, os administradores podem desativar essa verificação.
Uma vez que a senha é especificada como uma expressão, o texto inserido deve
estar visível. Evite o uso de sequências de caracteres literais e, em vez disso,
referencie as variáveis de conjunto de dados da senha.
Parâmetros
Especifica os parâmetros como no exemplo a seguir para passar para o programa:
/tmp/input_file
/tmp/output_file
O produto passa parâmetros para o processo na ordem em que eles são listados.
86 Referência do Criador de Conteúdo
Operador Executar o script
Os parâmetros do programa são passados individualmente para o programa na
inicialização (isto é, eles não são concatenados com espaços entre eles). Por
exemplo, inserir a expressão a seguir em uma linha retorna o parâmetro único
"P1P2":
P1 + P2
Inserir as expressões a seguir em duas linhas retorna os dois parâmetros, "P1" e
"P2":
"P1"
"P2"
Arquivo de saída padrão
Especifica o arquivo de saída padrão para o script. Se o caminho completo não for
especificado, o diretório de trabalho do valor de parâmetro define o diretório raiz
para o caminho (por exemplo, /tmp/trace.log).
O módulo Execução de comando direciona o fluxo stdout do processo para o
arquivo especificado. É possível especificar o mesmo arquivo tanto para o erro
padrão como para os arquivos de saída padrão. No entanto, o produto não mantêm
uma ordem relativa para os diferentes tipos de saída.
Arquivo de erro padrão
Especifica o arquivo de padrão para o script. Se o caminho completo não for
especificado, o diretório de trabalho do valor de parâmetro define o diretório raiz
para o caminho (por exemplo, /tmp/trace.err).
O módulo Execução de comando direciona o fluxo stderr do processo para o
arquivo especificado. É possível especificar o mesmo arquivo tanto para o erro
padrão como para os arquivos de saída padrão. No entanto, o produto não mantêm
uma ordem relativa para os diferentes tipos de saída.
Registrar saída para logs
Registra a saída do processo para arquivos de log globais.
Saída posterior para variável do conjunto de dados
Copia a saída de uma operação (stdout e stderr) para uma variável de conjunto de
dados do operador (por exemplo, scriptOutput).
Capítulo 4: Execução de comando 87
Operador Executar o script
Arquivo de log truncado usado para saída padrão
Marque esta caixa de seleção para que o produto substitua um arquivo de log
existente que tenha o mesmo nome ao gravar uma nova saída.
Com a caixa de seleção marcada, o produto substitui um arquivo existente, mesmo
quando os seguintes itens são verdadeiros:
■
O arquivo também é usado para a saída de erro padrão
■
A caixa de seleção Arquivo de log truncado usado para erro padrão está
desmarcada
Se a caixa de seleção estiver desmarcada, o produto anexa a saída a um arquivo de
log de erro existente com o mesmo nome.
Arquivo de log truncado usado para erro padrão
Marque esta caixa de seleção para que o produto substitua um arquivo de log de
erro existente que tenha o mesmo nome ao gravar uma nova saída.
Com a caixa de seleção marcada, o produto substitui um arquivo existente, mesmo
quando os seguintes itens são verdadeiros:
■
O arquivo também é usado para a saída padrão
■
A caixa de seleção Arquivo de log truncado usado para saída padrão está
desmarcada
Se a caixa de seleção estiver desmarcada, o produto anexa a saída a um arquivo de
erro existente com o mesmo nome.
Carregar o perfil de usuário do sistema operacional
Carrega o perfil do sistema operacional (normalmente o Windows) associado aos
itens a seguir:
■
A conta de usuário que a ID de usuário especifica
■
O perfil que o Perfil especifica, o qual define as variáveis do ambiente
O perfil de usuário do SO é geralmente usado somente para estabelecer
associações e construções semelhantes com base no Registro do Windows para um
determinado usuário. Fazer o download de informações do usuário de um servidor
de domínio acarreta uma penalidade de desempenho.
Cancelar processo no final do fluxo
Se esta opção for selecionada, o produto terminará o processo quando o fluxo do
processo for concluído.
88 Referência do Criador de Conteúdo
Operador Executar o script
Diretiva de execução do PowerShell
Para executar scripts do PowerShell, o Windows impõe uma segurança em termos de
sua diretiva de execução. A diretiva de execução do Windows PowerShell determina se
os scripts têm permissão para serem executados e, caso possam ser executados, se eles
devem ser assinados digitalmente. Ela também determina se arquivos de configuração
podem ser carregados.
A diretiva de execução padrão do PowerShell no Windows é Restrita. Para executar um
script do PowerShell, altere a diretiva de execução para um dos seguintes valores:
■
RemoteSigned
■
AllSigned
■
Unrestricted
O CA Process Automation fornece uma opção durante a instalação do agente ou
Orquestrador para definir a diretiva de execução do script do PowerShell como Remote
Signed (o que significa que os scripts baixados devem ser assinados por um editor
confiável para poderem ser executados). No entanto, você sempre tem a opção de
alterar a diretiva de execução por meio do prompt de comando usando o seguinte
comando do PowerShell:
Set-ExecutionPolicy
...seguido do nome da diretiva apropriada. Por exemplo, este comando define a diretiva
de execução como AllSigned:
Set-ExecutionPolicy AllSigned
Capítulo 4: Execução de comando 89
Operador Executar o script
Parâmetros de saída
scriptType
inLineScript
profile
workingDir
userID
password
Parâmetros
stdOutFileName
stdErrFileName
isPostToGlobalLog
isPostToOutVar
isTruncateForStdOut
isTruncateForStdErr
isLoadOSProfile
isKillProcessOnFlowEnd
processOutput
StartDate
StartTime
Resultado
ExitCode
PID
Motivo
Avisos
90 Referência do Criador de Conteúdo
Operador Executar comando de SSH
Operador Executar comando de SSH
O comando Executar SSH operador foi projetada para uso com destinos, como, por
exemplo, dispositivos de rede ou outras non-server dispositivos.
Para a execução em servidores remotos usando SSH, pode ser mais simples utilizar os
conceitos de touchpoint do proxy ou de grupo de hosts.
Observação: esse operador não exige que o usuário especifique a sequência de logon.
O operador Executar comando de SSH realiza as seguintes ações:
■
Abre uma conexão SSH com o host remoto.
■
Envia um comando de cada vez.
■
Lê a saída do comando até ver o prompt para indicar que o comando foi concluído.
■
Envia o próximo comando.
Você pode definir a quantidade máxima de tempo para aguardar o prompt antes que o
operador falhe. Verifique se essa configuração é maior do que o tempo de execução do
comando mais longo que esse operador pode executar.
Você pode definir esse operador para alternar para outro usuário (incluindo o root) após
o logon e antes de executar os comandos. A alternância de usuários permite que os
comandos sejam executados como um usuário diferente. A alternância para outro
usuário é executada de forma interativa.
Parâmetros de entrada
Para todas as entradas que podem ser especificadas como uma expressão regular neste
operador, o operador faz a correspondência entre todos os dados de resposta e o
padrão. O operador Executar comando de SSH não corresponde ao padrão como uma
subsequência dos dados de resposta). Um ponto ‘.’ corresponde a um novo terminador
de linha (pode ser usado para corresponder a dados de resposta com várias linhas).
Capítulo 4: Execução de comando 91
Operador Executar comando de SSH
Comandos
Nome do host remoto
O nome de host ou o endereço IP do computador ao qual você deseja se conectar.
Usar variável de sequência de caracteres indexada para comandos?
Se essa caixa de seleção não for marcada, você poderá digitar comandos no campo
Comandos. Selecione esse campo para especificar os comandos como variáveis
Sequência de caracteres indexadas no campo Variável indexada da sequência de
caracteres dos comandos.
Comandos
Lista de comandos para executar no host remoto. Não finalize a lista com um
comando sair, pois o operador sairá automaticamente da sessão SSH após a
execução do último comando.
Variável indexada da sequência de caracteres dos comandos
Nome da variável do conjunto de dados que contém uma lista de comandos para
executar no host remoto. Não finalize a lista com um comando sair, pois o operador
sairá automaticamente da sessão SSH após a execução do último comando.
Salvar saída na variável do conjunto de dados?
Marque essa caixa de seleção para copiar a saída de cada comando para o conjunto
de dados do operador. A saída de cada comando é armazenada na variável
SSHCommandsOutput.
Limite de tamanho de saída de comandos
Especifica o número máximo de bytes de saída de cada comando para salvar na
variável do conjunto de dados do operador. Se esse número não for especificado, o
operador usará o valor: 4096.
Prompt de comando do usuário
Esse campo tem duas finalidades:
■
Indica que o usuário está conectado. O operador procura esse prompt depois
que o usuário efetua logon.
■
Indica que um comando (na Lista de comandos ou Matriz de comandos
executados na sessão SSH sob este usuário) foi concluído. Em seguida, o
operador pode enviar o próximo comando na lista.
92 Referência do Criador de Conteúdo
Operador Executar comando de SSH
Esse campo geralmente é uma indicação do prompt de comando do usuário. O
campo tipicamente é especificado como "#", "$", ">" e assim por diante, mas deve
ser especificado como uma expressão regular. Por exemplo: ".*[$>?:#]" para
corresponder a qualquer entrada (incluindo novas linhas), seguido de $ ou > ou ? ou
: ou #. Especifique todos os prompts que você espera ver durante a execução dos
comandos.
Importante! Inicie a expressão regular com .* para corresponder a todos os dados
retornados pelo comando até que o prompt seja exibido. Essa expressão regular
deve corresponder a toda a saída do comando até o próximo prompt.
Observação: são necessários colchetes antes e depois de $ para indicar o caractere
$. $ tem significado especial em expressões regulares, caso não esteja entre
colchetes.
Tempo de espera de prompts (s)
O tempo (em segundos) para aguardar um prompt antes de desistir dele para
enviar os comandos. Se esse campo for deixado em branco, o operador usará o
valor: 60.
Esse campo se aplica aos prompts esperados após a execução de cada comando
especificado no operador. O operador não pode determinar se um comando
executado na sessão SSH retornou todos os seus dados. O operador continua lendo
a saída do comando até que ele corresponda ao prompt especificado de Usuário ou
Comando para alterar o usuário ou até que o tempo limite seja atingido (o que
ocorrer primeiro). O operador continua então a processar a saída do comando
antes de passar para o próximo comando ou causar a falha do operador.
Importante! Defina esse tempo para ser maior do que o tempo de execução do
comando mais longo que o operador executa.
Informações de logon remoto
Tipo de pseudoterminal
O tipo de pseudoterminal para solicitação na conexão SSH. Esse campo substitui o
valor especificado no nível da categoria. Se o campo for deixado em branco, o
operador usará o valor padrão definido no nível do módulo. Se esse valor ficar em
branco, o operador usará como padrão VT100.
■
VT100 normalmente funciona com a maioria dos computadores
(principalmente aqueles com base em Linux).
■
VT400 normalmente funciona com computadores com base no Windows.
VT400 é necessário para plataformas Windows, principalmente quando a saída
recuperada do servidor SSH (saída de comandos) contém caracteres de
controle em vez de espaços. Por exemplo, [19;1H em vez de um espaço na
saída. VT400 interpreta os espaços corretamente para Windows.
Capítulo 4: Execução de comando 93
Operador Executar comando de SSH
Outros tipos de terminal podem ser usados. Não deixe de testá-los antes de colocar
o operador em produção. Alguns tipos de pseudoterminal são:
■
terminal burro
■
xterm
■
vt220
■
vt320
■
gogrid
Verifique a instalação e a configuração de seu servidor SSH para obter informações
sobre os pseudoterminais suportados. Alguns servidores SSH listam os
pseudoterminais na pasta TermInfo.
O tipo de pseudoterminal controla como os caracteres de espaço são exibidos na
saída dos comandos. É necessário testar esse operador em relação aos
pseudoterminais suportados pelo servidor SSH para encontrar um pseudoterminal
apropriado que retorne os espaços de maneira adequada. Se os espaços não forem
retornados adequadamente e não houver um pseudoterminal disponível que possa
resolver o problema, faça o seguinte:
■
Modifique a entrada do operador para acomodar a limitação deste servidor
SSH.
■
Use o JavaScript para refinar/extrair a saída dos comandos.
Se você solicitar um pseudoterminal sem suporte, alguns servidores SSH retornarão
um erro, enquanto outros ignorarão o tipo de pseudoterminal solicitado e usarão
outro. Examine os logs do servidor SSH em referência ao pseudoterminal usado
quando o operador está em execução.
Porta
A porta para conexão no host remoto. Esse campo substitui o valor especificado no
nível do módulo. Se for deixado em branco, o operador usará o valor padrão
definido no nível da categoria. Se esse operador padrão categoria valor estiver em
branco, o operador usará o valor: 22.
Nome do usuário
O nome de usuário a ser usado para efetuar logon no host remoto. Esse campo
substitui o valor especificado no nível do módulo. Se for deixado em branco, o
operador usará o valor padrão definido no nível do módulo.
94 Referência do Criador de Conteúdo
Operador Executar comando de SSH
Usar a chave privada para logon?
Especifica se uma chave privada deve ser usada para efetuar logon no host remoto
(em vez das informações da senha). Esse campo substitui o valor especificado no
nível do módulo. Se for deixado em branco, o operador usará o valor padrão
definido no nível do módulo. Selecione uma das seguintes opções:
Verdadeiro
Solicita que o operador use uma chave privada.
A seleção de verdadeiro ativa os seguintes campos: Chave privada, Origem da
entrada, Conteúdo embutido da chave privada, Expressão de chave privada,
Caminho do arquivo de chave privada, Passphrase para a chave. O campo
Senha é desativado.
Falso
Solicita que o operador use as informações da senha.
A seleção de falso desativa os seguintes campos: Chave privada, Origem da
entrada, Conteúdo embutido da chave privada, Expressão de chave privada,
Caminho do arquivo de chave privada, Passphrase para a chave. O campo
Senha é ativado.
A inserção de qualquer outro valor solicita que o operador use falso e ativa todos os
campos (para acomodar a inserção de uma expressão pelo usuário).
Senha
A senha usada para efetuar logon no host remoto. Esse campo substitui o valor
especificado no nível do módulo. Se for deixado em branco, o operador usará o
valor padrão definido no nível do módulo.
Origem da entrada da chave privada
Especifica como fornecer a chave privada. Selecione uma das seguintes ações:
Conteúdo embutido
Ativa Conteúdo embutido da chave privada e desativa Expressão de chave
privada e Caminho do arquivo de chave privada.
Caminho do arquivo
Ativa Caminho do arquivo de chave privada e desativa Conteúdo embutido da
chave privada e Expressão de chave privada.
Expressão
Ativa Expressão de chave privada e desativa Conteúdo embutido da chave
privada e Caminho do arquivo de chave privada.
Capítulo 4: Execução de comando 95
Operador Executar comando de SSH
Conteúdo embutido da chave privada
O conteúdo da chave privada para efetuar logon no host remoto. Esse campo
substitui o valor especificado no nível do módulo. Se for deixado em branco e se a
Origem da entrada da chave privada for definida como Conteúdo embutido, o
operador usará o valor padrão definido no nível do módulo.
Caminho da chave privada
O caminho da chave privada para efetuar logon no host remoto. Esse campo
substitui o valor especificado no nível do módulo. Se for deixado em branco e se a
Origem da entrada da chave privada for definida como Caminho do arquivo, o
operador usará o valor padrão definido no nível do módulo.
Expressão de chave privada
A variável do conjunto de dados que contém o conteúdo da chave privada para
efetuar logon no host remoto.
Observação: verifique se a variável do conjunto de dados é uma sequência de
caracteres com várias linhas.
Passphrase para a chave
Passphrase opcional senha para desbloquear o conteúdo da chave privada. Esse
campo será obrigatório se a chave privada tiver sido criada com uma passphrase.
Esse campo substitui o valor especificado no nível do módulo.
Uma passphrase em branco para a chave não solicita automaticamente que o
operador herde a passphrase para o valor da chave do módulo. Na verdade, o
campo Passphrase para a chave está associado aos campos Conteúdo embutido da
chave privada, Caminho da chave privada ou Expressão de chave privada, conforme
é indicado a seguir:
■
Se a Passphrase para a chave do operador for especificada, será usada pelo
operador.
■
Se a Passphrase para a chave do operador ficar em branco, o Conteúdo
embutido da chave privada será especificado (não em branco) e a Origem da
entrada da chave privada será definida como Conteúdo embutido. O operador
usará então uma passphrase em branco para a chave (passphrase não
definida).
96 Referência do Criador de Conteúdo
Operador Executar comando de SSH
■
Se a Passphrase para a chave do operador ficar em branco, o Caminho do
arquivo de chave privada será especificado (não em branco) e a Origem da
entrada da chave privada será definida como Caminho do arquivo. O operador
usará então uma passphrase em branco para a chave (passphrase não
definida).
■
Se a Passphrase para a chave do operador ficar em branco, a Expressão para
chave privada será especificada (não em branco) e a Origem da entrada da
chave privada será definida como Expressão. O operador usará então uma
passphrase em branco para a chave (passphrase não definida).
■
Em todos os outros casos, o operador Executar comando SSH usa a Passphrase
padrão para a chave.
Observação: a criação de chaves SSH privadas/públicas é descrita no Guia de
Administração.
Alterar as informações do usuário
Executar comandos/script como outro usuário?
Os comandos especificados devem ser executados como um usuário diferente?
Selecione verdadeiro para alternar os usuários após o logon ou falso para continuar
a execução como o usuário que efetuou logon.
Esse campo substitui o valor especificado no nível de categoria do operador. Se esse
campo for deixado em branco, o operador usará o valor padrão definido no nível de
categoria do operador.
Comando para alterar o usuário
O comando para alternar o usuário no host remoto. Geralmente, trata-se de:
■
su - nome do usuário
ou
■
sudo su - nome do usuário
Esse campo substitui o valor especificado no nível de categoria do operador. Se esse
campo for deixado em branco, o operador usará o valor padrão definido no nível de
categoria do operador.
Prompt de texto para alterar a senha do usuário
O prompt de texto que indica que o host remoto exige uma senha para alternar o
usuário para outro usuário. Geralmente, trata-se de:
■
Password:
ou
■
password:
Esse parâmetro deve ser especificado como uma expressão regular. Por exemplo,
".*assword: " para corresponder a qualquer entrada (incluindo novas linhas),
seguido de "assword: ".
Capítulo 4: Execução de comando 97
Operador Executar comando de SSH
Esse campo substitui o valor especificado no nível de categoria do operador. Se esse
campo for deixado em branco, o operador usará o valor padrão definido no nível de
categoria do operador.
Se uma senha não for necessária para alternar para outro usuário (por exemplo, ao
alternar do usuário root para outro usuário), você poderá inserir qualquer valor
nesse campo. O operador tentará fazer a correspondência dos dados lidos da
sessão SSH após enviar o Comando para alterar o usuário com Prompt de texto para
alterar a senha do usuário primeiro. Se não houver correspondência, ele tentará
corresponder os dados em relação a Prompt de comando para alterar usuário para
verificar se é necessária uma senha.
Alterar a senha do usuário
A senha para alternar o usuário para outro usuário. Esse campo substitui o valor
especificado no nível de categoria do operador. Se esse campo for deixado em
branco, o operador usará o valor padrão definido no nível de categoria do
operador.
Esse campo não será usado se a alternância para outro usuário não exigir uma
senha.
Prompt de comando para alterar usuário
Esse campo tem duas finalidades:
■
Para indicar que a alternância de usuário ocorreu.
■
Para indicar que um comando na lista de comandos ou matriz de comandos
executado na sessão SSH sob o novo usuário (para o qual o operador alternou)
foi concluído e o operador pode enviar o próximo comando da lista.
Esse campo geralmente é uma indicação do prompt de comando do novo usuário
(para o qual o operador alternou). Geralmente, é "#", "$", ">" etc. Esse campo
precisa ser especificado como uma expressão regular. Por exemplo: ".*[$>?:#]" para
corresponder a qualquer entrada (incluindo novas linhas), seguido de $ ou > ou ? ou
: ou #. Especifique todos os prompts que você espera ver durante a execução dos
comandos. Inicie a expressão regular com .* para corresponder a todos os dados
retornados pelo comando até que o prompt seja exibido. Essa expressão regular
corresponde a toda a saída do comando até o próximo prompt.
Observação: são necessários colchetes antes e depois de $ para indicar o caractere
$. $ tem significado especial em expressões regulares, caso não esteja entre
colchetes.
Cuidado com a RegEx para evitar falsos positivos; por exemplo:
O usuário digita uma senha incorreta ao alternar para o root:
# su – root
Password:
A resposta para uma senha incorreta termina com #:
su: Sorry
#
98 Referência do Criador de Conteúdo
Operador Executar comando de SSH
Isso fornece o mesmo prompt mostrado quando o usuário digita uma senha correta
em que a resposta também termina com #:
Sun Microsystems Inc.
#
SunOS 5.10
Genérico janeiro de 2005
Esse campo substitui o valor especificado no nível de categoria do operador. Se esse
campo for deixado em branco, o operador usará o valor padrão definido no nível de
categoria do operador.
Parâmetros de saída
SSHSwitchUserPasswordPrompt
O Prompt de texto para alterar a senha do usuário real lido da sessão SSH durante o
tempo de espera de prompts. Esses são os dados que corresponderam ao padrão
especificado no campo Prompt de texto para alterar a senha do usuário. Esse
campo ficará vazio se a alternância de usuário não tiver exigido uma senha, como
ao alternar de Root para qualquer outro usuário, ou se o operador não for
configurado para alternar usuários.
SSHSwitchUserCommandPrompt
O Prompt de comando para alterar usuário real lido da sessão SSH (durante o
tempo de espera de prompts) na primeira vez após alternar para o novo usuário.
Esses são os dados que corresponderam ao padrão especificado no campo Prompt
de comando para alterar usuário. Esse campo ficará vazio se o operador não for
configurado para alternar os usuários.
SSHCommandsOutput
Uma sequência de caracteres indexada que contém a saída lida de cada comando
(durante o tempo de espera de prompts) executado no host remoto. A saída de
cada comando será truncada para o valor especificado no Limite de tamanho de
saída de comandos.
A saída completa de cada comando contém o prompt a seguir.
Capítulo 4: Execução de comando 99
Operador Executar comando de SSH
SSHHost
CommandsAsAnArray
Parâmetros
CommandsArray
isPostToOutVar
PostToOutVarSizeLimit
SSHHostUserCommandPrompt
SSHHostWaitTimeout
SSHPseudoTerminalType
SSHPort
SSHUsername
SSHUsePrivateKey
SSHPassword
SSHPrivateKeyOption
SSHPrivateKey
SSHPrivateKeyVar
SSHPrivateKeyPath
SSHPrivateKeyPassphrase
SSHSwitchUser
SSHHostSwitchUserCommand
SSHHostSwitchUserPasswordPrompt
SSHHostSwitchUserPassword
SSHHostSwitchUserCommandPrompt
100 Referência do Criador de Conteúdo
Operador Executar comando de SSH
Portas do operador
Êxito
■
O operador foi concluído com êxito.
■
O operador depende dos padrões especificados em Prompt de comando do
usuário e Prompt de comando para alterar usuário para decidir se um comando
(e o operador) terão êxito ou falharão.
Por exemplo, um padrão de ".*#" fará com que o seguinte comando tenha
êxito: ‘badCmd’:
1. O operador o executa:
# badCmd
2. A saída é lida (que corresponde a .*# prompt):
badCmd: não encontrado
#
3. Executar o próximo comando.
Falha
■
O usuário fornece uma entrada inválida; por exemplo, tempo limite de prompts
negativo, prompt de comando do usuário em branco e assim por diante.
■
Não é possível estabelecer uma conexão com o host remoto. Verifique o host
remoto, o nome do usuário, a senha e as chaves fornecidas ao operador.
■
O usuário fornece um host desconhecido no host remoto.
■
Não é possível autenticar o usuário no host remoto:
–
Autenticação de usuário/senha: nome de usuário ou senha inválidos
–
Autenticação de usuário/chave privada:
- Uma passphrase incorreta é fornecida para uma chave privada protegida
por passphrase: o operador indica que não pode ler a chave devido a um
problema de E/S interno
- A passphrase está ausente para uma chave privada protegida por
passphrase: o operador indica que a passphrase necessária para a
autenticação da chave não foi fornecida.
- Uma chave privada incorreta é fornecida: o operador indica que não pode
analisar a chave privada, não há suporte para o formato da chave ou não é
possível ler a chave devido a um problema de E/S interno.
- O caminho para o arquivo de chave privada é inválido, é inexistente ou
não pode ser lido.
Capítulo 4: Execução de comando 101
Operador Executar comando de SSH
■
Não é possível alternar o usuário. Não foi possível fazer a correspondência dos
dados lidos da sessão SSH (durante o tempo de espera de prompts) com o
padrão de Prompt de comando para alterar usuário especificado.
■
Não é possível alternar o usuário. Não foi possível fazer a correspondência dos
dados lidos da sessão SSH (durante o tempo de espera de prompts) com o
padrão de Prompt de texto para alterar a senha do usuário especificado.
■
O nome de usuário/senha fornecido não tem permissão para efetuar logon por
meio de SSH.
■
O operador não pôde fazer a correspondência do prompt de comando
(especificado no Prompt de comando do usuário ou Prompt de comando para
alterar usuário) com a saída lida de um comando durante o tempo de espera
de prompts. Nesse caso, ocorreu uma destas situações:
–
O comando concluiu a execução e retornou dados não correspondentes ao
padrão em Prompt de comando do usuário ou Prompt de comando para
alterar usuário.
–
A execução do comando está demorando mais do que o tempo de espera
de prompts, e o operador interrompeu a leitura dos dados de saída antes
da conclusão do comando. Como resultado, ele não fez a correspondência
dos dados lidos com o padrão no Prompt de comando do usuário ou
Prompt de comando para alterar usuário. Nesse caso, você deve aumentar
o Tempo de espera de prompts para que ele seja maior do que o tempo de
execução do comando mais longo da lista.
Observação: nesse caso, todos os comandos subsequentes na lista não serão
executados, e SSHCommandsOutput conterá apenas a saída dos comandos que
foram executados antes (incluindo a saída lida para o comando atual).
Portas personalizadas
Se definido pelo usuário durante a criação do processo.
102 Referência do Criador de Conteúdo
Operador Executar comando de SSH
Exemplo
Esse exemplo explica como o operador Executar comando de SSH opera de maneira
interativa.
Siga estas etapas::
1.
Abra uma conexão SSH com o host remoto.
2.
Efetue logon de forma não interativa usando uma das opções a seguir:
3.
4.
5.
■
Um nome de usuário e uma senha.
■
Um nome de usuário e uma chave privada.
■
Um nome de usuário, uma chave privada e uma passphrase, se a chave privada
tiver sido criada com uma passphrase.
Leia da sessão SSH até ocorrer uma das seguintes situações:
■
Você corresponde ao padrão especificado no Prompt de comando do usuário.
Continue na etapa 4.
■
O Tempo de espera de prompts padrão expira sem corresponder ao padrão
especificado no Prompt de comando do usuário. Acione a falha do operador.
Determine se o operador está configurado para Executar comandos como outro
usuário.
■
Se ele estiver, vá para a etapa 5.
■
Se ele não estiver, vá para a etapa 6.
Envie o Comando para alterar o usuário e leia da sessão SSH até ocorrer uma das
seguintes situações:
■
Você corresponde ao padrão especificado em Prompt de texto para alterar a
senha do usuário, o que requer uma senha para alternar usuários.
–
Envie a Senha do usuário da opção padrão.
–
Leia da sessão SSH até ocorrer uma das seguintes situações:
– Você corresponde ao padrão especificado no Prompt de comando para
alterar usuário. Continue na etapa 6.
– O Tempo de espera de prompts expira sem corresponder ao Prompt de
comando para alterar usuário. Acione a falha do operador.
■
Você corresponde ao padrão especificado em Prompt de comando para alterar
usuário, o que não requer uma senha para alternar usuários. Continue na etapa
6.
■
O Tempo de espera de prompts expira sem corresponder ao Prompt de texto
para alterar a senha do usuário e ao Prompt de comando para alterar usuário.
Acione a falha do operador.
Capítulo 4: Execução de comando 103
Operador Executar o script SSH
6.
O operador Executar comando de SSH efetuou logon e alternou o usuário, caso
aplicável. O operador agora está pronto para executar os comandos.
7.
Realize um loop pelos comandos, enviando um comando de cada vez, e leia da
sessão SSH até ocorrer uma das seguintes situações:
■
Você corresponde ao padrão especificado no Prompt de comando do usuário,
se não tivermos alternado para outro usuário. Repita a etapa 7 e envie o
próximo comando.
■
Você corresponde ao padrão especificado no Prompt de comando para alterar
usuário, se tivermos alternado para outro usuário. Repita a etapa 7 e envie o
próximo comando.
■
O Tempo de espera de prompts expira sem corresponder ao Prompt de
comando do usuário ou ao Prompt de comando para alterar usuário (o que for
aplicável). Acione a falha do operador.
Operador Executar o script SSH
O operador Executar o script SSH funciona no modo interativo para acomodar
dispositivos de rede, em que a presença de um sistema de arquivos é desconhecida.
Observação: para a comunicação SSH não interativa, use um touchpoint do proxy ou um
Grupo de hosts.
O operador usa as credenciais de logon que você especifica para fazer o seguinte:
■
Abra uma conexão SSH com o host remoto.
■
Criar um objeto "conn".
Observação: quando você especifica um script, seja ele de bean shell ou JavaScript,
o objeto "conn" é disponibilizado no escopo desse script.
Você pode aproveitar os métodos públicos do objeto "conn" no script. Você pode
usar esses métodos públicos para automatizar as operações executadas em um
pseudo terminal de SSH. Os exemplos incluem enviar comandos para o host SSH
remoto, aguardar o prompt após enviar cada comando e recuperar a saída de cada
comando.
104 Referência do Criador de Conteúdo
Operador Executar o script SSH
Diferentemente do operador Executar script de Telnet, o operador Executar o script SSH
fornece a você o objeto "conn" depois de efetuar logon no host SSH.
A diferença entre o operador Executar o script SSH e o operador Executar comando de
SSH é que no operador Executar comando de SSH:
■
A saída de todos os comandos pode ser automaticamente salva no conjunto de
dados do operador.
■
A expressão regular especificada no prompt de comando de usuário é usada para
fazer a correspondência do prompt após a execução de todos os comandos da lista.
■
O tempo de espera de prompts se aplica a todos os comandos da lista; portanto,
ele deve ser maior do que o tempo de execução do comando mais longo da lista.
Durante Executar o script SSH:
■
Você pode especificar a saída de comando a ser exibida ou salva no conjunto de
dados do operador chamando os seguintes comandos nesta sequência:
1.
‘conn.sendLine()’
2.
‘conn.waitFor()’
3.
‘conn.getLastOutput()’
■
Você pode especificar uma expressão regular diferente para a correspondência do
prompt após a execução de cada comando.
■
Você pode especificar um tempo diferente para aguardar o prompt após a
execução de cada comando.
Parâmetros de entrada
Os parâmetros de entrada para o operador Executar o script SSH incluem os itens a
seguir
Atributos do script SSH
Nome do host remoto
O nome de host ou o endereço IP do computador ao qual você deseja se conectar.
Tipo de script:
O tipo de script especificado no campo Script embutido. Selecione de script bean
shell (.bsh) e JavaScript (.js). Se esse campo for deixado em branco, o operador
usará .bsh como padrão.
Script embutido?
Esse operador oferece dois métodos para fornecer o script: embutido ou como uma
expressão. Marque essa caixa de seleção para fornecer o script embutido.
Capítulo 4: Execução de comando 105
Operador Executar o script SSH
Script embutido
O script, escrito em bean shell ou javascript, usa o objeto conn e sua API da
seguinte maneira:
■
Enviar um comando ao host remoto
■
Aguardar a conclusão do comando
■
Recuperar a saída do último comando
As APIs que o objeto conn expõe são detalhadas em Executar APIs de script
embutido de operador Executar o script SSH (na página 108).
Script como expressão
Fornece o script como uma expressão. Consulte o campo Script embutido para
obter mais informações sobre o script.
Parâmetros
Os parâmetros do CA Process Automation a serem passados ao script. Somente
tipos de parâmetros simples do CA Process Automation podem ser passados para o
script, como é indicado a seguir:
■
PAM Booleano é transmitido como um objeto booleano.
■
PAM Data é transmitido como um objeto de data.
■
PAM Duplo é passado como um objeto duplo.
■
PAM Inteiro é passado como um objeto de número inteiro.
■
PAM Longo é passado como um objeto longo.
■
PAM Sequência de caracteres é passado como um objeto de sequência de
caracteres.
■
PAM Referência de objeto é passada como um objeto de sequência de
caracteres.
Tipos de parâmetros do CA Process Automation complexos (tipos indexados, mapas
de valores etc.) não podem ser passados para o script.
O script pode acessar esses objetos por meio dos argumentos de matriz de objetos,
em que args[0] corresponde ao primeiro parâmetro da lista, args[1] corresponde ao
segundo parâmetro e assim por diante.
Nomes de variável de saída
Os nomes das variáveis, criados no script, para salvar no conjunto de dados do
operador ao final da execução do script.
As variáveis devem ser definidas no escopo do script, de forma que elas estejam
visíveis ao final da execução e possam ser salvas no conjunto de dados do operador.
106 Referência do Criador de Conteúdo
Operador Executar o script SSH
As variáveis de saída são salvas da seguinte forma:
■
Objeto booleano é salvo como PAM Booleano.
■
Objeto de data é salvo como uma PAM Data.
■
Objeto inteiro é salvo como PAM Inteiro.
■
Objeto numérico é salvo como um objeto PAM Longo ou Duplo.
■
Objeto de sequência de caracteres é salvo como PAM Sequência de caracteres.
■
Objeto de caractere é salvo como PAM Sequência de caracteres.
■
Uma matriz de objetos é salva como um tipo de PAM indexado, em que o tipo
de PAM é definido pelo tipo do primeiro objeto na matriz de objetos.
■
Indefinido salva como uma sequência de caracteres com o PAM definido como
seu valor (a variável não foi atribuída um valor).
Capítulo 4: Execução de comando 107
Operador Executar o script SSH
APIs de script embutido de operador Executar o script SSH
O produto usa um script que é gravado em bean shell ou JavaScript para o campo Script
embutido do operador Executar o script SSH. O script usa o objeto conn, que expõe as
seguintes APIs:
void send (String str, boolean log) aciona Exceção
Esse método envia dados ao host remoto.
String str
Define os dados a enviar ao host remoto.
boolean log
Expõe ou oculta os dados enviados ao host remoto nos logs do CA Process
Automation.
Para depuração, siga a interação entre o operador e o host remoto. Defina o
seguinte código no arquivo <install_dir>/server/conf/log4j.xml:
<category name="com.company.c2o.servicegroup.netutils">
<priority value="DEBUG" />
</category>
Além disso, defina o arquivo de log do CA Process Automation (c2o.log) para
aceitar instruções DEBUG em log4j.xml.
Quando você definir o nível de depuração, a categoria do operador Execução
de comando iniciará o registro no arquivo de log do CA Process Automation
(c2o.log) em nível de DEBUG. Os logs do CA Process Automation expõem todos
os dados enviados ao host remoto por meio de send ou sendLine.
Valores:
Verdadeiro: registra o valor de String str ao registrar em nível de DEBUG.
Falso: não registra o valor de String str.
Observação: c2o.log é o arquivo de log do CA Process Automation, mas não os
logs de processos. Os operadores não gravam mensagens no log de processo.
Esse método não tem valores de retorno. O produto gera uma exceção se a API não
puder gravar os dados no host remoto.
public void sendLine (String str, boolean log) aciona Exceção
Este método adiciona um caractere de nova linha aos dados e o envia para o host
remoto. Para forçar o host remoto a iniciar a execução do comando enviado no
parâmetro, use este método.
Este método tem os mesmos parâmetros e valores que void send (String str,
boolean log) aciona Exceção.
108 Referência do Criador de Conteúdo
Operador Executar o script SSH
void send (String str) aciona Exceção
Esse método é equivalente a Send (String str, verdadeiro).
void sendLine (String str) aciona Exceção
Esse método é equivalente a SendLine (String str, verdadeiro).
public boolean waitFor(String pattern, int timeout) throws Exception
Este método lê a saída do host remoto e é interrompido quando um dos seguintes
resultados é gerado:
■
A saída corresponde ao padrão especificado nos parâmetros.
■
O intervalo de tempo limite expira.
O produto armazena a saída do host remoto por cada chamada ao método waitFor
em um buffer que pode ser acessado por meio do método getLastOutput(). Cada
chamada a waitFor substitui o conteúdo do buffer da chamada anterior.
A próxima chamada a waitFor começa a ler a saída a partir do ponto em que a
chamada anterior a waitFor interrompeu a leitura. Isso é relevante ao utilizar o
método com getLastOutput.(). Por exemplo, se uma chamada a waitFor não
corresponder à saída inteira de um comando, a próxima chamada poderá conter o
restante da saída do comando anterior.
Importante: para não misturar a saída do comando anterior com a saída do
comando atual, chame waitFor após cada chamada a sendLine.
Os operadores de script de Telnet e script SSH usam mecanismos diferentes para ler
os dados do host remoto:
■
O waitFor de Telnet inicia a leitura dos dados diretamente do host e faz a
correspondência à medida que lê do host.
■
O waitFor de SSH recupera os dados lidos até o momento de um buffer e faz a
correspondência em relação ao padrão.
■
Chamar waitFor após cada chamada a sendLine faz com que os operadores SSH
e Telnet comportam-se da mesma maneira.
Capítulo 4: Execução de comando 109
Operador Executar o script SSH
Os parâmetros incluem:
String pattern
Define uma expressão regular para corresponder com os dados que o produto
lê do host remoto. Normalmente, esse padrão corresponde a quaisquer dados
até o próximo prompt (por exemplo, ".*[$]"). Como você pode fazer a
correspondência dos dados de saída do comando (e recuperá-los, incluindo
novas linhas até o próximo prompt), inicie o padrão com .*.
Observação: o método corresponde a todos os dados lidos (durante essa
chamada a waitFor) em relação ao padrão. O operador não faz a
correspondência do padrão como uma subsequência de caracteres dos dados
lidos. Além disso, um ponto (. ) pode corresponder a um terminador de nova
linha (pode ser usado para corresponder a dados com várias linhas).
Int timeout
Define o intervalo (em segundos) para ler os dados do host remoto e fazer a
correspondência entre eles e o padrão.
Os itens retornados serão Booleanos:
Verdadeiro
Os dados lidos antes da expiração do tempo limite correspondem ao padrão.
Falso
Os dados lidos antes da expiração do tempo limite não correspondem ao
padrão.
Observação: o método retorna um valor assim que corresponder ao padrão ou o
tempo limite expirar.
O produto gera uma exceção nos seguintes casos:
■
O parâmetro Int timeout é menor ou igual a 0.
■
O parâmetro String pattern é nulo ou vazio.
■
O produto não pode ler os dados da sessão SSH.
■
O padrão contém sintaxe inválida.
■
Ocorre um erro durante a correspondência entre o padrão e os dados
recebidos.
public String getLastOutput()
Este método retorna o conteúdo do buffer em que a última chamada a waitFor
salvou os dados lidos do host remoto. Esses dados nem sempre correspondem ao
padrão de waitFor. O buffer armazena a chamada a waitFor lida mais recente, se
waitFor tiver retornado verdadeiro ou falso.
Este método não contém parâmetros.
Este método não gera exceções.
110 Referência do Criador de Conteúdo
Operador Executar o script SSH
Informações de logon remoto
Tipo de pseudoterminal
O tipo de pseudoterminal para solicitação na conexão SSH. Esse campo substitui o
valor especificado no nível do módulo. Se o campo for deixado em branco, o
operador usará o valor padrão definido no nível da categoria. Se esse valor ficar em
branco, o operador usará como padrão VT100.
■
VT100 normalmente funciona com a maioria dos computadores
(principalmente aqueles com base em Linux).
■
VT400 normalmente funciona com computadores com base no Windows.
VT400 é necessário para plataformas Windows, principalmente quando a saída
recuperada do servidor SSH (saída de comandos) contém caracteres de
controle em vez de espaços. Por exemplo, [19;1H em vez de um espaço na
saída. VT400 interpreta os espaços corretamente para Windows.
Outros tipos de terminal podem ser usados. Não deixe de testá-los antes de colocar
o operador em produção. Alguns tipos de pseudoterminal são:
■
terminal burro
■
xterm
■
vt220
■
vt320
■
gogrid
Verifique a instalação e a configuração de seu servidor SSH para obter informações
sobre os pseudoterminais suportados. Alguns servidores SSH listam os
pseudoterminais na pasta TermInfo.
O tipo de pseudoterminal controla como os caracteres de espaço são exibidos na
saída dos comandos. É necessário testar esse operador em relação aos
pseudoterminais suportados pelo servidor SSH para encontrar um pseudoterminal
apropriado que retorne os espaços de maneira adequada. Se os espaços não forem
retornados adequadamente e não houver um pseudoterminal disponível que possa
resolver o problema, faça o seguinte:
■
Modifique a entrada do operador para acomodar a limitação deste servidor
SSH.
■
Use o JavaScript para refinar/extrair a saída dos comandos.
Se você solicitar um pseudoterminal sem suporte, alguns servidores SSH retornarão
um erro, enquanto outros ignorarão o tipo de pseudoterminal solicitado e usarão
outro. Examine os logs do servidor SSH em referência ao pseudoterminal usado
quando o operador está em execução.
Capítulo 4: Execução de comando 111
Operador Executar o script SSH
Porta
A porta para efetuar logon no host remoto. Esse campo substitui o valor
especificado no nível do módulo. Se esse campo for deixado em branco, o operador
usará o valor padrão definido no nível de categoria do operador padrão para o
operador; se a categoria valor estiver em branco, o operador usará o valor: 22.
Nome do usuário
O nome de usuário usado para efetuar logon no host remoto. Esse campo substitui
o valor especificado no nível do módulo. Se for deixado em branco, o operador
usará o valor padrão definido no nível do módulo.
Usar a chave privada para logon?
Especifica se uma chave privada deve ser usada para efetuar logon no host remoto
(em vez das informações da senha). Esse campo substitui o valor especificado no
nível do módulo. Se for deixado em branco, o operador usará o valor padrão
definido no nível do módulo. Selecione uma das seguintes opções:
Verdadeiro
Solicita que o operador use uma chave privada.
A seleção de verdadeiro ativa os seguintes campos: Chave privada, Origem da
entrada, Conteúdo embutido da chave privada, Expressão de chave privada,
Caminho do arquivo de chave privada, Passphrase para a chave. O campo
Senha é desativado.
Falso
Solicita que o operador use as informações da senha.
A seleção de falso desativa os seguintes campos: Chave privada, Origem da
entrada, Conteúdo embutido da chave privada, Expressão de chave privada,
Caminho do arquivo de chave privada, Passphrase para a chave. O campo
Senha é ativado.
A inserção de qualquer outro valor solicita que o operador use falso e ativa todos os
campos (para acomodar a inserção de uma expressão pelo usuário).
Senha
A senha usada para efetuar logon no host remoto. Esse campo substitui o valor
especificado no nível do módulo. Se for deixado em branco, o operador usará o
valor padrão definido no nível do módulo.
112 Referência do Criador de Conteúdo
Operador Executar o script SSH
Origem da entrada da chave privada
Especifica como fornecer a chave privada. Selecione uma das seguintes ações:
Conteúdo embutido
Ativa Conteúdo embutido da chave privada e desativa Expressão de chave
privada e Caminho do arquivo de chave privada.
Expressão
Ativa Expressão de chave privada e desativa Conteúdo embutido da chave
privada e Caminho do arquivo de chave privada.
Caminho do arquivo
Ativa Caminho do arquivo de chave privada e desativa Conteúdo embutido da
chave privada e Expressão de chave privada.
Conteúdo embutido da chave privada
O conteúdo da chave privada para efetuar logon no host remoto. Esse campo
substitui o valor especificado no nível do módulo. Se for deixado em branco e se a
Origem da entrada da chave privada for definida como Conteúdo embutido, o
operador usará o valor padrão definido no nível do módulo.
Expressão de chave privada
A variável do conjunto de dados que contém o conteúdo da chave privada para
efetuar logon no host remoto.
Observação: verifique se a variável do conjunto de dados é uma sequência de
caracteres com várias linhas.
Caminho da chave privada
O caminho da chave privada para efetuar logon no host remoto. Esse campo
substitui o valor especificado no nível do módulo. Se for deixado em branco e se a
Origem da entrada da chave privada for definida como Caminho do arquivo, o
operador usará o valor padrão definido no nível do módulo.
Passphrase para a chave
Passphrase opcional senha para desbloquear o conteúdo da chave privada. Esse
campo será obrigatório se a chave privada tiver sido criada com uma passphrase.
Esse campo substitui o valor especificado no nível do módulo.
Capítulo 4: Execução de comando 113
Operador Executar o script SSH
Uma passphrase em branco para a chave não solicita automaticamente que o
operador herde a passphrase para o valor da chave do módulo. Na verdade, o
campo Passphrase para a chave está associado aos campos Conteúdo embutido da
chave privada, Caminho da chave privada ou Expressão de chave privada, conforme
é indicado a seguir:
■
Se a Passphrase para a chave do operador for especificada, o operador a
utilizará.
■
O operador usa uma senha em branco para a chave (senha não definido) no
caso das condições a seguir:
■
■
–
O operador âÂ?Â? s Senha para chave está em branco
–
Chave particular in-line de conteúdo especificado (não em branco)
–
Chave particular de entrada está definida para Embutida conteúdo
O operador usa uma senha em branco para a chave (senha não definido) no
caso das condições a seguir:
–
O operador âÂ?Â? s Senha para chave está em branco
–
Arquivo de Chave Particular Caminho especificado (não em branco)
–
Chave particular Origem da entrada for definida como Arquivo
O operador usa uma senha em branco para a chave (senha não definido) no
caso das condições a seguir:
–
O operador âÂ?Â? s Senha para chave está em branco
–
A chave privada expressão for especificado (não em branco)
–
A chave privada é definido para a origem de entrada de expressão
Em todos os outros casos, o operador Executar o script SSH usa a Passphrase padrão
para a chave.
Observação: a criação de chaves privadas/públicas de SSH é descrita no Guia de
Administração do CA Process Automation.
Parâmetros de saída
Cada variável da lista Nomes de variável de saída é criada com o tipo do CA Process
Automation correspondente.
Se um nome de variável na caixa Nomes de variável de saída não existir no script, o
operador criará a variável correspondente como uma sequência de caracteres vazia.
114 Referência do Criador de Conteúdo
Operador Executar o script SSH
O interpretador de bean shell fornece um ambiente robusto em que, se o script acionar
uma exceção ou contiver um erro, as variáveis definidas e inicializadas no script antes da
ocorrência do erro poderão ser recuperadas com seus valores. Por outro lado, o
intérprete de javascript não permitirá que variável alguma seja recuperada com seu
valor se o script acionar uma exceção ou contiver um erro.
Os parâmetros de saída são:
SSHHost
inLineScriptLanguage
inlineScriptType
inLineScript
scriptExpression
Parâmetros
outputVariables
SSHPseudoTerminalType
SSHPort
SSHUsername
SSHUsePrivateKey
SSHPassword
SSHPrivateKeyOption
SSHPrivateKey
SSHPrivateKeyVar
SSHPrivateKeyPath
SSHPrivateKeyPassphrase
Portas do operador
Êxito
O operador foi concluído com êxito.
Falha
O operador falhar por qualquer uma das seguintes razões:
■
O usuário fornece uma entrada inválida; por exemplo: script embutido vazio,
host remoto vazio, porta negativa, nome de usuário vazio e assim por diante.
■
O usuário especifica um tipo de script embutido diferente de ‘.bsh’ e ‘.js’.
Capítulo 4: Execução de comando 115
Operador Executar o script SSH
■
Não é possível estabelecer uma conexão com o host remoto. Verifique o host
remoto e a porta fornecidos ao operador.
■
O usuário fornece um host desconhecido no host remoto.
■
Não é possível autenticar o usuário no host remoto:
–
Autenticação de usuário/senha: nome de usuário ou senha inválido(a).
–
Autenticação de usuário/chave privada:
- Uma frase secreta incorreta foi fornecida para uma chave privada
protegida por frase secreta: o operador indica que não é possível ler a
chave devido a um problema de E/S interno
- Está faltando a frase secreta para uma chave privada protegida por frase
secreta: o operador indica que a frase secreta necessária para a
autenticação da chave não foi fornecida.
- Uma chave privada incorreta é fornecida: o operador indica que não pode
analisar a chave privada, não há suporte para o formato da chave ou não é
possível ler a chave devido a um problema de E/S interno.
- O caminho para o arquivo de chave privada é inválido, inexistente ou não
pode ser lido.
■
O nome de usuário/senha fornecidos não têm permissão para fazer logon por
SSH.
■
O usuário fornece um tipo de dados complexo na lista de parâmetros. Os tipos
de valores complexos (matrizes, mapas de valores etc.) não podem ser
passados para o script. Use tipos de valores simples tipos como Duplo, Inteiro,
Longo, Sequência de caracteres, Data e Booleano.
■
Ao executar um script ‘.bsh’ ou ‘.js’:
–
Erro de análise ou sintaxe durante a avaliação do script.
–
O script lançou uma exceção.
–
Ocorreu um erro ao executar o script.
–
Erro ao recuperar uma variável do escopo do script (ao final da execução).
Portas personalizadas
Se definido pelo usuário durante a criação do processo.
116 Referência do Criador de Conteúdo
Operador Executar o script SSH
Exemplo
O procedimento indicado a seguir é um exemplo de como usar o operador Executar o
script SSH.
Siga estas etapas::
1.
O operador Executar o script SSH lerá as credenciais de logon que você especificar e
as usará da seguinte forma:
■
Para conectar e realizar a autenticação com o host SSH remoto.
■
Para criar o objeto "conn".
Um exemplo de um painel Informações de logon remoto concluído para esse
operador é mostrado a seguir:
Capítulo 4: Execução de comando 117
Operador Executar o script SSH
2.
Preencha os parâmetros do script da seguinte forma:
a.
Especifique o nome do host remoto.
b.
Especifique os parâmetros a serem passados ao script, em que os valores deste
exemplo são mostrados a seguir:
Uma sequência de caracteres cujo valor é a palavra: "data".
c.
Especifica o nome das variáveis de saída que você cria no script (bean shell ou
javascript) e que você deseja salvar no conjunto de dados do operador ao final
da execução (aqui, "svrDate").
Observação: no momento não há suporte para a criação de variáveis do
conjunto de dados diretamente do script.
118 Referência do Criador de Conteúdo
Operador Executar o script SSH
Capítulo 4: Execução de comando 119
Operador Executar o script SSH
3.
No script embutido, você aproveita o objeto "conn", conforme é mostrado no
seguinte exemplo de script de bean shell:
a.
Crie a variável svrDate para ser visível no escopo do script, para que ela possa
ser salva no conjunto de dados do operador ao final da execução.
b.
Use "conn.waitFor()" para esperar o primeiro prompt “.**$+” (Reg Ex) por até
10 segundos.
c.
Se o prompt for encontrado dentro de 10 segundos, use "conn.sendLine()" para
enviar o valor do primeiro parâmetro passado para o script, seguido de um
caractere de nova linha. Neste exemplo, o valor é: args[0] = a palavra "data".
d.
Use "conn.waitFor()" para esperar o próximo prompt “.**$+” (Reg Ex) por até 10
segundos.
e.
Se o prompt for encontrado dentro de 10 segundos, use ‘conn.getLastOutput’
() para recuperar a saída lida durante a última chamada do método waitFor e
armazená-la em svrDate.
Ao final da execução, o operador salva o objeto String svrDate como uma sequência de
caracteres do CA Process Automation no conjunto de dados do operador.
Observação: o prompt que correspondeu aparece na saída retornado por
conn.getLastOutput(). Alguns servidores SSH retornam esse prompt duas vezes na saída,
enquanto outros o retornam uma vez.
120 Referência do Criador de Conteúdo
Operador Executar comando de Telnet
Operador Executar comando de Telnet
O operador Executar comando de Telnet realiza as seguintes ações:
■
Abre uma conexão Telnet com o host remoto.
■
Envia um comando de cada vez.
■
Lê a saída do comando até ver o prompt para indicar que o comando foi concluído.
■
Envia o próximo comando.
Observação: o operador Executar comando de Telnet e o operador Executar comando
de SSH efetuam logon no host remoto de maneiras diferentes. O operador Executar
comando de Telnet efetua logon em modo interativo.
Você pode definir a quantidade máxima de tempo para aguardar o prompt antes que o
operador falhe. Verifique se essa configuração é maior do que o tempo de execução do
comando mais longo que esse operador executa.
É possível configurar o operador Executar comando de Telnet para alternar para outro
usuário (incluindo o root) após o logon e antes de executar os comandos. A alternância
de usuários permite que comandos subsequentes sejam executados sob um usuário
diferente. A alternância para outro usuário é realizada de forma interativa.
Parâmetros de entrada
Observações:
■
■
Para todas as entradas que podem ser especificadas como uma expressão regular
no operador Executar comando de Telnet:
–
O operador faz a correspondência entre todos os dados de resposta e o padrão.
–
O operador não faz a correspondência do padrão como uma subsequência de
caracteres dos dados de resposta.
Um ponto ‘.’ corresponde a um novo terminador de linha (pode ser usado para
corresponder a dados de resposta com várias linhas).
Capítulo 4: Execução de comando 121
Operador Executar comando de Telnet
Comandos
Nome do host remoto
O nome de host ou o endereço IP do computador ao qual você deseja se conectar.
Usar variável de sequência de caracteres indexada para comandos?
Se essa caixa de seleção não for marcada, você poderá digitar comandos no campo
Comandos. Selecione essa opção para especificar os comandos como variáveis
Sequência de caracteres indexadas no campo Variável indexada da sequência de
caracteres dos comandos.
Comandos
Lista de comandos para executar no host remoto. Não finalize a lista com um
comando sair, pois o operador sairá automaticamente da sessão Telnet após a
execução do último comando.
Variável indexada da sequência de caracteres dos comandos
Nome da variável do conjunto de dados que contém uma lista de comandos para
executar no host remoto. Não finalize a lista com um comando 'sair'. O operador
sairá automaticamente da sessão Telnet após a execução do último comando.
Salvar saída na variável do conjunto de dados?
Marque essa caixa de seleção para copiar a saída de cada comando para o conjunto
de dados do operador. A saída de cada comando é armazenada na variável
TelnetCommandsOutput.
Limite de tamanho de variável de conjunto de dados de saída de comandos (bytes)
Especifique o número máximo de bytes da saída de cada comando para salvar na
variável do conjunto de dados do operador. Se esse número não for especificado, o
operador usará o valor: 4096.
Informações de logon remoto
Tipo de pseudoterminal
O tipo de pseudoterminal para solicitar na conexão Telnet. Esse campo substitui o
valor especificado no nível do módulo. Se o campo for deixado em branco, o
operador usará o valor padrão definido no nível da categoria. Se esse valor ficar em
branco, o operador usará como padrão VT100.
122 Referência do Criador de Conteúdo
Operador Executar comando de Telnet
■
VT100 normalmente funciona com a maioria dos computadores
(principalmente aqueles com base em Linux).
■
VT400 normalmente funciona com computadores com base no Windows.
VT400 é necessário para plataformas Windows, principalmente quando a saída
recuperada do servidor Telnet (saída de comandos) contém caracteres de
controle em vez de espaços. Por exemplo, [19;1H em vez de um espaço na
saída. VT400 interpreta os espaços corretamente para Windows.
Outros tipos de terminal podem ser usados. Não deixe de testá-los antes de colocar
o operador em produção. Alguns tipos de pseudoterminal são:
■
terminal burro
■
xterm
■
vt220
■
vt320
■
gogrid
Verifique a instalação e a configuração de seu servidor Telnet para obter
informações sobre os pseudoterminais suportados.
O tipo de pseudoterminal controla como os caracteres de espaço são exibidos na
saída dos comandos. É necessário testar esse operador em relação aos
pseudoterminais suportados pelo servidor Telnet para encontrar um
pseudoterminal apropriado que retorne os espaços de maneira adequada. Se os
espaços não forem retornados adequadamente e não houver um pseudoterminal
disponível que possa resolver o problema, faça o seguinte:
■
Modifique a entrada do operador para acomodar a limitação desse servidor
Telnet.
■
Use o JavaScript para refinar/extrair a saída dos comandos.
Se você solicitar um pseudoterminal sem suporte, alguns servidores Telnet
retornarão um erro, enquanto outros ignorarão o tipo de pseudoterminal solicitado
e usarão outro. Examine os logs do servidor Telnet em referência ao
pseudoterminal usado quando o operador está em execução.
Porta remota
A porta para conexão no host remoto. Esse campo substitui o valor especificado no
nível do módulo. Se esse campo for deixado em branco, o operador usará o valor
padrão definido no nível de categoria do operador; se esse valor de categoria
padrão estiver em branco, o operador usará o valor: 23.
Tempo limite de conexão (s)
O tempo limite da conexão em segundos antes de desistir da conexão. Esse campo
substitui o valor especificado no nível do módulo. Se esse campo for deixado em
branco, o operador usará o valor padrão definido no nível de categoria do
operador; se esse valor de categoria padrão estiver em branco, o operador usará o
valor: 20.
Capítulo 4: Execução de comando 123
Operador Executar comando de Telnet
Esquema de logon
O esquema de logon; selecione uma das seguintes opções:
0
Solicita que o operador use o nome de usuário e a senha.
1
Solicita que o operador use somente a senha, o que desativa os seguintes
campos: Prompt de texto de senha e Senha.
2
Solicita que o operador não use um nome de usuário nem senha, o que
desativa os seguintes campos: Prompt de texto de logon de usuário, Nome do
usuário, Prompt de texto de senha e Senha.
Esse campo substitui o valor especificado no nível do módulo. Se você não
especificar um valor e deixar o campo em branco, o operador usará o valor definido
no nível de categoria do operador. Qualquer outro valor solicita que o operador use
nome de usuário e senha.
Prompt de texto de logon de usuário
O prompt de texto que indica que o host remoto exige uma ID de logon para
efetuar logon. Geralmente, trata-se de:
■
Login:
ou
■
login:
Esse parâmetro deve ser especificado como uma expressão regular. Por exemplo,
".*ogin: " para corresponder a qualquer entrada (incluindo novas linhas), seguido
de "ogin: ".
Esse campo substitui o valor especificado no nível do módulo. Se for deixado em
branco, o operador usará o valor padrão definido no nível de categoria.
Nome do usuário
O nome de usuário a ser usado para efetuar logon no host remoto. Esse campo
substitui o valor especificado no nível do módulo. Se for deixado em branco, o
operador usará o valor padrão definido no nível de categoria.
Prompt de texto para a senha do usuário
O prompt de texto que indica que o host remoto exige uma senha para que o
usuário efetue logon. Geralmente, trata-se de:
■
Password:
ou
■
password:
124 Referência do Criador de Conteúdo
Operador Executar comando de Telnet
Esse parâmetro deve ser especificado como uma expressão regular. Por exemplo,
".*assword: " para corresponder a qualquer entrada (incluindo novas linhas),
seguido de "assword: ". Esse campo substitui o valor especificado no nível do
módulo. Se for deixado em branco, o operador usará o valor padrão definido no
nível de categoria.
Senha
A senha usada para efetuar logon no host remoto. Esse campo substitui o valor
especificado no nível do módulo. Se for deixado em branco, o operador usará o
valor padrão definido no nível de categoria.
Prompt de comando do usuário
Esse campo tem duas finalidades:
■
Para indicar que o usuário está conectado.
■
Para indicar que um comando na lista de comandos ou matriz de comandos
executado na sessão Telnet sob este usuário foi concluído e o operador pode
enviar o próximo comando da lista.
Esse campo geralmente é uma indicação do prompt de comando do usuário.
Geralmente, ele é "#", "$", ">" e assim por diante, mas deve ser especificado como
uma expressão regular. Por exemplo: ".*[$>?:#]" para corresponder a qualquer
entrada (incluindo novas linhas), seguido de $ ou > ou ? ou : ou #. Você deve
especificar todos os prompts que espera ver durante a execução dos comandos. A
expressão regular deve ser iniciada com .* para fazer a correspondência com todos
os dados retornados pelo comando até que o prompt seja exibido. Essa expressão
regular deve fazer a correspondência com toda a saída do comando até o próximo
prompt.
Esse campo substitui o valor especificado no nível do módulo. Se for deixado em
branco, o operador usará o valor padrão definido no nível de categoria.
Observação: são necessários colchetes antes e depois de $ para indicar o caractere
$. $ tem significado especial em expressões regulares, caso não esteja entre
colchetes.
Capítulo 4: Execução de comando 125
Operador Executar comando de Telnet
Tempo de espera de prompts padrão
O tempo (em segundos) para aguardar um prompt antes de desistir dele para
enviar os comandos. Esse campo substitui o valor especificado no nível do módulo.
Se for deixado em branco, o operador usará o valor padrão definido no nível de
categoria. Se esse valor padrão estiver em branco, o operador usará o valor: 60.
Esse campo se aplica aos prompts esperados após cada comando nos comandos de
usuário login e switch, e também aos prompts esperados após a execução de cada
comando especificado no operador. O operador não pode determinar se um
comando executado na sessão Telnet retornou todos os seus dados; portanto, ele
continua lendo a saída do comando até fazer a correspondência com o Prompt de
comando para alterar usuário ou Usuário especificado ou até que o tempo limite
seja atingido (o que ocorrer primeiro). Em seguida, ele continua a processar a saída
do comando antes de passar para o próximo comando ou acionar a falha do
operador.
Importante: Defina esse tempo para ser maior do que o tempo de execução do
comando mais longo a ser executado pelo operador.
Alterar as informações do usuário
Executar comandos/script como outro usuário?
Executar o script ou os comandos especificados como um usuário diferente?
Selecione Verdadeiro ou Falso.
■
Se você selecionar verdadeiro, o usuário conectado no momento será
alternado para outro usuário antes da execução dos comandos.
■
Se você selecionar falso, os campos a seguir serão desativados: Comando para
alterar o usuário, Prompt de texto para alterar a senha do usuário, Alterar a
senha do usuário e Prompt de comando para alterar usuário.
Esse campo substitui o valor especificado no nível de categoria do operador. Se for
deixado em branco, o operador usará o valor padrão definido no nível de categoria.
Comando para alterar o usuário
O comando para alternar o usuário no host remoto. Geralmente, trata-se de:
■
su - nome do usuário
ou
■
sudo su - nome do usuário
Esse campo substitui o valor especificado no nível de categoria do operador. Se for
deixado em branco, o operador usará o valor padrão definido no nível de categoria.
126 Referência do Criador de Conteúdo
Operador Executar comando de Telnet
Prompt de texto para alterar a senha do usuário
O prompt de texto que indica que o host remoto exige uma senha para alternar o
usuário para outro usuário. Geralmente, trata-se de:
■
Password:
ou
■
password:
Esse parâmetro deve ser especificado como uma expressão regular. Por exemplo,
".*assword: " para corresponder a qualquer entrada (incluindo novas linhas),
seguido de "assword: ".
Esse campo substitui o valor especificado no nível de categoria do operador. Se for
deixado em branco, o operador usará o valor padrão definido no nível de categoria.
Se uma senha não for necessária para alternar para outro usuário (por exemplo, ao
alternar do usuário root para outro usuário), você poderá inserir qualquer valor
nesse campo. O operador tentará fazer a correspondência dos dados lidos da
sessão Telnet após enviar o Comando para alterar o usuário em relação a Prompt
de texto para alterar a senha do usuário primeiro. Se não houver correspondência,
ele tentará corresponder os dados em relação a Prompt de comando para alterar
usuário para verificar se é necessária uma senha.
Alterar a senha do usuário
A senha para alternar o usuário para outro usuário. Esse campo substitui o valor
especificado no nível de categoria do operador. Se for deixado em branco, o
operador usará o valor padrão definido no nível de categoria.
Esse campo não será usado se a alternância para outro usuário não exigir uma
senha.
Prompt de comando para alterar usuário
Esse campo tem duas finalidades:
■
Para indicar que a alternância de usuário ocorreu.
■
Para indicar que um comando na lista de comandos ou matriz de comandos
executado na sessão Telnet sob o novo usuário (para o qual o operador
alternou) foi concluído e o operador pode enviar o próximo comando da lista.
Capítulo 4: Execução de comando 127
Operador Executar comando de Telnet
Esse campo geralmente é uma indicação do prompt de comando do novo usuário
(para o qual o operador alternou). Geralmente, é "#", "$", ">" etc. Esse campo
precisa ser especificado como uma expressão regular.
Por exemplo: ".*[$>?:#]" para corresponder a qualquer entrada (incluindo novas
linhas), seguido de $ ou > ou ? ou : ou #. Especifique todos os prompts que você
espera ver durante a execução dos comandos. A expressão regular deve ser iniciada
com .* para fazer a correspondência com todos os dados retornados pelo comando
até que o prompt seja exibido. Essa expressão regular deve fazer a correspondência
com toda a saída do comando até o próximo prompt.
Observação: são necessários colchetes antes e depois de $ para indicar o caractere
$. $ tem significado especial em expressões regulares, caso não esteja entre
colchetes.
Cuidado com a RegEx para evitar falsos positivos; por exemplo:
O usuário digita uma senha incorreta ao alternar para o root:
# su – root
Password:
A resposta para uma senha incorreta termina com #:
su: Sorry
#
Isso fornece o mesmo prompt mostrado quando o usuário digita uma senha correta
em que a resposta também termina com #:
Sun Microsystems Inc.
#
SunOS 5.10
Genérico janeiro de 2005
Esse campo substitui o valor especificado no nível de categoria do operador. Se for
deixado em branco, o operador usará o valor padrão definido no nível de categoria.
Parâmetros de saída
TelnetUserLoginPrompt
O Prompt de texto de logon de usuário real que foi lido da sessão Telnet durante o
tempo de espera de prompts. Esses são os dados que corresponderam ao padrão
especificado no campo Prompt de texto de logon de usuário padrão.
TelnetUserPasswordPrompt
O Prompt de texto para a senha do usuário real que foi lido da sessão Telnet
durante o tempo de espera de prompts. Esses são os dados que corresponderam ao
padrão especificado no campo Prompt de texto para a senha do usuário.
128 Referência do Criador de Conteúdo
Operador Executar comando de Telnet
TelnetUserCommandPrompt
O Prompt de comando do usuário real que foi lido da sessão Telnet (no tempo de
espera de prompts) na primeira vez, após o logon ou após a conexão (se não for
necessário logon). Esses são os dados que corresponderam ao padrão especificado
no campo Prompt de comando do usuário.
TelnetSwitchUserPasswordPrompt
O Prompt de texto para alterar a senha do usuário real que foi lido da sessão Telnet
durante o tempo de espera de prompts. Esses são os dados que corresponderam ao
padrão especificado no campo Prompt de texto para alterar a senha do usuário.
Esse campo ficará vazio se a alternância de usuário não tiver exigido uma senha, por
exemplo, ao alternar de Root para qualquer outro usuário, ou se o operador não for
configurado para alternar usuários.
TelnetSwitchUserCommandPrompt
O Prompt de comando para alterar usuário real lido da sessão Telnet (durante o
tempo de espera de prompts) na primeira vez após alternar para o novo usuário.
Esses são os dados que corresponderam ao padrão especificado no campo Prompt
de comando para alterar usuário. Esse campo ficará vazio se o operador não for
configurado para alternar os usuários.
Capítulo 4: Execução de comando 129
Operador Executar comando de Telnet
TelnetCommandsOutput
Uma sequência de caracteres indexada que contém a saída lida de cada comando
(durante o tempo de espera de prompts) executado no host remoto. A saída de
cada comando será truncada para o valor especificado no Limite de tamanho de
saída de comandos.
A saída completa de cada comando contém o prompt a seguir.
TelnetHost
CommandsAsAnArray
Parâmetros
CommandsArray
isPostToOutVar
PostToOutVarSizeLimit
TelnetPseudoTerminalType
TelnetPort
TelnetHostConnectTimeout
TelnetloginScheme
TelnetHostUserLoginPrompt
TelnetUsername
TelnetHostUserPasswordPrompt
TelnetPassword
TelnetHostUserCommandPrompt
TelnetHostWaitTimeout
TelnetSwitchUser
TelnetHostSwitchUserCommand
TelnetHostSwitchUserPasswordPrompt
TelnetHostSwitchUserPassword
TelnetHostSwitchUserCommandPrompt
TelnetSwitchUserPasswordPrompt
TelnetSwitchUserCommandPrompt
TelnetUserLoginPrompt
TelnetUserPasswordPrompt
TelnetUserCommandPrompt
130 Referência do Criador de Conteúdo
Operador Executar comando de Telnet
Portas do operador
Êxito
■
O operador foi concluído com êxito.
■
O operador depende dos padrões especificados em Prompt de comando do
usuário e Prompt de comando para alterar usuário para decidir se um comando
(e o operador) terão êxito ou falharão.
Por exemplo, um padrão de ".*#" fará com que o seguinte comando tenha
êxito: ‘badCmd’:
1. O operador o executa:
# badCmd
2. A saída é lida (que corresponde a .*# prompt):
badCmd: não encontrado
#
3. Executar o próximo comando.
Falha
■
O usuário fornece uma entrada inválida; por exemplo, porta remota negativa,
tempo limite de conexão negativo, tempo limite de prompts 0 ou negativo,
prompt de comando do usuário em branco e assim por diante.
■
Não é possível efetuar logon. Não foi possível fazer a correspondência dos
dados lidos da sessão Telnet (durante o tempo de espera de prompts) com o
padrão de Prompt de texto de logon de usuário especificado.
■
Não é possível efetuar logon. Não foi possível fazer a correspondência dos
dados lidos da sessão Telnet (durante o tempo de espera de prompts) com o
padrão de Prompt de texto para a senha do usuário especificado.
■
Não é possível efetuar logon. Não foi possível fazer a correspondência dos
dados lidos da sessão Telnet (durante o tempo de espera de prompts) com o
padrão de Prompt de comando do usuário especificado.
■
Não é possível alternar o usuário. Não foi possível fazer a correspondência dos
dados lidos da sessão Telnet (durante o tempo de espera de prompts) com o
padrão de Prompt de comando para alterar usuário especificado.
■
Não é possível alternar o usuário. Não foi possível fazer a correspondência dos
dados lidos da sessão Telnet (durante o tempo de espera de prompts) com o
padrão de Prompt de texto para alterar a senha do usuário especificado.
■
O usuário forneceu credenciais de logon de nome de usuário/senha incorretas.
■
O usuário forneceu credenciais de nome de usuário/senha incorretas para
alternar o usuário.
■
Não é possível alternar para outro usuário, a menos que o esquema de nome
do usuário/senha seja usado para efetuar logon na sessão Telnet.
Capítulo 4: Execução de comando 131
Operador Executar comando de Telnet
■
O usuário forneceu um host remoto desconhecido.
■
A conexão Telnet com o host remoto foi recusada (Telnet não é permitido).
■
O nome de usuário/senha fornecidos não têm permissão para efetuar logon
por meio de Telnet.
■
O operador não pôde fazer a correspondência do prompt de comando
(especificado no Prompt de comando do usuário ou Prompt de comando para
alterar usuário) com a saída lida de um comando durante o tempo de espera
de prompts. Nesse caso, ocorreu uma destas situações:
–
O comando concluiu a execução e retornou dados não correspondentes ao
padrão em Prompt de comando do usuário ou Prompt de comando para
alterar usuário.
–
A execução do comando está demorando mais do que o tempo de espera
de prompts, e o operador interrompeu a leitura dos dados de saída antes
da conclusão do comando. Como resultado, ele não fez a correspondência
dos dados lidos com o padrão abrangido no Prompt de comando do
usuário ou Prompt de comando para alterar usuário. Nesse caso, você
deve aumentar o Tempo de espera de prompts para que ele seja maior do
que o tempo de execução do comando mais longo da lista.
Observação: nesse caso, todos os comandos subsequentes na lista não serão
executados, e TelnetCommandsOutput conterá apenas a saída dos comandos
que foram executados antes (incluindo a saída lida para o comando atual).
Portas personalizadas
Se definido pelo usuário durante a criação do processo.
Exemplo:
Usar operador Executar comando de Telnet de forma interativa
O operador Executar comando de Telnet opera da seguinte maneira interativa:
1.
Abra uma conexão Telnet com o host remoto.
2.
Proceda de uma das seguintes maneiras:
■
Se não for necessário o logon, vá para a etapa 8.
■
Se o logon somente por senha for necessário, vá para a etapa 4.
■
Se o logon com nome de usuário e senha for necessário, leia da sessão Telnet
até ocorrer uma das seguintes situações:
–
Você corresponde ao padrão especificado no Prompt de texto de logon de
usuário. (Vá para a etapa 3.)
–
O Tempo de espera de prompts é atingido. Se esse tempo for excedido, o
operador falhará.
132 Referência do Criador de Conteúdo
Operador Executar comando de Telnet
3.
Envie o nome de usuário.
4.
Leia da sessão Telnet até ocorrer uma das seguintes situações:
5.
■
Você corresponde ao padrão especificado no Prompt de texto para a senha do
usuário (vá para a Etapa 5).
■
O Tempo de espera de prompts expira. Se isso ocorrer, acione a falha do
operador.
Envie a senha e, em seguida:
a.
b.
6.
Leia da sessão Telnet até ocorrer uma das seguintes situações:
–
Você corresponde ao padrão especificado no Prompt de comando do
usuário e continua.
–
O Tempo de espera de prompts expira e, em seguida, é acionada a falha do
operador.
Determine se o operador está definido para Executar comandos como outro
usuário.
–
Se ele estiver, vá para a etapa 6.
–
Se ele não estiver, vá para a etapa 7.
Envie o Comando para alterar o usuário e faça o seguinte:
a.
b.
Leia da sessão Telnet até ocorrer uma das seguintes situações:
–
Você corresponde ao padrão especificado no Prompt de texto para alterar
a senha do usuário.
–
– Você corresponde ao padrão especificado no Prompt para alterar a
senha do usuário.
–
O Tempo de espera de prompts expira.
Execute uma das seguintes ações, de acordo com o resultado:
–
Se você corresponder ao padrão para Prompt de texto para alterar a senha
do usuário (senha necessária para alternar o usuário), envie Alterar a
senha do usuário e leia da sessão Telnet até ocorrer uma das seguintes
situações:
– Você corresponde ao padrão especificado no Prompt de comando para
alterar usuário. Vá para a etapa 7.
- O Tempo de espera de prompts expira e o operador falha.
–
Se você corresponder ao padrão para Prompt de comando para alterar
usuário (nenhuma senha necessária para alternar o usuário), vá para a
etapa 7.
–
Se o Tempo de espera de prompts expirar, acione a falha do operador.
Capítulo 4: Execução de comando 133
Operador Executar script de Telnet
7.
O operador Executar comando de Telnet efetuou logon e alternou o usuário, caso
aplicável. O operador agora está pronto para executar os comandos.
8.
Realize um loop pelos comandos, envie um comando de cada vez e leia da sessão
Telnet até ocorrer uma das seguintes situações:
■
Você corresponde ao padrão especificado no Prompt de comando do usuário
(se não tivermos alternado para outro usuário). Repita a etapa 8 e envie o
próximo comando.
■
Você corresponde ao padrão especificado no Prompt de comando para alterar
usuário (se tivermos alternado para outro usuário). Repita a etapa 8 e envie o
próximo comando.
■
O Tempo de espera de prompts expira sem corresponder ao Prompt de
comando do usuário ou ao Prompt de comando para alterar usuário (o que for
aplicável). Acione a falha do operador.
Operador Executar script de Telnet
O operador Executar script de Telnet usa o host remoto e a porta especificada para
fazer o seguinte:
■
Abra uma conexão Telnet com o host remoto.
■
Criar um objeto "conn".
Observação: quando você especifica um script, seja ele de bean shell ou javascript,
o objeto "conn" é disponibilizado no escopo desse script.
Você pode aproveitar os métodos públicos do objeto "conn" no script. Os métodos
públicos são usados para autenticação na sessão Telnet e para automatizar
operações executadas em um pseudoterminal Telnet. Alguns exemplos de
operações automatizadas são:
■
Enviar comandos ao host Telnet remoto.
■
Aguardar o prompt após enviar cada comando.
■
Recuperar a saída de cada comando.
Diferentemente do operador Executar o script SSH, o operador Executar script de Telnet
não autentica uma ID de usuário na conexão Telnet. Em vez disso, você deve aproveitar
os métodos do objeto ‘conn’ para autenticação na conexão Telnet no início do script.
134 Referência do Criador de Conteúdo
Operador Executar script de Telnet
Diferentemente do operador Executar comando de Telnet, o operador Executar script
de Telnet:
■
Permite especificar a saída do comando a ser exibida ou salva no conjunto de dados
do operador. É possível chamar os métodos a seguir nesta sequência:
1.
‘conn.sendLine()’
2.
‘conn.waitFor()’
3.
‘conn.getLastOutput()’
■
Você pode especificar uma expressão regular diferente para fazer a
correspondência do prompt após a execução de cada comando.
■
Você pode especificar um tempo diferente para aguardar o prompt após a
execução de cada comando.
Parâmetros de entrada
Os parâmetros de entrada para o operador Executar script de Telnet incluem os itens a
seguir.
Script
Nome de host remoto
O nome de host ou o endereço IP do computador ao qual você deseja se conectar.
Tipo de script:
O tipo de script especificado no campo Script embutido. Selecione de script bean
shell (.bsh) e JavaScript (.js). Se esse campo for deixado em branco, o operador
usará .bsh como padrão.
Script embutido?
Esse operador oferece dois métodos para fornecer o script: embutido ou como uma
expressão. Marque essa caixa de seleção para fornecer o script embutido.
Script embutido
O script, escrito em bean shell ou javascript, usa o objeto conn e sua API da
seguinte maneira:
■
Enviar um comando ao host remoto
■
Aguardar a conclusão do comando
■
Recuperar a saída do último comando
As APIs que o objeto conn expõe são detalhadas em Executar APIs de script
embutido de operador Executar o script de Telnet (na página 137).
Capítulo 4: Execução de comando 135
Operador Executar script de Telnet
Script como expressão
Fornece o script como uma expressão. Consulte o campo Script embutido para
obter informações sobre o próprio script.
Parâmetros
Os parâmetros do CA Process Automation a serem passados ao script. Somente
tipos de parâmetros simples do CA Process Automation podem ser passados para o
script, como é indicado a seguir:
■
PAM Booleano é passado como um objeto booleano
■
PAM Data é passado como um objeto de data
■
PAM Duplo é passado como um objeto duplo.
■
PAM Inteiro é passado como um objeto de número inteiro.
■
PAM Longo é passado como um objeto longo.
■
PAM Sequência de caracteres é passado como um objeto de sequência de
caracteres.
■
PAM Referência de objeto é passada como um objeto de sequência de
caracteres.
Tipos de parâmetros do CA Process Automation complexos (tipos indexados, mapas
de valores etc.) não podem ser passados para o script.
O script pode acessar esses objetos por meio dos argumentos de matriz de objetos,
em que args[0] corresponde ao primeiro parâmetro da lista, args[1] corresponde ao
segundo parâmetro e assim por diante.
Nomes de variável de saída
Os nomes das variáveis, criados no script, para serem salvos no conjunto de dados
do operador ao final da execução do script.
As variáveis devem ser definidas no escopo do script, de forma que elas estejam
visíveis ao final da execução e possam ser salvas no conjunto de dados do operador.
As variáveis de saída são salvas da seguinte forma:
■
Objeto booleano é salvo como PAM Booleano
■
Objeto de data é salvo como PAM Data
■
Objeto inteiro é salvo como PAM Inteiro
■
Objeto de número é salvo como PAM Longo ou Objeto duplo
■
Objeto de sequência de caracteres é salvo como PAM Sequência de caracteres
■
Objeto de caracteres é salvo como PAM Sequência de caracteres
136 Referência do Criador de Conteúdo
Operador Executar script de Telnet
■
Uma matriz de objetos é salva como um tipo de PAM indexado, em que o tipo
de PAM é definido pelo tipo do primeiro objeto na matriz de objetos.
■
Indefinido é salvo como PAM Sequência de caracteres, com ‘indefinido’ como
valor.
APIs de script embutido de operador Executar o script de Telnet
O produto usa um script que é gravado em bean shell ou JavaScript para o campo Script
embutido do operador Executar script de Telnet. O script usa o objeto conn, que expõe
as seguintes APIs:
void send (String str, boolean log) aciona Exceção
Esse método envia dados ao host remoto.
String str
Define os dados a enviar ao host remoto.
boolean log
Expõe ou oculta os dados enviados ao host remoto nos logs do CA Process
Automation.
Para depuração, siga a interação entre o operador e o host remoto. Defina o
seguinte código no arquivo <install_dir>/server/conf/log4j.xml:
<category name="com.company.c2o.servicegroup.netutils">
<priority value="DEBUG" />
</category>
Além disso, defina o arquivo de log do CA Process Automation (c2o.log) para
aceitar instruções DEBUG em log4j.xml.
Quando você definir o nível de depuração, a categoria do operador Execução
de comando iniciará o registro no arquivo de log do CA Process Automation
(c2o.log) em nível de DEBUG. Os logs do CA Process Automation expõem todos
os dados enviados ao host remoto por meio de send ou sendLine.
Valores:
Verdadeiro: registra o valor de String str ao registrar em nível de DEBUG.
Falso: não registra o valor de String str.
Observação: c2o.log é o arquivo de log do CA Process Automation, mas não os
logs de processos. Os operadores não gravam mensagens no log de processo.
Esse método não tem valores de retorno. O produto gera uma exceção se a API não
puder gravar os dados no host remoto.
Capítulo 4: Execução de comando 137
Operador Executar script de Telnet
public void sendLine (String str, boolean log) aciona Exceção
Este método adiciona um caractere de nova linha aos dados e o envia para o host
remoto. Para forçar o host remoto a iniciar a execução do comando enviado no
parâmetro, use este método.
Este método tem os mesmos parâmetros e valores que void send (String str,
boolean log) aciona Exceção.
void send (String str) aciona Exceção
Esse método é equivalente a Send (String str, verdadeiro).
void sendLine (String str) aciona Exceção
Esse método é equivalente a SendLine (String str, verdadeiro).
public boolean waitFor(String pattern, int timeout) throws Exception
Este método lê a saída do host remoto e é interrompido quando um dos seguintes
resultados é gerado:
■
A saída corresponde ao padrão especificado nos parâmetros.
■
O intervalo de tempo limite expira.
O produto armazena a saída do host remoto por cada chamada ao método waitFor
em um buffer que pode ser acessado por meio do método getLastOutput(). Cada
chamada a waitFor substitui o conteúdo do buffer da chamada anterior.
A próxima chamada a waitFor começa a ler a saída a partir do ponto em que a
chamada anterior a waitFor interrompeu a leitura. Isso é relevante ao utilizar o
método com getLastOutput.(). Por exemplo, se uma chamada a waitFor não
corresponder à saída inteira de um comando, a próxima chamada poderá conter o
restante da saída do comando anterior.
Importante: para não misturar a saída do comando anterior com a saída do
comando atual, chame waitFor após cada chamada a sendLine.
Os operadores de script de Telnet e script SSH usam mecanismos diferentes para ler
os dados do host remoto:
■
O waitFor de Telnet inicia a leitura dos dados diretamente do host e faz a
correspondência à medida que lê do host.
■
O waitFor de SSH recupera os dados lidos até o momento de um buffer e faz a
correspondência em relação ao padrão.
■
Chamar waitFor após cada chamada a sendLine faz com que os operadores SSH
e Telnet comportam-se da mesma maneira.
138 Referência do Criador de Conteúdo
Operador Executar script de Telnet
Os parâmetros incluem:
String pattern
Define uma expressão regular para corresponder com os dados que o produto
lê do host remoto. Normalmente, esse padrão corresponde a quaisquer dados
até o próximo prompt (por exemplo, ".*[$]"). Como você pode fazer a
correspondência dos dados de saída do comando (e recuperá-los, incluindo
novas linhas até o próximo prompt), inicie o padrão com .*.
Observação: o método corresponde a todos os dados lidos (durante essa
chamada a waitFor) em relação ao padrão. O operador não faz a
correspondência do padrão como uma subsequência de caracteres dos dados
lidos. Além disso, um ponto (. ) pode corresponder a um terminador de nova
linha (pode ser usado para corresponder a dados com várias linhas).
Int timeout
Define o intervalo (em segundos) para ler os dados do host remoto e fazer a
correspondência entre eles e o padrão.
Os itens retornados serão Booleanos:
Verdadeiro
Os dados lidos antes da expiração do tempo limite correspondem ao padrão.
Falso
Os dados lidos antes da expiração do tempo limite não correspondem ao
padrão.
Observação: o método retorna um valor assim que corresponder ao padrão ou o
tempo limite expirar.
O produto gera uma exceção nos seguintes casos:
■
O parâmetro Int timeout é menor ou igual a 0.
■
O parâmetro String pattern é nulo ou vazio.
■
O produto não pode ler os dados da sessão Telnet.
■
O padrão contém sintaxe inválida.
■
Ocorre um erro durante a correspondência entre o padrão e os dados
recebidos.
public String getLastOutput()
Este método retorna o conteúdo do buffer em que a última chamada a waitFor
salvou os dados lidos do host remoto. Esses dados nem sempre correspondem ao
padrão de waitFor. O buffer armazena a chamada a waitFor lida mais recente, se
waitFor tiver retornado verdadeiro ou falso.
Este método não contém parâmetros.
Este método não gera exceções.
Capítulo 4: Execução de comando 139
Operador Executar script de Telnet
Informações de logon remoto
Tipo de pseudoterminal padrão
O tipo de pseudoterminal para solicitar na conexão Telnet. Esse campo substitui o
valor especificado no nível do módulo. Se o campo for deixado em branco, o
operador usará o valor padrão definido no nível do módulo. Se esse valor ficar em
branco, o operador usará como padrão VT100.
■
VT100 normalmente funciona com a maioria dos computadores
(principalmente aqueles com base em Linux).
■
VT400 normalmente funciona com computadores com base no Windows.
VT400 é necessário para plataformas Windows, principalmente quando a saída
recuperada do servidor Telnet (saída de comandos) contém caracteres de
controle em vez de espaços. Por exemplo, [19;1H em vez de um espaço na
saída. VT400 interpreta os espaços corretamente para Windows.
Outros tipos de terminal podem ser usados. Não deixe de testá-los antes de colocar
o operador em produção. Alguns tipos de pseudoterminal são:
■
terminal burro
■
xterm
■
vt220
■
vt320
■
gogrid
Verifique a instalação e a configuração de seu servidor Telnet para obter
informações sobre os pseudoterminais suportados.
O tipo de pseudoterminal controla como os caracteres de espaço são exibidos na
saída dos comandos. É necessário testar esse operador em relação aos
pseudoterminais suportados pelo servidor Telnet para encontrar um
pseudoterminal apropriado que retorne os espaços de maneira adequada. Se os
espaços não forem retornados adequadamente e não houver um pseudoterminal
disponível que possa resolver o problema, faça o seguinte:
■
Modifique a entrada do operador para acomodar a limitação desse servidor
Telnet.
■
Use o JavaScript para refinar/extrair a saída dos comandos.
Se você solicitar um pseudoterminal sem suporte, alguns servidores Telnet
retornarão um erro, enquanto outros ignorarão o tipo de pseudoterminal solicitado
e usarão outro. Examine os logs do servidor Telnet em referência ao
pseudoterminal usado quando o operador está em execução.
140 Referência do Criador de Conteúdo
Operador Executar script de Telnet
Porta remota
A porta para conexão no host remoto. Esse campo substitui o valor especificado no
nível do módulo. Se for deixado em branco, o operador usará o valor padrão
definido no nível do módulo. Se o valor do módulo padrão estiver em branco, o
operador usará o valor: 23.
Tempo limite de conexão (s)
O tempo limite da conexão em segundos antes de desistir da conexão. Esse campo
substitui o valor especificado no nível do módulo. Se for deixado em branco, o
operador usará o valor padrão definido no nível do módulo. Se o valor do módulo
padrão estiver em branco, o operador usará o valor: 20.
Parâmetros de saída
Cada variável da lista Nomes de variável de saída é criada com o tipo do CA Process
Automation correspondente.
Se um nome de variável em Nomes de variável de saída não existir no script, o operador
Executar script de Telnet criará a variável correspondente como uma sequência de
caracteres vazia.
O interpretador de bean shell oferece um ambiente robusto para o script. Por exemplo,
se o script bean shell acionar uma exceção ou contiver um erro, as variáveis definidas e
inicializadas no script, antes da ocorrência do erro, poderão ser recuperadas com seus
valores. Como alternativa, se o script javascript acionar uma exceção ou contiver um
erro, o intérprete de javascript não permitirá que variável alguma seja recuperada com
seu valor.
Os parâmetros de saída incluem:
TelnetHost
inLineScriptLanguage
inlineScriptType
inLineScript
scriptExpression
Parâmetros
outputVariables
TelnetPseudoTerminalType
TelnetPort
TelnetHostConnectTimeout
Capítulo 4: Execução de comando 141
Operador Executar script de Telnet
Portas do operador
Êxito
O operador foi concluído com êxito.
Falha
O operador falhar por qualquer uma das seguintes razões:
■
O usuário fornece uma entrada inválida; por exemplo: script embutido vazio,
host remoto vazio, porta negativa e assim por diante.
■
O usuário especifica um tipo de script embutido diferente de ‘.bsh’ e ‘.js’.
■
Não é possível estabelecer uma conexão com o host remoto. Verifique o host
remoto e a porta fornecidos ao operador.
■
O usuário fornece um host desconhecido no host remoto.
■
O usuário fornece um tipo de dados complexo na lista de parâmetros. Os tipos
de valores complexos (matrizes, mapas de valores etc.) não podem ser
passados para o script. Use tipos de valores simples tipos como Duplo, Inteiro,
Longo, Sequência de caracteres, Data e Booleano.
■
Ao executar um script ‘.bsh’ ou ‘.js’:
–
Erro de análise ou sintaxe durante a avaliação do script.
–
O script lançou uma exceção.
–
Ocorreu um erro ao executar o script.
–
Erro ao recuperar uma variável do escopo do script (no final da execução).
Portas personalizadas
Se definido pelo usuário durante a criação do processo.
142 Referência do Criador de Conteúdo
Operador Executar script de Telnet
Exemplo:
O procedimento a seguir fornece um exemplo de como usar o operador Executar script
de Telnet.
1.
O operador Executar script de Telnet lê as informações de logon que você
especifica. O operador usa essas informações de logon para a conexão ao host
Telnet remoto e para criar o objeto "conn". O seguinte exemplo de Informações de
logon remoto mostra entradas típicas:
Capítulo 4: Execução de comando 143
Operador Executar script de Telnet
2.
Você pode especificar o seguinte na paleta Script:
■
O nome do host remoto.
■
Os parâmetros a serem passados ao script. No exemplo a seguir, o usuário, a
senha e uma sequência de caracteres cujo valor é a palavra: ‘"data".
■
O nome das variáveis de saída que você cria no script (bean shell ou javascript)
e que você deseja salvar no conjunto de dados do operador ao final da
execução. Se você não desejar que uma variável seja salva no conjunto de
dados do operador ao final da execução, não precisará especificá-la aqui.
Observação: no momento não há suporte para a criação de variáveis do
conjunto de dados diretamente do script. O campo Nomes de variável de saída
tem a função de C2OSVD nesse caso.
Neste exemplo, os nomes de variáveis de saída a seguir são salvos no conjunto de
dados do operador ao final da execução: 'svrDate', 'loginStr', 'pwdStr' e 'promptStr'.
144 Referência do Criador de Conteúdo
Operador Executar script de Telnet
Capítulo 4: Execução de comando 145
Operador Executar script de Telnet
3.
No script embutido, você pode aproveitar o objeto 'conn' criado pelo CA Process
Automation. A maneira como você pode aproveitar o objeto 'conn' é mostrada no
seguinte exemplo de script bean shell:
a.
Crie as variáveis svrDate, loginStr, pwdStr e promptStr para serem visíveis no
escopo do script, de modo que possam ser salvas no conjunto de dados do
operador ao final da execução.
b.
Use ‘conn.waitFor()’ para aguardar o prompt de logon “.*ogin: ” (Reg Ex) por
até 10 segundos.
c.
Se o prompt de logon for encontrado dentro de 10 segundos, use
‘conn.getLastOutput()' para salvar o prompt de logon que foi correspondido na
variável loginStr.
d.
Use ‘conn.sendLine()’ para enviar o nome de usuário passado como o primeiro
objeto na lista de parâmetros: args[0].
e.
Use ‘conn.waitFor()’ para aguardar o prompt de senha “.*assword: ” (Reg Ex)
por até 10 segundos.
f.
Se o prompt de senha for encontrado dentro de 10 segundos, use
‘conn.getLastOutput()’ para salvar o prompt de senha correspondido na
variável pwdStr.
g.
Use ‘conn.sendLine()’ para enviar a senha passada como o segundo objeto na
lista de parâmetros: args[1].
146 Referência do Criador de Conteúdo
Operador Executar script de Telnet
h.
Use ‘conn.waitFor()’ para aguardar o prompt de usuário “.*[$] ” (Reg Ex) por
até 15 segundos.
i.
Se o prompt de usuário for encontrado dentro de 15 segundos, use
‘conn.getLastOutput()’ para salvar o prompt de usuário correspondido na
variável promptStr.
j.
Use ‘conn.sendLine()’ para enviar o comando passado como o terceiro objeto
na lista de parâmetros: args[2].
k.
Use ‘conn.waitFor()’ para aguardar o prompt de usuário “.*[$] ” (Reg Ex) por
até 10 segundos.
l.
Se o prompt de usuário for encontrado dentro de 10 segundos, use
‘conn.getLastOutput()’ para salvar o prompt de usuário correspondido com a
saída do comando na variável svrDate.
m. Ao final da execução, o operador Executar script de Telnet salva as variáveis de
saída no conjunto de dados do operador como objetos do CA Process
Automation.
O prompt correspondente aparece na saída retornada por
conn.getLastOutput().
Capítulo 4: Execução de comando 147
Capítulo 5: Bancos de dados
Operadores Bancos de dados suportam drivers JDBC do tipo 2 para comunicarem um
banco de dados. Os operadores Banco de dados podem realizar diferentes operações de
banco de dados, como consultas no banco de dados, porém, não oferecem suporte a
operações administrativas como a interrupção de um servidor de banco de dados,
backup/recuperação e assim por diante.
A sequência de caracteres da conexão é diferente, com base no tipo de servidor.
A combinação de nome do TNS e tipo thin driver é suportada apenas nas versões 12.x e
superiores do Oracle. O CA Process Automation não validar qualquer combinação nem
as credenciais do servidor fornecidas no nível de operador.
Observação: você pode usar o Módulo JDBC com diferentes RDBMS (Relational
Database Management System) diferentes daquele usado pelos bancos de dados do CA
Process Automation. Por exemplo, se o CA Process Automation tiver sido instalado
usando o Microsoft SQL, você poderá usar o Módulo JDBC com Oracle. No entanto,
primeiro o arquivo JAR do driver de banco de dados apropriado deve ser implementado
corretamente em sua instalação do CA Process Automation. Consulte o Guia de
Instalação para obter detalhes.
Parâmetros do Oracle
Herdar configurações
Se essa opção estiver marcada, os valores exibidos refletem os valores atuais do
domínio. Em tempo de execução, os valores são selecionados a partir do ambiente
(se definido).
Capítulo 5: Bancos de dados 149
Parâmetros do Oracle
Tipo de driver
Aceita uma das seguintes opções:
Thin
O thin driver é uma pura implementação Java do protocolo de rede do Oracle
(Net8). Por ser independente, ele poderá ser usado em qualquer computador
com ou sem o Oracle instalado, ou distribuído com classes de aplicativo em um
miniaplicativo.
OCI
O driver "OCI" (tipo 2) consiste em Java wrappers para as bibliotecas de
interface de chamada (OCI) de nível baixo do Oracle, usadas pelos utilitários
como o SQL*Plus para acessar o servidor de banco de dados. O driver OCI
oferece um desempenho potencialmente melhor que o thin driver. No entanto,
requer que as bibliotecas OCI sejam instaladas no computador local.
KPRB
O driver "KBRP" é usado para procedimentos armazenados de Java e JSP do
banco de dados.
Driver
Especifica o driver do JDBC do Oracle.
Host do servidor
Especifica o host em que o banco de dados do Oracle está em execução.
UserName
Especifica o usuário do banco de dados padrão do Oracle.
Senha
Especifica a senha do usuário padrão do Oracle.
ServiceID
Especifica a ID de serviço do Oracle.
Nome do TNS
Os Nomes do TNS do Oracle convertem um alias do banco de dados local para todas
as informações de conectividade necessárias para a conexão ao banco de dados.
Isso inclui endereço IP, porta, ID do serviço de banco de dados ou nome do serviço,
e assim por diante. Essas informações são armazenadas em um arquivo chamado
tnsnames.ora no diretório do Oracle.
Número máximo de linhas
Especifica o número máximo de linhas a serem recuperadas.
150 Referência do Criador de Conteúdo
Parâmetros do Servidor MSSQL
Criptografia do cliente
O Oracle oferece suporte a várias criptografias dos dados para o cliente (RC4_40,
RC4_56, RC4_128, RC4_256, DES40C, DES56C, 3DES112, 3DES168, SSL, AES256,
AES192 e AES128). O usuário deve fornecer um desses valores. Esses valores serão
definidos como propriedades, como parte da conexão. Os níveis de criptografia
RC4_128 e RC4_256 são apenas para edições domésticas.
Soma de Verificação do cliente
Especifica as somas de verificação suportadas pelo Oracle. Consulte a
documentação do Oracle.
Parâmetros do Servidor MSSQL
Herdar configurações
Se essa opção estiver marcada, os valores exibidos refletem os valores atuais do
domínio. Em tempo de execução, os valores são selecionados a partir do ambiente
(se definido).
Driver padrão
Especifica o driver padrão do MSSQL.
Host do servidor padrão
Especifica o host em que o banco de dados do MSSQL está em execução.
Porta do servidor padrão
Especifica a porta do servidor de banco de dados padrão do MSSQL.
UserName padrão
Especifica o usuário padrão do banco de dados do MSSQL.
Senha padrão
Especifica a senha do usuário padrão do MSSQL.
Máximo de linhas padrão
Especifica o número máximo de linhas a serem recuperadas.
Nome do banco de dados padrão
Especifica o nome do banco de dados do MSSQL.
Nome padrão da instância
Especifica o nome da instância do MSSQL.
Capítulo 5: Bancos de dados 151
Parâmetros do MySQL
Parâmetros do MySQL
Herdar configurações
Se essa opção estiver marcada, os valores exibidos refletem os valores atuais do
domínio. Em tempo de execução, os valores são selecionados a partir do ambiente
(se definido).
Driver padrão
Especifica o driver padrão do MySQL.
Host do servidor padrão
Especifica o host em que o banco de dados do MySQL está em execução.
Porta do servidor padrão
Especifica a porta do servidor de banco de dados padrão do MySQL.
UserName padrão
Especifica o usuário padrão do banco de dados do MySQL.
Senha padrão
Especifica a senha do usuário padrão do MySQL.
Máximo de linhas padrão
Especifica o número máximo de linhas a serem recuperadas.
Nome do banco de dados padrão
Especifica o nome padrão do banco de dados do MySQL.
Parâmetros do Sybase
Herdar configurações
Se essa opção estiver marcada, os valores exibidos refletem os valores atuais do
domínio. Em tempo de execução, os valores são selecionados a partir do ambiente
(se definido).
Tipo de servidor padrão
Especifica um dos seguintes tipos de servidor do Sybase:
■
Adaptive Server Anywhere (ASA) (o valor padrão)
■
ASE (Adaptive Server Enterprise)
Protocolo de conexão padrão
Especifica o protocolo de conexão padrão. O valor padrão é Tds.
152 Referência do Criador de Conteúdo
Propriedades de nível do operador
Driver padrão
Especifica o driver padrão do Sybase. O valor padrão é
com.sybase.jdbc2.jdbc.SybDriver.
Host do servidor padrão
Especifica o host em que o Sybase está em execução.
Porta do servidor padrão
Especifica a porta do servidor padrão do Sybase.
UserName padrão
Especifica o nome do usuário padrão do Sybase.
Senha padrão
Especifica a senha do usuário do Sybase.
Máximo de linhas padrão
Especifica o número máximo de linhas a serem recuperadas. Se essa opção for
deixada em branco, o valor padrão é 10 linhas.
Tamanho do buffer de cache padrão
O Tamanho do buffer do cache do Sybase é a quantidade de memória usada pelo
driver para armazenar no cache os dados do conjunto de resultados sem
diferenciação de maiúscula e minúscula. Os valores válidos são:
-1 = todos os dados estão armazenados em cache
0 = todos os dados são armazenadas em cache até 2 GB.
X = deve ser positivo. Esse é o tamanho do buffer (devem ser uma potência de 2).
Esse valor é especificado em KB.
Após o limite ser alcançado (se houver), os dados do conjunto de resultados são
gravados no disco.
Solução de contorno padrão de desempenho em lote
A Solução de contorno de desempenho em lote do Sybase é uma das seguintes
opções:
■
True é compatível com o mecanismo JDBC v3.0.
■
False é o mecanismo nativo do lote. O padrão é False.
Propriedades de nível do operador
A seguir são relacionados os parâmetros de conexão para os operadores Banco de
dados.
Capítulo 5: Bancos de dados 153
Propriedades de nível do operador
Parâmetros de logon do servidor de banco de dados
Os parâmetros Logon do servidor de banco de dados definem as configurações
necessárias para efetuar logon no servidor de banco de dados e se comunicar com o
mesmo.
Nome de usuário
Especifica o nome de usuário do banco de dados.
Senha
Especifica a senha do usuário do banco de dados.
Observações:
■
Se Outro for selecionado como Tipo de banco de dados, digite o Nome de usuário e
a Senha a serem usados para se conectar com o banco de dados (se necessário). A
conexão assistente cria um URL que é preenchido de acordo com o operador.
■
Se desejar usar a Autenticação do Windows, não especifique um Nome de
usuário/Senha ao configurar um Operador JDBC. Consulte o Guia de Administração
para obter mais informações sobre como configurar a Autenticação do Windows
para os Operadores JDBC.
Assistente para conexão
Um assistente que permite especificar as propriedades da conexão. Você pode
digitar as propriedades (na página 155) que configuram como o operador se
conecta ao banco de dados.
URL de conexão
Representa um localizador universal de recursos (URL, Universal Resource Locator)
que especifica um tipo específico de servidor de banco de dados (compatível com o
driver do JDBC local) e um host específico.
Observações:
■
Se Outro for selecionado como Tipo de banco de dados (no Assistente para
conexão), um URL JDBC deverá ser inserido nesse campo.
■
Se desejar usar a Autenticação do Windows, acrescente o seguinte ao URL da
Conexão:
;integratedSecurity=true
154 Referência do Criador de Conteúdo
Propriedades de nível do operador
Propriedades do Assistente de conexão
Tipo de banco de dados
Selecione o tipo de banco de dados na lista suspensa:
■
MySQL (padrão)
■
Oracle
■
SQLSERVER
■
Sybase
■
Informix
■
Hypersonic
■
Postgres
■
DB2
■
Interbase
■
Ingres
■
Outros
Tipo de banco de dados, host do servidor, porta do servidor, nome do banco de
dados, nome do driver e URL de conexão sempre são exibidos no Assistente de
conexão. Os campos restantes são exibidos/ocultos com base na seleção do tipo de
banco de dados.
Por exemplo, se você selecionar "Oracle" como o tipo de banco de dados, então
todos os campos relacionados a Oracle são exibidos e os demais são ocultos.
Observação: se você selecionar SQLSERVER como o Tipo de banco de dados e
desejar usar a Autenticação do Windows (segurança integrada), deixe todos os
campos em branco, exceto o campo URL de conexão. Nesse campo, digite algo
semelhante ao seguinte exemplo:
"jdbc:sqlserver//ms-db-host:1433;DatabaseName=dbname;integratedSecurity=true
"
Se você definir o host, a porta, o nome do banco de dados ou o nome da instância
do SQL Server, o operador criará o URL com base nesses valores, em vez de usar o
banco de dados configurado no campo URL de conexão com integratedSecurity
definido como true).
Observação: se Outros for selecionado como o tipo de banco de dados, digite o
nome de usuário e a senha a ser usada para estabelecer conexão com o banco de
dados (se necessário), nos parâmetros de logon do servidor de banco de dados.
Outro tipo de banco de dados
Se o banco de dados não estiver relacionado na lista suspensa Tipo de banco de
dados, digite-o aqui.
Capítulo 5: Bancos de dados 155
Propriedades de nível do operador
Host do servidor
Especifica o host em que o banco de dados está em execução.
Porta do servidor
Especifica a porta do servidor de banco de dados.
Nome do banco de dados
Especifica o nome do banco de dados.
Nome do driver
Especifica o nome do driver de banco de dados (a classe Java que faz interface com
o banco de dados).
URL de conexão
Especifica que a URL de um banco de dados é um Localizador Universal de Recursos
(URL) que especifica um tipo específico de servidor de banco de dados (compatível
com o driver do JDBC local) e um host específico.
Esse campo é atualizado quando as informações são inseridas no Assistente de
conexão.
As seguintes propriedades somente são exibidas se elas se aplicarem ao tipo de banco
de dados especificado.
Tamanho do buffer de cache do Sybase
Disponível quando Sybase é selecionado como o tipo de banco de dados. Este
campo especifica a quantidade de memória usada pelo driver para armazenar em
cache os dados dos resultados, sem diferenciar maiúscula de minúscula. Os valores
válidos são:
-1
Todos os dados são armazenados em cache.
0
Todos os dados são armazenados em cache, até 2 GB.
X
Esse é o tamanho do buffer. Deve ser um número positivo e ser potência de 2.
Esse valor é especificado em kilobytes.
156 Referência do Criador de Conteúdo
Propriedades de nível do operador
Solução de contorno de desempenho em lote do Sybase
Disponível quando Sybase é selecionado como o tipo de banco de dados. Selecione
true ou false.
■
O padrão é False (mecanismo do lote nativo).
■
True serve para o mecanismo compatível com o JDBC v3.0.
Protocolo de conexão do Sybase
Disponível quando Sybase é selecionado como o tipo de banco de dados. Especifica
o protocolo de conexão para o Sybase. O protocolo de conexão padrão é Tds. A
sequência de caracteres da conexão é diferente, com base no tipo de servidor.
Tipo de servidor do Sybase
Disponível quando Sybase é selecionado como o tipo de banco de dados. Especifica
os tipos de servidor do Sybase. Selecione um dos seguintes na lista suspensa:
■
ASA (Adaptive Server Anywhere) (padrão)
■
ASE (Adaptive Server Enterprise)
Tipo de driver Oracle
Disponível quando Oracle é selecionado como o tipo de banco de dados. Especifica
o tipo de driver para Oracle. Selecione um dos seguintes na lista suspensa:
thin
O driver thin é uma implementação Java pura do protocolo de rede do Oracle
(Net8). Por ser independente, ele poderá ser usado em qualquer computador
com ou sem o Oracle instalado, ou distribuído com classes de aplicativo em um
miniaplicativo.
OCI
O driver OCI (tipo 2) consiste em wrappers Java para as bibliotecas OCI (Oracle
Call Interface - Interface de Chamada Oracle) de nível inferior, usadas por
utilitários como o SQL*Plus para acessar o servidor de banco de dados. O driver
de OCI pode potencialmente aprimorar o desempenho em relação ao thin
driver; no entanto, requer que as bibliotecas OCI sejam instaladas no
computador local.
KBRP
O driver KBRP é usado para procedimentos armazenados Java e bancos de
dados JSP.
Capítulo 5: Bancos de dados 157
Propriedades de nível do operador
ID do serviço Oracle
Disponível quando Oracle é selecionado como o tipo de banco de dados. Uma
expressão de suporte que especifica a ID de serviço do Oracle.
Nome TNS Oracle
Disponível quando Oracle é selecionado como o tipo de banco de dados. Converte
um alias do banco de dados local para todas as informações de conectividade
necessárias para a conexão ao banco de dados. Isso inclui endereço IP, porta, ID do
serviço de banco de dados ou nome do serviço, e assim por diante. Essas
informações são armazenadas em um arquivo chamado tnsnames.ora no diretório
do Oracle.
Criptografia do cliente Oracle
Disponível quando Oracle é selecionado como o tipo de banco de dados. O Oracle
oferece suporte às seguintes criptografias de vários dados para o cliente:
RC4_40, RC4_56, RC4_128, RC4_256
DES40C, DES56C, 3DES112, 3DES168
SSL, AES256, AES192, AES128
Especifique um desses valores, que será definido como as propriedades como parte
da conexão. Os níveis de criptografia RC4_128 e RC4_256 são apenas para edições
domésticas.
Soma de verificação do cliente Oracle
Disponível quando Oracle é selecionado como o tipo de banco de dados. Especifica
o valor da soma de verificação do cliente Oracle (um número calculado pelo banco
de dados de todos os bytes armazenados em um bloco de dados ou refazer). A
Oracle oferece suporte a soma de verificação MD5. Para obter mais informações,
consulte a documentação do Oracle.
Nome da instância do servidor SQL
Disponível quando o SQL Server é selecionado como o tipo de banco de dados. Em
um determinado servidor, é possível executar vários serviços do SQL Server, cada
um com suas próprias portas, logons e bancos de dados. Cada um desses serviços é
denominado uma instância do SQL Server. Esse campo especifica um determinado
nome de instância para o SQLServer.
Tipo de banco de dados Hypersonic
Disponível quando o Hypersonic é selecionado como o tipo de banco de dados.
Selecione um dos seguintes na lista suspensa:
■
Servidor
■
Arquivo
■
Dentro da memória
158 Referência do Criador de Conteúdo
Operador Inserção em massa no banco de dados
Operador Inserção em massa no banco de dados
O operador Inserção em massa no banco de dados permite importar rapidamente um
número volumoso de linhas para uma tabela ou exibição de banco de dados que você
especificar.
Parâmetros de entrada
Fonte de dados
O nome da tabela para fornecer na instrução SQL como sequência de caracteres ou
variável.
Inserir matriz de mapa
Uma matriz de mapas de valores; cada um representa uma linha a ser inserida no
banco de dados.
Importante: Verifique se as aspas simples encapsulam quaisquer valores de seqüência
de caracteres.
O nome do parâmetro ValueMap que você deseja inserir em uma tabela deve ser o
mesmo que o nome da coluna associada.
Cada uma das variáveis do mapa de valores deve corresponder às colunas na tabela. Por
exemplo, se você tiver uma tabela com duas colunas, "Nome" e "Número", ValueMap
deverá ser organizado da mesma maneira.
Capítulo 5: Bancos de dados 159
Operador Excluir do banco de dados
Parâmetros de saída
DataSource
JDBCInsertMapArray
Senha do UserName
DatabaseType
OtherDatabaseType
DriverName
DatabaseName
CacheBufferSize
BatchPerfWorkaround
ConnectionProtocol
ServerType
DriverType
ServiceID
TNSName
ClientEncryption
ClientChecksum
InstanceName
HypersonicDatabaseType
ServerHost
ServerPort
ConnectionString
Operador Excluir do banco de dados
Use o operador Excluir do banco de dados para excluir as linhas de uma tabela com base
em critérios especificados por você.
160 Referência do Criador de Conteúdo
Operador Excluir do banco de dados
Parâmetros de entrada
Origem da entrada
Especifica que o usuário pode optar por enviar uma expressão SQL como uma
expressão embutida (o padrão) ou uma variável de dados. Selecione Texto
embutido ou Expressão na lista suspensa.
Texto embutido
Disponível apenas mediante a seleção de Texto embutido como Origem da entrada.
Especifica a instrução SQL genérica como texto embutido. Clique no campo Texto
embutido para abrir o editor de texto embutido, onde é possível inserir uma
instrução SQL literal.
Expressão
Disponível apenas mediante a seleção de Expressão como Origem da entrada.
Especifica a instrução SQL genérica como uma expressão. Use esse campo para
fornecer uma variável.
Parâmetros de entrada
Uma matriz de valores de entrada. Se a instrução SQL genérica especificada usar a
sintaxe de escape do JDBC e exigir parâmetros de entrada, eles podem ser
especificados aqui.
Parâmetros de saída
Consultar resultados
Retorna o número de linhas excluídas.
Motivo
Especifica o motivo, se houver falha no operador após a execução.
Capítulo 5: Bancos de dados 161
Operador Excluir do banco de dados
Resultado
Especifica o resultado de execution.InputSource do operador
InlineText
InputSourceExpression
JDBCInputParamArray
IsConstructSQLStatement
CompleteSQLStatement
DataSource
SelectionCriteria
UserName
Senha
DatabaseType
OtherDatabaseType
DriverName
DatabaseName
CacheBufferSize
BatchPerfWorkaround
ConnectionProtocol
ServerType
DriverType
ServiceID
TNSName
ClientEncryption
ClientChecksum
InstanceName
HypersonicDatabaseType
ServerHost
ServerPort
ConnectionString
162 Referência do Criador de Conteúdo
Operador Obter esquema de banco de dados
Operador Obter esquema de banco de dados
Use o operador Obter esquema de banco de dados para recuperar nomes de esquemas
no banco de dados.
Parâmetros de entrada
Os parâmetros de Logon do servidor de banco de dados (na página 154) são necessários
para esse operador.
Parâmetros de saída
UserName
Senha
DatabaseType
OtherDatabaseType
DriverName
DatabaseName
CacheBufferSize
BatchPerfWorkaround
ConnectionProtocol
ServerType
DriverType
ServiceID
TNSName
ClientEncryption
ClientChecksum
InstanceName
HypersonicDatabaseType
ServerHost
ServerPort
ConnectionString
Capítulo 5: Bancos de dados 163
Operador Obter espaço livre
Operador Obter espaço livre
Use o operador Obter espaço livre para retornar o espaço livre (em MB) disponível no
banco de dados.
Parâmetros de entrada
Nome do esquema
Especifica o nome do esquema cujo espaço livre deve ser calculado.
Parâmetros de saída
Consultar resultados
Retorna o espaço livre (em MB).
Motivo
Especifica o motivo, caso haja falha do operador após a execução.
164 Referência do Criador de Conteúdo
Operador Obter o procedimento armazenado
Resultado
Especifica o resultado da execução do operador.
SchemaName
UserName
Senha
DatabaseType
OtherDatabaseType
DriverName
DatabaseName
CacheBufferSize
BatchPerfWorkaround
ConnectionProtocol
ServerType
DriverType
ServiceID
TNSName
ClientEncryption
ClientChecksum
InstanceName
HypersonicDatabaseType
ServerHost
ServerPort
ConnectionString
Quando os parâmetros de entrada necessários são fornecidos, ConnectionString é
automaticamente criado.
Operador Obter o procedimento armazenado
Use o operador Obter o procedimento armazenado para retornar os nomes de
procedimentos armazenados disponíveis no banco de dados.
Capítulo 5: Bancos de dados 165
Operador Obter o procedimento armazenado
Parâmetros de entrada
Nome do catálogo
Deve corresponder ao nome do catálogo conforme armazenado no banco de dados.
Os valores "" e nulo indicam que o nome do catálogo não deve ser usado para
limitar a pesquisa.
Padrão de esquema
Deve corresponder ao nome do esquema conforme armazenado no banco de
dados. Os valores "" e nulo indicam que o nome do esquema não deve ser usado
para limitar a pesquisa. O padrão deve ser uma expressão regular.
Padrão do nome do procedimento
Deve corresponder ao nome do procedimento conforme armazenado no banco de
dados. O padrão deve ser uma expressão regular com suporte em banco de dados.
Parâmetros de saída
Consultar resultados
Retorna uma matriz na qual cada linha é um nome de procedimento.
Motivo
Especifica o motivo, caso haja falha do operador após a execução.
166 Referência do Criador de Conteúdo
Operador Obter tabela
Resultado
Especifica o resultado do operador executado.
CatalogName
SchemaPattern
TableNamePattern
UserName
Senha
DatabaseType
OtherDatabaseType
DriverName
DatabaseName
CacheBufferSize
BatchPerfWorkaround
ConnectionProtocol
ServerTypeDriverType
ServiceID
TNSName
ClientEncryption
ClientChecksum
InstanceName
HypersonicDatabaseType
ServerHost
ServerPort
ConnectionString
Operador Obter tabela
Use o operador Obter tabela para retornar a lista de tabelas do banco de dados.
Capítulo 5: Bancos de dados 167
Operador Obter tabela
Parâmetros de entrada
Nome do catálogo
O nome do catálogo deve corresponder ao nome do catálogo conforme
armazenado no banco de dados. Os valores "" e nulo indicam que o nome do
catálogo não deve ser usado para limitar a pesquisa.
Padrão de esquema
O padrão do esquema deve corresponder ao nome do esquema conforme
armazenado no banco de dados. Os valores "" e nulo indicam que o nome do
esquema não deve ser usado para limitar a pesquisa. O padrão deve ser uma
expressão regular.
Padrão de nome de tabela
O padrão do nome da tabela deve corresponder ao nome da tabela conforme
armazenado no banco de dados. O padrão deve ser uma expressão regular com
suporte em banco de dados.
Parâmetros de saída
Consultar resultados
Retorna uma matriz em que cada linha é um nome de tabela.
Motivo
Especifica o motivo, caso haja falha do operador após a execução.
168 Referência do Criador de Conteúdo
Operador Obter o espaço usado
Resultado
Especifica o resultado do operador executado.
CatalogName
SchemaPattern
TableNamePattern
UserName
Senha
DatabaseType
OtherDatabaseType
DriverName
DatabaseName
CacheBufferSize
BatchPerfWorkaround
ConnectionProtocol
ServerType
DriverType
ServiceID
TNSName
ClientEncryption
ClientChecksum
InstanceName
HypersonicDatabaseType
ServerHost
ServerPort
ConnectionString
Operador Obter o espaço usado
Esse operador Obter o espaço usado retorna o espaço usado (em MB) no banco de
dados.
Capítulo 5: Bancos de dados 169
Operador Obter o espaço usado
Parâmetros de entrada
Nome do esquema
Especifica o nome do esquema para o qual a operação deve retornar o espaço
usado.
Parâmetros de saída
Consultar resultados
Retorna o espaço livre (em MB).
Motivo
Especifica o motivo, caso haja falha do operador após a execução.
170 Referência do Criador de Conteúdo
Operador Obter versão
Resultado
Especifica o resultado da execução do operador.
SchemaName
UserName
Senha
DatabaseType
OtherDatabaseType
DriverName
DatabaseName
CacheBufferSize
BatchPerfWorkaround
ConnectionProtocol
ServerType
DriverType
ServiceID
TNSName
ClientEncryption
ClientChecksum
InstanceName
HypersonicDatabaseType
ServerHost
ServerPort
ConnectionString
Operador Obter versão
Use o operador Obter Versão para retornar o nome e o número de versão do banco de
dados.
Capítulo 5: Bancos de dados 171
Operador Obter exibição
Parâmetros de entrada
Os parâmetros de Logon do servidor de banco de dados (na página 154) são necessários
para esse operador.
Parâmetros de saída
UserName
Senha
DatabaseType
OtherDatabaseType
DriverName
DatabaseName
CacheBufferSize
BatchPerfWorkaround
ConnectionProtocol
ServerType
DriverType
ServiceID
TNSName
ClientEncryption
ClientChecksum
InstanceName
HypersonicDatabaseType
ServerHost
ServerPort
ConnectionString
Operador Obter exibição
Use o operador Obter exibição para retornar uma lista de exibições do banco de dados.
172 Referência do Criador de Conteúdo
Operador Obter exibição
Parâmetros de entrada
Nome do catálogo
O nome do catálogo deve corresponder ao nome do catálogo conforme
armazenado no banco de dados. Os valores "" e nulo indicam que o nome do
catálogo não deve ser usado para limitar a pesquisa.
Padrão de esquema
O padrão do esquema deve corresponder ao nome do esquema conforme
armazenado no banco de dados. Os valores "" e nulo indicam que o nome do
esquema não deve ser usado para limitar a pesquisa. O padrão deve ser uma
expressão regular.
Padrão do nome da exibição
O padrão do nome da exibição deve corresponder ao nome da exibição conforme
armazenado no banco de dados. O padrão deve ser uma expressão regular.
Parâmetros de saída
Consultar resultados
Retorna uma matriz em que cada linha é um nome de exibição.
Motivo
Especifica o motivo, caso haja falha do operador após a execução.
Capítulo 5: Bancos de dados 173
Operador Inserir no banco de dados
Resultado
Especifica o resultado do operador executado.
CatalogName
SchemaPattern
TableNamePattern
UserName
Senha
DatabaseType
OtherDatabaseType
DriverName
DatabaseName
CacheBufferSize
BatchPerfWorkaround
ConnectionProtocol
ServerType
DriverType
ServiceID
TNSName
ClientEncryption
ClientChecksum
InstanceName
HypersonicDatabaseType
ServerHost
ServerPort
ConnectionString
Operador Inserir no banco de dados
Use o operador Inserir no banco de dados para inserir uma nova linha em uma tabela.
174 Referência do Criador de Conteúdo
Operador Inserir no banco de dados
Parâmetros de entrada
Origem da entrada
Especifica que o usuário pode optar por enviar uma expressão SQL como uma
expressão embutida (o padrão) ou uma variável de dados. Selecione Texto
embutido ou Expressão na lista suspensa.
Texto embutido
Disponível apenas mediante a seleção de Texto embutido como origem da entrada.
Especifica a instrução SQL genérica como texto embutido. Clique no campo Texto
embutido para abrir o editor de texto embutido, onde é possível inserir uma
instrução SQL literal.
Expressão
Disponível apenas mediante a seleção de Expressão como origem da entrada.
Especifica a instrução SQL genérica como uma expressão. Use esse campo para
fornecer uma variável.
Parâmetros de entrada
Uma matriz de valores de entrada. Se a instrução SQL genérica especificada usar a
sintaxe de escape do JDBC e exigir parâmetros de entrada, eles podem ser
especificados aqui.
Parâmetros de saída
Consultar resultados
Retorna o número de linhas inseridas em uma tabela.
Motivo
Especifica o motivo, caso haja falha do operador após a execução.
Capítulo 5: Bancos de dados 175
Operador Inserir no banco de dados
Resultado
Especifica o resultado do operador executado.
InputSource
InlineText
InputSourceExpression
JDBCInputParamArray
IsConstructSQLStatement
CompleteSQLStatement
DataSource
ColumnNameMode
ColumnNames
ColumnNameAsArray
ColumnValueMode
ColumnValues
ColumnValueAsArray
UserName
Senha
DatabaseType
OtherDatabaseType
DriverName
DatabaseName
CacheBufferSize
BatchPerfWorkaround
ConnectionProtocol
ServerType
DriverType
ServiceID
TNSName
ClientEncryption
ClientChecksum
InstanceName
HypersonicDatabaseType
ServerHost
176 Referência do Criador de Conteúdo
Operador Consultar o banco de dados
ServerPort
ConnectionString
Operador Consultar o banco de dados
Use esse o operador Consultar o banco de dados para emitir uma única instrução SQL
em relação ao banco de dados. Esse operador oferece suporte à sintaxe de escape JDBC.
O operador Consultar o banco de dados usa CallableStatement e ParameterMetaData
para coletar informações sobre os parâmetros de entrada e saída antes e depois da
execução da instrução. Se o driver do JDBC não oferecer suporte a esse
comportamento, o operador SQL genérico pode não ser capaz de reunir todos os
resultados das instruções SQL. Além disso, o driver do JDBC entregue pelo fornecedor
do banco de dados pode não oferecer suporte ao uso de todos os tipos de dados com o
driver do JDBC. Por exemplo, o driver do JDBC do SQL Server não oferece suporte ao
tipo de dados sql_variant do SQL Server. Consulte sempre a documentação do driver do
JDBC para obter mais informações sobre quais recursos e tipos de dados são suportados
pelo driver.
Parâmetros de entrada
Origem da entrada
Especifica que o usuário pode optar por enviar a instrução SQL como uma variável
de dados ou uma expressão embutida (o padrão). Selecione Texto embutido ou
Expressão na lista suspensa.
Texto embutido
Disponível apenas mediante a seleção de Texto embutido como Origem da entrada.
Especifica a instrução SQL genérica como texto embutido.
Clique no campo Texto embutido para abrir o editor de texto embutido, onde é
possível inserir uma instrução SQL literal.
Expressão
Disponível apenas mediante a seleção de Expressão como Origem da entrada.
Especifica a instrução SQL genérica como uma expressão. Use esse campo para
fornecer uma variável.
Máximo de linhas a serem recuperadas
Especifica o número máximo de linhas a serem recuperadas. Se essa opção for
deixada em branco, o valor padrão é 10 linhas. O Operador SQL genérico recupera
no máximo 512 linhas. Linhas adicionais serão truncadas.
Capítulo 5: Bancos de dados 177
Operador Consultar o banco de dados
Parâmetros de entrada
Uma matriz de valores de entrada. Se a instrução SQL genérica especificada usar a
sintaxe de escape do JDBC e exigir parâmetros de entrada, eles podem ser
especificados aqui.
Exibir valores nulos
Se marcada, os resultados do Operador SQL genérico irão conter o campo
NullFieldFlags. Se a instrução SQL genérica retornar resultados, esse campo pode
ser usado para distinguir os valores nulos dos valores padrão.
Por exemplo, a consulta de uma coluna de números inteiros que contém um valor
nulo retorna 0. O valor NullFieldFlags para essa coluna seria True. No entanto, se a
tabela realmente armazenasse o valor 0, o valor NullFieldFlags seria False.
Parâmetros de saída
ResultsSets
Uma matriz de Mapas de valores indexados, em que cada item contém os
resultados de uma consulta. O tamanho de ResultsSets corresponde ao número de
conjuntos de resultados retornados pela instrução SQL. Cada Mapa de valores
contém os seguintes campos:
Linhas
Uma matriz de Mapas de valores que representam as linhas do conjunto de
resultados. Cada Mapa de valores contém um campo para cada coluna e o
valor da coluna nessa linha específica.
NullFieldFlags
Uma matriz de mapas de valores. Os campos de cada Mapa de valores
correspondem aos campos nas linhas. O valor de cada campo é True. O valor
correspondente nas linhas é Null ou False. A saída é exibida somente se Exibir
valores nulos estiver selecionado.
UpdatedRowCounters
Uma matriz de inteiros que representa o número de linhas atualizadas pela
instrução SQL genérica. Se a instrução SQL genérica executar várias atualizações,
esse valor conterá diversos valores.
RowCount
(Reprovado) Retorna a contagem de linhas para as instruções DML (Linguagem de
manipulações de dados) do SQL ou o número de linhas no primeiro conjunto de
resultados em ResultSets. Se a instrução SQL genérica não executar nenhuma
atualização e não retornar conjuntos de resultados, esse valor será definido como
-1. Esse campo é incluído para a compatibilidade com versões anteriores.
178 Referência do Criador de Conteúdo
Operador Consultar o banco de dados
OutputParam
O valor do parâmetro de saída para a instrução SQL genérica. Se a instrução SQL
genérica não retornou nenhum parâmetro de saída, então esse campo não será
incluído nos resultados do Operador. Os campos outputParam são numerados; por
exemplo: outputParam1, outputParam2.
isNullOutputParam
Um valor booleano que indica se o valor OutputParam correspondente é nulo. Esse
campo só será exibido se a instrução SQL genérica retornar um parâmetro de saída
e Exibir os valores nulos estiver selecionado.
Motivo
Especifica o motivo, caso haja falha do operador após a execução.
Resultado
Especifica o resultado do operador executado.
Capítulo 5: Bancos de dados 179
Operador Consultar o banco de dados
InputSource
InlineText
InputSourceExpression
MaximumRows
JDBCInputParamArray
JDBCReportNull
UserName
Senha
DatabaseType
OtherDatabaseType
DriverName
DatabaseName
CacheBufferSize
BatchPerfWorkaround
ConnectionProtocol
ServerType
DriverType
ServiceID
TNSName
ClientEncryption
ClientChecksum
InstanceName
HypersonicDatabaseType
ServerHost
ServerPort
ConnectionString
180 Referência do Criador de Conteúdo
Operador Consultar o banco de dados
Executar um procedimento armazenado
Para executar um procedimento armazenado em um banco de dados, use o operador
Consultar banco de dados.
Esse exemplo usa o driver de SQL Server que o CA Process Automation fornece durante
a instalação. Para executar o processo com relação a outro banco de dados, carregue o
driver do JDBC correspondente na paleta Gerenciar recursos do Usuário na guia
Configuração. O CA Process Automation poderá acessar o driver quando você reiniciar o
serviço do orquestrador. Para obter mais informações, consulte o Guia do administrador
de conteúdo.
É possível criar esse exemplo do SQL Server Management Studio no banco de dados
PAMReporting. PAMReporting é o nome do banco de dados que é fornecido com as
tabelas de relatório do CA Process Automation durante a instalação. É possível usar um
nome diferente. Também pode usar qualquer banco de dados de sua preferência.
Capítulo 5: Bancos de dados 181
Operador Consultar o banco de dados
Siga estas etapas:
1.
Crie um procedimento armazenado que contenha o seguinte corpo:
USE PAMReporting
GO
-- ================================================
-- Modelo gerado a partir do Explorador de modelos usando:
-- Criar procedimento (menu Novo).SQL
--- Usar o comando Especifique valores para os parâmetros de modelo
-- (Ctrl-Shift-M) para preencher os valores do
-- parâmetro a seguir.
-- Este bloco de comentários não será incluído na
-- definição do procedimento.
-- ================================================
SET ANSI_NULLS ON
GO
SET QUOTED_IDENTIFIER ON
GO
CREATE PROCEDURE sp_getSOAPRows
-- Adicionar os parâmetros para o procedimento armazenado aqui
AS
BEGIN
-- SET NOCOUNT ON adicionado para evitar que conjuntos de resultados extras
-- interfiram em instruções SELECT.
-- SET NOCOUNT ON;
-- Inserir instruções de procedimento aqui
select count(*) from SOAPClientCall;
END
GO
2.
O procedimento retorna o número de linhas em uma tabela que foi chamada como
SOAPClientCall.
3.
Clique em Analisar no SQL Server Management Studio.
4.
Clique em Executar no SQL Server Management Studio.
O CA Process Automation salva o novo procedimento armazenado no banco de
dados PAMReporting.
5.
Crie um processo com o operador Consultar banco de dados e, em seguida, digite a
seguinte linha no texto embutido para o operador:
EXECUTE sp_getSOAPRows
6.
Nos parâmetros de Logon do servidor de banco de dados (na página 154), digite os
detalhes relevantes que o CA Process Automation requer para se comunicar com o
seu banco de dados.
7.
Salve o processo.
182 Referência do Criador de Conteúdo
Operador Selecionar do banco de dados
8.
Executar o processo.
9.
Abra o conjunto de dados do operador.
O número de linhas que o procedimento retorna é exibido como resultado do
processo.
Observação: o resultado varia de acordo com o número de linhas na tabela
SOAPClientCall.
Operador Selecionar do banco de dados
Use o operador Selecionar do banco de dados para recuperar seletivamente os dados de
uma ou mais origens de dados com os critérios de seleção opcionais.
Parâmetros de entrada
Origem da entrada
Especifica que o usuário pode optar por enviar a instrução SQL como uma variável
de dados ou uma expressão embutida (o padrão). Selecione Texto embutido ou
Expressão na lista suspensa.
Texto embutido
Disponível apenas mediante a seleção de Texto embutido como Origem da entrada.
Especifica a instrução SQL genérica como texto embutido. Clique no campo Texto
embutido para abrir o editor de texto embutido, onde é possível inserir uma
instrução SQL literal.
Expressão
Disponível apenas mediante a seleção de Expressão como Origem da entrada.
Especifica a instrução SQL genérica como uma expressão. Use esse campo para
fornecer uma variável.
Máximo de linhas a serem recuperadas
Especifica o número máximo de linhas a serem recuperadas pela instrução de
seleção. Esse parâmetro substitui o conjunto de propriedades no nível de categoria
d operador.
Parâmetros de entrada
Uma matriz de valores de entrada. Se a instrução SQL genérica especificada usar a
sintaxe de escape do JDBC e exigir parâmetros de entrada, eles podem ser
especificados aqui.
Capítulo 5: Bancos de dados 183
Operador Selecionar do banco de dados
Exibir valores nulos
Se marcada, os resultados do Operador SQL genérico irão conter o campo
NullFieldFlags. Se a instrução SQL genérica retornar resultados, esse campo pode
ser usado para distinguir os valores nulos dos valores padrão.
Por exemplo, a consulta de uma coluna de números inteiros que contém um valor
nulo retorna 0. O valor NullFieldFlags para essa coluna seria True. No entanto, se a
tabela realmente armazenasse o valor 0, o valor NullFieldFlags seria False.
184 Referência do Criador de Conteúdo
Operador Selecionar do banco de dados
Parâmetros de saída
Resultados da consulta
Uma matriz de mapas de valores que representam as linhas do conjunto de
resultados. Cada mapa de valores contém um campo para cada coluna e o valor da
coluna nessa linha específica.
NullFieldFlags
Uma matriz de mapas de valores. Os campos de cada mapa de valores
correspondem aos campos nas linhas. O valor de cada campo é Verdadeiro (o valor
correspondente em linhas é null) ou Falso (o campo correspondente não é null). A
saída é exibida somente se Exibir valores nulos estiver selecionado.
InputSource
InlineText
InputSourceExpression
MaximumRows
JDBCInputParamArray
JDBCReportNull
IsConstructSQLStatement
CompleteSQLStatement
ReturnValueMode ReturnValues
ReturnValuesAsArray
DataSourceMode
DataSources
DataSourcesAsArray
SelectionCriteria
SortCriteriaMode
SortCriteria
SortCriteriaAsArray
Senha do UserName
DatabaseType
OtherDatabaseType
DriverName
DatabaseName
CacheBufferSize
BatchPerfWorkaround
Capítulo 5: Bancos de dados 185
Operador Atualizar no banco de dados
ConnectionProtocol
ServerType
DriverType
ServiceID
TNSName
ClientEncryption
ClientChecksum
InstanceName
HypersonicDatabaseType
ServerHost
ServerPort
ConnectionString
Operador Atualizar no banco de dados
Use o operador Atualizar no banco de dados para atualizar os registros em uma tabela.
Parâmetros de entrada
Origem da entrada
Especifica que o usuário pode optar por enviar uma expressão SQL como uma
expressão embutida (o padrão) ou uma variável de dados. Selecione Texto
embutido ou Expressão na lista suspensa.
Texto embutido
Disponível apenas mediante a seleção de Texto embutido como Origem da entrada.
Especifica a instrução SQL genérica como texto embutido. Clique no campo Texto
embutido para abrir o editor de texto embutido, onde é possível inserir uma
instrução SQL literal.
186 Referência do Criador de Conteúdo
Operador Atualizar no banco de dados
Expressão
Disponível apenas mediante a seleção de Expressão como Origem da entrada.
Especifica a instrução SQL genérica como uma expressão. Use esse campo para
fornecer uma variável.
Parâmetros de entrada
Uma matriz de valores de entrada. Se a instrução SQL genérica especificada usar a
sintaxe de escape do JDBC e exigir parâmetros de entrada, eles podem ser
especificados aqui.
Parâmetros de saída
Consultar resultados
Retorna o número de linhas atualizadas.
Motivo
Especifica o motivo, caso haja falha do operador após a execução.
Resultado
Especifica o resultado do operador executado.
InputSource
InlineText
InputSourceExpression
JDBCInputParamArray
IsConstructSQLStatement
CompleteSQLStatement
FieldValueModeArray
FieldValueModeC2OValueMap
DataSource
FieldsValues
FieldsAsArray
ValuesAsArray
FieldValueMap
SelectionCriteria
UserName
Senha
Capítulo 5: Bancos de dados 187
Operador Atualizar no banco de dados
DatabaseType
OtherDatabaseType
DriverName
DatabaseName
CacheBufferSize
BatchPerfWorkaround
ConnectionProtocol
ServerType
DriverType
ServiceID
TNSName
ClientEncryption
ClientChecksum
InstanceName
HypersonicDatabaseType
ServerHost
ServerPort
ConnectionString
188 Referência do Criador de Conteúdo
Capítulo 6: Data e hora
Os operadores Data e hora executam as restrições de hora e calendário em processos.
Todos os operadores desse grupo só podem ser executados em um orquestrador.
Operador Verificar o calendário
O operador Verificar calendário determina se uma data está dentro de um conjunto de
regras de calendário.
Parâmetros de entrada
Calendário de datas de permissão
Especifica o caminho completo do calendário. Essa expressão define que as datas
permitidas para as ramificações subsequentes no processo a ser processado.
Clique
para localizar um objeto Calendário. Depois de selecionar um calendário,
clique em Abrir para abrir o objeto de calendário no criador de calendários.
Capítulo 6: Data e hora 189
Operador Verificar o calendário
Calendário de datas de exclusão
Especifica o caminho completo do calendário usado para definir os dias excluídos.
Dias excluídos são aqueles nos quais as ramificações subsequentes no processo não
podem ser processadas.
Não há dias excluídos quando nenhum calendário é especificado.
Clique
para localizar um objeto Calendário. Depois de selecionar um calendário,
clique em Abrir para abrir o objeto de calendário no criador de calendários.
Delta
Especifica o número de dias que uma data permitida é alternada quando incidir em
uma data excluída.
O deslocamento depende de o valor ser positivo, negativo ou zero. Um valor
negativo alterna avançando (mais cedo) e um positivo alterna regredindo (mais
tarde). Quando esse valor for zero, a data permitida é ignorada.
Apenas dias em aberto
Conta apenas os dias em aberto ao deslocar uma data elegível que incide em uma
data excluída.
Os Dias em aberto são os que não foram especificados por uma condição ou regra
que fecha ou exclui as datas.
Máximo de alternâncias
Essa opção define o número máximo de deslocamentos permitidos, se
deslocamentos subsequentes caírem em uma data fechada.
Essa configuração é relevante somente se Apenas dias em aberto estiver
selecionada.
Data
Especifica a data para testar as regras de calendário.
Clique no ícone do calendário para selecionar uma data. Essa opção não está
disponível se você marcar a caixa de seleção Usar data atual ou Usar data calculada.
Usar data atual
Especifica para usar a data atual para testar as regras de calendário.
Desmarque essa caixa de seleção para especificar uma data específica no campo
Data. Essa caixa de seleção é inicialmente marcada.
Usar data calculada
Especifica a utilização da data no campo Data calculada.
Data calculada
Se Usar data calculada for selecionado, esse parâmetro especifica uma expressão
que retorna uma data. Em geral, esta opção é usada para calcular uma data futura
com base na data atual.
190 Referência do Criador de Conteúdo
Operador Verificar data e hora
Parâmetros de saída
CalenderDate
VacationsDate
Delta
OpenDays
MaxShifts
Data
UseCurrentDate
UseCalculatedDate
CalculatedDate
Operador Verificar data e hora
O operador Verificar data e hora executa condicionalmente as ramificações de um
processo, dependendo de uma data e hora especificadas terem passado. O operador
Verificar data e hora coloca uma condição de verificação de data e hora em um
processo.
Uma condição de verificação de data e hora permite que o processamento continue
para ramificações subsequentes em um processo, antes e depois da data especificada
nas propriedades do operador. O operador pode ser usado para impor condições de
data e hora em diversos segmentos de processos que são executados várias vezes por
dia. Com essa configuração, é possível adicionar links extras no operador para
especificar as ramificações que devem ser processadas antes (<) ou após (>) uma data e
hora.
Em contrapartida, quando a caixa de seleção Aguardar data e hora especificadas for
inicialmente selecionada, o operador criará uma condição de espera de data/hora.
Dessa forma, o operador somente processará os links extras após (>) e irá ignorar
qualquer link antes (<).
Capítulo 6: Data e hora 191
Operador Verificar data e hora
Parâmetros de entrada
Data
Especifica a data em que deve ser determinada a elegibilidade para processar
ramificações subsequentes no processo.
Clique no ícone do calendário para abrir o calendário e selecionar uma data. Essa
opção não está disponível se você marcar a caixa de seleção Usar data atual ou Usar
data calculada.
Usar data atual
Especifica a data em que o processo é executado, para determinar a eligibilidade
para processar ramificações subsequentes no processo.
Desmarque essa caixa de seleção para especificar uma data específica no campo
Data. Essa caixa de seleção é inicialmente marcada.
Usar data calculada
Retorna uma data. Essa expressão permite usar as funções e variáveis de data do
CA Process Automation para retornar uma data.
Data calculada
Se Usar data calculada for selecionado, esse parâmetro especifica uma expressão
que retorna uma data. Em geral, esta opção é usada para calcular uma data futura
com base na data atual.
Tempo
Especifica um período no formato de 12 horas HH:MM PM/AM.
Por exemplo: 07:30 PM
Aguardar data e hora especificadas
Cria uma condição de espera de data e hora. Essa propriedade atrasa o
processamento de operadores subsequentes em uma ramificação do processo até a
hora especificada. Apenas os links de saída designados para ocorrer após (>) da
hora especificada são processados.
Desmarque essa caixa de seleção para desviar o processamento para ramificações
diferentes antes ou depois da data e hora especificadas. O operador impõe as
seguintes condições quando a caixa de seleção Aguardar data e hora especificadas é
desmarcada:
Se a data e a hora especificadas ocorrerem no futuro, apenas os links de saída
especificados para serem processados antes (<) serão processados.
192 Referência do Criador de Conteúdo
Operador Verificar data e hora
Parâmetros de saída
Data
UseCurrentDate
UseCalculatedDate
CalculatedDate
Tempo
WaitForSpecifiedDate
Capítulo 6: Data e hora 193
Capítulo 7: Serviços de diretório
Os operadores Directory Services oferecem uma interface para suporte a LDAP
(Lightweight Directory Access Protocol). Você pode automatizar as operações que são
executadas em servidores LDAP. Todos esses operadores funcionam com diferentes
servidores LDAP, exceto os operadores específicos do Active Directory. Os operadores
Serviços de diretório são executados em um orquestrador ou agente do CA Process
Automation com os mesmos resultados, seja qual for a plataforma do sistema
operacional em que o CA Process Automation estiver sendo executado.
Parâmetros de logon do LDAP
Os campos padrão do LDAP especificados no nível de categoria Serviços de diretório
podem ser substituídos na página Parâmetros de logon LDAP. Esta página é parte da
entrada para cada operador Serviços de diretório. Se um campo contiver um valor, ele
substituirá o valor especificado para o mesmo campo no nível de configuração de
categoria.
Host LDAP remoto
Especifica o IP ou URL do servidor LDAP.
Porta do servidor LDAP remoto
Especifica a porta do servidor LDAP.
Usuário LDAP
Especifica se o usuário LDAP que tem acesso ao servidor LDAP consegue efetuar
logon. No entanto, as operações que podem ser executadas por esse usuário são
limitadas pelos ACIs definidos nas entradas LDAP.
Senha LDAP do usuário
Especifica a senha para o usuário LDAP.
DN de base
Especifica o nome distinto de base (DN) a ser usado. Este é o DN base onde o
Usuário LDAP fica armazenado.
Prefixo de usuário
Especifica o prefixo de usuário a ser usada, que pode ser uid ou cn.
Capítulo 7: Serviços de diretório 195
Operador Adicionar computador ao domínio
Operador Adicionar computador ao domínio
O operador Adicionar computador ao domínio cria um novo objeto de computador no
servidor Active Directory. Esse operador se aplica somente a um servidor Active
Directory.
Parâmetros de entrada
Caminho do computador
Especifica o nome distinto do objeto no qual você deseja criar o novo objeto de
computador.
Nome do computador
Especifica o nome do novo objeto computador.
Parâmetros de saída
LDAPADComputerBaseDn
LDAPADComputerName
remoteLDAPHost
remoteLDAPPort
remoteLDAPUser
remoteLDAPPassword
LDAPBaseDN
LDAPUserPrefix
Exemplo:
196 Referência do Criador de Conteúdo
Operador Adicionar usuário ao grupo
Adicionar o atributo LDAP ao nome do novo objeto de computador. Normalmente, os
objetos de computador usam o atributo "cn" como parte do RDN (nome relativo
distinto) do nome do computador.
Falha do operador
Este operador falhará nos seguintes casos:
■
O nome do novo objeto de computador já está sendo usado.
■
Alguns dos atributos obrigatórios necessários para criar o novo objeto de
computador estão ausentes
■
O caminho no qual o objeto de computador deve ser criado, é inválido.
■
Não é possível se conectar ao servidor Active Directory.
Operador Adicionar usuário ao grupo
O operador Adicionar usuário ao grupo adiciona um usuário LDAP a um grupo LDAP no
servidor LDAP.
Parâmetros de entrada
DN do usuário
Especifica o nome distinto do usuário que você deseja adicionar ao grupo.
DN do grupo
Especifica o nome distinto do grupo ao qual você deseja adicionar o usuário.
Capítulo 7: Serviços de diretório 197
Operador Adicionar usuário ao grupo
Parâmetros de saída
LDAPUserDn
LDAPGroupDn
remoteLDAPHost
remoteLDAPPort
remoteLDAPUser
remoteLDAPPassword
LDAPBaseDN
LDAPUserPrefix
Exemplo:
Falha do operador
Este operador falhará nos seguintes casos:
■
O usuário já é um membro do grupo.
■
O grupo não existe no servidor LDAP.
■
O grupo DN aponta para um objeto LDAP que não é do tipo grupo, groupofnames
ou groupofuniquenames.
■
Falha ao se conectar ao servidor do LDAP.
198 Referência do Criador de Conteúdo
Operador Criar grupo
Operador Criar grupo
O operador Criar grupo cria um objeto de grupo LDAP no servidor LDAP. Este objeto de
grupo pode ser do tipo: grupo, grupo de nomes ou grupo de nomes exclusivos.
Parâmetros de entrada
Caminho do grupo
Especifica o nome distinto do objeto no qual você deseja criar o novo objeto de
grupo.
Nome do grupo
Especifica o nome do grupo que você deseja criar. Este é o atributo CN do grupo.
Tipo de grupo LDAP
Especifica o tipo de grupo LDAP. Selecione grupo, grupo de nomes ou grupo de
nomes exclusivos.
Use o campo da matriz especificada para os membros do grupo
Se esta opção estiver selecionada, a matriz de integrantes é usada para esta
solicitação.
Matriz de membros do grupo LDAP
Especifica a matriz de membros do grupo (obrigatório para o grupo de nomes ou
grupo de nomes exclusivos no Active Directory). Esse campo é ativado somente
quando o campo Usar matriz especificada para o campo Membros de grupo estiver
selecionado.
Membros do grupo LDAP
Especifica os membros do grupo (obrigatório para o grupo de nomes ou grupo de
nomes exclusivos no Active Directory). Esse campo é ativado somente quando o
campo Usar a matriz especificada para campo Membros do grupo não estiver
selecionado.
Criando um objeto do tipo 'Grupo' no Active Directory?
Verifique se estamos criando um objeto do tipo 'Grupo', conforme especificado no
tipo de grupo LDAP, em um servidor Active Directory. Para um objeto Grupo no
Active Directory, é possível definir dois atributos adicionais: Escopo do grupo e Tipo
de grupo.
Capítulo 7: Serviços de diretório 199
Operador Criar grupo
Escopo do grupo do Active Directory
Especifica o escopo do grupo criado no Active Directory. Selecione domínio local,
global ou universal. Esse campo é ativado somente quando você marca a caixa de
seleção Criando um objeto do tipo 'Grupo' no Active Directory?
Tipo de grupo do Active Directory
Especifica o tipo de grupo criado no Active Directory. Selecione segurança ou
distribuição. Esse campo é habilitado somente quando a criação de um objeto do
tipo 'Grupo' no campo Active Directory? está marcado.
Observações
■
O Active Directory não permite que um grupo de escopo Universal seja do tipo
Segurança. Nesse caso, a operação falhará.
■
Os valores especificados nos campos Escopo do grupo do Active Directory e Tipo de
grupo do Active Directory são ignorados quando o campo Tipo de grupo LDAP não
está definido com o valor Grupo.
■
Os campos Escopo do grupo do Active Directory e Tipo de grupo do Active Directory
não são ignorados quando Tipo de grupo LDAP não estiver definido com o valor
Grupo. Esses campos são ativados quando você marca a caixa de seleção Criando
um objeto do tipo Grupo no Active Directory (porque não é possível fazer seleções
múltiplas no CA Process Automation). O importante é que os valores desses campos
só são relevantes quando você cria um Group no Active Directory. Na UI, eles
podem ainda estar ativos, mas no back-end eles são ignorados em todos os outros
casos.
200 Referência do Criador de Conteúdo
Operador Criar grupo
Parâmetros de saída
LDAPGroupBaseDn
LDAPGroupName
LDAPGroupType
LDAPGroupMembersType
LDAPGroupMembersArray
LDAPGroupMembers
LDAPIsADGroup
LDAPADGroupScope
LDAPADGroupType
remoteLDAPHost
remoteLDAPPort
remoteLDAPUser
remoteLDAPPassword
LDAPBaseDN
LDAPUserPrefix
Capítulo 7: Serviços de diretório 201
Operador Criar grupo
Exemplo:
Falha do operador
Este operador falhará nos seguintes casos:
■
O grupo já existe.
■
Alguns dos atributos obrigatórios necessários para criar o novo objeto do grupo
estão ausentes.
■
O caminho no qual o novo objeto de grupo será criado é inválido.
■
O servidor LDAP não oferece suporte ao tipo de grupo especificado: grupo,
groupofnames ou groupofuniquenames.
202 Referência do Criador de Conteúdo
Operador Criar objeto
■
O grupo é criado em um servidor Active Directory com um escopo 'Universal' e um
tipo 'Segurança'.
■
O objeto é criado como um 'Grupo de nomes' no Active Directory sem nenhum
membro definido na operação.
■
O objeto é criado como um 'Grupo de nomes exclusivos' no Active Directory sem
nenhum membro definido na operação.
■
Falha ao se conectar ao servidor do LDAP.
Operador Criar objeto
O operador Criar objeto cria um objeto LDAP de qualquer tipo no servidor LDAP.
Parâmetros de entrada
Caminho do objeto
Especifica o nome distinto do objeto no qual você deseja criar o novo objeto LDAP.
Nome do objeto
Especifica o nome do novo objeto LDAP.
Adicione o atributo LDAP ao o nome do novo objeto LDAP. O atributo pode ser
"ou", "CN", "UID", e assim por diante, e depende do tipo de objeto LDAP que está
sendo criado.
Use o campo de matriz especificada para a Caixa de seleção de Valores de atributos
"objectclass" do objeto
Se essa opção estiver selecionada, a Matriz de valores de atributos "objectclass"
será usada para esta solicitação.
Matriz de valores de atributos "objectclass" do objeto
Especifica a matriz que contêm os valores do atributo "objectclass". Este campo do
conjunto de dados deve ser definido como uma matriz (sequência de caracteres
indexada). Se Use o campo de matriz especificada para Valores de atributos de
"objectclass" do objeto estiver selecionado, este campo será usado.
Capítulo 7: Serviços de diretório 203
Operador Criar objeto
Valores de atributos "objectclass" do objeto
Especifica os valores do atributo "objectclass". Se o campo Use o campo da matriz
especificada para os Valores de atributos "objectclass" do objeto estiver
selecionado, este campo será usado.
O "objectclass" é o atributo LDAP que define o tipo do novo objeto.
Mapas do valor de atributos LDPA do objeto adicional
Esta é uma matriz de mapas de valor mapeia contendo atributos LDAP para serem
definidos para o novo objeto. Cada chave do mapa de valor deve ser do tipo
sequência de caracteres, o Valor deve ser do tipo sequência de caracteres ou uma
matriz de sequências de caracteres (sequência de caracteres indexada). A chave
deve ser nomeada como Chaves e o valor deve ser nomeado como Valores.
O usuário pode definir o campo Valores para ser do tipo sequência de caracteres,
de modo a criar atributos LDAP de valor único para o novo objeto LDAP que está
sendo criado. Por exemplo:
O objeto newObjAttributes é um mapa de valores indexados cujos campos de chave
são chamados de Chaves e são do tipo sequência de caracteres, enquanto os
campos de valor são chamados de Valores e são do tipo sequência de caracteres.
204 Referência do Criador de Conteúdo
Operador Criar objeto
Como alternativa, o usuário pode definir o campo Valores para ser do tipo matriz de
sequências de caracteres (sequência de caracteres indexada), de modo a criar
atributos LDAP com vários valores para o novo objeto LDAP que está sendo criado.
O objeto newObjAttributes2 é um mapa de valores indexados cujos campos de
chave são chamados de Chaves e são do tipo sequência de caracteres, enquanto os
campos de valor são chamados de Valores e são do tipo sequência de caracteres
indexada. Nesse caso, o usuário pode criar atributos LDAP de valor exclusivo e de
valores múltiplos para o novo objeto LDAP que está sendo criado.
Por exemplo:
Dentro do mesmo objeto newObjAttributes2, há um atributo telephoneNumber
com vários valores e também um atributo Description de valor único.
Observe que, se a mesma chave aparecer várias vezes no mapa de valores
indexado, somente o último valor associado à chave permanecerá.
Observe que os nomes de atributo inseridos nos Mapas de valores de atributos LDAP do
objeto adicional devem ser nomes LDAP desses atributos como especificado no
esquema do servidor LDAP. Por exemplo, para definir o valor do atributo "Sobrenome",
você deve usar LDAP do atributo:"sn", para definir o valor do atributo "Nome", você
deve usar o atributo givenName ", e assim por diante. Consulte o tópico "Nomes de
atributos comuns do LDAP (na página 231)".
Os nomes de LDAP são diferentes dos nomes de exibição dos atributos.
A maioria de servidores LDAP é diferente nos nomes de exibição dos atributos LDAP,
mas todos devem oferecer suporte aos nomes LDAP desses atributos, portanto o motivo
pelo qual nós exigimos o uso dos nomes de atributos LDAP em vez dos nomes de
exibição.
Capítulo 7: Serviços de diretório 205
Operador Criar objeto
Parâmetros de saída
LDAPCreateObjectBaseDn
LDAPCreateObjectName
LDAPCreateObjObjectClassUseArray
LDAPCreateObjObjectClassArray
LDAPCreateObjObjectClass
LDAPCreateObjectAttributes
remoteLDAPHost
remoteLDAPPort
remoteLDAPUser
remoteLDAPPassword
LDAPBaseDN
LDAPUserPrefix
Exemplo:
Neste exemplo, estamos criando uma unidade organizacional chamada Teste de
unidade. O atributo objectclass define o objeto com do tipo 'superior' e 'Unidade
Organizacional'. O tipo 'superior' é a raiz de todos os tipos de LDAP.
206 Referência do Criador de Conteúdo
Operador Criar objeto
Incluímos também atributos adicionais à nova unidade organizacional através do mapa
do valor indexado Process.newObjAttributes..
Falha do operador
Este operador falhará nos seguintes casos:
■
O nome do novo objeto LDAP já está sendo usado.
■
Alguns dos atributos obrigatórios necessários para criar o novo objeto LDAP estão
ausentes.
■
O "objectclass" do novo objeto LDAP está ausente ou incorreto.
■
Alguns dos atributos que estão sendo criados para o objeto contêm valores
inválidos.
■
Alguns dos atributos que estão sendo criados para o objeto não se aplicam a este
tipo de objeto, por exemplo, não é possível adicionar um atributo 'mail' para um
objeto LDAP do tipo unidade organizacional.
■
O caminho no qual o objeto LDAP será criado é inválido.
Capítulo 7: Serviços de diretório 207
Operador Criar unidade organizacional
■
O usuário selecionou que uma matriz de atributos seja usada para o atributo
"objectclass", mas o objeto do CA Process Automation inserido no campo de matriz,
na verdade, não é do tipo matriz (sequências de caracteres indexadas).
■
Falha ao se conectar ao servidor do LDAP.
Operador Criar unidade organizacional
O operador Criar unidade organizacional permite que um usuário crie um objeto LDAP
do tipo Unidade organizacional no servidor LDAP.
Parâmetros de entrada
Caminho da unidade organizacional
Especifica o nome distinto do objeto sob o qual deseja criar o novo objeto Unidade
organizacional.
Nome da unidade organizacional
Especifica o nome do novo objeto Unidade organizacional.
Parâmetros de saída
LDAPOrgUnitBaseDn
LDAPOrgUnitName
remoteLDAPHost
remoteLDAPPort
remoteLDAPUser
remoteLDAPPassword
LDAPBaseDN
LDAPUserPrefix
Exemplo:
208 Referência do Criador de Conteúdo
Operador Criar usuário
Exemplo:
Importante! Certifique-se de adicionar o atributo LDAP ao nome da nova unidade
organizacional. As unidades organizacionais geralmente usam o atributo "ou" como
parte do RDN (nome relativo distinto) do nome.
Falha do operador
Este operador falhará nos seguintes casos:
■
O nome da nova unidade organizacional já está sendo usado.
■
Alguns dos atributos obrigatórios necessários para criar a nova unidade
organizacional estão ausentes.
■
O caminho no qual a unidade organizacional será criada é inválido.
■
Falha ao se conectar ao servidor do LDAP.
Operador Criar usuário
O operador Criar usuário cria um objeto LDAP do tipo conta do usuário no servidor
LDAP.
Parâmetros de entrada
Caminho da conta de usuário
Especifica o nome distinto do objeto sob o qual deseja criar a nova conta de
usuário.
Nome
Especifica o nome do usuário.
Capítulo 7: Serviços de diretório 209
Operador Criar usuário
Iniciais do segundo nome
Especifica o segundo nome do usuário. Observe que o Active Directory não permite
iniciais do meio com mais de seis caracteres.
Sobrenome
Identifica o sobrenome do usuário.
ID do usuário
Especifica a ID de usuário do usuário.
Senha
Certifique-se de especificar uma senha que atenda aos Requisitos da diretiva de
senha definida no servidor LDAP, especialmente para um servidor Active Directory.
Active Directory?
Verifique se você está criando a nova conta de usuário em um servidor Active
Directory.
Criar a ID de usuário como nome de logon do usuário
Especifica se você deseja que a ID de usuário também seja o nome de logon do
usuário. Nesse caso, crie um nome de logon do usuário no formato "ID de usuário
@ domínio" em que domínio representa o domínio do Active Directory. Esse campo
só é habilitado quando o campo Active Directory? está marcado.
Ativar usuário?
Selecione Sim para tornar o novo usuário ativo ou não para criar o novo usuário
está inativo. Esse campo só é habilitado quando o campo Active Directory? está
marcado.
A senha expira para o usuário
Escolha se a senha do usuário expira de acordo com a diretiva de domínio ou nunca
expira. Esse campo só é habilitado quando o campo Active Directory? está marcado.
Quando a senha do usuário é definida para nunca expirar, o usuário não será
forçado a alterar a senha no primeiro logon.
210 Referência do Criador de Conteúdo
Operador Criar usuário
Alterar senha no primeiro logon?
Obriga o usuário a alterar a senha no primeiro logon, essa opção é aplicável apenas
quando a senha é escolhido para expirar. Observe que o usuário pode definir a
combinação de Senha NÃO expira e É necessário alteração de senha no primeiro
logon. Nesse caso, CA Process Automation define que a senha NÃO expira e ignora
a alteração de senha no primeiro logon. Esse campo só é habilitado quando o
campo Active Directory? está marcado.
O Active Directory não permitirá que a senha dos usuários seja modificada, a menos que
o CA Process Automation esteja conectado ao servidor Active Directory por meio de SSL.
Se o CA Process Automation não estiver conectado por meio de SSL, a conta de usuário
será criada sem uma senha e sem os controles da conta especificada (conta
ativada/desativada, expiração da senha, alteração de senha no logon) e a operação
falhará no CA Process Automation.
Consulte o tópico Adicionar um certificado SSL ao CA Process Automation (na
página 259) para saber como importar um certificado do Active Directory para o CA
Process Automation. Depois que o certificado for importado, será possível alterar as
propriedades do módulo LDAP para estabelecer uma conexão SSL com o servidor Active
Directory.
Capítulo 7: Serviços de diretório 211
Operador Criar usuário
Parâmetros de saída
LDAPUserBaseDn
LDAPUserFirstName
LDAPUserMiddleInits
LDAPUserLastName
LDAPUserId
LDAPUserPwd
LDAPIsAD
LDAPAsUserLogon
LDAPEnableUser
LDAPPwdExpire
LDAPForcePwdChg
remoteLDAPHost
remoteLDAPPort
remoteLDAPUser
remoteLDAPPassword
LDAPBaseDN
LDAPUserPrefix
212 Referência do Criador de Conteúdo
Operador Criar usuário
Exemplo:
Falha do operador
Este operador falhará nos seguintes casos:
■
O usuário já existe.
■
Alguns dos atributos obrigatórios necessários para criar a nova conta de usuário
estão ausentes.
■
O valor de um dos atributos usados para criar a conta de usuário é inválido.
■
O caminho no qual a nova conta de usuário será criada é inválido.
■
A nova conta de usuário é criada em um servidor do Active Directory e não é
conectada por meio de SSL.
Capítulo 7: Serviços de diretório 213
Operador Excluir objeto
■
Falha ao se conectar ao servidor do LDAP.
■
Você especificou a senha de um usuário que não está em conformidade com os
Requisitos da diretiva de senhas definidos em seu servidor LDAP, especialmente se
for para um Active Directory. Nesse caso, o Active Directory retorna uma
mensagem de erro genérica: WILL_NOT_PERFORM para indicar que não é possível
executar a operação.
Operador Excluir objeto
O operador Excluir objeto exclui um ou vários objetos LDAP do servidor LDAP.
Parâmetros de entrada
Use o campo da matriz especificada para os Nomes distintos de objetos
Se isso for selecionado, a matriz de nomes distintos será usada para esta
solicitação.
Matriz de nomes distintos de objetos
Especifica a matriz de DNS dos objetos que deseja excluir. Esse campo é ativado
somente quando o campo Usar matriz especificada para o campo Nomes distintos
de objetos for selecionado.
Nomes de objetos distintos
Especifica o DNS dos objetos que deseja excluir. Esse campo é ativado somente
quando o campo Usar o campo da matriz especificada para os nomes diferenciados
de objetos não está marcado.
Escopo de exclusão de objetos
Selecione uma das seguintes opções:
Excluir objeto (retornará um erro se existirem filhos)
Para tentar excluir cada objeto (na lista de objetos nos campos Matriz de
Nomes distintos de objetos ou Nomes distintos de objetos), pois ele não têm
uma subárvore abaixo deles na árvore LDAP. Se existir uma subárvore para um
objeto na lista, CA Process Automation falhará a operação; no entanto,
também continuará a excluir todos os outros objetos na lista de objetos a
serem excluídos.
214 Referência do Criador de Conteúdo
Operador Excluir objeto
Excluir objeto e subárvore (se existir)
Tentar excluir cada objeto (da lista de objetos nos campos Matriz de nomes
distintos de objetos ou Nomes distintos de objetos) e toda subárvore sob ele,
se uma subárvore existir.
Parâmetros de saída
NumberOfObjectsToDelete
Especifica o número de objetos encontrados para serem excluídos.
■
Se o Escopo de exclusão do objeto for definido para Excluir objeto e subárvore,
então, essa variável retornará o número de todos os objetos encontrados nas
subárvores.
■
Se o Escopo de exclusão do objeto for definido como Excluir objeto, então, essa
variável retornará o número de objetos definidos na operação.
NumberOfDeletedObjects
Contém o número de objetos realmente excluídos.
DeletionFailures
Especifica uma matriz de mapas de valores criada somente quando a operação
falhar. Nesse caso, essa matriz de mapas de valores conterá o DNS dos objetos que
não foram excluídos, juntamente com as mensagens de erro, indicando por que
cada objeto não foi excluído.
Observe que a operação de exclusão será bem-sucedida ao tentar excluir um objeto que
não existe no servidor LDAP.
LDAPDeleteObjsUseArray
LDAPDeleteObjsArray
LDAPDeleteObjs
LDAPDeleteObjectsScope
remoteLDAPHost
remoteLDAPPort
remoteLDAPUser
remoteLDAPPassword
LDAPBaseDN
LDAPUserPrefix
Capítulo 7: Serviços de diretório 215
Operador Excluir objeto
Exemplos
Exemplos de uma exclusão bem-sucedida e não são fornecidas aqui.
Falha do operador
Este operador falhará nos seguintes casos:
■
O operador não pôde excluir nenhum dos objetos inseridos na operação.
■
Falha ao se conectar ao servidor do LDAP.
Falha na exclusão
Excluir um único objeto e definir que a operação falhará se houver objetos filho
(subárvore) existentes neste objeto.
216 Referência do Criador de Conteúdo
Operador Excluir objeto
Este é o conjunto de dados do operador de uma instância em tempo de execução:
Após a execução do operador, ele falhará e, em seguida, serão exibidos dados na guia
Resultados da operação.
NumberOfObjectsToDelete
1 (apenas uma tentativa para excluir um objeto).
NumberOfDeletedObjects
0 (como não foi possível excluir o objeto).
DeletionFailures
Especifica uma matriz de ValueMaps com um único objeto que contém o DN do
objeto que você tentou excluir, e a mensagem de erro do LDAP indicando por que
ele não foi excluído.
A mensagem do LDAP indica que este objeto possui uma subárvore (é um não-folha).
Capítulo 7: Serviços de diretório 217
Operador Excluir objeto
Exemplo: outra falha na exclusão
Suponha que você deseja excluir três objetos dentro da mesma operação: dois objetos
não têm subárvores abaixo deles na árvore LDAP e um objeto tem uma subárvore sob
ele.
Neste exemplo, o 1º e o 2º objetos não têm nenhuma subárvore abaixo deles. O 3º
objeto na lista tem uma subárvore sob ele.
Observe que você especificou a exclusão do objeto (e retornar um erro se existirem
filhos).
Após a execução da operação, ela falhou e a página Resultados da operação contém os
seguintes dados:
NumberOfObjectsToDelete
3 (conforme tentamos excluir 3 objetos)
NumberOfDeletedObjects
2 (não foi possível excluir apenas dois objetos)
218 Referência do Criador de Conteúdo
Operador Excluir objeto
DeletionFailures
Matriz de mapas de valores com um único objeto que contém:
■
O DN do objeto que não foi possível excluir
■
A mensagem de erro do LDAP indicando por que ele não foi excluído
A mensagem do LDAP indica que este objeto possui uma subárvore (é um não-folha).
Lembre-se de que a operação de exclusão pesquisa toda a lista de objetos a serem
excluídos. Se um objeto não puder ser excluído, a operação continuará excluindo todos
os outros objetos na lista, mas a operação também falhará ao terminar.
Capítulo 7: Serviços de diretório 219
Operador Excluir objeto
Operador Êxito
Tentativa de excluir o mesmo objeto e todos os seus filhos (subárvore sob ele):
Após a execução da operação, os Resultados da operação mostram os dados a seguir:
NumberOfObjectsToDelete: 25 (pois o objeto tinha 24 objetos filho na subárvore sob
ele).
220 Referência do Criador de Conteúdo
Operador Obter controlador de domínio
NumberOfDeletedObjects: 25 (pois não foi possível excluir o objeto e todos os objetos
filhos na subárvore abaixo dele).
Observe que a variável DeletionFailures não foi criada.
Se você tiver tentado excluir mais de um objeto nos exemplos anteriores,
NumberOfObjectsToDelete e NumberOfDeletedObjects representarão a soma de todos
os 'objetos excluídos' e 'objetos a serem excluídos' para todos os objetos inseridos na
operação (incluindo todas as suas subárvores, se aplicável).
Operador Obter controlador de domínio
O operador Obter controlador de domínio recupera todos os controladores de domínio
do servidor Active Directory. Esse operador se aplica somente ao Active Directory.
Parâmetros de entrada
O operador Controladores do domínio para recuperação do AD não inclui parâmetros de
entrada. A operação simplesmente obterá informações do servidor Active Directory da
página Parâmetros de logon LDAP associados à operação ou das informações de logon
do LDAP padrão definido no nível do módulo LDAP.
Capítulo 7: Serviços de diretório 221
Operador Obter controlador de domínio
Parâmetros de saída
DomainControllers
Especifica uma matriz de sequência de caracteres (sequência de caracteres
indexada) que contém todos os controladores de domínio recuperados do servidor
Active Directory. Essa variável será criada se a operação for bem-sucedida.
remoteLDAPHost
remoteLDAPPort
remoteLDAPUser
remoteLDAPPassword
LDAPBaseDN
LDAPUserPrefix
222 Referência do Criador de Conteúdo
Operador Obter controlador de domínio
Exemplo:
Esse exemplo mostra uma instância com êxito do operador recuperar o
DomainControllers a partir de um servidor do Active Directory. A operação
bem-sucedida e a variável DomainControllers é criada com os seguintes dados:
Neste exemplo, agora temos um único controlador de domínio neste domínio.
Falha do operador
Este operador falhará nos seguintes casos:
■
CA Process Automation não pode recuperar o configurationNamingContext do
servidor Active Directory.
■
Não há objetos do tipo TDSDSA no servidor Active Directory.
■
Falha ao se conectar ao servidor do LDAP.
Capítulo 7: Serviços de diretório 223
Operador Obter conta inativa
Operador Obter conta inativa
Use o operador Obter conta inativa para recuperar todas as contas inativas do Active
Directory. Você pode especificar uma data e um número de dias como um intervalo de
inatividade, qualquer conta de usuário cuja data do último logon seja anterior a esse
intervalo será considerada inativa. Esse operador se aplica somente ao Active Directory.
Parâmetros de entrada
Dias inativos
Especifica o número de dias inativos
Data
Especifica a data designada para contas inativas. Esse campo é habilitado quando
usar a data calculada? não está selecionada. Clique no ícone do calendário para
selecionar uma data.
Usar data calculada?
Especifica que o usuário pode fornecer uma variável de conjunto de dados que
contenha um valor de data no campo Data calculada.
Data calculada
Especifica a data calculada para contas inativas. Esse campo é habilitado quando
usar a data calculada? está marcado.
224 Referência do Criador de Conteúdo
Operador Obter conta inativa
Atributo do último logon
LastLogonTimeStamp
Selecione este campo quando recuperar contas inativas do Active Directory
2003/2008 (NÃO do Active Directory 2000).
O atributo LastLogonTimeStamp contém a última data de logon de um usuário,
mas é replicado em todos os controladores de domínio somente após um
período de tempo definido no atributo msDS-LogonTimeSyncInterval do Active
Directory.
Se a data inativa for anterior à "data de hoje - msDS-LogonTimeSyncInterval",
usar o atributo lastLogonTimestamp recuperado de um único controlador de
domínio recuperará todas as contas inativas.
O atributo msDS-LogonTimeSyncInterval especifica a frequência (em dias) com
a qual a hora do último logon para um usuário ou computador, registrada no
atributo lastLogonTimestamp, é replicada para todos os controladores de
domínio em um domínio.
Quando o atributo LastLogonTimeStamp é usado, o CA Process Automation
recupera as informações de LastLogonTimeStamp de cada usuário de apenas
um controlador de domínio e as utiliza para determinar se o usuário está
inativo ou não.
lastLogon
Selecione este campo quando recuperar contas inativas do Active Directory
2000, 2003 e 2008.
O atributo LastLogon contém data do último logon de um usuário, mas NÃO é
replicada em todos os controladores de domínio.
Nesse caso, CA Process Automation começa a recuperar a lista de todos os
controladores de domínio e depois verifica esses valores para salvar o valor mais
recente do atributo lastLogon de cada usuário. Finalmente, o valor lastLogon mais
recente de cada usuário é usado para determinar as contas inativas.
Parâmetros de saída
DormantAccounts
Especifica uma matriz de mapas de valores, em que cada mapa de valor representa
um uma conta inativa. Cada mapa de valor contém as seguintes chaves/valores:
DN
Especifica o nome distinto da conta inativa do usuário.
Capítulo 7: Serviços de diretório 225
Operador Obter conta inativa
Data do último logon
Especifica a data do último logon da conta inativa do usuário.
Dias inativos
Especifica o número de dias inativos entre a data do último logon da conta de
usuário e a data de inativação definida na operação. Observe que esse número será
arredondado, por exemplo, se a data do último logon de um usuário for 15 de maio
de 2009 12:25:49 PM e tivermos uma data inativa de: 18 de maio de 2009, os dias
de inatividade serão 4 (não 3).
A data do último logon e os dias de inatividade poderão ser definidos como -1 para
cada conta de usuário inativo que nunca tenha se conectado antes.
NoLogonParameterAccounts
Especifica uma matriz de sequência de caracteres (sequência de caracteres
indexada) que contém o DNS das contas de usuários que não possuem o atributo
LastLogonTimeStamp ou LastLogon definido no Active Directory (dependendo de
qual atributo foi selecionado pelo usuário para a pesquisa). Se todas as contas de
usuário tiverem o atributo selecionado definido, essa variável será deixada em
branco.
LDAPADDormantDays
LDAPADDormantDate
LDAPADUseCalculatedDate
LDAPADCalculatedDate
LDAPADLastLogonAttr
remoteLDAPHost
remoteLDAPPort
remoteLDAPUser
remoteLDAPPassword
LDAPBaseDN
LDAPUserPrefix
226 Referência do Criador de Conteúdo
Operador Obter o objeto
Operador Obter o objeto
O operador Obter objeto recuperar qualquer tipo de objeto LDAP do servidor LDAP. É
possível especificar o caminho de pesquisa, o filtro de pesquisa (na página 230), o
escopo de pesquisa, os atributos (na página 231) para recuperar com cada objeto e os
critérios de classificação.
Parâmetros de entrada
Obter critérios
Início do caminho de pesquisa
Especifica o local de início para a pesquisa, tal como CN =Users, dc =domainpart, DC
=company-name, DC =top-level-domain-name
Recuperar escopo
Selecione uma das seguintes opções:
Escopo de subárvore
Pesquise a subárvore inteira (incluindo o objeto no caminho de pesquisa).
Escopo de nível um
Pesquise os objetos diretamente sob o objeto no caminho de pesquisa.
Escopo do objeto
Pesquise somente o objeto no caminho de pesquisa.
Resultados da contagem de limite
Número máximo de entradas para retornar.
■
Se você digitar 0 ou não digitar nada nesse campo, o CA Process Automation
usará o valor definido no campo Número máximo de resultados de pesquisa
(da configuração de categoria dos Serviços de diretório).
■
Se você digitar um valor nesse campo, o CA Process Automation usará o menor
valor entre o campo desse valor e o valor definido no campo Número máximo
de resultados de pesquisa (da configuração de categoria dos Serviços de
diretório).
Tempo limite para recuperar
Tempo em segundos para aguardar antes do tempo limite da pesquisa. Se o limite é
0 (ou se nada foi inserido), não há um limite de tempo definido na pesquisa.
Capítulo 7: Serviços de diretório 227
Operador Obter o objeto
Recuperar tipo de objeto
Selecione uma das seguintes opções:
■
Usuário
■
Computador
■
Grupo
■
Unidade organizacional
■
Função
■
Outros
Esse campo controla o valor do filtro exibido no campo Recuperar filtro.
Recuperar filtro
Escolha o filtro de pesquisa para usar para esta pesquisa.
Você pode:
Usar um filtro genérico selecionando Usuário, Grupo, Unidade organizacional,
Função ou Computador no campo Recuperar tipo de objeto, que exibe o valor do
filtro associado no campo Recuperar filtro e torna esse campo somente leitura.
ou
Digite seu próprio filtro selecionando Outros no campo Recuperar tipo de objeto,
que exibe "objectclass=" no campo Recuperar filtro e torna esse campo gravável
para que você possa preencher o valor do seu filtro. A expressão deve estar
sintaticamente correta; caso contrário, pode ocorrer falha na pesquisa. Consulte a
seção "Noções básicas do filtro de pesquisa do LDAP (na página 230)" para obter os
fundamentos da sintaxe dos filtros de pesquisa do LDAP.
Observe que você pode usar filtros diferentes para Usuário, Grupo, Unidade
organizacional, Função ou Computador, selecionando Outros no campo Recuperar
tipo de objeto e inserindo seu valor de filtro no campo Recuperar filtro. Os filtros de
pesquisa genérica fornecidos podem não funcionar com alguns servidores LDAP,
especialmente se o servidor LDAP não oferecer suporte a algumas das classes de
objeto listadas nos filtros.
Recuperar atributos especificados como uma variável de matriz?
Se essa opção for selecionada, você poderá fornecer uma variável de conjunto de
dados contendo uma matriz de atributos para ser recuperada.
Recuperar variável da matriz de atributos
A variável do conjunto de dados que fornece uma matriz de atributos a serem
recuperados. Esse campo é ativado quando os atributos de recuperação
especificados são como um campo variável de matriz? está marcado.
228 Referência do Criador de Conteúdo
Operador Obter o objeto
Recuperar lista de atributos
Especifica uma lista de atributos para recuperar para esse filtro de pesquisa. Essa
lista é ativada quando o campo Recuperar atributos especificados como uma
variável da matriz? não está selecionado.
Critérios de classificação
Campos de classificação especificada como uma variável de matriz?
Se essa opção for selecionada, você poderá fornecer uma variável do conjunto de
dados contendo uma matriz de atributos usados para classificar os dados
recuperados.
Classificar variável da matriz do campo de lista
A variável do conjunto de dados que fornece uma matriz de atributos a serem
usados para a ordem de classificação. Esse campo é ativado quando Classificar
campos for especificado como Variável de matriz? está marcado.
Classificar ordem da lista
Lista de atributos que serão usados para a ordem de classificação. Esse campo é
ativado quando o campo Classificar campos especificados como uma variável da
matriz?: não está selecionado.
Se nada for inserido na seção de critérios de classificação, os objetos recuperados
não serão classificados.
Observe que alguns servidores LDAP (por exemplo, OpenLDAP) não oferecem
suporte à "Classificação" de dados. Nesse caso, o operador poderá falhar com o
seguinte motivo: [LDAP: código de erro de 12 - extensão crítica não é reconhecida].
Não fornecer os critérios de classificação nesse caso. Esta é uma limitação do
servidor LDAP e não do CA Process Automation.
Capítulo 7: Serviços de diretório 229
Operador Obter o objeto
Noções básicas do filtro de pesquisa do LDAP
A sintaxe do filtro de pesquisa do LDAP sintaxe é uma expressão lógica em notação de
prefixo, em que o operador lógico aparece antes dos argumentos associados.
Por exemplo: (& (givenname =John) (sn =Green))
No filtro acima & é o operador E e aparece antes de seus argumentos. Neste exemplo,
estamos procurando objetos LDAP com John como givenname (givenname é o atributo
LDAP do nome) e SN como Green (SN é o atributo LDAP para sobrenome).
Cada item no filtro é composto usando um identificador de atributo LDAP e um valor de
atributo ou símbolos que indicam o valor do atributo. Cada item também deve ser
incluído em um conjunto de parênteses, como em "(sn =Green)".
Itens dentro de um filtro são combinados juntos usando operadores lógicos para criar
expressões lógicas. Cada expressão lógica pode ainda ser combinada com outros itens
que também são expressões lógicas, como em alguns dos filtros usados em CA Process
Automation:
(&(|(objectclass=usuário)(objectclass=pessoa))(!(objectclass=computador)))
Nesse filtro, estamos buscando todos os objetos em que objectclass é um usuário OU
uma pessoa:
(|(objectclass=usuário)(objectclass=pessoa))
E o objectclass não é computador
(! (objectclass =computador))
Observe o & no início do filtro que combina esses dois segmentos juntos em um lógico
E.
Observe que o objectClass do atributo LDAP armazena o (s) tipo (s) de um objeto LDAP
no diretório LDAP.
Alguns dos operadores lógicos usados para a criação de filtros estão listados na tabela a
seguir:
Símbolo
Descrição
=
Igualdade
Exemplo: (givenname =John)
Pesquisar objetos com John como primeiro nome.
230 Referência do Criador de Conteúdo
Operador Obter o objeto
&
Lógico E
Por exemplo: (& (givenname =John) (sn =Green))
Pesquisar objetos com John, como nome e Green como sobrenome
|
Lógico OU
Exemplo:(| (givenname =João) (givenname =Michael))
Pesquisar objetos com John ou Michael como nome
!
Lógico NÃO
Exemplo: (&(givenname=John)(!(sn=Green)))
Pesquisar objetos com John como nome em que Green não seja o sobrenome
>=
Maior que
Exemplo:(numsubordinates <=2)
Pesquisar objetos com 2 ou mais nós filhos na árvore LDAP.
<=
Menor que
Exemplo:(numsubordinates <=2)
Pesquisar objetos com 2 ou menos nós filhos na árvore LDAP.
=*
Presença
O objeto deve ter o atributo, mas seu valor é irrelevante.
Exemplo:(givenname =*)
Pesquisar objetos com o atributo givenName.
*
Caractere curinga
Exemplo:(givenname =Joh *)
Pesquisar objetos cujo givenname começa com Joh
Nomes dos atributos comuns do LDAP
Alguns dos atributos LDAP comuns estão listados abaixo. A lista completa das classes de
objetos LDAP e atributos usados no esquema do servidor LDAP está localizada no
servidor LDAP.
Nome de atributo LDAP
Descrição
cn
Atributo Nome comum, que contém o nome do objeto
dc
Atributo Componente do domínio
ObjectClass
Atributo Classe de objeto, que contém o tipo de LDAP do objeto
distinguishedName
Atributo Nome distinto no Active Directory
Este é o atributo que identifica exclusivamente o objeto no Active
Directory.
Capítulo 7: Serviços de diretório 231
Operador Obter o objeto
Nome de atributo LDAP
Descrição
entrydn
Atributo Nome distinto em servidores LDAP (diferente do Active
Directory)
Este é o atributo que identifica exclusivamente o objeto em um
servidor LDAP.
o
O atributo Nome da organização que contém o nome da organização
ou
O atributo Nome da unidade organizacional que contém o nome da
unidade organizacional
sn
O atributo Sobrenome que contém o nome da família de um indivíduo
Givenname
Atributo Nome que contém o nome de uma pessoa
personalTitle
Atributo Título pessoal que contém o cargo da pessoa
Exemplos de títulos pessoais são "Mr", "Dr", "Prof." e "Rev".
initials
Atributo Iniciais, que contém as iniciais de alguns ou de todos os
nomes de uma pessoa, mas não o sobrenome
uid
Atributo da ID do usuário
userPassword
Atributo Senha que contém a senha de um usuário
As senhas são armazenadas usando uma sintaxe de sequência de
caracteres de octeto e não estão criptografadas.
título
Atributo Título, que especifica a posição designada ou função do
objeto dentro da organização
mail
Atributo Email, que contém um endereço de email do usuário
empresa
Atributo Nome da empresa ou organização
departamento
Atributo Nome do departamento
manager
Atributo Chefe, Gerente
celular
Atributo Número do telefone celular
FoneResid
Atributo Número do telefone residencial
telephoneNumber
Atributo Número do telefone
facsimileTelephoneNumber
Atributo Número do fax
postalAddress
Atributo Endereço postal, que contém as informações necessárias
para a entrega de correspondências físicas
postalCode
Atributo Código Postal
Se o valor deste atributo estiver presente, ele será parte do endereço
postal do objeto.
c
232 Referência do Criador de Conteúdo
Atributo Nome do país, que contém um código de país ISO 3166 de
duas letras
Operador Obter o objeto
Nome de atributo LDAP
Descrição
h
Atributo Nome da Localidade, que contém o nome de uma localidade,
como, por exemplo, uma cidade, estado ou região geográfica
º
Atributo Nome do estado ou província
rua
Atributo Rua, que contém o endereço físico do objeto, como um
endereço para entrega de pacotes
proprietário
Atributo Proprietário, que especifica o nome de um objeto que tem
alguma responsabilidade para o objeto associado
O valor é um nome distinto
descrição
Atributo Descrição, que pode ser lido por pessoas que contém uma
descrição do objeto
Seealso
Atributo Consulte também.
serialNumber
Atributo Número de série, que armazena o número de série do
dispositivo
member
O atributo Membro é usado em entradas de definição de grupos
Ele tem uma sintaxe de nome distinto, de forma que cada valor seja
efetivamente um indicador para outra entrada no diretório. Observe
que a classe de objeto groupOfNames padrão faz com que o atributo
Membro seja obrigatório. Como os atributos não podem ter valores
vazios, isso efetivamente exige que todos os grupos tenham sempre
pelo menos um membro.
uniqueMember
O atributo uniqueMember é semelhante ao atributo Membro
mencionado acima, e é usado para armazenar os membros exclusivos
em um objeto groupOfUniqueNames
sAMAccountName
O atributo do nome de logon antigo do NT 4.0 (Active Directory), que
deve ser exclusivo em um domínio do Active Directory
LastLogonTimeStamp
Atributo Carimbo de data/hora do último logon (Active Directory
2003/2008 somente), que contém a última data de logon de um
usuário; mas é replicado em todos os controladores de domínio
somente após um período de tempo definido no atributo
msDS-LogonTimeSyncIntervall do Active Directory
lastLogon
Atributo Último logon (Active Directory), que contém a data do último
logon de um usuário, mas ele NÃO é replicado em todos os
controladores de domínio
Capítulo 7: Serviços de diretório 233
Operador Obter o objeto
Parâmetros de saída
Retrievedobjects
Uma matriz de mapas de valores, em que cada mapa de valor contém os atributos
recuperados para cada objeto. Essa variável é criada apenas quando a operação
tiver êxito.
LDAPSearchPath
LDAPSearchScope
ResultsLimit
LDAPGetTimeLimit
LDAPSearchType
LDAPGetFilter
LDAPGetAttributesType
LDAPGetAttributesArray
LDAPGetAttributes
LDAPGetSortAttributesType
LDAPGetSortAttributesArray
LDAPGetSortAttributes
remoteLDAPHost
remoteLDAPPort
remoteLDAPUser
remoteLDAPPassword
LDAPBaseDN
LDAPUserPrefix
Observações:
■
Os nomes de atributo inseridos nas seções classificação e recuperação devem ser os
nomes LDAP desses atributos, conforme especificado no esquema do servidor
LDAP. Por exemplo, para recuperar o atributo "Sobrenome", você deve usar nome
LDAP desse atributo: "sn", para recuperar o atributo "Nome", deve usar o atributo
"givenname" e assim por diante. Consulte o tópico "Nomes de atributos comuns do
LDAP (na página 231)".
■
Os nomes de LDAP são diferentes dos nomes de exibição dos atributos.
■
A maioria de servidores LDAP é diferente nos nomes de exibição dos atributos
LDAP, mas todos devem oferecer suporte aos nomes LDAP desses atributos,
portanto o motivo pelo qual nós exigimos o uso dos nomes de atributos LDAP em
vez dos nomes de exibição.
234 Referência do Criador de Conteúdo
Operador Obter o objeto
■
Você deve fornecer os nomes dos atributos a serem recuperados; caso contrário,
CA Process Automation não retornará nenhum dado na variável RetrievedObjects.
■
Se nenhum objeto for encontrado no caminho de pesquisa especificado, a operação
de pesquisa será bem-sucedida e a variável RetrievedObjects ficará vazia. A
operação de pesquisa não falhará neste caso.
Capítulo 7: Serviços de diretório 235
Operador Obter o objeto
Exemplos
Exemplo - usar um filtro genérico
Neste exemplo, estamos tentando recuperar todas as contas de computador no
caminho "CN =computadores, DC =ITPAM, dc =ca, dc =local". Estamos especificamente
solicitando os atributos "cn", "distinguishedname", "objectcategory" e "objectclass"
dessas contas.
236 Referência do Criador de Conteúdo
Operador Obter o objeto
Estamos também classificando as contas de usuários retornadas por "cn".
Após a execução do operador, ele foi finalizado com êxito e a variável RetrievedObjects
foi criada como segue:
Para cada mapa de valores na variável RetrievedObjects, agora temos os valores
recuperados para cada atributo da conta do computador. Neste exemplo, a variável
RetrievedObjects contém oito objetos.
Capítulo 7: Serviços de diretório 237
Operador Obter o objeto
Observe também que os valores de atributos com valores múltiplos (objectclass neste
exemplo) são retornados com "|" entre os vários valores:
238 Referência do Criador de Conteúdo
Operador Obter o objeto
Exemplo - usar seu próprio filtro
Neste exemplo, estamos usando nosso próprio filtro (observe que Recuperar tipo de
objeto está definido como Outros) para recuperar todas as contas no recipiente no
caminho "DC =ITPAM, dc =ca, dc =local". Estamos especificamente solicitando os
atributos "cn", "distinguishedname", "objectcategory" e "objectclass" dessas contas.
Capítulo 7: Serviços de diretório 239
Operador Obter o objeto
Estamos também classificando as contas de usuários retornadas por "cn".
Após a execução do operador, ele foi finalizado com êxito e a variável RetrievedObjects
foi criada como segue:
240 Referência do Criador de Conteúdo
Operador Obter o objeto
Em cada mapa de valores na variável no RetrievedObjects, agora temos os valores
recuperados para cada atributo da conta de recipiente. A variável RetrievedObjects
contém 86 objetos neste exemplo.
Observe também que os valores de atributos com valores múltiplos (objectclass neste
exemplo) são retornados com "|" entre os vários valores:
Capítulo 7: Serviços de diretório 241
Operador Obter usuário
Falha do operador
Este operador falhará nos seguintes casos:
■
O caminho de pesquisa não existe no servidor LDAP.
■
O tempo limite de pesquisa foi excedido.
■
Falha ao se conectar ao servidor do LDAP.
Esta operação pode falhar nos casos a seguir, dependendo do servidor LDAP, pois alguns
servidores LDAP consideram isso como erros, enquanto outros não:
■
O filtro de pesquisa é inválido.
■
Os atributos de retorno são inválidos.
■
Os atributos de classificação são inválidos.
Operador Obter usuário
O operador Obter usuário recupera os objetos LDAP da conta de usuário no servidor
LDAP. É possível especificar o caminho de pesquisa, o filtro de pesquisa, o escopo de
pesquisa, os atributos para recuperar com cada objeto e os critérios de classificação.
Parâmetros de entrada
Os parâmetros de entrada do operador Obter usuário incluem critérios de obtenção e
critérios de classificação.
242 Referência do Criador de Conteúdo
Operador Obter usuário
Obter critérios
Início do caminho de pesquisa
Especifica o local de início para a pesquisa, como cn =Users, dc =domainpart, DC
=company-name, DC =top-level-domain-name.
Recuperar escopo
Selecione uma das seguintes opções:
Escopo de subárvore
Pesquisa toda a subárvore (incluindo o objeto no caminho de pesquisa).
Escopo de nível um
Procura os objetos diretamente sob o objeto no caminho de pesquisa.
Escopo do objeto
Pesquisa somente o objeto no caminho de pesquisa.
Resultados da contagem de limite
Número máximo de entradas para retornar.
■
Digite 0 ou nada nesse campo para usar o valor definido no campo Número
máximo de resultados de pesquisa (da configuração de categoria dos Serviços
de diretório).
■
Digite um valor nesse campo para usar o menor valor entre o valor desse
campo e o valor definido no campo Número máximo de resultados de pesquisa
(da configuração de categoria dos Serviços de diretório).
Tempo limite para recuperar
Especifica o tempo em segundos para aguardar antes do tempo limite da pesquisa.
Se 0 ou nada for inserido, não haverá limite de tempo definido na pesquisa.
Recuperar filtro
Especifica o filtro de pesquisa para usar para esta pesquisa.
■
O filtro de pesquisa genérica procura contas de usuário no LDAP, e você pode
refinar esse filtro conforme necessário. Esse campo é gravável (pode ser
modificado). Consulte a seção "Noções básicas do filtro de pesquisa do LDAP
(na página 230)" para obter os fundamentos da sintaxe dos filtros de pesquisa
do LDAP.
■
O filtro de pesquisa genérica pode não funcionar com alguns servidores LDAP,
especialmente se o servidor LDAP não oferecer suporte a alguns dos
objectClasses listados no filtro:
"(&(|(objectclass=usuário)(objectclass=pessoa))(!(objectclass=computador)))"
Capítulo 7: Serviços de diretório 243
Operador Obter usuário
■
A expressão deve estar sintaticamente correta; caso contrário, pode ocorrer
falha na pesquisa.
■
Entre em contato com seu administrador LDAP para saber sobre os
objectclasses LDAP suportados.
Recuperar atributos especificados como uma variável de matriz?
Selecione essa caixa para fornecer uma variável de conjunto de dados contendo
uma matriz de atributos para ser recuperada.
Recuperar variável da matriz de atributos
Especifica a variável do conjunto de dados que fornece uma matriz de atributos
para ser recuperada. Esse campo é ativado quando os atributos de recuperação
especificados são como um campo variável de matriz? A caixa de seleção está
ativada.
Recuperar lista de atributos
Especifica uma lista de atributos para recuperar para esse filtro de pesquisa. Essa
lista é ativada quando o campo Recuperar atributos especificados como uma
variável da matriz? não está selecionado.
Critérios de classificação
Campos de classificação especificada como uma variável de matriz?
Marque essa caixa para fornecer uma variável do conjunto de dados que contenha
uma matriz de atributos usados para classificar os dados recuperados.
Classificar variável da matriz do campo de lista
Especifica a matriz do conjunto de dados que fornece uma matriz de atributos a
serem usados para a ordem de classificação. Esse campo é ativado quando os
campos de classificação são especificados como uma variável de matriz? a caixa de
seleção está marcada.
Classificar ordem da lista
Lista de atributos que será usada para a ordem de classificação. Esse campo é
ativado quando os campos de classificação são especificados como uma variável de
matriz? a caixa de seleção está desmarcada.
Se nada for inserido na seção de critérios de classificação, os objetos recuperados
não serão classificados.
Observação: alguns servidores LDAP (como OpenLDAP) não oferecem suporte à
"Classificação" de dados. Nesse caso, a operação poderá falhar com o seguinte
motivo: [LDAP: código de erro de 12 - extensão crítica não é reconhecida]. Não
fornecer os critérios de classificação nesse caso. Esta é uma limitação do servidor
LDAP e não do CA Process Automation.
244 Referência do Criador de Conteúdo
Operador Obter usuário
Parâmetros de saída
Contas de usuário
Esta é uma matriz de mapas de valores, em que cada mapa de valor contém os
atributos recuperados para o usuário. Essa variável é criada apenas quando a
operação tiver êxito.
LDAPSearchPath
LDAPSearchScope
ResultsLimit
LDAPGetTimeLimit
LDAPGetFilter
LDAPGetAttributesType
LDAPGetAttributesArray
LDAPGetAttributes
LDAPGetSortAttributesType
LDAPGetSortAttributesArray
LDAPGetSortAttributes
remoteLDAPHost
remoteLDAPPort
remoteLDAPUser
remoteLDAPPassword
LDAPBaseDN
LDAPUserPrefix
Capítulo 7: Serviços de diretório 245
Operador Obter usuário
Os nomes de atributos inseridos nas seções Classificação e Recuperação devem ser os
nomes LDAP desses atributos, conforme especificado no esquema do servidor LDAP. Por
exemplo, para recuperar o atributo "Sobrenome", você deve usar nome LDAP deste
atributo: "sn", para recuperar o atributo "Nome", deve usar o atributo "givenname" e
assim por diante. Para obter mais informações, consulte o tópico "Nomes comuns do
atributo LDAP (na página 231)".
Os nomes de LDAP são diferentes dos nomes de exibição dos atributos.
A maioria de servidores LDAP é diferente nos nomes de exibição dos atributos LDAP,
mas todos devem oferecer suporte aos nomes LDAP desses atributos, portanto o motivo
pelo qual nós exigimos o uso dos nomes de atributos LDAP em vez dos nomes de
exibição.
Você deve fornecer os nomes dos atributos a serem recuperados; caso contrário, CA
Process Automation não retornará nenhum dado na variável RetrievedObjects.
Se nenhuma conta de usuário foi encontrada no caminho de pesquisa especificado, a
operação de pesquisa será bem-sucedida e a variável UserAccounts será deixada em
branco. A operação de pesquisa não falhará neste caso.
246 Referência do Criador de Conteúdo
Operador Obter usuário
Exemplos
No exemplo acima, estamos tentando recuperar todas as contas de usuário no caminho
"ou =ldapconnector, dc =ca, dc =com". É especificamente solicitado para os atributos
"entrydn", "uid" e "objectclass" dessas contas.
Também estamos classificando as contas de usuário que retornaram pelo "entryDn" e
depois pelo "cn".
Capítulo 7: Serviços de diretório 247
Operador Obter usuário
Após a execução do operador, ele foi finalizado com êxito e a variável UserAccounts foi
criada como segue:
248 Referência do Criador de Conteúdo
Operador Obter usuário
Cada mapa de valores na variável UserAccounts agora mostra os valores recuperados
para cada atributo de conta de usuário. A operação retornou apenas dez contas de
usuário porque especificamos nosso limite de resultados da pesquisa como dez. Os
valores de atributos com valores múltiplos (objectclass neste exemplo) também são
retornadas com um "|" entre os vários valores:
Falha do operador
Este operador falhará nos seguintes casos:
■
O caminho de pesquisa não existe no servidor LDAP.
■
O tempo limite de pesquisa foi excedido.
■
Falha ao se conectar ao servidor do LDAP.
Esta operação pode falhar nos casos a seguir, dependendo do servidor LDAP, pois alguns
servidores LDAP consideram isso como erros, enquanto outros não:
■
O filtro de pesquisa é inválido.
■
Os atributos de retorno são inválidos.
■
Os atributos de classificação são inválidos.
Capítulo 7: Serviços de diretório 249
Operador Mover o objeto
Operador Mover o objeto
O Operador Mover objeto move um objeto LDAP de um local para outro no servidor
LDAP.
Parâmetros de entrada
DN do objeto Antigo
Especifica o nome distinto do objeto que você deseja mover.
Novo DN do objeto
Especifica o destino do nome distinto para onde você deseja que o objeto seja
movido.
Parâmetros de saída
LDAPMoveObjectOldDn
LDAPMoveObjectNewDn
remoteLDAPHost
remoteLDAPPort
remoteLDAPUser
remoteLDAPPassword
LDAPBaseDN
LDAPUserPrefix
Exemplo:
250 Referência do Criador de Conteúdo
Operador Remover usuário do grupo
Falha do operador
Este operador falhará nos seguintes casos:
■
O DN antigo do objeto não existe no servidor LDAP.
■
O novo DN do objeto já existe.
■
O servidor LDAP está configurado para evitar que um 'Movimento' do operador
ocorra de maneira programática.
■
Falha ao se conectar ao servidor do LDAP.
Operador Remover usuário do grupo
O operador Remover usuário do grupo permite que você remova um usuário LDAP de
um grupo LDAP no servidor LDAP.
Parâmetros de entrada
DN do usuário
Especifica o nome distinto do usuário que você deseja remover do grupo.
DN do grupo
Especifica o nome distinto do grupo do qual você deseja remover o usuário.
Parâmetros de saída
LDAPUserDn
LDAPGroupDn
remoteLDAPHost
remoteLDAPPort
remoteLDAPUser
remoteLDAPPassword
LDAPBaseDN
LDAPUserPrefix
Capítulo 7: Serviços de diretório 251
Operador Atualizar atributos de objeto
Exemplo:
Falha do operador
Este operador falhará nos seguintes casos:
■
O usuário não é um membro do grupo.
■
O grupo não existe no servidor LDAP.
■
O grupo DN aponta para um objeto LDAP que não é do tipo grupo, groupofnames
ou groupofuniquenames.
■
Falha ao se conectar ao servidor do LDAP.
Operador Atualizar atributos de objeto
O operador Atualizar de atributos de objeto executa as seguintes tarefas
simultaneamente:
■
Adicionar novos atributos a um objeto LDAP.
■
Substituir os valores de atributos de um objeto LDAP existente.
■
Remover atributos de um objeto LDAP existente.
Você pode executar todas as três operações no mesmo objeto ao mesmo tempo, ou
pode optar por ignorar quaisquer das operações, não digitando nada na página de
operador.
252 Referência do Criador de Conteúdo
Operador Atualizar atributos de objeto
Observação: o Active Directory não permitirá a modificação de uma senha de usuário, a
menos que o CA Process Automation esteja conectado ao servidor Active Directory por
meio de SSL. Se o CA Process Automation não estiver conectado por meio de SSL, a
substituição do operador em uma senha de usuário falhará.
Para obter mais informações sobre como importar um certificado do Active Directory
para o CA Process Automation, consulte Adicionar um certificado SSL ao CA Process
Automation (na página 259). Depois que o certificado for importado, será possível
alterar as propriedades do módulo LDAP para estabelecer uma conexão SSL com o
servidor Active Directory.
Parâmetros de entrada
Os parâmetros de entrada para o operador Atualizar atributos de objeto são indicados a
seguir.
Parâmetros de objetos
O nome distinto do objeto
Especifica o nome distinto do objeto LDAP cujos atributos você deseja modificar.
Página Adicionar parâmetros de atributos
Use a página Adicionar parâmetros de atributos para inserir todos os atributos que você
deseja criar para o objeto LDAP.
Use os campos de matriz especificados para os atributos LDAP a serem adicionados
Selecione esta caixa para usar os atributos e valores de atributos matrizes para esta
solicitação.
Matriz de atributos LDAP
A matriz que contém os nomes LDAP dos atributos a serem adicionados ao objeto.
Este campo do conjunto de dados deve ser definido como uma matriz (sequência
de caracteres indexada). Se a opção Usar campos da matriz especificada para os
atributos LDAP a serem adicionados estiver marcada, este campo será utilizado.
Matriz de valores de atributos LDAP
A matriz que contém os valores dos atributos a serem adicionados ao objeto. Este
campo do conjunto de dados deve ser definido como uma matriz (sequência de
caracteres indexada). Se a opção Usar campos da matriz especificada para os
atributos LDAP a serem adicionados estiver marcada, este campo será utilizado.
Atributos LDAP
Os nomes LDAP dos atributos a serem adicionados ao objeto. Se a opção Usar
campos da matriz especificada para os atributos LDAP a serem adicionados estiver
desmarcada, este campo será utilizado.
Capítulo 7: Serviços de diretório 253
Operador Atualizar atributos de objeto
Valores de atributos LDAP
Os valores dos atributos a serem adicionados ao objeto. Se a opção Usar campos da
matriz especificada para os atributos LDAP a serem adicionados estiver
desmarcada, este campo será utilizado.
Mapas de valor de atributos LDAP
Esta é uma matriz de mapas de valores contendo atributos LDAP a serem
adicionados ao objeto. Cada chave e valor do mapa de valores valor deve ser do
tipo sequência de caracteres; além disso, a chave deve ser nomeada como Chaves e
o valor como Valores.
Exemplo:
Neste exemplo, o objeto addAttrHashMapArray é um MapaDeValor indexado cujos
campos de chave são denominados Chaves e campos de valor são denominados
Valores.
Observe que o usuário pode usar os Mapas de valores de atributos LDAP
individualmente ou como uma inclusão a qualquer atributo (e os valores de atributos
associados) inseridos nos outros campos da página.
Página Substituir parâmetros de atributos
Use a página Substituir parâmetros de atributos para inserir todos os atributos cujos
valores você deseja substituir no objeto LDAP.
Use os campos de matriz especificados para os atributos LDAP a serem adicionados
Se estiver selecionado, os atributos e valores de atributo serão usados para esta
solicitação.
254 Referência do Criador de Conteúdo
Operador Atualizar atributos de objeto
Matriz de atributos LDAP
Especifica a matriz que contém nomes LDAP dos atributos cujos valores serão
substituídos no objeto. Este campo do conjunto de dados deve ser definido como
uma matriz (sequência de caracteres indexada). Se a opção Usar campos da matriz
especificada para os atributos LDAP a serem adicionados estiver marcada, este
campo será utilizado.
Matriz de valores de atributos LDAP
Especifica a matriz que contém os novos valores de atributos a serem substituídos
no objeto. Este campo do conjunto de dados deve ser definido como uma matriz
(sequência de caracteres indexada). Se a opção Usar campos da matriz especificada
para os atributos LDAP a serem adicionados estiver marcada, este campo será
utilizado.
Atributos LDAP
Especifica os nomes LDAP dos atributos cujos valores serão substituídos no objeto.
Se a opção Usar campos da matriz especificada para os atributos LDAP a serem
adicionados estiver desmarcada, este campo será utilizado.
Valores de atributos LDAP
Especifica os novos valores dos atributos a serem substituídos no objeto. Se a opção
Usar campos da matriz especificada para os atributos LDAP a serem adicionados
estiver desmarcada, este campo será utilizado.
Mapas de valor de atributos LDAP
Especifica uma matriz de mapas de valores que contém nomes LDAP e novos
valores de atributos cujos valores serão substituídos no objeto. Cada mapa de
valores Chave e Valor deve ser do tipo sequência de caracteres; além disso, a chave
deve ser nomeada como Chaves e o valor deve nomeado como Valores.
Página Remover parâmetros de atributos
A página Remover parâmetros de atributos é usada para inserir todos os atributos que
você deseja remover do objeto LDAP.
Use o campo de matriz especificado para os atributos LDAP a serem removidos
Selecione esta caixa para usar as matrizes dos atributos para esta solicitação.
Matriz de atributos LDAP
Especifica a matriz que contém nomes LDAP dos atributos a serem removidos do
objeto. Este campo do conjunto de dados deve ser definido como uma matriz
(sequência de caracteres indexada). Se o campo Usar matriz especificada para os
atributos LDPA a serem adicionados estiver selecionado, este campo será utilizado.
Capítulo 7: Serviços de diretório 255
Operador Atualizar atributos de objeto
Atributos LDAP
Especifica os nomes LDAP dos atributos a serem removidos do objeto. Se o campo
Usar matriz especificada para os atributos LDAP a serem adicionais não estiver
selecionado, este campo será utilizado.
Parâmetros de saída
LDAPModifyObjAttrsDN
LDAPAddAttributesType
LDAPAddAttributesKeyArray
LDAPAddAttributesValueArray
LDAPAddAttributesKeys
LDAPAddAttributesValues
LDAPAddAttributesMap
LDAPRemoveAttributesType
LDAPRemoveAttributesKeyArray
LDAPRemoveAttributesKeys
LDAPReplaceAttributesType
LDAPReplaceAttributesKeyArray
LDAPReplaceAttributesValueArray
LDAPReplaceAttributesKeys
LDAPReplaceAttributesValues
LDAPReplaceAttributesMap
remoteLDAPHost
remoteLDAPPort
remoteLDAPUser
remoteLDAPPassword
LDAPBaseDN
LDAPUserPrefix
256 Referência do Criador de Conteúdo
Operador Atualizar o diretório inicial do usuário
Falha do operador
Este operador falhará nos seguintes casos:
■
O objeto LDAP especificado não existe.
■
O atributo LDAP que você deseja adicionar, substituir ou remover não existe
■
A lista de atributos e valores de atributo das páginas 'Adicionar' ou 'Modificar' não
têm a mesma extensão.
■
O usuário observou que uma matriz de atributos e uma matriz de valores de
atributo são usadas para 'Adicionar', 'Substituir' ou 'Remover' páginas, mas o objeto
CA Process Automation inserido no campo da matriz, na verdade, não é do tipo
matriz (sequência de caracteres indexadas).
■
O servidor LDAP está configurado para evitar quaisquer modificações de objetos
LDAP realizadas de maneira programática.
■
Falha ao se conectar ao servidor do LDAP.
Operador Atualizar o diretório inicial do usuário
O operador Atualizar o diretório inicial do usuario configura um compartilhamento para
um usuário em um servidor Active Directory. O compartilhamento inclui uma unidade
inicial, o diretório inicial e o script de logon.
Parâmetros de entrada
DN do usuário
Especifica o nome distinto do objeto de usuário para o qual você deseja definir o
diretório inicial, unidade inicial e o script de logon.
Diretório inicial
Especifica o novo diretório inicial do usuário.
Unidade Inicial
Especifica a nova unidade inicial do usuário.
Script de logon
Especifica o novo script de logon do usuário.
Capítulo 7: Serviços de diretório 257
Operador Atualizar o diretório inicial do usuário
Parâmetros de saída
LDAPUserDn
LDAPADHomeDirectory
LDAPADHomeDrive
LDAPADLogonScript
remoteLDAPHost
remoteLDAPPort
remoteLDAPUser
remoteLDAPPassword
LDAPBaseDN
LDAPUserPrefix
Exemplo:
Falha do operador
Este operador falhará nos seguintes casos:
■
O objeto de usuário não existe.
■
O Active Directory está configurado para evitar que qualquer modificação de
objetos LDAP ocorra de maneira programática.
258 Referência do Criador de Conteúdo
Adicionar um certificado SSL ao CA Process Automation
Adicionar um certificado SSL ao CA Process Automation
Para adicionar um certificado SSL ao CA Process Automation
1.
Recupere o arquivo de certificado do servidor do Active Directory.
Por exemplo, se você precisar estabelecer uma conexão SSL entre o CA Process
Automation e um servidor Active Directory, recupere o certificado. Efetue logon no
site http://i.p./CertSrv em que i.p. é o endereço IP do servidor Active Directory e,
em seguida, faça download do certificado.
2.
Copie o arquivo de certificado para o computador em que o módulo LDAP do CA
Process Automation está em execução.
3.
Importe o certificado usando o comando keytool:
keytool -import -alias PAM -file certnew.cer -keystore "C:\\Arquivos de
programas\\Java\\jdk1.6.0_03\\jre\\lib\\security\\cacerts"
Em que certnew.cer é o caminho para o arquivo do certificado recuperado na etapa
1.
"C:\\ Arquivos de programas\\ Java\\ jdk1.6.0_03\\jre\\ lib\\security\\ cacerts" é o
caminho para o arquivo cacerts dentro do Java JRE ou JDK.
4.
■
O programa keytool faz parte da instalação do Java.
■
Keytool solicitará uma senha. A senha é 'changeit' por padrão.
■
Keytool pergunta: 'Confia neste certificado? [não]'. Digite Sim.
Adicione as seguintes linhas ao arquivo do CA Process Automation:
PAM\server\c2o\bin\c2osvcw.conf
(ou, no caso de uma atualização): I
PAM_DIR%\server\c2o\bin\c2osvcw.conf:
wrapper.java.additional.11 =-djavax.net.ssl.truststore ="c:\ Arquivos de
programas\ Java\ jdk1.6.0_03\ire\ lib\scurity\ cacerts"
wrapper.java.additional.12=-Djavax.net.ssl.trustStorePassword="changeit"
Os números podem ser diferentes para você. Inicie com o próximo número
disponível. Se wrapper.java.additional.11 já estiver definido, use 12 e 13.
A pasta do programa é diferente para sua instalação do JDK.
A senha é changeit.
5.
Reinicie o touchpoint do CA Process Automation que contém o Directory Services
operadores.
Capítulo 7: Serviços de diretório 259
Adicionar um certificado SSL ao CA Process Automation
Configurar o servidor do Active Directory
Para estabelecer uma conexão SSL entre o Módulo LDAP do CA Process Automation e
um servidor Active Directory, verifique se o servidor Active Directory está configurado:
1.
Os serviços de certificado estão instalados no servidor Active Directory (consulte o
Active Directory Admin para esta tarefa).
2.
A solicitação de certificado automática está configurada para controladores de
domínio (consulte o administrador do Active Directory para esta tarefa).
Observação: quando você cria uma nova conta de usuário ou modifica a senha de uma
conta de usuário existente no Active Directory, o Active Directory não permite criar ou
modificar a senha de um usuário, a menos que o CA Process Automation esteja
conectado ao servidor Active Directory por meio de SSL.
260 Referência do Criador de Conteúdo
Capítulo 8: Email
Os operadores Email podem automatizar tarefas executadas em mensagens e pastas em
um servidor de email. Os operadores de email se comunicar com o servidor de emails
remotamente, usando um dos seguintes protocolos:
POP3 (Post Office Protocol versão 3)
O POP3, adequado para o acesso de usuário único a uma caixa de correio, permite
que você faça o download de mensagens de email para o computador local. Por
padrão, os servidores POP3 escutam na porta TCP 110.
POP-SSL
Por padrão, os servidores POP-SSL escutam na porta TCP 995.
IMAP (Internet Message Application Protocol)
O IMAP, adequado para o acesso de vários usuários a uma caixa de correio, permite
o acesso simultâneo por vários clientes. Por padrão, os servidores IMAP escutam na
porta TCP 143.
IMAP-SSL
Por padrão, os servidores IMAP-SSL escutam na porta TCP 993.
Os operadores do módulo Email só poderão se comunicar com o servidor de email se
ele oferecer suporte a IMAP ou POP3. Os operadores Email realizam ações como obter
contas de email. Ambos os protocolos suportam esse tipo de ação. Algumas ações,
como excluir uma pasta, são suportadas somente pelo protocolo IMAP.
Parâmetros de operadores comuns de email
As propriedades a seguir são aplicadas para vários operadores de email:
■
Critérios de filtro de mensagem
■
Parâmetros de logon do servidor de e-mail
Capítulo 8: Email 261
Parâmetros de operadores comuns de email
Critérios de filtro de mensagem
ID da mensagem
Especifica a ID exclusiva da mensagem a ser filtrada. Você também pode passar
uma subsequência de caracteres da ID da mensagem. Se as IDs das mensagens
desejadas não forem conhecidas, você poderá recuperar as IDs das mensagens por
meio do operador Obter lista de mensagens (na página 276). A ação é executada
em todas as mensagens que correspondem à subsequência de caracteres de
assunto.
Observação: esse parâmetro não está disponível para todos os operadores no
módulo Email.
Número da mensagem
Especifica o número da mensagem da mensagem a ser filtrada. Esse parâmetro não
é um número estático para uma mensagem. Se mensagens forem excluídas e
movidas para pastas diferentes, o número de mensagens será alterado. Se houver
ações paralelas executadas na mesma pasta de caixa de correio, é recomendável
usar a ID da Mensagem (em vez de Número da mensagem) para especificar as
mensagens.
Observação: esse parâmetro não está disponível para todos os operadores no
módulo Email.
Assunto da mensagem
Especifica o assunto da mensagem para correspondência. Esse parâmetro pode ser
uma subsequência de caracteres ou uma expressão regular. A ação é executada em
todas as mensagens que correspondem à subsequência de caracteres de assunto.
Remetente da mensagem
Especifica o remetente da mensagem para correspondência. Esse parâmetro pode
ser uma subsequência de caracteres ou uma expressão regular. A ação é executada
em todas as mensagens que correspondem à subsequência de caracteres de
assunto.
Os valores Assunto e Remetente da mensagem são expressões regulares
Marque essa caixa de seleção para especificar valores de Assunto da mensagem e
Remetente da mensagem como expressões regulares (em vez de uma sequência de
caracteres simples) ao filtrar mensagens.
Importante: Para analisar mensagens para os operadores do módulo Email usando
expressões regulares, todas as mensagens devem ser recuperadas da caixa de
correio e analisadas no lado do cliente. Ou seja, no touchpoint em que o operador é
executado. Recomendamos que você não selecione esse campo e use expressões
regulares apenas quando necessário.
Conteúdo da mensagem
Especificado como uma subsequência de caracteres do corpo do email que você
deseja que corresponda.
262 Referência do Criador de Conteúdo
Parâmetros de operadores comuns de email
Hora de envio da mensagem mais antiga
Fazer a correspondência de mensagens que são enviadas após a hora especificada.
Esse parâmetro identifica o primeiro horário em que a mensagem para
correspondência foi enviada, especificado em uma variável do CA Process
Automation.
Hora de envio da mensagem mais recente
Fazer a correspondência de mensagens que são enviadas antes da hora
especificada. Esse parâmetro identifica o último horário em que a mensagem para
correspondência foi enviada, especificado em uma variável do CA Process
Automation.
Observação: os campos Hora de envio da mensagem mais antiga e Hora de envio da
mensagem mais recente são variáveis do tipo de data do CA Process Automation.
Funções do sistema como now() (na página 577) ou today() (na página 584) geram
variáveis do tipo de data. Uma função do sistema chamada parseDate (na página 577)
(stringDate, simpleDateFormat) cria a data corretamente. stringDate é a data no
formato de sequência de caracteres e simpleDateFormat é o formato a ser usado ao
analisar a data. Essa função pode ser usada para analisar uma cadeia de caracteres em
uma variável do tipo de data do CA Process Automation. Por exemplo:
parseDate("2010/07/28 13:00:01", "yyyy/MM/dd HH:mm:ss")
Sinalizador de mensagem IMAP
IMAP usa sinalizadores de mensagem para monitorar o estado de um email. Esses
sinalizadores são armazenadas no servidor. Diferentes clientes que acessando a
mesma caixa de correio em momentos diferentes podem detectar alterações feitas
por outros clientes.
Os sinalizadores a seguir são válidos e podem ser definidos por programação
definindo-se os valores para o nome de sinalizadores. O nome dos sinalizadores
diferencia maiúsculas de minúsculas e é passado totalmente em maiúsculas.
Selecione o sinalizador que deseja definir para a mensagem. Esses sinalizadores
funcionam em conjunto com a caixa de seleção O sinalizador de mensagem IMAP
está definido como verdadeiro.
Respondido
Quando você marca a caixa de seleção O sinalizador de mensagem IMAP está
definido como verdadeiro, apenas os emails que foram respondidos retornam
(os emails para os quais as respostas foram enviadas).
Excluído
Quando você marca a caixa de seleção O sinalizador de mensagem IMAP está
definido como verdadeiro, todos os emails que não foram marcados como
excluídos do servidor retornam.
Capítulo 8: Email 263
Parâmetros de operadores comuns de email
Rascunho
Quando você marca a caixa de seleção O sinalizador de mensagem IMAP está
definido como verdadeiro, todos os emails que não estiverem atualmente em
um estado de rascunho retornam.
Sinalizado
Quando você marca a caixa de seleção O sinalizador de mensagem IMAP está
definido como verdadeiro, os emails que não estiverem sinalizados retornam.
recente
Quando você marca a caixa de seleção O sinalizador de mensagem IMAP está
definido como verdadeiro, os emails que não foram abertos (clicados)
retornam.
Visualizado
Quando você marca a caixa de seleção O sinalizador de mensagem IMAP está
definido como verdadeiro, qualquer email que esteja marcado como LIDO
retorna. Quando você não marca a caixa de seleção O sinalizador de mensagem
IMAP está definido como verdadeiro, qualquer email que esteja marcado como
NÃO LIDO retorna.
O sinalizador de mensagem IMAP está definido como verdadeiro
O nome do sinalizador IMAP é definido na lista suspensa Sinalizador de
mensagem IMAP. Seu valor booleano pode ser selecionado nessa caixa de
seleção. Por exemplo, se desejar selecionar Visualizado como verdadeiro,
marque Visualizado na lista suspensa e, em seguida, marque essa caixa de
seleção.
Parâmetros de logon do servidor de e-mail
Protocolo para conexão
Selecione o protocolo de email usado para estabelecer conexão com o servidor:
■
IMAP
■
IMAP-SSL
■
POP3
■
POP3-SSL
Host do servidor de e-mail
Especifica o nome de host/endereço IP do servidor de email.
Porta do servidor de e-mail
Especifica a porta do servidor de email.
264 Referência do Criador de Conteúdo
Operador Criar pasta
Nome de usuário
Especifica o nome do usuário para acessar o servidor de email.
Senha
Especifica a senha para que o usuário acesse o servidor de email.
Operador Criar pasta
O operador Criar pasta cria uma pasta no servidor de email. As pastas são criadas de
forma recursiva usando o protocolo IMAP.
Se a pasta já existir, será lançada uma exceção informando que A pasta já existe.
Parâmetros de entrada
Nome da pasta da caixa de correio
Nome da pasta a ser criada no servidor de email.
Parâmetros de logon do servidor de e-mail (na página 264)
Parâmetros de saída
FolderCreated
Retorna verdadeiro quando a pasta é criada com êxito e, caso contrário, retorna
falso.
FolderName
Protocolo
ServerHost
ServerPort
UserName
Senha
Capítulo 8: Email 265
Operador Excluir email
Operador Excluir email
O operador Excluir email exclui mensagens da caixa de correio e retorna o número de
mensagens excluídas. Esse operador usa o protocolo IMAP.
Observação: se todos os campos forem deixados em branco, esse operador excluirá
todas as mensagens da caixa de correio (o nome da pasta da caixa de correio
especificado).
Parâmetros de entrada
Nome da pasta da caixa de correio
Especifica o nome da pasta que contém as mensagens a serem excluídas do
servidor de email.
Critérios de filtro de mensagem (na página 262)
Parâmetros de logon do servidor de e-mail (na página 264)
266 Referência do Criador de Conteúdo
Operador Excluir pasta
Parâmetros de saída
DeletedCount
Retorna o número de mensagens excluídas.
FolderName
MessageID
MessageNumber
Assunto
De
IsRegExp
Corpo
SentFromDate
SentToDate
FlagField
FlagValue
Protocolo
ServerHost
ServerPort
UserName
Senha
Operador Excluir pasta
O Excluir pasta operador exclui uma pasta no servidor usando o protocolo IMAP. A pasta
será excluída mesmo se contiver subpastas.
Parâmetros de entrada
Nome da pasta da caixa de correio
Especifica o nome da pasta a ser excluída do servidor de email.
Parâmetros de logon do servidor de e-mail (na página 264)
Capítulo 8: Email 267
Operador Excluir pasta
Parâmetros de saída
FolderCreated
Retorna verdadeiro quando a pasta é excluída com êxito, caso contrário, retorna
falso.
FolderName
Protocolo
ServerHost
ServerPort
UserName
Senha
Exemplo:
Importante! O cenário a seguir usa um servidor de email hmail. O cenário a seguir não
funciona quando um servidor Dominos é usado.
1.
Criar hierarquia de pastas, como teste1\teste2\teste3\teste4 (paralela à "Caixa de
entrada").
2.
Criar outra hierarquia, teste2\teste5\teste6 (paralela à "Caixa de entrada").
3.
Excluir a pasta "teste2" usando o operador Excluir pasta.
Resultado esperado
A hierarquia "test2\test5\test6" é excluída.
Resultado real
O processo é executado com êxito e retorna falso. Em condições ideais, ele retorna
verdadeiro. A pasta ainda existe no servidor de email.
268 Referência do Criador de Conteúdo
Operador Obter o conteúdo do email
Operador Obter o conteúdo do email
O operador Obter conteúdo de email recupera o corpo da mensagem e os anexos. Se o
campo de número da mensagem não estiver em branco ou nulo, o operador recuperará
um único email (com base no número de mensagem) e retornará os detalhes. Caso
contrário, o operador retornará o conteúdo de todos os emails na pasta.
Observação: se todos os campos forem deixados em branco, esse operador recuperará
o conteúdo de todas as mensagens da pasta de caixa de correio especificada.
Parâmetros de entrada
Nome da pasta da caixa de correio
Especifica o nome da pasta que contém as mensagens a serem processadas.
Definir mensagens recuperadas como visualizadas
Quando selecionada, esta opção define as mensagens recuperadas como
visualizadas.
Iniciar índice de conteúdo de email a ser obtido na variável do conjunto de dados
Se você inserir um índice nesse campo, o conteúdo a partir desse índice será
exibido na variável Conjunto de dados. Deixe em branco para começar do início.
Comprimento do conteúdo de email a ser obtido na variável do conjunto de dados
Se você inserir um índice nesse campo, o conteúdo até esse índice será exibido na
variável Conjunto de dados. Deixe-o em branco para obter o máximo possível de
conteúdo de email.
Processar anexos de email
Quando selecionada, os anexos também são processados. O padrão é desmarcado.
Capítulo 8: Email 269
Operador Obter o conteúdo do email
Operação do anexo
Especifica uma das seguintes operações que podem ser executadas no anexo. Essa
opção é ativada quando o usuário marca a caixa de seleção Processar anexos de
email.
Salvar anexo a um arquivo
Salva o anexo na pasta de destino.
Obter conteúdo de anexo na variável do conjunto de dados
Grava o conteúdo do anexo em uma variável do conjunto de dados.
A propriedade para recuperar conteúdo de email é exibida como uma
propriedade configurável. O tamanho padrão é 64 K.
Adicione "mail.maximum.content.size=64" a OasisConfig.properties para
configurar o tamanho. A unidade de tamanho é K.
Ambos
Executa as operações Salvar e Gravar conteúdo na variável conjunto de dados.
Nome da pasta de destino
Especifica a pasta de destino em que o anexo deve ser salvo.
Gerar nomes de arquivos exclusivos para salvar anexos
Quando marcada, fornece a opção de gerar nomes de arquivo exclusivos ao salvar
anexos.
Iniciar índice de conteúdo do anexo a ser obtido na variável do conjunto de dados
Se você inserir um índice nesse campo, o conteúdo do anexo a partir desse índice
será exibido na variável Conjunto de dados. Deixe em branco para começar do
início.
Comprimento do conteúdo do anexo a ser obtido na variável do conjunto de dados
Se você inserir um índice nesse campo, o conteúdo do anexo até esse índice será
exibido na variável Conjunto de dados. Deixe-o em branco para obter o máximo
possível de conteúdo de email.
Critérios de filtro de mensagem (na página 262)
Parâmetros de logon do servidor de e-mail (na página 264)
270 Referência do Criador de Conteúdo
Operador Obter o conteúdo do email
Parâmetros de saída
MessageContent
Retorna o conteúdo de mensagens e dos anexos.
Contém:
ResultRow
AttachmentContents
MailContents
AttachmentFiles
FolderName
MarkMessagesAsSeen
MessageContentStartIndex
MessageContentLength
IsProcessAttachement
ProcessAttachmentType
DestinationFolderName
GenerateUniqueName
MessageAttachmentStartIndex
MessageAttachmentLength
MessageID
MessageNumber
Assunto
De
IsRegExp
Corpo
SentFromDate
SentToDate
FlagField
FlagValue
Protocolo
ServerHost
ServerPort
UserName
Senha
Capítulo 8: Email 271
Operador Obter contagem de emails
Operador Obter contagem de emails
O operador Obter contagem de email retorna o número de mensagens na pasta.
Você pode se conectar ao servidor de email usando o protocolo POP3 ou IMAP e, com
base no protocolo, o usuário deve fornecer o número da porta apropriado.
■
A porta padrão para POP3 é 110.
■
A porta padrão para IMAP é 143.
■
A porta padrão para POP-SSL é 995.
■
A porta padrão para IMAP-SSL é 993.
Parâmetros de entrada
Nome da pasta da caixa de correio
Especifica o nome da pasta que contenha os emails a serem processados.
Critérios de filtro de mensagem (na página 262)
Parâmetros de logon do servidor de e-mail (na página 264)
272 Referência do Criador de Conteúdo
Operador Obter envelope de email
Parâmetros de saída
MessageCount
Retorna o número de emails na pasta.
FolderName
MessageID
MessageNumber
Assunto
De
IsRegExp
Corpo
SentFromDate
SentToDate
FlagField
FlagValue
Protocolo
ServerHost
ServerPort
UserName
Senha
Operador Obter envelope de email
O operador Obter envelope de email recupera os envelopes de email a partir de
critérios de filtro especificados. Se o número da mensagem não estiver em branco ou
nulo (especificado nos Critérios de filtro de mensagem (na página 262)), o operador
recuperará um único email (com base no número da mensagem) e retornará os
detalhes. Caso contrário, esse operador retornará envelopes de todos os emails na
pasta.
Observação: se todos os campos forem deixados em branco, esse operador recuperará
o conteúdo de todas as mensagens da pasta de caixa de correio especificada.
Capítulo 8: Email 273
Operador Obter envelope de email
Parâmetros de entrada
Nome da pasta da caixa de correio
Especifica o nome da pasta que contém as mensagens a serem processadas.
Definir mensagens recuperadas como visualizadas
Quando selecionada, esta opção define os emails como visualizados.
Critérios de filtro de mensagem (na página 262)
Parâmetros de logon do servidor de e-mail (na página 264)
274 Referência do Criador de Conteúdo
Operador Obter envelope de email
Parâmetros de saída
MessageEnvelope
(Mapa de valores) Retorna o envelope das mensagens na pasta.
Contém:
ResultRow
SentDate
Assunto
Para
Cco
Cc
De
FolderName
MarkMessagesAsSeen
MessageID
MessageNumber
Assunto
De
IsRegExp
Corpo
SentFromDate
SentToDate
FlagField
FlagValue
Protocolo
ServerHost
ServerPort
UserName
Senha
Capítulo 8: Email 275
Operador Obter lista de emails
Operador Obter lista de emails
O operador Obter lista de emails recupera uma lista de emails que correspondem a
determinados critérios de filtro. Você pode configurar campos descritos em Critérios de
filtro de mensagem (na página 262) para filtrar apenas os emails dos quais você deseja
recuperar os envelopes. Esse operador pode usar os protocolos IMAP e POP3. Use o
operador Obter lista de emails especificamente para recuperar informações básicas de
emails. Essas informações incluem ID da mensagem e Número da mensagem, que
podem ser usados em outros operadores.
Observação: o operador Obter lista de emails pode recuperar envelopes de no máximo
512 emails em uma iteração.
Parâmetros de entrada
Nome da pasta da caixa de correio
Especifica o nome da pasta de caixa de correio de destino que contenha emails a
serem processados. Não é permitido deixar este campo vazio
Critérios de filtro de mensagem (na página 262)
Parâmetros de logon do servidor de e-mail (na página 264)
Parâmetros de saída
MessageList
Uma matriz de mapas de valores. Cada índice da matriz é um tipo de dados Mapa
de valores do CA Process Automation. O Mapa de valores contém os seguintes
campos que contêm as seguintes informações em uma única mensagem:
MessageID
UniqueID da mensagem.
MessageNumber
O número de mensagem poderá variar para o mesmo email se emails forem
movidos de uma pasta para outra ou forem excluídos e apagados. É
recomendável usar MessageID para especificar os emails de forma exclusiva.
276 Referência do Criador de Conteúdo
Operador Obter lista de emails
Assunto
Assunto do email.
SenderAddress
Endereço do remetente do email.
SentDate
Uma variável de tipo de dados do CA Process Automation com a data em que o
email foi enviado.
ReceivedDate
Uma variável de tipo de dados do CA Process Automation com a data em que o
servidor recebeu o email. Este valor só é preenchido quando se usa o protocolo
IMAP para se conectar ao servidor.
NumOfAttachments
Uma variável do tipo de número inteiro para fornecer o número de anexos
presentes no email.
FolderName
Assunto
De
IsRegExp
Corpo
SentFromDate
SentToDate
FlagField
FlagValue
Protocolo
ServerHost
ServerPort
UserName
Senha
Capítulo 8: Email 277
Operador Mover email
Operador Mover email
O operador Mover email move os emails de uma pasta para outra.
Parâmetros de entrada
Nome da pasta de origem da caixa de correio
Nome da pasta de origem que contenha os emails a serem movidos.
Nome da pasta de destino da caixa de correio
Especifica o nome da pasta de destino em que os emails são copiados.
Observações:
■
Se a pasta de origem não existir, o CA Process Automation irá gerar uma exceção
informando que a pasta de origem não existe.
■
Se a pasta de destino não existir, o CA Process Automation criará a pasta de destino
e, em seguida, moverá os emails da pasta de origem para a pasta de destino.
Critérios de filtro de mensagem (na página 262)
Parâmetros de logon do servidor de e-mail (na página 264)
278 Referência do Criador de Conteúdo
Operador Limpar pasta
Parâmetros de saída
MovedCount
SourceFolderName
DestinationFolderName
MessageID
MessageNumber
Assunto
De
IsRegExp
Corpo
SentFromDate
SentToDate
FlagField
FlagValue
Protocolo
ServerHost
ServerPort
UserName
Senha
Operador Limpar pasta
O operador Limpar pasta limpa (remove permanentemente) as pastas marcadas como
EXCLUÍDO e retorna o número de emails limpos. Esse operador usa o protocolo IMAP.
Parâmetros de entrada
Nome da pasta da caixa de correio
Especifica o nome da pasta no servidor de email que contenha emails a serem
excluídos permanentemente.
Parâmetros de logon do servidor de e-mail (na página 264)
Capítulo 8: Email 279
Operador Renomear pasta
Parâmetros de saída
ExpungedCount
Retorna o número de emails excluídos.
FolderName
Protocolo
ServerHost
ServerPort
UserName
Senha
Operador Renomear pasta
Renomear pasta do operador renomeia a pasta no servidor de email. O operador usa o
protocolo IMAP.
Parâmetros de entrada
Nome da pasta atual da caixa de correio
Especifica o nome antigo da pasta a ser renomeada
Novo nome de pasta da caixa de correio
Especifica o novo nome da pasta.
Parâmetros de logon do servidor de e-mail (na página 264)
280 Referência do Criador de Conteúdo
Operador Enviar email
Parâmetros de saída
FolderRenamed
Retorna verdadeiro quando a pasta foi renomeada com êxito, caso contrário,
retorna falso.
OldFolderName
NewFolderName
Protocolo
ServerHost
ServerPort
UserName
Senha
Operador Enviar email
Use o operador Alerta de email para enviar notificações por email aos destinatários
especificados.
A implementação de email do CA Process Automation oferece suporte ao envio de
mensagens por meio de um servidor SMTP. É possível especificar qualquer endereço de
email válido aceito pelo servidor SMTP. Esses endereços podem incluir aliases, uma lista
de endereçamento, endereço de fax ou um pager digital. O servidor SMTP, em vez do
CA Process Automation, controla a entrega real de uma mensagem.
Capítulo 8: Email 281
Operador Enviar email
Um operador Alerta de email pode incluir arquivos anexados. É possível especificar
anexos para enviar arquivos atualizados dinamicamente, em vez de informações
estáticas especificadas quando você adicionou um operador Alerta de email a um
processo. Esse recurso é útil para enviar anexos como arquivos de log e de exceção.
O operador Alerta de email também oferece suporte a URLs HTTP/HTTPS como um
caminho de anexo. O operador Alerta de email falhará se um nome de caminho não for
válido no tempo de execução.
Dica: especifique que os locais para os anexos são relativos ao touchpoint que está
executando o módulo Alerta.
Parâmetros de entrada
Nome de usuário
Uma expressão que especifica um nome de usuário válido ou perfil para enviar
emails no servidor SMTP. Por exemplo, Process.Email.nome do usuário.
Senha
Especifica a senha para a conta do nome do usuário. Por exemplo,
Process.Email.senha.
De
O endereço de email que será exibido no campo do remetente de email de saída.
Para
Especifica os endereços de email dos destinatários. Separe vários endereços de
email com vírgula ou um ponto-e-vírgula. Por exemplo, [email protected],
[email protected].
Cc
Uma expressão que especifica os endereços de destinatários que recebem cópias
deste alerta de email. Separe vários endereços de email com vírgula ou um
ponto-e-vírgula. Por exemplo, [email protected];
[email protected].
Assunto
Uma expressão que especifica uma descrição curta que será exibida no assunto da
mensagem de email. Por exemplo, Alerta do CA Process Automation.
Mensagem
Especifica a mensagem do email enviado. Por exemplo,
Advertência
Problemas de backup em um Touchpoint: + Process.TouchpointName.
282 Referência do Criador de Conteúdo
Operador Enviar email
Enviar email no formato HTML
Quando selecionado, o CA Process Automation usa texto HTML no campo
Mensagem. Se essa opção não for selecionada, o CA Process Automation usa texto
sem formatação.
Por exemplo, use o seguinte texto para exibir Advertência em fonte vermelha:
<font size="5" color="red">Advertência</font>
Attachment
Uma expressão que especifica os caminhos completos dos arquivos para anexar ao
email. Separe os diferentes nomes de caminhos com vírgulas ou pontos-e-vírgulas.
Você também pode especificar URLs HTTP/HTTPS para locais remotos e locais.
Esse parâmetro deve especificar locais válidos para o módulo Alerta no tempo de
execução e no touchpoint em que esse módulo está sendo executado. Por exemplo,
C:\\CA Process Automation\\Data\\Log\\Global.log.
Confirmação
Marque esta caixa de seleção para solicitar uma confirmação da entrega da
mensagem. A confirmação é geralmente um serviço fornecido pelo cliente de email
do destinatário. O CA Process Automation não pode garantir a confirmação.
Codificação
Especifica o esquema de codificação em que o leitor recebe o texto (UTF-8, UTF-16,
US-ASCII, Windows-1250, Windows-1252, Shift_JIS).
Parâmetros de saída
usuário
password
from
to
cc
subject
texto
isContentHtml
anexo
recpt
Capítulo 8: Email 283
Capítulo 9: Gerenciamento de arquivos
Os operadores Gerenciamento de arquivos monitoram diretórios, arquivos e seu
conteúdo. Eles podem ser executados localmente ou em um sistema remoto. Os
operadores Gerenciamento de arquivos também suportam operações em um nó do
proxy. O processo segue um caminho de êxito ou falha, com base nos resultados da
operação.
Use os operadores de gerenciamento de arquivos para criar, excluir, renomear,
compactar e descompactar arquivos locais. Você também pode usar o operador de
Gerenciamento de Arquivos para exibição de arquivos no touchpoint em que o operador
é executado. Todos os operadores do módulo Arquivo são executados sob o mesmo
nome de usuário que executa o touchpoint, como administrator no touchpoint do
Windows ou raiz em um touchpoint do UNIX.
Os operadores do módulo Arquivo podem ser executados em agentes do proxy. As
propriedades em um serviço normal e do proxy são as mesmas, mas alguns
comportamentos são diferentes. Por exemplo, se o Serviço do proxy do processo está
sendo executado com a opção de saída do log marcada, o arquivo de log é criado no
sistema de arquivos em que o agente está sendo executado. O arquivo de log não é
criado no computador onde o agente do proxy está localizado.
Importante: As seguintes condições se aplicam a todos os operadores nessa categoria
ao executá-los em um host remoto do Windows por um touchpoint do proxy:
- Use caminhos de estilo UNIX para os campos relacionados a caminhos (barras e
nenhuma letra de unidade).
- Cada servidor SSH pode ter um local diferente para seu diretório "raiz". Os
comandos permitidos que são relativos ao diretório raiz podem variar muito.
Operador Compactar arquivo
O operador Compactar arquivo compacta um arquivo ou diretório. Em um ambiente
Windows, ele é compactado com o utilitário de linha de comando WINZIP. Em
ambientes UNIX, ele é compactado com o utilitário gzip.
Capítulo 9: Gerenciamento de arquivos 285
Operador Compactar arquivo
Pré-requisitos
■
O utilitário de linha de comando WZZIP deverá ser instalado no host de destino se
ele for um host do Windows. O utilitário de linha de comando WZZIP é um
suplemento gratuito para usuários do WinZip 12 standard ou pro com uma licença
válida.
■
O utilitário gzip é exigido para os ambientes UNIX.
Parâmetros de entrada
Arquivo de origem/nome do diretório
Especifica o nome do arquivo ou diretório a ser compactado.
Observação: no host do Windows, a extensão do arquivo compactado é .zip.
Em um host do UNIX, se a origem for um diretório, todos os arquivos nesse
diretório serão compactados e a extensão de cada arquivo será substituída por .gz.
Diretório de trabalho
Especifica o diretório de trabalho para executar essa operação.
Observação: se o diretório de trabalho não for especificado, o diretório inicial do
usuário será o diretório de trabalho.
O caminho de arquivo para o diretório de trabalho pode ser absoluto ou relativo.
ID do usuário
Especifica a conta de usuário a ser usada ao executar o operador no host. Substitui
o usuário especificado nas propriedades de nível de categoria do operador.
Senha
Especifica a senha para o usuário.
Parâmetros de saída
fileName
workingDir
userID
password
286 Referência do Criador de Conteúdo
Operador Copiar arquivo
Operador Copiar arquivo
O operador Copiar arquivo copia a origem para o destino. A origem e o destino podem
ser um arquivo ou diretório.
Parâmetros de entrada
Arquivo de origem/nome do diretório
Especifica o arquivo ou diretório a ser copiado.
Arquivo/diretório de destino
Especifica o arquivo ou diretório a ser copiado.
Diretório de trabalho
Especifica o diretório de trabalho para executar essa operação.
Observações: se o diretório de trabalho não for especificado, o diretório inicial do
usuário será o diretório de trabalho.
O caminho de arquivo para o diretório de trabalho pode ser absoluto ou relativo.
ID do usuário
Especifica a conta de usuário a ser usada ao executar o operador no host. Substitui
o usuário especificado no nível de categoria do operador.
Senha
Especifica a senha para o usuário.
Observações:
■
Se o destino não existir e a origem for um arquivo, supõe-se que o destino seja um
arquivo.
■
Se o destino não existir e a origem for um diretório, supõe-se que o destino seja um
diretório.
■
Em um host do Windows, um erro "Não é possível executar cópia cíclica" é emitido
quando o diretório de origem contém o diretório de destino.
Capítulo 9: Gerenciamento de arquivos 287
Operador Criar pasta
Parâmetros de saída
fileName
destinationFileName
workingDir
userID
password
Operador Criar pasta
O operador Criar pasta oferece a funcionalidade para criar um diretório. O operador não
gera um erro se o diretório já existe, criando diretórios de maneira recorrente,
conforme necessário.
Parâmetros de entrada
Nome do diretório
Especifica o diretório a ser criado.
Shell padrão
Modos de permissão (apenas para UNIX)
Define o modo de permissão. Essa entrada é válida para um host UNIX somente.
Diretório de trabalho
Especifica o diretório de trabalho para executar essa operação.
Observações: se o diretório de trabalho não for especificado, o diretório inicial do
usuário será o diretório de trabalho.
O caminho de arquivo para o diretório de trabalho pode ser absoluto ou relativo.
ID do usuário
Especifica a conta de usuário a ser usada ao executar o operador no host. Substitui
o usuário especificado nas propriedades no nível do módulo.
Senha
Especifica a senha para o usuário.
288 Referência do Criador de Conteúdo
Operador Descompactar arquivo
Parâmetros de saída
fileName
defaultShell
permissão
workingDir
userID
password
Operador Descompactar arquivo
O operador Descompactar arquivo extrai um arquivo/diretório compactado.
Pré-requisitos
■
Em um host Windows, o computador de destino deve ter o utilitário de linha de
comando WZZIP instalado. O utilitário de linha de comando WZZIP é um
suplemento gratuito para usuários do WinZip 12 standard ou pro com uma licença
válida.
■
Em ambientes UNIX, esse operador usa o utilitário gzip.
Parâmetros de entrada
Nome de arquivo/diretório a ser descompactado
Especifica o arquivo/diretório a ser descompactado.
Diretório de trabalho
Especifica o diretório de trabalho para executar essa operação.
Observações: se o diretório de trabalho não for especificado, o diretório inicial do
usuário será o diretório de trabalho.
O caminho de arquivo para o diretório de trabalho pode ser absoluto ou relativo.
ID do usuário
Especifica a conta de usuário a ser usada ao executar o operador no host. Substitui
o usuário especificado nas propriedades no nível do módulo.
Senha
Especifica a senha para o usuário.
Capítulo 9: Gerenciamento de arquivos 289
Operador Excluir arquivo
Parâmetros de saída
compressFileName
workingDir
userID
password
Operador Excluir arquivo
O operador Excluir arquivo remove (exclui) um arquivo ou diretório.
Parâmetros de entrada
Arquivo de origem/nome do diretório
Especifica o arquivo ou diretório a ser excluído.
Diretório de trabalho
Especifica o diretório de trabalho para executar essa operação.
Observação: se o diretório de trabalho não for especificado, o diretório inicial do
usuário será o diretório de trabalho.
O caminho de arquivo para o diretório de trabalho pode ser absoluto ou relativo.
ID do usuário
Especifica a conta de usuário a ser usada ao executar o operador no host. Substitui
o usuário especificado nas propriedades no nível do módulo.
Senha
Especifica a senha para o usuário.
Observações:
■
Uma tentativa de excluir um arquivo ou diretório inexistente seguirá o caminho de
erro.
■
Uma tentativa de excluir um arquivo ou diretório com permissão insuficiente
seguirá o caminho de erro.
290 Referência do Criador de Conteúdo
Operador Obter o conteúdo do diretório
Parâmetros de saída
fileName
workingDir
userID
password
Operador Obter o conteúdo do diretório
O operador Obter o conteúdo do diretório cria uma lista de caminhos para todas as
pastas ou arquivos em um diretório especificado que correspondam a uma condição de
pesquisa.
Parâmetros de entrada
Diretório base
Especifica o caminho para o diretório em que deseja iniciar a pesquisa.
Caminho do arquivo/nome da máscara
Especifica o padrão que o operador detectou.
Diferenciação de padrão de maiúscula e minúscula
Quando essa opção é marcada, faz-se a correspondência de caracteres maiúsculos e
minúsculos ao pesquisar um padrão. Se desmarcada, as letras em um padrão
correspondem a caracteres maiúsculos e minúsculos.
Classificar itens pela hora da última modificação
Quando essa opção é marcada, classifica as pastas ou os arquivos em um diretório
especificado pela última hora de modificação.
Capítulo 9: Gerenciamento de arquivos 291
Operador Obter o conteúdo do diretório
Padrão de correspondência no nome de arquivo/diretório
Quando essa opção é marcada, faz-se a correspondência somente de nomes de
arquivo ou diretório, em vez de usar qualquer parte de um caminho.
Diretórios incluídos nos resultados
Selecione uma das seguintes opções:
■
Todos os diretórios sob o diretório base
■
Diretórios que incluem arquivos correspondentes
■
Diretórios com caminho ou nome de correspondência
Nível de recorrência
A quantidade de níveis de diretório a ser desativada ao fazer a correspondência de
arquivos ou diretórios.
Timer de estado (segundos)
O intervalo mínimo no qual a condição deve ser mantida.
Parâmetros de saída
DirectoryCount
DirectoryList
FilesCount
FilesList
fileName
Padrão
caseSensitive
timeSort
matchPath
dirFilterOptions
recursionLevel
stateTimer
timeOut
292 Referência do Criador de Conteúdo
Operador Obter atributos de arquivo
Operador Obter atributos de arquivo
O operador Obter atributos de arquivo lê os atributos de um arquivo especificado e os
salva como variáveis (como FileExists, FileSize, IsFile, IsLink) no conjunto de dados do
operador.
Para acessar um atributo em uma expressão do CA Process Automation, use a seguinte
sintaxe:
Process.Operator_name.field_name
Process acessa o conjunto de dados do processo.
Operator_name especifica o conjunto de dados do operador.
field_name especifica o atributo no conjunto de dados do operador.
Parâmetros de entrada
Nome do arquivo/diretório
Especifica o caminho completo para um arquivo ou diretório a ser exibido. O local
deve estar acessível para o módulo Exibição de arquivo no touchpoint em que ele
está sendo executado em tempo de execução.
Por exemplo:
/tmp/IT PAM/scripts/backup_ora1.log
Se você especificar um arquivo ou diretório sem especificar o caminho completo, os
operadores Gerenciamento de arquivos usarão
<diretório_de_instalação>\server\c2o como caminho relativo para o arquivo ou
diretório especificado. Na maioria dos casos, é possível usar a barra (/) em um
caminho.
Capítulo 9: Gerenciamento de arquivos 293
Operador Obter atributos de arquivo
Parâmetros de saída
@FileName
O caminho completo para o arquivo, conforme calculado com a expressão "Nome
de arquivo".
FileExists
1 se um arquivo existir, 0 se não existir.
FileName
FileTime
Especifica a hora do arquivo.
FileDate
Especifica uma data do arquivo.
IsDirectory
1 se descrever um diretório, 0 se não.
IsFile
1 se descrever um arquivo, 0 se não.
IsLink
1 se o item for um link simbólico no UNIX, 0 se não.
FileOtherRead
FileOtherWrite
FilePermission
FileSize
O tamanho do arquivo em bytes.
FileSizeKB
O tamanho do arquivo em kilobytes (KB =1.024 bytes). Uma fração de um kilobyte é
contada como um kilobyte.
FileSizeMB
O tamanho do arquivo em megabytes (MB =1.024 KB). Uma fração de um megabyte
é contada como um megabyte.
294 Referência do Criador de Conteúdo
Operador Obter atributos de arquivo
FileGroup
FileOwner
FileGroupExec
1 se o grupo puder executar, 0 se não puder.
FileGroupRead
1 se o grupo puder ler, 0 se não puder.
FileGroupWrite
1 se o grupo puder gravar, 0 se não puder.
FileOtherExec
1 se outros puderem executar, 0 se não puderem.
FileOwnerExec
1 se o proprietário puder executar, 0 se não puder.
FileOwnerRead
1 se o proprietário puder ler, 0 se não puder.
FileOwnerWrite
1 se o proprietário puder gravar, 0 se não puder.
IsSpecial
1 se um arquivo de sistema especial, 0 se não for.
Observação: a definição de um arquivo de sistema especial depende da plataforma.
Exemplo:
Este operador pode corresponder a um soquete ou fifo em plataformas UNIX.
Outros (por exemplo, FileOtherExec) se referem a usuários que não são o proprietário
nem estão no grupo definido para a permissão especificada.
Capítulo 9: Gerenciamento de arquivos 295
Operador Monitorar arquivo
Operador Monitorar arquivo
O operador Exibir arquivo define uma espera para uma condição em um arquivo ou
diretório. Esse operador permite atrasar o processamento em um processo para a
existência ou ausência de um arquivo ou diretório.
As condições disponíveis são:
■
A existência de um arquivo e, opcionalmente, um tamanho mínimo (em bytes).
■
A ausência de um arquivo.
■
A presença de sequências de caracteres que correspondem a um padrão em um
arquivo.
Um timer de estabilidade especifica o atraso mínimo durante o qual a condição deve ser
continuamente mantida, antes de retornar que o operador foi concluído com êxito. Por
exemplo, esse operador pode especificar o tamanho mínimo de um arquivo enviado por
uma transferência de FTP.
Os testes em um arquivo são distintos. Esse operador não indica que uma condição está
continuamente presente. Em vez disso, o operador Exibir arquivo indica que a condição
é atendida em cada intervalo de teste executado pelo operador.
Parâmetros de entrada
Nome do arquivo/diretório
Especifica o caminho completo para um arquivo ou diretório a ser exibido. O local
deve estar acessível para o módulo Exibição de arquivo no touchpoint em que ele
está sendo executado em tempo de execução.
Se você especificar um arquivo ou diretório sem indicar o caminho completo, os
Módulos de exibição de arquivos usam o diretório Bin do CA Process Automation
como o caminho relativo para o arquivo ou diretório especificado. Na maioria dos
casos, é possível usar o caractere de barra (/) em um caminho.
296 Referência do Criador de Conteúdo
Operador Monitorar arquivo
Timer de estado (segundos)
Especifica o atraso mínimo em segundos durante o qual a condição especificada
deve continuamente mantida, antes que o CA Process Automation execute as
ramificações para o estado Concluído.
Condição
Especifica a condição para executar as ramificações para o estado Concluído:
■
Sua presença requer que o arquivo exista e que seu tamanho seja maior que o
Tamanho mínimo do arquivo.
■
Sua ausência requer que o arquivo não exista.
■
Correspondência de padrão especifica que um padrão de caracteres ocorra no
conteúdo de um arquivo especificado ou nos nomes de arquivos em um
diretório especificado.
Tamanho mínimo de arquivo
Se "Presença" é especificado para Condição, essa opção especifica o tamanho de
arquivo mínimo em bytes para esse operador execute ramificações para a condição
Concluído.
Padrão
Se Correspondência de padrão for especificado para Condição, essa opção
especificará uma expressão regular que retorna o padrão pesquisado pelo operador
(consulte “Usando máscaras para especificar padrões em sequências de caracteres”
no Guia do Criador de Conteúdo).
Para fazer a correspondência com qualquer número de linhas, é possível usar o
escape \n no campo Padrão. O exemplo a seguir faz correspondência das linhas
iniciadas por “Log” seguido por qualquer número de linhas novas intermediárias e
uma sequência de caracteres de texto terminada em “Error=89”:
"Log.*\n.*Error=89"
Caso esteja acostumado a usar caracteres de escape em linguagens de
programação, esse escape \n corresponde a qualquer quantidade de novas linhas
no Windows ou UNIX. Esse escape não corresponde a um caractere de alimentação
de linha única.
Separador
Especifica o caractere que delimita a zona no Padrão a ser salvo para as variáveis
especificadas pelos nomes de variáveis.
Iniciar no final do arquivo
Inicia a pesquisa no final de um arquivo especificado, para encontrar a última
ocorrência de um padrão em um arquivo. Essa opção permite que você faça a
correspondência das mensagens mais recentes em um arquivo.
Capítulo 9: Gerenciamento de arquivos 297
Operador Monitorar arquivo
Diferenciação de padrão de maiúscula e minúscula
Considera caracteres maiúsculos e minúsculos ao pesquisar um padrão. Se esta
caixa de seleção não for marcada, as letras em um padrão farão correspondência
com caracteres tanto maiúsculos quanto minúsculos.
Deslocamento da pesquisa de arquivo
Especifica uma posição inicial para uma pesquisa.
Para executar uma correspondência de padrão em loop, é possível usar as variáveis
MatchPos e MatchEntry a partir do conjunto de dados do operador para iniciar no
ponto em que a correspondência anterior parou:
Process.Operator_name. MatchedPos+ Len(Process.Operator_name.MatchedEntry)
Nomes da variável
Especifica os nomes das variáveis para salvar o texto que corresponde às zonas
delimitadas no padrão. As variáveis do conjunto de dados do operador são
acessadas por meio do conjunto de dados do processo, usando o processo de
palavra-chave. Por exemplo, a especificação dos nomes de variáveis Nível e Código
atribuiria valores de subsequências de caracteres extraídos para as variáveis do
conjunto de dados do operador Process.Operator_name.Level e
Process.Operator_name.Code. É possível adicionar, remover e classificar as
variáveis usadas para armazenar sequências de caracteres correspondentes usando
a barra de ferramentas.
Parâmetros de saída
LastRead Post
MatchedEnd
MatchedEntry
MatchedPos
fileName
stateTimer
condição
minFileSize
Padrão
Separador
startFromEnd
caseSensitive
fileSearchOffset
variableNames
298 Referência do Criador de Conteúdo
Operador Ler a partir do arquivo
Exemplo:
Esse operador pode aguardar até que um operador de saída entre em spool e exclua um
arquivo. Um problema seria indicado se um arquivo existisse no diretório de spool por
mais tempo que a duração especificada. O Processo pode então executar um alerta para
notificar um operador sobre o problema.
Operador Ler a partir do arquivo
O operador Ler a partir do arquivo lê o conteúdo do arquivo em uma variável do
conjunto de dados. O usuário também pode ler linhas específicas.
A variável do conjunto de dados pode ser uma sequência de caracteres ou uma matriz
de sequência de caracteres. Se a variável do conjunto de dados for uma matriz, o
comprimento máximo poderá ser 1024. As linhas que excederem esse limite são
ignoradas e um novo campo de variável do conjunto de dados "avisos" é criado depois
da execução. Esse novo conjunto de dados de avisos contém a mensagem de aviso.
Parâmetros de entrada
Nome do arquivo de origem
Especifica o arquivo para leitura.
Retornar conteúdo do arquivo em uma matriz de sequência
Especifica se a variável do conjunto de dados é uma matriz de sequência de
caracteres. Se essa opção for marcada, a variável do conjunto de dados será
considerada uma sequência de caracteres.
A partir do número da linha
Especifica o número da linha no arquivo cujo conteúdo deve ser lido. Se esse campo
for deixado em branco, o operador lerá a partir da linha número 1. Este campo deve
conter apenas valores positivos diferentes de zero.
Até o número da linha
Especifica o número da linha no arquivo até onde o conteúdo deve ser lido. Este
campo deve conter apenas valores positivos diferentes de zero. Se for deixado em
branco, esse operador lerá até o final do arquivo.
Capítulo 9: Gerenciamento de arquivos 299
Operador Ler a partir do arquivo
Nome de variável de Conjunto de dados
Especifica o nome da variável do conjunto de dados.
O comprimento desse campo pode ser no máximo de 1024. As linhas que
excederem esse limite serão ignoradas, e um novo campo de variável do conjunto
de dados chamado "advertências" será criado após a execução (contendo a
mensagem de advertência).
Diretório de trabalho
Especifica o diretório de trabalho para executar essa operação.
Observações: se o diretório de trabalho não for especificado, o diretório inicial do
usuário será o diretório de trabalho.
O caminho de arquivo para o diretório de trabalho pode ser absoluto ou relativo.
ID do usuário
Especifica a conta de usuário a ser usada ao executar o operador no host. Substitui
o usuário especificado na configuração de categoria de operador.
Senha
Especifica a senha da ID de usuário.
Codificação do arquivo
Especifica o esquema de codificação usado para ler o arquivo (UTF-8, UTF-16,
US-ASCII, Windows-1250, Windows-1252, Shift_JIS).
Parâmetros de saída
DatasetVariable
O comprimento da variável do conjunto de dados pode ser no máximo 1024 para
uma matriz. As linhas que excederem esse limite serão ignoradas e um novo campo
de variável do conjunto de dados denominado "avisos" será criado após a execução
contendo a mensagem de aviso.
fileName
isReturnAsStringArray
fromLineNumber
toLineNumber
datasetVariableName
workingDir
userID
password
fileencoding
300 Referência do Criador de Conteúdo
Operador Ler a partir do arquivo
Exemplo (Operador Ler a partir do arquivo)
Este exemplo permite ler um arquivo chamado ReadFile.txt. O conteúdo do arquivo é o
seguinte:
Este exemplo considera os seguintes cenários:
■
Ler a partir do arquivo
■
Ler a partir do arquivo e salvar o conteúdo do arquivo como uma matriz
■
Ler linhas específicas do arquivo
■
Ler a partir do arquivo e salvar o conteúdo do arquivo em um conjunto de dados
Siga estas etapas:
1.
Crie um processo com o operador Ler a partir do arquivo, como mostra a ilustração
a seguir:
2.
Clique duas vezes no operador Ler a partir do arquivo para abrir as propriedades de
Ler a partir do arquivo, e selecione o painel Ler arquivo na variável do conjunto de
dados.
Para ler a partir do arquivo
3.
Digite o caminho de arquivo a seguir em Nome do arquivo de origem.
(Windows) C:\\ReadFile.txt
(UNIX) /root/readfromfile.txt
Capítulo 9: Gerenciamento de arquivos 301
Operador Ler a partir do arquivo
4.
Executar o processo.
5.
Abra Resultados da operação para exibir o valor DatasetVariable, como mostra a
ilustração a seguir:
Para ler a partir do arquivo e salvar o conteúdo do arquivo como uma matriz
6.
Marque a caixa de seleção Retornar conteúdo do arquivo em uma matriz de
sequência.
O conteúdo do arquivo está disponível como uma matriz, como mostra a ilustração
a seguir:
302 Referência do Criador de Conteúdo
Operador Ler a partir do arquivo
Para ler linhas específicas no arquivo
7.
Digite 1 no campo A partir do número da linha, para ler a partir da linha um do
arquivo ReadFile.txt.
8.
Digite 4 no campo Até o número da linha, para ler até a quarta linha do arquivo
ReadFile.txt.
O conteúdo do arquivo é lido e salvo no formato de conjunto de dados, linhas 1 a 4,
como mostra a ilustração a seguir:
Para ler o arquivo e salvar o seu conteúdo em uma variável de conjunto de dados
9.
Digite Dataread como nome da variável de conjunto de dados.
O conteúdo do arquivo é salvo no conjunto de dados DataRead e não no conjunto
de dados do sistema, como mostra a seguinte ilustração:
Você também pode especificar a ID de usuário e a senha da conta de usuário para
conceder permissão de execução em um processo. Ao fornecer os valores de ID do
usuário e senha no nível de operador, você substitui os valores definidos no campo
Requer credenciais de usuário. Você define o campo Requer credenciais de usuário nas
propriedades de Gerenciamento de arquivos.
Observação: conceda a permissão de Leitura ao usuário e as permissões Leitura e
Executar para o diretório de instalação do PAM, para executar a operação de serviço
ReadFile. Para obter mais informações sobre como configurar o gerenciamento de
arquivos, consulte a seção Configurar gerenciamento de arquivos, no Guia do
Administrador de Conteúdo.
Capítulo 9: Gerenciamento de arquivos 303
Operador Renomear arquivo
Operador Renomear arquivo
O operador Renomear arquivo fornece a funcionalidade para renomear um arquivo ou
um diretório.
Parâmetros de entrada
Arquivo de origem/nome do diretório
Especifica o arquivo/diretório a ser renomeado.
Nome do novo arquivo/diretório
Especifica o novo nome do arquivo/diretório.
Diretório de trabalho
Especifica o diretório de trabalho para executar essa operação.
Observações: se o diretório de trabalho não for especificado, o diretório inicial do
usuário será o diretório de trabalho.
O caminho de arquivo para o diretório de trabalho pode ser absoluto ou relativo.
ID do usuário
Especifica a conta de usuário a ser usada ao executar o operador no host. Substitui
o usuário especificado nos parâmetros no nível de módulo.
Senha
Especifica a senha da ID de usuário.
Observação: para o UNIX, se o local de destino for diferente do de origem, o arquivo
será movido para o local de destino.
Parâmetros de saída
fileName
newFileName
workingDir
userID
password
304 Referência do Criador de Conteúdo
Operador Pesquisar conteúdo de arquivo
Operador Pesquisar conteúdo de arquivo
O operador Verificar conteúdo do arquivo extrai informações de arquivos relativamente
pequenos. Esse operador pesquisa o conteúdo de um arquivo de texto ou diretório para
localizar uma sequência de caracteres que corresponda a um padrão especificado. O
padrão pode indicar subsequências de caracteres para extrair em variáveis do conjunto
de dados do operador. Os delimitadores no padrão podem indicar as zonas que serão
extraídas para as variáveis.
■
Para um arquivo, esse operador pesquisa o conteúdo para localizar o padrão
especificado.
■
Uma pesquisa de grupo é recomendada para pesquisar eficientemente os arquivos
grandes que contenham gigabytes de informações.
Parâmetros de entrada
Nome do arquivo/diretório
Especifica o caminho para o arquivo ou diretório onde procurar correspondências
de padrões. O caminho deve estar acessível para o Módulo de exibição de arquivos
no touchpoint no qual ele está em execução. Para um arquivo, esse operador
pesquisa o conteúdo para localizar o padrão especificado.
Se você especificar um arquivo ou diretório sem especificar o caminho completo, os
operadores Gerenciamento de arquivos usarão
<diretório_de_instalação>\server\c2o como caminho relativo para o arquivo ou
diretório especificado. Na maioria dos casos, é possível usar a barra (/) em um
caminho.
Capítulo 9: Gerenciamento de arquivos 305
Operador Pesquisar conteúdo de arquivo
Padrão
Especifica uma expressão regular definindo o padrão pesquisado pelo operador
(consulte o tópico Usando as máscaras para especificar padrões nas sequências de
caracteres no Guia do Criador de Conteúdo).
O padrão usa o símbolo de número (#) usado como separador para retornar valores
para as variáveis Nível e Código:
"BACKUP LEVEL #.*# - CODE #.*#"
A partir da sequência de caracteres "BACKUP LEVEL A400 - CODE FSC137.0359”,
esse padrão poderia atribuir as subsequências de caracteres “A400” para a variável
Nível e “FSC731.0359” para a Código. A atribuição é feita na mesma ordem em que
as variáveis são definidas nos nomes das Variáveis.
Para fazer a correspondência com qualquer número de linhas, é possível usar o
escape \n no campo Padrão. O exemplo a seguir faz correspondência das linhas
iniciadas por “Log” seguido por qualquer número de linhas novas intermediárias e
uma sequência de caracteres de texto terminada em “Error=89”:
"Log.*\n.*Error=89"
Caso esteja acostumado a usar caracteres de escape em linguagens de
programação, esse escape \n corresponde a qualquer quantidade de novas linhas
no Windows ou UNIX. Esse escape não corresponde a um caractere de alimentação
de linha única.
Separador
Especifica que um caractere usado para delimitar a zona seja salvo para as variáveis
especificadas pelos nomes de variáveis, como o símbolo #.
Iniciar no final do arquivo
Marque essa caixa de seleção para iniciar a pesquisa do final de um arquivo
especificado. Essa opção é usada para localizar a última ocorrência do padrão em
um arquivo. Essa opção permite que você faça a correspondência das mensagens
mais recentes em um arquivo.
Diferenciação de padrão de maiúscula e minúscula
Marque essa caixa de seleção para levar em conta os caracteres maiúsculos e
minúsculos ao pesquisar um padrão. Se esta caixa de seleção não for marcada, as
letras em um padrão farão correspondência com caracteres tanto maiúsculos
quanto minúsculos.
Deslocamento da pesquisa de arquivo
Especifica uma posição inicial para uma pesquisa. O valor representa o número de
caracteres desde o início do arquivo, a menos que a caixa de seleção Iniciar no final
do arquivo esteja marcada. Nesse caso, o valor representa o número de caracteres
desde o final do arquivo.
306 Referência do Criador de Conteúdo
Operador Pesquisar conteúdo de arquivo
Para realizar uma correspondência de padrão em loop, é possível usar as variáveis
MatchPos e MatchEntry do conjunto de dados de um operador de correspondência
de verificação de arquivo anterior para iniciar no ponto em que a correspondência
anterior parou:
Process.Operator_name.MatchPos + Len(Process.Operator_name.MatchEntry)
Nomes da variável
Especifica os nomes das variáveis para salvar o texto que corresponde às zonas
delimitadas no padrão. As zonas delimitadas são salvas nas variáveis listadas na
ordem definida na lista de variáveis. As variáveis do conjunto de dados do operador
são acessadas por meio do conjunto de dados do processo, usando o processo de
palavra-chave.
Por exemplo, especificar os nomes de variáveis Nível e Código para atribuir valores
de subsequências de caracteres extraídos para as variáveis do conjunto de dados do
operador Process.Operator_name.Level e Process.Operator_name.Code.
É possível adicionar, remover e classificar as variáveis usadas para armazenar
sequências de caracteres correspondentes usando a barra de ferramentas.
Parâmetros de saída
fileName
Padrão
Separador
startFromEnd
caseSensitive
fileSearchOffset
variableNames
LastReadPos
MatchedEnd
MatchedEntry
MatchedPos
Capítulo 9: Gerenciamento de arquivos 307
Operador Atualizar a propriedade do arquivo
Operador Atualizar a propriedade do arquivo
O operador Atualizar a propriedade do arquivo modifica a propriedade do usuário e/ou
grupo de cada arquivo específico. Somente um superusuário pode alterar o proprietário
e o grupo ao qual um arquivo pertence. Esse operador é suportado em um host UNIX
somente.
Parâmetros de entrada
Nome de usuário
Especifica o proprietário do arquivo.
Nome do grupo
Especifica o grupo ao qual o arquivo pertence.
Observação: o usuário deve fornecer uma entrada para ao menos um dos campos,
"Nome de usuário" ou "Nome do grupo".
Arquivo de origem/nome do diretório
Especifica o nome do arquivo ou diretório cuja propriedade será alterada.
Recorrência
Quando marcado, especifica a alteração da propriedade do arquivo de forma
recorrente.
Diretório de trabalho
Especifica o diretório de trabalho para executar essa operação.
Observações: se o diretório de trabalho não for especificado, o diretório inicial do
usuário será o diretório de trabalho.
O caminho de arquivo para o diretório de trabalho pode ser absoluto ou relativo.
ID do usuário
Especifica a conta de usuário a ser usada ao executar o operador no host. Esse
campo substitui o usuário especificado nas propriedades do nível da categoria do
operador.
Senha
Especifica a senha da ID de usuário.
308 Referência do Criador de Conteúdo
Operador Atualizar as permissões do arquivo
Parâmetros de saída
userName
nomeGrupo
fileName
isRecursive
workingDir
userID
password
Operador Atualizar as permissões do arquivo
O operador Atualizar as permissões do arquivo altera as permissões de cada arquivo
específico de acordo com o modo, que pode ser um número octal que representa o
padrão de bits para as novas permissões ou uma representação simbólica das alterações
a serem feitas (+-= rwxXstugoa). Esse operador é suportado em um host UNIX somente.
Parâmetros de entrada
Arquivo de origem/nome do diretório
Especifica o nome do arquivo ou diretório cuja permissão será alterada.
Permissão (modos)
Especifica a permissão ou modo para o arquivo, que pode ser um número octal que
representa o padrão de bits para as novas permissões ou uma representação
simbólica das alterações a serem feitas (+-= rwxXstugoa).
Recorrência
Especifica a alteração de arquivos e diretórios de forma recorrente.
Diretório de trabalho
Especifica o diretório de trabalho para executar essa operação.
Observações: se o diretório de trabalho não for especificado, o diretório inicial do
usuário será o diretório de trabalho.
O caminho de arquivo para o diretório de trabalho pode ser absoluto ou relativo.
Capítulo 9: Gerenciamento de arquivos 309
Operador Atualizar o carimbo de data e hora do arquivo
ID do usuário
Especifica a conta de usuário a ser usada ao executar o operador no host. Substitui
o usuário especificado nas propriedades no nível do módulo.
Senha
Especifica a senha da ID de usuário.
Parâmetros de saída
fileName
permissão
isRecursive
workingDir
userID
password
Operador Atualizar o carimbo de data e hora do arquivo
O operador Atualizar o carimbo de data e hora do arquivo altera marcas de data e hora
do arquivo, como atualizar as horas de acesso e modificação de cada arquivo para a
hora atual ou o carimbo de data e hora especificado pelo usuário. Esse operador é
suportado em um host UNIX somente.
Parâmetros de entrada
Arquivo de origem/nome do diretório
Especifica o nome do arquivo ou diretório cujo carimbo de data/hora será alterado.
Carimbo de data/hora ([[CC]MMDDhhmm[.ss])
Use este campo no formato [[CC]AA]MMDDhhmm[.ss] em vez da hora atual.
Onde cada par de letras representa as seguintes informações:
CC
Especifica os dois primeiros dígitos do ano (o século).
310 Referência do Criador de Conteúdo
Operador Atualizar o carimbo de data e hora do arquivo
YY
Especifica os dois segundos dígitos do ano. Se "AA" for especificado, mas "CC"
não for, um valor para "AA" entre 69 e 99 resulta em um valor de 19 para "CC".
Caso contrário, um valor de 20 para "CC" é usado.
Se os pares de letras "CC" e "AA" não forem especificados, os valores usam
como padrão o ano atual.
MM
Especifica o mês do ano, de 1 a 12.
DD
Especifica o dia do mês, de 1 a 31.
hh
Especifica a hora do dia, de 0 a 23.
mm
Especifica o minuto da hora, de 0 a 59.
ss
O segundo do minuto, de 0 a 61.
Se o par de letras "ss" não for especificado, o valor usa como padrão o 0.
Alterar hora de acesso
Especifica para alterar a hora de acesso. O padrão é marcado.
Alterar hora da modificação
Especifica para alterar a hora de modificação. O padrão é marcado.
Diretório de trabalho
Especifica o diretório de trabalho para usar a fim de executar essa operação.
Observação: se o diretório de trabalho não for especificado, o diretório inicial do
usuário será o diretório de trabalho.
O caminho de arquivo para o diretório de trabalho pode ser absoluto ou relativo.
ID do usuário
Especifica a conta de usuário a ser usada ao executar o operador no host. Substitui
o usuário especificado nas propriedades no nível do módulo.
Senha
Especifica a senha da ID de usuário.
Capítulo 9: Gerenciamento de arquivos 311
Operador Gravar arquivo
Parâmetros de saída
fileName
Marca de data e hora
isChangeAccessTime
isChangeModificationTime
workingDir
userID
password
Operador Gravar arquivo
O operador Gravar arquivo grava o conteúdo da variável do conjunto de dados em um
arquivo. A variável do conjunto de dados pode ser uma sequência de caracteres ou uma
matriz de sequência de caracteres. Esse operador também fornece uma opção para
substituir ou acrescentar o conteúdo a um arquivo existente.
Parâmetros de entrada
Conteúdo do arquivo como matriz
Quando marcado, especifica se a variável do conjunto de dados é uma matriz de
sequência de caracteres.
Conteúdo do arquivo
Se você não marcar a caixa de seleção Conteúdo do arquivo como matriz, grave o
conteúdo nesse campo para o arquivo especificado.
Conteúdo do arquivo como matriz
Se a caixa de seleção Conteúdo do arquivo como matriz estiver marcada, grave o
conteúdo deste campo no arquivo especificado, com cada índice como uma nova
linha no arquivo.
Você pode adicionar, remover e classificar as variáveis usando a barra de
ferramentas.
312 Referência do Criador de Conteúdo
Operador Gravar arquivo
Nome do arquivo de destino
Especifica o nome do arquivo de destino.
Observação: se o arquivo de destino não existir, ele é criado antes de os dados
serem gravados.
Anexar (se o arquivo existir)
Especifica que o conteúdo da variável do conjunto de dados será anexado a um
arquivo, se ele já existir. O padrão é marcado.
Diretório de trabalho
Especifica o diretório de trabalho para executar essa operação.
Observação: se o diretório de trabalho não for especificado, o diretório inicial do
usuário será o diretório de trabalho.
O caminho de arquivo para o diretório de trabalho pode ser absoluto ou relativo.
ID do usuário
Especifica a conta de usuário a ser usada ao executar o operador no host. Substitui
os parâmetros especificados pelo usuário no nível de módulo.
Senha
Especifica a senha da ID de usuário.
Codificação do arquivo
Especifica o esquema de codificação usado para gravar no arquivo (UTF-8, UTF-16,
US-ASCII, Windows-1250, Windows-1252, Shift_JIS).
Parâmetros de saída
fileContentsMode
fileContents
fileContentsAsArray
fileName
isFileAppend
workingDir
userID
password
fileencoding
Capítulo 9: Gerenciamento de arquivos 313
Capítulo 10: Transferência de arquivo
Os operadores de transferência de arquivo fornece os Operadores de transferência de
arquivos (FTP/SFTP).
Use os operadores do módulo Transferência de arquivo para gerenciar diretórios e
arquivos como FTP ou um cliente do SFTP. Esses operadores se conectam aos servidores
FTP padrão nos computadores de destino. O host remoto para todos os operadores
Transferência de arquivo deve ter um servidor FTP configurado.
Importante: Com exceção do operador Arquivo para download por TFTP e do operador
Arquivo para upload por TFTP, as seguintes condições se aplicam a todos os operadores
nessa categoria quando executados em um host remoto do Windows por um
touchpoint do proxy:
- Use caminhos de estilo UNIX para os campos relacionados a caminhos (barras e
nenhuma letra de unidade).
- Cada servidor SSH pode ter um local diferente para seu diretório "raiz". Os
comandos permitidos que são relativos ao diretório raiz podem variar muito.
Operador Criar diretório
O operador Criar diretório cria um diretório no sistema de arquivos remoto.
Para permitir que o operador crie um diretório, as credenciais de usuário especificadas
deverão ter as permissões apropriadas de alteração de diretório e gravação no host
remoto. O host remoto deve ter um servidor FTP configurado.
Capítulo 10: Transferência de arquivo 315
Operador Criar diretório
Parâmetros de entrada
Caminho remoto
Especifica o caminho para o diretório a ser criado no host remoto. Por exemplo:
/temp/IT PAM/scripts
O diretório pai (/temp/IT PAM no exemplo) deve existir para que os operadores
Transferência de arquivo concluam esse operador com êxito. O caminho relativo
também pode ser especificado nesse campo e será relativo ao diretório inicial do
usuário do FTP.
Host remoto
Especifica o endereço IP ou o URL do FTP para o host remoto. Para um site de FTP
na intranet da sua empresa, é possível especificar o nome do servidor
(//nome_do_servidor) para o site FTP.
Por padrão, sites FTP usam a porta 21. No entanto, é possível atribuir uma porta
para um site FTP. Portas privadas variam de 49152 a 65535. Para especificar uma
porta FTP privada, adicione um sinal de dois pontos (:) e, em seguida, um número
de porta privada no final do endereço. Por exemplo, o seguinte especifica a porta
50021 em um servidor FTP remoto:
172.24.36.107:50021
ID de usuário remoto
Especifica uma ID de usuário para acessar o host do FTP remoto.
Senha de usuário remoto
Especifica a senha para acessar o host do FTP remoto.
Usar FTP seguro (SFTP)
Abre uma sessão SFTP (Secure FTP - FTP Seguro). O SFTP é semelhante ao FTP, mas
ao contrário do FTP, a sessão inteira é criptografada. Nenhuma senha é enviada na
forma de texto não criptografado e, assim, elas são muito menos vulneráveis à
interceptação de terceiros.
Especificar um comando SITE opcional
Especifica o uso do comando SITE para chamar os serviços específicos ao sistema do
host. Em seguida, use o campo Parâmetros do site para especificar uma expressão
que retorne parâmetros para o comando SITE.
Parâmetros do site
Digite uma expressão do CA Process Automation que retorne os parâmetros para o
comando SITE.
316 Referência do Criador de Conteúdo
Operador Excluir diretório
Parâmetros de saída
remotedir
remoteHost
remoteUserId
remoteUserPassword
secureFtp
siteCommand
siteParameters
Operador Excluir diretório
O operador Excluir diretório exclui um diretório especificado do sistema de arquivos
remoto. O diretório especificado deve estar vazio para que o processo execute esse
operador.
A exclusão de um diretório requer que as credenciais de usuário especificadas tenham
as permissões apropriadas de alteração de diretório e gravação no host remoto. O host
remoto deve ter um servidor FTP configurado.
Capítulo 10: Transferência de arquivo 317
Operador Excluir diretório
Propriedades da opção Excluir diretório remoto
Caminho remoto
Especifica o caminho para o diretório a ser excluído no host remoto. Por exemplo:
/temp/IT PAM/scripts. O diretório especificado deve estar vazio para que os
operadores Transferência de arquivo concluam esse operador.
Host remoto
Especifica o endereço IP ou o URL do FTP para o host remoto. Para um site de FTP
na intranet da sua empresa, é possível especificar o nome do servidor
(//nome_do_servidor) para o site FTP.
Por padrão, sites FTP usam a porta 21. No entanto, é possível atribuir uma porta
para um site FTP. Portas privadas variam de 49152 a 65535. Para especificar uma
porta FTP privada, adicione um sinal de dois pontos (:) e, em seguida, um número
de porta privada no final do endereço. Por exemplo, o seguinte especifica a porta
50021 em um servidor FTP remoto:
172.24.36.107:50021
ID de usuário remoto
Especifica uma ID de usuário para acessar o host do FTP remoto.
Senha de usuário remoto
Especifica a senha para acessar o host do FTP remoto.
Usar FTP seguro (SFTP)
Abre uma sessão SFTP (Secure FTP - FTP Seguro). O SFTP é semelhante ao FTP, mas
ao contrário do FTP, a sessão inteira é criptografada. Nenhuma senha é enviada na
forma de texto não criptografado e, assim, elas são muito menos vulneráveis à
interceptação de terceiros.
Especificar um comando SITE opcional
Especifica o uso do comando SITE para chamar os serviços específicos ao sistema do
host. Em seguida, use o campo Parâmetros do site para especificar uma expressão
do CA Process Automation que retorne parâmetros para o comando SITE.
Remover todos os arquivos/subdiretórios sob o diretório de destino
Essa opção é usada para excluir um diretório que não esteja vazio. Se essa caixa de
seleção for marcada, todos os diretórios sob o diretório especificado serão
excluídos, inclusive o diretório especificado. Se essa caixa de seleção for
desmarcada, qualquer tentativa de excluir um diretório que não esteja vazio
resultará em uma falha de operador de serviço.
Parâmetros do site
Digite uma expressão do CA Process Automation que retorne os parâmetros para o
comando SITE.
318 Referência do Criador de Conteúdo
Operador Excluir arquivo
Parâmetros de saída
remotedir
remoteHost
remoteUserId
remoteUserPassword
secureFtp
siteCommand
forceDelete
siteParameters
Operador Excluir arquivo
O operador Excluir arquivo remove um arquivo especificado de um local remoto. O host
remoto deve ter um servidor FTP configurado. Para permitir que o operador exclua um
diretório, as credenciais de usuário especificadas deverão ter as permissões apropriadas
de gravação no host remoto.
Parâmetros de entrada
Caminho remoto
Especifica o caminho para o arquivo a ser excluído no host de FTP remoto. Por
exemplo: /tmp/IT PAM/scripts/script_ora1.sh.
Capítulo 10: Transferência de arquivo 319
Operador Excluir arquivo
Host remoto
Especifica o endereço IP ou o URL do FTP para o host remoto. Para um site de FTP
na intranet da sua empresa, é possível especificar o nome do servidor
(//nome_do_servidor) para o site FTP.
Por padrão, sites FTP usam a porta 21. No entanto, é possível atribuir uma porta
para um site FTP. Portas privadas variam de 49152 a 65535. Para especificar uma
porta FTP privada, adicione um sinal de dois pontos (:) e, em seguida, um número
de porta privada no final do endereço. Por exemplo, o seguinte especifica a porta
50021 em um servidor FTP remoto:
172.24.36.107:50021
ID de usuário remoto
Especifica uma ID de usuário para acessar o host do FTP remoto.
Senha de usuário remoto
Especifica a senha para acessar o host do FTP remoto.
Usar FTP seguro (SFTP)
Abre uma sessão SFTP (Secure FTP - FTP Seguro). O SFTP é semelhante ao FTP, mas
ao contrário do FTP, a sessão inteira é criptografada. Nenhuma senha é enviada na
forma de texto não criptografado e, assim, elas são muito menos vulneráveis à
interceptação de terceiros.
Especificar um comando SITE opcional
Especifica o uso do comando SITE para chamar os serviços específicos ao sistema do
host. Em seguida, use o campo Parâmetros do site para especificar uma expressão
que retorne parâmetros para o comando SITE.
Parâmetros do site
Digite uma expressão do CA Process Automation que retorne os parâmetros para o
comando SITE.
Parâmetros de saída
remoteFile
remoteHost
remoteUserId
remoteUserPassword
secureFtp
siteCommand
siteParameters
320 Referência do Criador de Conteúdo
Operador Fazer download de arquivo
Operador Fazer download de arquivo
O operador Fazer download de arquivo copia um arquivo de um local remoto. Esse
operador corresponde ao comando Obter FTP.
O host remoto deve ter um servidor FTP configurado. Para obter um arquivo remoto, as
credenciais de usuário especificadas devem ter os direitos apropriados de alteração de
diretório e leitura no arquivo.
Propriedades da opção Obter arquivo remoto
Arquivo local
Especifica o local para salvar o arquivo localmente. Por exemplo: /IT
PAM/import/script_ora1.sh.
O local deve ser válido em tempo de execução no touchpoint que está executando
os operadores Transferência de arquivo.
Quando você usa a nomenclatura de arquivos do Windows, as barras invertidas
devem ser ignoradas conforme segue.
C:\\IT PAM\\import\\script_ora1.bat
Recomendamos o uso de nomes de arquivo “normalizados”, com marcas de barras
(/), mesmo ao especificar um caminho em um host do Windows. Por exemplo: C:/IT
PAM/import/script_ora1.bat.
Arquivo remoto
Especifica o caminho completo para o arquivo no host de FTP remoto. Por exemplo:
/tmp/IT PAM/scripts/script_ora1.sh.
Capítulo 10: Transferência de arquivo 321
Operador Fazer download de arquivo
Host remoto
Especifica o endereço IP ou o URL do FTP para o host remoto. Para um site de FTP
na intranet da sua empresa, é possível especificar o nome do servidor
(//nome_do_servidor) para o site FTP.
Por padrão, sites FTP usam a porta 21. No entanto, é possível atribuir uma porta
para um site FTP. Portas privadas variam de 49152 a 65535. Para especificar uma
porta FTP privada, adicione um sinal de dois pontos (:) e, em seguida, um número
de porta privada no final do endereço. Por exemplo, o seguinte especifica a porta
50021 em um servidor FTP remoto:
172.24.36.107:50021
ID de usuário remoto
Especifica a ID de usuário para acessar o host de FTP remoto.
Senha de usuário remoto
Especifica a senha para acessar o host do FTP remoto.
Transferência binária
Especifica o uso do modo binário do FTP para a transferência de arquivos binários.
Por exemplo:
Marque uma caixa de seleção com os seguintes tipos de arquivos:
■
Arquivos executáveis
■
Arquivos de sistema do SPSS
■
Arquivos do SAS
■
Conjuntos de dados do Stata
■
Arquivos gráficos
Converter de ASCII em EBCDIC
Especifica a conversão do código de caracteres ASCII para EBCDIC antes da
transferência do arquivo. EBCDIC é usado em um ambiente z/OS, em que o arquivo
deve ser legível em um host z/OS.
Usar FTP seguro (SFTP)
Abre uma sessão SFTP (Secure FTP - FTP Seguro). O SFTP é semelhante ao FTP, mas
ao contrário do FTP, a sessão inteira é criptografada. Nenhuma senha é enviada na
forma de texto não criptografado e, assim, elas são muito menos vulneráveis à
interceptação de terceiros.
O CA Process Automation usa o protocolo SSH2/SFTP com a autenticação de nome
de usuário/senha. O protocolo SSH2/SFTP só oferece suporte para transferências
binárias.
322 Referência do Criador de Conteúdo
Operador Obter informações do arquivo
Especificar um comando SITE opcional
Use o comando SITE para chamar os serviços específicos para o sistema do host. Em
seguida, use o campo Parâmetros do SITE para especificar uma expressão do CA
Process Automation que retorne parâmetros para o comando SITE. Essa opção é
usada, por exemplo, para dimensionar arquivos em um sistema MVS de destino.
Parâmetros do site
Digite uma expressão do CA Process Automation que retorne os parâmetros para o
comando SITE.
Parâmetros de saída
localFile
remoteFile
remoteHost
remoteUserId
remoteUserPassword
transferMode
secureFtp
siteCommand
siteParameters
Operador Obter informações do arquivo
Esse operador obtém os atributos para um arquivo remoto e os salva em variáveis
(como Permissões, Tamanho e Grupo) em seu conjunto de dados do operador.
A lista de atributos significativos depende do sistema de arquivos. Para exibir os
atributos de um arquivo ou pasta especificado, exiba o conjunto de dados do operador.
Capítulo 10: Transferência de arquivo 323
Operador Obter informações do arquivo
O host remoto deve ter um servidor FTP configurado. As credenciais de usuário
especificadas devem ter as permissões de leitura no host remoto.
Parâmetros de entrada
Arquivo remoto
Especifica o caminho para o arquivo no host do FTP remoto. Por exemplo: "/tmp/IT
PAM/scripts/script_ora1.sh"
Host remoto
Especifica o endereço IP ou o URL do FTP para o host remoto. Para um site de FTP
na intranet da sua empresa, é possível especificar o nome do servidor
(//nome_do_servidor) para o site FTP.
Por padrão, sites FTP usam a porta 21. No entanto, é possível atribuir uma porta
para um site FTP. Portas privadas variam de 49152 a 65535. Para especificar uma
porta FTP privada, adicione um sinal de dois pontos (:) e, em seguida, um número
de porta privada no final do endereço. Por exemplo, o seguinte especifica a porta
50021 em um servidor FTP remoto:
172.24.36.107:50021
ID de usuário remoto
Especifica uma ID de usuário para acessar o host do FTP remoto.
Senha de usuário remoto
Especifica a senha para acessar o host do FTP remoto.
Usar FTP seguro (SFTP)
Abre uma sessão SFTP (Secure FTP - FTP Seguro). O SFTP é semelhante ao FTP, mas
ao contrário do FTP, a sessão inteira é criptografada. Nenhuma senha é enviada na
forma de texto não criptografado e, assim, elas são muito menos vulneráveis à
interceptação de terceiros.
324 Referência do Criador de Conteúdo
Operador Obter informações do arquivo
Especificar um comando SITE opcional
Especifica o uso do comando SITE para chamar os serviços específicos ao sistema do
host. Em seguida, use o campo Parâmetros do site para especificar uma expressão
do CA Process Automation que retorne parâmetros para o comando SITE.
Parâmetros do site
Digite uma expressão do CA Process Automation que retorne os parâmetros para o
comando SITE.
Capítulo 10: Transferência de arquivo 325
Operador Obter informações do arquivo
Parâmetros de saída
remoteFile
remoteHost
remoteUserId
remoteUserPassword
secureFtp
siteCommand
siteParameters
FileExists
FileName
FileTime
IsDirectory
IsFile
IsSpecial
FileGroup
FileGroupExec
FileGroupRead
FileGroupWrite
FileOtherExec
FileOtherRead
FileOtherWrite
FileOwner
FileOwnerExec
FileOwnerRead
FileOwnerWrite
FilePermission
FileSize
FileSizeKB
FileSizeMB
326 Referência do Criador de Conteúdo
Operador Mover arquivo
Operador Mover arquivo
O operador Mover arquivo move um arquivo de um local remoto para outro no mesmo
servidor. É possível usá-lo para renomear um arquivo especificando os mesmos
caminhos para o nome antigo e o novo.
O host remoto deve ter um servidor FTP configurado. Para mover um arquivo, as
credenciais de usuário especificadas devem ter os direitos apropriados de alteração de
diretório e leitura no arquivo.
Parâmetros de entrada
Novo nome
Especifica o caminho e o novo nome para o arquivo no servidor de FTP remoto.
"/tmp/IT PAM/scripts/archived/IT PAM.new"
Nome atual
Especifica o caminho existente e o novo nome do arquivo no servidor de FTP
remoto. Por exemplo: /tmp/IT PAM/scripts/IT PAM.old.
Capítulo 10: Transferência de arquivo 327
Operador Mover arquivo
Host remoto
Especifica o endereço IP ou o URL do FTP para o host remoto. Para um site de FTP
na intranet da sua empresa, é possível especificar o nome do servidor
(//nome_do_servidor) para o site FTP.
Por padrão, sites FTP usam a porta 21. No entanto, é possível atribuir uma porta
para um site FTP. Portas privadas variam de 49152 a 65535. Para especificar uma
porta FTP privada, adicione um sinal de dois pontos (:) e, em seguida, um número
de porta privada no final do endereço. Por exemplo, o seguinte especifica a porta
50021 em um servidor FTP remoto:
172.24.36.107:50021
ID de usuário remoto
Especifica uma ID de usuário para acessar o host do FTP remoto.
Senha de usuário remoto
Especifica a senha para acessar o host do FTP remoto.
Usar FTP seguro (SFTP)
Abre uma sessão SFTP (Secure FTP - FTP Seguro). O SFTP é semelhante ao FTP, mas
ao contrário do FTP, a sessão inteira é criptografada. Nenhuma senha é enviada na
forma de texto não criptografado e, assim, elas são muito menos vulneráveis à
interceptação de terceiros.
Especificar um comando SITE opcional
Especifica o uso do comando SITE para chamar os serviços específicos ao sistema do
host. Em seguida, use o campo Parâmetros do site para especificar uma expressão
do CA Process Automation que retorne parâmetros para o comando SITE.
Parâmetros do site
Digite uma expressão do CA Process Automation que retorne os parâmetros para o
comando SITE.
Parâmetros de saída
newName
currentName
remoteHost
remoteUserId
remoteUserPassword
secureFtp
siteCommand
siteParameters
328 Referência do Criador de Conteúdo
Operador Arquivo para download por TFTP
Operador Arquivo para download por TFTP
O operador Arquivo para download por TFTP recebe um arquivo de um host na rede por
meio do protocolo TFTP. O host deve ter um servidor TFTP em execução.
Detalhes sobre o protocolo TFTP são fornecidos a seguir:
■
Usa UDP para a transferência de dados.
■
Emite envios e aguarda ACKs.
■
Normalmente inicia a transferência de dados na porta 69.
■
Em geral, envia dados em um tamanho de bloco de 512 b ou menos.
■
Não usa autenticação nem autorização.
Importante! Teste a funcionalidade de TFTP fora do CA Process Automation antes de
incorporá-la a fluxos de processo do CA Process Automation. Firewalls ou roteamento
podem bloquear UDP na porta 69 por padrão. Geralmente, o serviço TFTP não está
instalado ou está desativado.
Parâmetros de entrada
Nome do host remoto
O nome do host ou o endereço IP do host remoto.
Porta UDP remota para TFTP
A porta UDP do serviço TFTP no host remoto. Se esse parâmetro for especificado,
esse valor substituirá o valor do campo de categoria do operador: Porta UDP
padrão para Trivial FTP. Se nenhum desses campos for especificado, o operador
usará o valor padrão de 69.
Nome do arquivo remoto
O nome do arquivo remoto para obter do host remoto. Esse parâmetro não é o
caminho do arquivo remoto no host remoto. Dependendo de sua configuração, o
servidor TFTP recupera o arquivo do diretório base no host remoto.
Tipo de transferência de dados
BIN para binário ou ASCII para ASCII (texto). Se esse tipo não for especificado, o
operador usará o valor padrão: ASCII. Se qualquer outro valor for especificado
(exceto ASCII ou BIN), o operador usará o valor padrão de ASCII.
Capítulo 10: Transferência de arquivo 329
Operador Arquivo para download por TFTP
Arquivo local para download
O caminho totalmente qualificado do arquivo local (em que você salva o arquivo
recuperado por meio de TFTP).
Número de porta local (0 para porta anônima)
O número da porta local a ser usada ao recuperar dados do host remoto/porta. Se
for 0, uma porta anônima será usada. Se a porta for especificada e não estiver
disponível, a operação poderá falhar. Se esse número não for especificado, o
operador usará o valor padrão: 0.
Tempo limite (s)
O valor de tempo limite a ser usado ao abrir a conexão com o servidor TFTP. Se esse
número não for especificado, será usado o valor padrão de 20.
Máximo de novas tentativas após expiração de TFTP
O número máximo de vezes para repetir a operação de download de arquivo (não
todo o operador do CA Process Automation) após um tempo limite do TFTP. Se esse
número não for especificado, o operador usará o valor padrão: 5.
Parâmetros de saída
Resultado:
■
1: se o operador for concluído com êxito.
■
-1: se o operador falhar.
Motivo:
■
Concluído: se o operador for concluído com êxito.
■
Uma mensagem de erro se o operador falhar.
remoteSSHHost
PORT
RemoteURL
TransferType
LocalFileName
LocalPort
Tempo de expiração
MaxRetries
330 Referência do Criador de Conteúdo
Operador Arquivo para upload por TFTP
Portas do operador
Êxito
O operador é concluído com êxito.
Falha
O operador falha por qualquer uma das seguintes razões:
■
Parâmetro de entrada inválido do usuário. O campo de motivo contém uma
mensagem de erro que especifica o problema.
■
O arquivo local existe, mas não é possível gravar nele.
■
O arquivo local é um diretório.
■
O arquivo local não existe. Não é possível gravar no diretório pai devido a
privilégios e restrições atuais que impedem que o CA Process Automation grave
no diretório.
■
Os privilégios e restrições atuais impedem que o CA Process Automation grave
no arquivo local.
■
Host desconhecido especificado.
■
Erro de E/S ao receber o arquivo remoto.
■
Erro de tempo limite se o CA Process Automation não puder se conectar ao
host remoto na porta remota especificada. Nesse caso, o operador não
expirará, pois o cliente TFTP relata o problema como um erro de E/S (não um
erro de tempo limite).
■
Outros (especificado no campo de motivo).
Portas personalizadas
Se definido pelo usuário durante a criação do processo.
Operador Arquivo para upload por TFTP
O operador Arquivo para upload por TFTP envia um arquivo para um host na rede por
meio do protocolo TFTP. O host deve ter um servidor TFTP em execução.
Detalhes sobre o protocolo TFTP são fornecidos a seguir:
■
Usa UDP para a transferência de dados.
■
Emite envios e aguarda ACKs.
Capítulo 10: Transferência de arquivo 331
Operador Arquivo para upload por TFTP
■
Normalmente inicia a transferência de dados na porta 69.
■
Em geral, envia dados em um tamanho de bloco de 512 b ou menos.
■
Não usa autenticação nem autorização.
Importante! Teste a funcionalidade de TFTP fora do CA Process Automation antes de
incorporá-la a fluxos de processo do CA Process Automation. Firewalls ou roteamento
podem bloquear UDP na porta 69 por padrão. Geralmente, o serviço TFTP não está
instalado ou está desativado.
Parâmetros de entrada
Nome do host remoto
O nome do host ou o endereço IP do host remoto.
Porta UDP remota para TFTP
A porta UDP do serviço TFTP no host remoto. Se essa porta for especificada, esse
valor substituirá o valor do campo de categoria do operador: Porta UDP padrão
para Trivial FTP. Se nenhum desses campos for especificado, o operador usará o
valor padrão de 69.
Nome do arquivo remoto
O nome a ser usado ao criar o arquivo (que está sendo enviado) no host remoto.
Esse parâmetro não é o caminho do arquivo remoto no host remoto. Dependendo
de sua configuração, o servidor TFTP salva o arquivo em seu diretório base no host
remoto.
Tipo de transferência de dados
BIN para binário ou ASCII para ASCII (texto). Se não for especificado, o operador
usará o valor padrão: ASCII. Se qualquer outro valor for especificado (exceto ASCII
ou BIN), o operador usará o valor padrão de ASCII.
Arquivo local para upload
O caminho totalmente qualificado do arquivo local para enviar por meio de TFTP.
Número de porta local (0 para porta anônima)
O número da porta local a ser usada ao enviar dados do host remoto/porta. Se for
0, uma porta anônima será usada. Se a porta for especificada e não estiver
disponível, a operação poderá falhar. Se esse número não for especificado, o
operador usará o valor padrão: 0.
332 Referência do Criador de Conteúdo
Operador Arquivo para upload por TFTP
Tempo limite (s)
O valor de tempo limite a ser usado ao abrir a conexão com o servidor TFTP. Se esse
número não for especificado, será usado o valor padrão de 20.
Máximo de novas tentativas após expiração de TFTP
O número máximo de vezes para repetir a operação de upload de arquivo (não todo
o operador do CA Process Automation) após um tempo limite do TFTP. Se esse
número não for especificado, o operador usará o valor padrão: 5.
Parâmetros de saída
Resultado:
■
1: se o operador for concluído com êxito.
■
-1: se o operador falhar.
Motivo:
■
Concluído: se o operador for concluído com êxito.
■
Uma mensagem de erro se o operador falhar.
remoteSSHHost
PORT
RemoteURL
TransferType
LocalFileName
LocalPort
Tempo de expiração
MaxRetries
Portas do operador
Êxito
O operador é concluído com êxito.
Falha
O operador falha por qualquer uma das seguintes razões:
■
Parâmetro de entrada inválido do usuário. O campo de motivo contém uma
mensagem de erro que especifica o problema.
■
O local do arquivo é inexistente, é inválido ou não pode ser lido.
■
Os privilégios e restrições atuais impedem que o CA Process Automation leia o
arquivo local.
Capítulo 10: Transferência de arquivo 333
Operador Fazer upload de arquivo
■
Erro de E/S ao enviar o arquivo local.
■
Host desconhecido especificado.
■
Erro de tempo limite se o CA Process Automation não puder se conectar ao
host remoto na porta remota especificada. Nesse caso, o operador não
expirará, pois o cliente TFTP relata o problema como um erro de E/S (não um
erro de tempo limite).
■
Outros (especificado no campo de motivo).
Portas personalizadas
Se definido pelo usuário durante a criação do processo.
Operador Fazer upload de arquivo
O operador Fazer upload de arquivo copia um arquivo de um local para um local
remoto. Essa ação corresponde ao comando PUT do FTP.
Fazer upload de um arquivo remoto requer que as credenciais de usuário especificadas
tenham as permissões apropriadas de alteração de diretório e gravação no host remoto.
O host remoto deve ter um servidor FTP configurado.
Parâmetros de entrada
Arquivo local
Especifica o caminho completo do arquivo local para transferência. Por exemplo:
C:\\IT PAM\\import\\script_ora1.sh. Essa opção não está disponível se você
selecionar a caixa de seleção São dados embutidos.
São dados embutidos
Quando marcada, essa opção transfere o texto armazenado com o operador na
biblioteca. Clique no campo Dados embutidos para inserir dados.
334 Referência do Criador de Conteúdo
Operador Fazer upload de arquivo
Dados embutidos
Clique nesse campo para abrir o Editor de dados embutidos, em que é possível
inserir os dados a serem transferidos.
Arquivo remoto
Especifica o caminho para o arquivo no host do FTP remoto. Por exemplo: /tmp/IT
PAM/scripts/script_ora1.sh. Se você não especificar um nome de arquivo, o
operador salvará o arquivo usando o mesmo nome do arquivo copiado. O local
deve ser válido em tempo de execução no touchpoint que está executando os
operadores Transferência de arquivo.
Host remoto
Especifica o endereço IP ou o URL do FTP para o host remoto. Para um site de FTP
na intranet da sua empresa, é possível especificar o nome do servidor
(//nome_do_servidor) para o site FTP.
Por padrão, sites FTP usam a porta 21. No entanto, é possível atribuir uma porta
para um site FTP. Portas privadas variam de 49152 a 65535. Para especificar uma
porta FTP privada, adicione um sinal de dois pontos (:) e, em seguida, um número
de porta privada no final do endereço. Por exemplo, o seguinte especifica a porta
50021 em um servidor FTP remoto:
172.24.36.107:50021
ID de usuário remoto
Especifica uma ID de usuário para acessar o host do FTP remoto.
Senha de usuário remoto
Especifica a senha para acessar o host do FTP remoto.
Transferência binária
Usa o modo binário do FTP para transferir arquivos binários. Por exemplo, se for
marcada, essa opção usará os seguintes tipos de arquivos:
■
Arquivos executáveis
■
Arquivos de sistema do SPSS
■
Arquivos do SAS
■
Conjuntos de dados do Stata
■
Arquivos gráficos
Usar FTP seguro (SFTP)
Marque essa caixa de seleção para abrir uma sessão de FTP (SFTP) segura. O SFTP é
semelhante ao FTP, mas, ao contrário do FTP, a sessão inteira é criptografada.
Nenhuma senha é enviada na forma de texto não criptografado e são menos
vulneráveis a interceptação de terceiros.
Capítulo 10: Transferência de arquivo 335
Operador Fazer upload de arquivo
Especificar um comando SITE opcional
Marque essa caixa de seleção para usar o comando SITE para chamar os serviços
específicos do sistema do host. Em seguida, use o campo Parâmetros do site para
especificar uma expressão do CA Process Automation que retorne parâmetros para
o comando SITE.
Parâmetros do site
Digite uma expressão do CA Process Automation que retorne os parâmetros para o
comando SITE.
Parâmetros de saída
localFile
isInline
Dados embutidos
remoteFile
remoteHost
remoteUserId
remoteUserPassword
transferMode
secureFtp
siteCommand
siteParameters
336 Referência do Criador de Conteúdo
Capítulo 11: Gerenciamento de Java
Os operadores Gerenciamento de Java fornecem uma interface de gerenciamento para
sistemas externos que oferecem suporte a JMX.
Parâmetros de logon do JMX
Os parâmetros de logon do JMX exibidas para cada Java Management operadores. Esses
parâmetros definem as configurações necessárias para fazer logon e se comunicar com
o servidor JMX.
Usar URL do serviço do JMX especificado pelo usuário
Selecione esta caixa de seleção para especificar um URL de serviço do JMX em vez
de especificar um servidor.
Quando você marca essa caixa de seleção, os seguintes campos são ativados:
■
URL do JMX
■
Usuário JMX remoto
■
Senha JMX remota
Quando você marca essa caixa de seleção, os seguintes campos são desativados:
■
Host JMX remoto
■
Porta de registro remota
■
Servidor JMX remoto
URL do JMX
Especifica uma URL de serviço do JMX.
URL padrão:
service:jmx:rmi:///jndi/rmi://<computador_de_destino>:<porta_do_registro_de_R
MI>/servidor_RMI_JMX
Por exemplo:
computador_de_destino: PA-w2k3-3
porta_do_registro_de_RMI: 9999
servidor_RMI_JMX: server
O URL tem a seguinte aparência:
service:jmx:rmi:///jndi/rmi://PA-w2k3-2:9999/server
Capítulo 11: Gerenciamento de Java 337
Operador Obter atributos MBean
Host JMX remoto
Especifica o nome da máquina host para o agente JMX. É possível especificar o
nome completo da máquina ou um endereço IP na rede.
Quando o agente JMX está em execução no mesmo computador que o CA Process
Automation, o host local é o padrão.
Porta do registro de RMI
Especifica a porta de conexão para o agente JMX.
A porta padrão é 12345. No entanto, você pode executar o agente JMX em uma
porta do registro de RMI que você definir.
Servidor JMX remoto
Especifica o nome do servidor do JMX.
Usuário JMX remoto
Especifica o nome de usuário para estabelecer conexão com o agente JMX no
servidor MBean. Se a segurança estiver desativada para o agente JMX, deixe esta
opção em branco.
Senha JMX remota
Especifica a senha para estabelecer conexão com o agente JMX no servidor MBean.
Se a segurança estiver desativada para o agente JMX, deixe esta opção em branco.
Operador Obter atributos MBean
O operador Obter atributos MBean obtém o valor de um MBean através de JMX em um
nó. O operador do modelo exige o nome do MBean e as informações de contato e
credenciais para o servidor JMX. Os valores recuperados são colocados no conjunto de
dados do Processo. A variável de conjunto de dados do operador é atribuída ao mesmo
nome que o atributo e seu valor é o recuperado.
Parâmetros de entrada
Nome Bean gerenciado
Especifica o nome do bean de gerenciamento a ser acessado.
Na lista suspensa, selecione o nome do bean de gerenciamento a ser acessado ou
insira manualmente o nome do Mbean definido pelo usuário.
338 Referência do Criador de Conteúdo
Operador Obter atributos MBean
Atributo Bean gerenciado
Selecione ou digite o nome do atributo a ser buscado na lista.
Parâmetros de logon do JMX (na página 337)
Parâmetros de saída
ManagedBeanName
ManagedBeanAttribute
Estado
UserSpecifiedURL
RemoteJMXURL
RemoteHost
RemoteRMIRegistryPort
RemoteJMXServer
RemoteUser
RemotePassword
Capítulo 11: Gerenciamento de Java 339
Operador Obter atributos MBean
Exemplo:
Este exemplo mostra um Nome bean gerenciado definido pelo usuário e um Atributo
bean gerenciado.
Nos parâmetros de logon do JMX, é fornecido um URL de serviço remoto do JMX. Em
decorrência disso, os campos Host JMX remoto, Porta do registro de RMI e Servidor JMX
remoto são desativados.
Os campos Usuário JMX remoto e Senha JMX remota estão em branco, pois o servidor
não possui a segurança ativada.
Após a execução bem-sucedida do operador, o parâmetro Estado é retornado como
estado inicial do MBean, conforme mostrado no conjunto de dados de saída do
operador no painel Conjunto de dados:
340 Referência do Criador de Conteúdo
Operador Chamar método MBean
Essas informações também aparecem nas propriedades da variável de saída do
operador no painel de log:
Operador Chamar método MBean
Esse operador Chamar método MBean chama um método em um servidor JMX.
Parâmetros de entrada
Nome Bean gerenciado
Especifica o nome do bean de gerenciamento a ser acessado.
Na lista suspensa, selecione o nome do bean de gerenciamento a ser acessado ou
insira manualmente o nome do Mbean definido pelo usuário.
Capítulo 11: Gerenciamento de Java 341
Operador Chamar método MBean
Método Bean gerenciado
Especifica o método a ser chamado.
Parâmetros do método
Especifica os parâmetros para o método.
Use os botões desse campo para adicionar, remover ou reordenar parâmetros.
Parâmetros de logon do JMX (na página 337)
Parâmetros de saída
ManagedBeanName
ManagedBeanMethod
ManagedBeanMethodParams
InvokeResults
UserSpecifiedURL
RemoteJMXURL
RemoteHost
RemoteRMIRegistryPort
RemoteJMXServer
RemoteUser
RemotePassword
342 Referência do Criador de Conteúdo
Operador Chamar método MBean
Exemplo:
Este exemplo chama o método MBean "sayHello" sem nenhum parâmetro do MBean
definido pelo usuário.
Após a execução bem-suceduda do operador, o método MBean retorna o valor para o
parâmetro InvokeResults, como mostrado no conjunto de dados de saída do operador
no painel Conjunto de dados:
Essas informações também aparecem nas propriedades da variável de saída do
operador no painel de log:
Capítulo 11: Gerenciamento de Java 343
Operador Atualizar atributos MBean
Operador Atualizar atributos MBean
O operador Atualizar atributos MBean define o valor para o atributo MBean.
Parâmetros de entrada
Nome Bean gerenciado
Especifica o nome do bean de gerenciamento a ser acessado.
Na lista suspensa, selecione o nome do bean de gerenciamento a ser acessado ou
insira manualmente o nome do Mbean definido pelo usuário.
344 Referência do Criador de Conteúdo
Operador Atualizar atributos MBean
Atributo Bean gerenciado
Especifica o nome de um atributo JMX MBean a ser atualizado.
Valor de atributo
Especifica um valor definido como o valor do atributo JMX.
Parâmetros de logon do JMX (na página 337)
Parâmetros de saída
ManagedBeanName
ManagedBeanAttribute
ManagedBeanAttributeValue
UserSpecifiedURL
RemoteJMXURL
RemoteHost
RemoteRMIRegistryPort
RemoteJMXServer
RemoteUser
RemotePassword
Capítulo 11: Gerenciamento de Java 345
Operador Atualizar atributos MBean
Exemplo:
Este exemplo ilustra:
■
Atualização do valor do atributo MBean de inicial a intermediário usando o
operador Atualizar atributos MBean.
■
Obtenção do valor atualizado do estado do atributo MBean usando o operador
Obter atributos MBean.
346 Referência do Criador de Conteúdo
Operador Atualizar atributos MBean
Esses parâmetros são os parâmetros de entrada do operador Atualizar atributos MBean:
Após a execução bem-sucedida do operador, o valor do estado do atributo MBean é
definido como intermediário, conforme mostrado no conjunto de dados de saída do
operador no painel Conjunto de dados:
Essas informações também aparecem nas propriedades da variável de saída do
operador no painel de log:
Capítulo 11: Gerenciamento de Java 347
Operador Atualizar atributos MBean
Essas variáveis são as variáveis do conjunto de dados de saída do operador no painel
Conjunto de dados de Obter atributos MBean. O valor de estado foi atualizada para
intermediário.
348 Referência do Criador de Conteúdo
Capítulo 12: Utilitários de rede
O módulo Utilitários de rede oferece vários utilitários de protocolo de rede padrão para
os processos de negócios automatizados possibilitados pelo CA Process Automation.
Esse módulo oferece utilitários gerais que validam várias interfaces de rede e
dispositivos. Esse módulo também opera em servidores e serviços remotos e move
dados como parte do processo geral de automação, reduzindo assim a verificação e a
validação manual.
Os operadores do módulo Utilitários de rede têm a opção de criar portas de saída
personalizadas. Você pode definir portas personalizadas (portas de saída não
automáticas) no operador ao criar o processo. Essas portas são adicionais às portas de
saída automáticas que todos os operadores têm (portas de êxito e falha).
Use os operadores de Utilitários de rede para usar utilitários de interface de rede
nativos (em vez de linguagens de script com base em host e outros utilitários com base
em host).
Operador Obter interfaces de rede local
O operador Obter interfaces de rede local lista todas as interfaces de rede no host local.
O host local é o host no qual o touchpoint para o operador está em execução.
Para cada interface de rede, o operador exibe as seguintes informações:
■
Nome da interface
■
Endereço Mac
■
Nome de exibição
■
Lista de inetaddresses associados à interface.
Observação: cada InetAddress consiste em seu nome canônico, nome do host e
endereço IP.
Parâmetros de entrada
Nenhuma entrada do operador é necessária.
Capítulo 12: Utilitários de rede 349
Operador Obter interfaces de rede local
Parâmetros de saída
StartTime
StartDate
NetworkInterfaces
Especifica uma matriz de mapas de valor que contém as interfaces de rede
associadas ao host local.
Cada mapa de valores em NetworkInterfaces contém as seguintes informações:
Nome
Especifica o nome da interface de rede.
Exibir
Especifica o nome de exibição da interface de rede.
MacAddress
Especifica o endereço de hardware, normalmente o endereço MAC, da
interface de rede. Um espaço em branco nesse campo indica que o operador
não conseguiu recuperar o endereço MAC da interface de rede. A falha de
recuperação pode ocorrer devido à ausência de privilégios ou devido à falta de
um endereço MAC para essa interface de rede.
InetAddresses
Especifica uma matriz de mapas de valor que contém os InetAddresses
associados à interface de rede. Cada mapa de valores em InetAddresses
contém as seguintes informações:
IpAddress
Especifica o endereço IP.
Host
Especifica o nome do host. O endereço IP será retornado se o operador
não puder executar uma pesquisa inversa devido à configuração da rede.
CanonicalName
Especifica o nome canônico. Se o operador não puder obter o FQDN, será
retornado um endereço IP.
Resultado
Um dos seguintes itens:
1
Indica que o operador foi concluído com êxito.
-1
Indica que o operador falhou.
350 Referência do Criador de Conteúdo
Operador Obter interfaces de rede local
Motivo
Um dos seguintes itens:
concluído
Indica que o operador foi concluído com êxito.
<mensagem de erro>
Especifica o motivo da falha do operador em uma mensagem de erro.
Portas do operador
Êxito
O operador foi concluído com êxito.
Falha
O operador falhou por um dos seguintes motivos:
■
Não é possível recuperar a lista de interfaces de rede locais do host local.
■
Outros motivos especificados em mensagens de erro.
Portas personalizadas
Se definido pelo usuário durante a criação do processo.
Capítulo 12: Utilitários de rede 351
Operador Obter status do serviço de rede
Exemplo:
Exemplo de mapa de valores: interfaces de rede e InetAddresses
Operador Obter status do serviço de rede
O operador Obter status do serviço de rede permite que você se comunique com um
serviço local ou remoto, por meio de TCP ou UDP. Você pode usar esse operador para
enviar dados e receber uma resposta. Esse operador pode validar a resposta em relação
a um padrão pré-determinado para determinar se o serviço de rede está ativo. Esse tipo
de validação permite que o operador relate o status do serviço e o computador que está
hospedando o serviço.
Observação: não é possível enviar uma mensagem binária usando esse operador, pois
apenas sequências de caracteres (texto) são suportadas.
352 Referência do Criador de Conteúdo
Operador Obter status do serviço de rede
TCP é um protocolo orientado para conexão. O operador permite que você se conecte
ao serviço, envie dados e receba uma resposta que poderá ser correspondida em
relação a um padrão. Outro serviço pode escutar na mesma porta. Portanto, uma
conexão bem-sucedida não significa necessariamente que determinado serviço está em
execução.
UDP é um protocolo sem conexão. O operador não se conecta ao serviço para obter seu
status por meio de UDP. Para obter o status, o operador envia uma mensagem UDP, lê a
resposta e verificará se os dados de resposta correspondem a um padrão.
Parâmetros de entrada
Nome do host remoto
Especifica o nome do host ou o FQDN do computador que hospeda o serviço.
Padrão
Em branco - indica que o operador pressupõe que o serviço está em execução
no host do touchpoint.
Porta remota
Especifica a porta de host em que o serviço está escutando. Algumas portas
conhecidas e registradas são:
■
21: FTP - Transferência de arquivos
■
22: SSH - protocolo SSH (Secure Shell)
■
23: Telnet
■
2483: Oracle TTC
■
25: SMTP - Simple Mail Transfer
■
3306: MySQL
■
69: TFTP - Trivial File Transfer
■
80: HTTP
■
1433: Microsoft SQL Server
Você pode especificar qualquer porta válida nesse campo.
Número de porta local (0 para porta anônima)
Especifica a porta que o operador Obter status do serviço de rede usa no host do
touchpoint para se conectar à porta remota.
Valores
■
0 - indica que uma porta anônima é usada.
■
Em branco - igual a 0.
Observação: se a porta especificada não estiver disponível, o operador falhará.
Capítulo 12: Utilitários de rede 353
Operador Obter status do serviço de rede
Protocolo a ser usado
Especifica o protocolo a ser usado ao verificar o status do serviço e ao enviar dados.
Se UDP for especificado, o campo Tempo limite de conexão (s) será desativado,
porque UDP é um protocolo sem conexão.
Valores
Esse valor pode ser um dos seguintes:
■
TCP
■
UDP
Padrão
TCP (se deixado em branco).
Tempo limite de conexão (s)
Especifica o tempo máximo durante o qual o operador aguarda uma conexão com o
serviço antes de expirar. Esse campo é aplicável apenas ao protocolo TCP.
Valores
Esse valor pode ser um dos seguintes:
■
0 (zero) - indica nenhum tempo limite.
■
Qualquer número inteiro positivo (em segundos)
Padrão
20 segundos (se estiver em branco)
Dados a serem enviados
(Opcional) Especifica dados a serem enviados ao serviço. A maioria dos serviços não
espera dados.
Ler dados do serviço?
Especifica se o operador lê dados do serviço após contatá-lo.
Valores
Esse valor pode ser um dos seguintes:
■
Selecionado – indica que o operador lê dados do serviço após contatá-lo.
Selecione essa opção para ativar os campos Tempo de leitura de dados (s),
Máximo de dados para ler (bytes) e Padrão de resposta para
correspondência.
■
Desmarcado - indica que o operador não lê dados do serviço após
contatá-lo. Esse valor é apropriado para serviços que não retornam dados.
354 Referência do Criador de Conteúdo
Operador Obter status do serviço de rede
Observações:
■
Com UDP, todos os dados (se houver) são lidos de uma vez. Se não houver
dados, o operador aguardará até que o Tempo de leitura de dados seja
atingido. Todo o Máximo de dados para ler é lido de uma vez em uma
sequência de caracteres com o comprimento de Máximo de dados para ler.
■
Com TCP, o operador lê os dados em lotes até alcançar um dos seguintes
limites:
–
Tempo de leitura de dados
–
Máximo de dados para ler
Tempo de leitura de dados (s)
Especifica o tempo a ser gasto esperando pelos dados de resposta do serviço. Esse
campo é especificado porque os dados do serviço não têm um EOF no final.
Valores
Esse valor é um número inteiro positivo. Zero (0) não é permitido. Caso
contrário, o operador deverá aguardar por muito tempo até que o serviço
feche o soquete.
Padrão
20 segundos (se estiver em branco).
Máximo de dados para ler (bytes)
Especifica a quantidade máxima de dados a serem lidos do serviço.
Padrão
4096 bytes
Padrão de resposta para correspondência
(Opcional) especifica um padrão a ser usado para fazer a correspondência dos
dados retornados do serviço. Se for especificado, a correspondência de padrão
determinará se o operador terá êxito ou falhará.
O operador faz a correspondência entre o padrão e os dados lidos durante o
período de tempo especificado em Tempo de leitura de dados até o número de
bytes especificado em Máximo de dados para leitura.
O operador faz a correspondência do padrão como uma subsequência de caracteres
dos dados de resposta.
■
Para fazer a correspondência de dados de resposta que se iniciam com uma
sequência específica, use ^ no início do padrão.
■
Para fazer a correspondência de dados de resposta que terminam com uma
sequência específica, use $ no final do padrão.
■
Para fazer a correspondência de um terminador de nova linha, use um ponto
(.). O ponto é usado para fazer a correspondência de dados com várias linhas.
Capítulo 12: Utilitários de rede 355
Operador Obter status do serviço de rede
Parâmetros de saída
ReplyMessage
Contém os dados recebidos do serviço. Esse campo estará vazio se o serviço não
tiver enviado dados ou se o operador não ler dados do serviço.
LocalAddressInfo
Informações sobre o endereço local usado para a conexão com o serviço, no
formato:
localhost/IP:porta
Essas informações permitem identificar o número da porta local real usada quando
o Número de porta local (na página 353) é definido como 0 para anônimo.
RemoteAddressInfo
Informações sobre o endereço remoto ao qual o operador se conectou, no formato:
Hostname/IP:porta
Observação: o UDP é um protocolo sem conexão; esse campo fica em branco
quando UDP é selecionado em Protocolo a ser usado (na página 353).
Resultado
■
1: o operador teve êxito.
■
-1: o operador falhou.
Motivo
■
Concluído, se o operador for concluído com êxito.
■
Uma mensagem de erro será retornada se o operador falhar.
remoteSSHHost
PORT
LocalPort
SendProtocol
ConnTimeout
CommandData
IsReadData
ReadDataPeriod
ReadDataBytes
ReplyPattern
StartTime
StartDate
356 Referência do Criador de Conteúdo
Operador Obter status do serviço de rede
Portas do operador
Êxito
■
O operador foi concluído com êxito.
■
Se o operador for configurado para ler dados do serviço, o operador terá êxito
se:
–
TCP:
a. Vincular-se à porta local (caso especificada)
b. Conectar-se ao host remoto na porta remota especificada
c. Gravar dados no serviço (caso especificado)
d. Ler os dados de resposta do serviço
e. Verificar se os dados de resposta correspondem ao padrão (caso
especificado).
–
UDP:
a. Vincular-se à porta local (caso especificada)
b. Enviar uma mensagem UDP ao host remoto na porta remota
especificada
c. Ler a resposta do serviço
d. Verificar se os dados de resposta correspondem ao padrão (caso
especificado).
■
Se o operador não for configurado e, assim, não ler dados do serviço, ele terá
êxito se:
–
TCP:
a. Vincular-se à porta local (caso especificada)
b. Conectar-se ao host remoto na porta remota especificada
c. Gravar dados no serviço (caso especificado).
–
UDP:
a. Vincular-se à porta local (caso especificada)
b. Enviar uma mensagem UDP ao host remoto na porta remota
especificada.
Esse processo não significa que o serviço UDP está operacional. É
recomendável configurar o operador ao ler a resposta do serviço e fazer a
correspondência entre ela e um padrão. Assim, você poderá ter certeza de
que o serviço UDP está ativo e em execução. Não é possível ter certeza de
que um serviço foi verificado corretamente por meio de UDP quando o
serviço não retorna dados.
Capítulo 12: Utilitários de rede 357
Operador Obter status do serviço de rede
Tempo de expiração
O tempo limite ocorre ao tentar abrir uma conexão com o serviço por meio de TCP.
O valor do tempo limite é especificado em Tempo limite da conexão (s) (na
página 353).
Falha
Os motivos incluem:
■
O operador está definido para ler dados do serviço, mas os dados lidos não
corresponderam ao padrão especificado pelo usuário.
■
O usuário especifica dados inválidos. Por exemplo: portas remotas/locais
negativas, Tempo limite da conexão negativo (apenas para TCP), Tempo de
leitura de dados (s) igual a 0 ou negativo.
■
O host remoto não é conhecido.
■
Não é possível conectar-se ao host remoto na porta remota (ou a conexão é
recusada) por meio de TCP; o serviço pode estar desativado, nesse caso.
■
Não é possível vincular-se à porta local especificada.
■
Erro ao enviar ou receber dados de/para o serviço.
Portas personalizadas
Retornado caso definido pelo usuário durante a criação do processo.
358 Referência do Criador de Conteúdo
Operador Obter variável SNMP
Operador Obter variável SNMP
O operador Obter variável de SNMP lê o valor de uma variável remota MIB (base de
informações de gerenciamento). As identificações de objeto (OIDs) e semântica das
variáveis SNMP estão documentadas no MIB do agente remoto SNMP.
O SNMP é um protocolo, sem conexão não-confiável. Uma opção de tempo limite
especifica o tempo permitido para que a solicitação alcance o endereço de destino. A
opção Repetir especifica o número de vezes que uma solicitação é enviada em caso de
falhas. Esse operador pode falhar por várias condições de erro, como a variável SNMP
não encontrada, a permissão de leitura negada ou um dispositivo não disponível.
Capítulo 12: Utilitários de rede 359
Operador Obter variável SNMP
Parâmetros de entrada
Host do agente
Define o endereço IP ou o nome de domínio totalmente qualificado para o host do
agente. Por exemplo: 192.168.1.254.
Para especificar uma porta junto com o nome do host, use um dos seguintes
formatos:
■
host:port
■
host/port
Por exemplo: comet.hq.company.com:10162
Comunidade
Define a comunidade em que a variável será acessada (por exemplo, pública).
ID do objeto (OID)
Especifica a ID de objeto (OID) para a variável. A MIB (Management Information
Base - Base de Informações de Gerenciamento) associada a um agente remoto
documenta as OIDs. Por exemplo: 1.3.6.1.2.1.1.1.0.
Contagem de tentativas
Define quantas vezes o produto faz uma nova tentativa em uma solicitação com
falha.
Intervalo de tempo limite (s)
Define o intervalo em segundos até que o operador expire.
Versão do SNMP
Especifica o número de versão do agente do SNMP. Selecione Versão 1 ou Versão 2
na lista.
360 Referência do Criador de Conteúdo
Operador Obter variável SNMP
Parâmetros de saída
Object_ID
Retry_Count
Tempo de expiração
SNMP_Version
Comunidade
Agent_Host
Porta
OIDValue
Agent_Host
Comunidade
RequestId
ErrorIndex
ErrorStatus
Capítulo 12: Utilitários de rede 361
Operador Monitorar a variável do SNMP
Operador Monitorar a variável do SNMP
O operador Monitorar a variável do SNMP aguarda até que uma variável SNMP tenha
um valor que satisfaça as condições especificadas. Essas condições são definidas por um
padrão ou um intervalo de valores. O operador pode extrair subsequências de um
padrão correspondente.
Esse operador é implementado com um operador Obter variável de SNMP iterativo até
que a condição especificada seja satisfeita.
Parâmetros de entrada
Host do agente
Define o endereço IP ou o nome de domínio totalmente qualificado para o host do
agente. Por exemplo: 192.#68.1.254
Para especificar uma porta junto com o nome do host, use um dos seguintes
formatos:
■
host:port
■
host/port
Por exemplo: comet.hq.company.com:10162
Comunidade
Define a comunidade em que a variável será acessada (por exemplo, pública).
362 Referência do Criador de Conteúdo
Operador Monitorar a variável do SNMP
ID do objeto (OID)
Especifica a ID de objeto (OID) para a variável. A MIB (Management Information
Base - Base de Informações de Gerenciamento) associada a um agente remoto
documenta as OIDs. Por exemplo:1.3.6.1.2.1.1.1.0
Contagem de tentativas
Define quantas vezes o produto faz uma nova tentativa em uma solicitação com
falha.
Intervalo de tempo limite (s)
Define o intervalo em segundos que o produto deverá aguardar por Obter variável
de SNMP antes que o operador expire.
Tipo de variável
Especifica um tipo de dados para a variável. Para configurar este parâmetro,
selecione um valor na lista suspensa.
Tempo de espera (s)
Define o intervalo máximo em segundos entre as tentativas para verificar o valor da
variável inspecionada.
Versão do SNMP
Especifica o número de versão do agente do SNMP. Selecione Versão 1 ou Versão 2
na lista.
Valor baixo
Define o valor numérico mínimo esperado.
Valor alto
Define o valor numérico máximo esperado.
Máscara
Define o padrão pelo qual o operador pesquisa (para obter mais informações,
consulte o Guia do Criador de Conteúdo).
Os separadores (#) no padrão delimitam o texto que será salvo nas variáveis do
conjunto de dados do operador.
Separador
Define o caractere que delimita a zona a ser salva para as variáveis especificadas
pelos nomes de variáveis.
Capítulo 12: Utilitários de rede 363
Operador Monitorar a variável do SNMP
Nomes da variável
Define os nomes das variáveis para salvar o texto que corresponde às zonas
delimitadas no padrão. O produto salva as zonas delimitadas nas variáveis listadas
na ordem. O produto usa a palavra-chave processo para acessar variáveis do
conjunto de dados do operador por meio do conjunto de dados do processo.
Por exemplo, a especificação dos nomes de variáveis V1 e V2 atribui valores de
sequência de caracteres secundária extraídos para as variáveis do conjunto de
dados do operador Process.Operator_name.V1 e Process.Operator_name.V2. Para
adicionar, remover e classificar as variáveis para armazenar as sequências de
caracteres correspondentes, use a barra de ferramentas.
Diferenciação de padrão de maiúscula e minúscula
Especifica se é necessário usar a diferenciação de padrão de maiúscula e minúscula.
Selecionado: coincidir maiúsculas e minúsculas em um padrão apenas com letras
iguais.
Desmarcado: ignorar maiúsculas e minúsculas quando corresponder ao padrão.
364 Referência do Criador de Conteúdo
Operador Monitorar a variável do SNMP
Parâmetros de saída
Object_OID
Retry_Count
Tempo de expiração
Variable_Type
Tempo de espera
SNMP_Version
Low_Value
High_Value
Máscara
Separador
Variable_Names
IsCaseSensitivePatternMatching
Expiração da exibição
Comunidade
Agent_Host
Porta
MatchedEntry
LastReadPos
RequestId
ErrorIndex
ErrorStatus
Porta
OIDValue
Capítulo 12: Utilitários de rede 365
Operador Executar ping para o host
Operador Executar ping para o host
O operador Executar ping para o host permite que você avalie o acesso a determinado
host ou endereço IP. Você pode especificar o número de solicitações a serem feitas ao
host remoto, bem como os valores de tempo limite e de TTL. Você também pode
especificar o endereço IP local do computador no qual o operador está sendo
executado. Nesse caso, o operador usa a interface de rede local associada ao endereço
IP local para iniciar a operação de ping.
A variável de saída isHostReachable indica se o host pode ser acessado.
■
Se nenhuma das solicitações de ping indicar que o host pode ser acessado,
isHostReachable será definido como Verdadeiro.
■
Se todas as solicitações de ping indicarem que o host não está acessível,
isHostReachable será definido como Falso e o operador falhará.
O operador Executar ping para o host falha quando ocorre um erro ou quando todas as
solicitações de ping para um host falham.
Parâmetros de entrada
Nome do host remoto
Especifica o nome do host ou o endereço IP para ping. Para um endereço IPv6, use
o formato definido em RFC 2732 ou o formato de endereço IPv6 literal definido em
RFC 2373. Caso não seja especificado, o padrão será usado.
Padrão
O endereço de loopback do host associado ao touchpoint.
Endereço IP local
Especifica o endereço IP local do host com o agente associado ao touchpoint, cuja
interface de rede inicia o ping. Se não for especificado, o operador Executar ping
para o host usará o valor padrão.
Padrão
Em branco - indica que não há uma interface.
366 Referência do Criador de Conteúdo
Operador Executar ping para o host
Número de solicitações
Especifica o número de vezes para executar a operação, que determina se o host
remoto está inacessível. O operador Executar ping para o host considera o host
remoto inacessível quando todas essas solicitações retornam que o host está
inacessível. Se não for especificado, o operador usará o padrão.
■
Se nenhuma das solicitações de ping indicar que o host pode ser acessado,
isHostReachable será definido como Verdadeiro.
■
Se todas as solicitações de ping indicarem que o host não está acessível,
isHostReachasble será definido como Falso e o operador falhará.
Padrão
1
Tempo de vida
Especifica o valor máximo de tempo de vida para cada solicitação no número
especificado de solicitações. Para pings (solicitações ICMP), especifica o número
máximo de saltos que os pacotes devem percorrer antes de desistir e considerar o
host remoto inacessível. Se não for especificado, o operador usará o padrão.
Padrão
30
Tempo limite (segundos)
Especifica o tempo limite, em segundos, em que o valor é aplicado a cada
solicitação no número especificado de solicitações. Se uma solicitação expirar antes
de obter uma resposta, ela considerará o host remoto inacessível. Se não for
especificado, o operador usará o padrão.
Padrão
5
Capítulo 12: Utilitários de rede 367
Operador Executar ping para o host
Parâmetros de saída
isHostReachable
isHostReachable é definido com um dos seguintes valores:
Verdadeiro
Indica que pelo menos uma das solicitações de ping acessou o host.
Falso
Indica que nenhuma das solicitações de ping acessou o host. O operador falha.
Uma solicitação considerará o host inacessível se:
■
O host não estiver acessível
■
TTL expira
■
O tempo limite expirar
HostIpAddress
O endereço IP do host remoto.
HostCanonicalName
O nome canônico do host remoto. O operador recupera o FQDN ou o endereço IP,
dependendo da configuração do sistema subjacente.
LocalNetworkInterface
Um dos seguintes:
O nome da interface de rede local usada para enviar as solicitações ao host
remoto.
Indica que o usuário especificou um endereço IP local.
Em branco
Indica que nenhum endereço IP local foi especificado na entrada do operador.
TotalRequests
O número de solicitações emitidas pelo operador.
Se nenhum erro ocorrer durante a execução do operador, TotalRequests deverá ser
igual ao valor de Número de solicitações.
SuccessfulRequests
O número de solicitações que atingiram o host remoto.
FailedRequests
O número de solicitações que não conseguiu acessar o host remoto.
368 Referência do Criador de Conteúdo
Operador Executar ping para o host
FailurePercentage
FailedRequests * 100 / TotalRequests.
Resultado
1
Indica que o operador foi concluído com êxito.
-1
Indica que o operador falhou.
Motivo
Um dos seguintes:
concluído
Indica que o operador foi concluído com êxito.
<mensagem de erro>
Especifica o motivo da falha do operador em uma mensagem de erro.
remoteSSHHost
localIp
NUMBER_OF_REQUESTS
TTL
Tempo de expiração
Capítulo 12: Utilitários de rede 369
Operador Enviar interceptação de SNMP
Portas do operador
Êxito
O operador foi concluído com êxito.
Falha
O operador falhou por um dos seguintes motivos:
■
isHostReachable é falso.
■
Um firewall ou um problema na rede impede que o CA Process Automation
procure ou se conecte com o computador.
■
Nome de host remoto desconhecido.
■
Endereço IP local inválido.
■
Não é possível recuperar a interface de rede local associada ao endereço IP
local.
■
A interface de rede local associada ao endereço IP local não está ativa.
■
O tempo limite, o número de solicitações ou o tempo de vida é menor ou igual
a 0 (zero).
■
Outro motivo, especificado no campo de motivo.
Portas personalizadas
Se definido pelo usuário durante a criação do processo.
Operador Enviar interceptação de SNMP
O operador Enviar interceptação de SNMP gera interceptações de SNMP. Uma
interceptação é uma mensagem não solicitada que um agente envia a um sistema de
gerenciamento SNMP. O agente envia uma interceptação quando ele detecta que um
determinado tipo de evento ocorreu localmente no host gerenciado. Por exemplo, o
agente pode enviar uma mensagem de interceptação em um evento de reinicialização
do sistema. Interceptações de SNMP normalmente são usadas para disparar alarmes e
notificações ou para causar ações predefinidas por dispositivos remotos (como
reinicialização ou redefinição de dispositivo).
370 Referência do Criador de Conteúdo
Operador Enviar interceptação de SNMP
A semântica exata de interceptações específica é definida na documentação de MIB
(base de informações de gerenciamento) do agente SNMP. Para interceptações
personalizadas, consulte a documentação do agente de destino.
Parâmetros de entrada
Host do agente
Define o endereço IP ou o nome de domínio totalmente qualificado para o host do
agente.
Para especificar uma porta junto com o nome do host, use um dos seguintes
formatos:
■
host:port
■
host/port
Por exemplo: comet.hq.company.com: #####
Comunidade
Define o nome da comunidade da interceptação SNMP. Por exemplo: pública
Versão do SNMP
Especifica o número de versão do agente do SNMP. Selecione a versão 2 na lista.
Capítulo 12: Utilitários de rede 371
Operador Enviar interceptação de SNMP
ID Trap
Especifica uma das IDs padrão da interceptação:
■
Cold Start
■
Uma ID de interceptação personalizada específica da empresa
■
Perda de vizinho Egp
■
Link Down
■
Link Up
■
Warm Start
■
Falha na autenticação
Personalizar ID Trap
Quando você define o parâmetro ID de interceptação como Personalizada, esse
parâmetro define a ID de interceptação personalizada específica da empresa. Para
obter mais informações, consulte a documentação do agente de destino.
Carga da ID Trap
Define a ID de interceptação de carga.
Tipo de interceptação de carga
Especifica o tipo de dado para a carga das mensagens de interceptação SNMP.
Valor de interceptação de carga
Especifica o valor da carga de interceptação SNMP.
Parâmetros de saída
SNMP_Version
Trap_ID
Custom_Trap_ID
Payload_Trap_ID
Payload_Trap_Type
Payload_Trap_Value
Comunidade
Agent_Host
Porta
RequestId
372 Referência do Criador de Conteúdo
Operador Atualizar variável de SNMP
Operador Atualizar variável de SNMP
O operador Atualizar variável de SNMP define o valor de uma variável SNMP gerenciada
por um agente SNMP remoto. Em geral, a variável SNMP controla o comportamento de
dispositivos IP. A semântica exata das variáveis SNMP é definida no MIB associado a um
dispositivo.
Para definir a variável, a conta de usuário que está executando o operador Atualizar
variável de SNMP deve ter permissão de gravação no servidor SNMP para alterar o valor
da OID.
Parâmetros de entrada
Host do agente
Especifica o endereço IP ou o nome de domínio totalmente qualificado para o host
do agente. Por exemplo: 192.#68.1.254.
É possível especificar uma porta junto com o nome do host que estiver usando um
dos seguintes formatos:
■
host:port
■
host/port
Comunidade
Especifica a comunidade em que a variável será acessada (por exemplo, pública).
ID do objeto (OID)
Especifica a ID de objeto para a variável. As OIDs (Object IDs - IDs de objeto) são
documentadas na MIB (Management Information Base - Base de informações de
gerenciamento) associada a um agente remoto.
Capítulo 12: Utilitários de rede 373
Operador Atualizar variável de SNMP
Tipo de variável
Especifica um tipo de dados para a variável. Selecione um dos valores da lista para
configurar esse parâmetro do operador.
Valor variável
Especifica o valor da variável.
Versão SNMP
Especifica o número da versão para o agente remoto SNMP. Selecionar versão 1 e
versão 2 da lista.
Parâmetros de saída
Object_ID
Variable_Type
Variable_Value
SNMP_Version
Comunidade
Agent_Host
Porta
RequestId
ErrorIndex
ErrorStatus
374 Referência do Criador de Conteúdo
Capítulo 13: Controle de processo
Os operadores Controle de processo executam, monitoram e controlam os processos do
CA Process Automation. Os operadores do módulo Controle de processo iniciam
processos do sistema de dentro de um processo. O operador Atribuir tarefa de usuário
solicita que os usuários forneçam informações durante a execução de um processo.
Todos os operadores Controle de processo são executados apenas em orquestradores,
não em agentes.
Operador Atribuir tarefa de usuário
O operador Atribuir tarefa de usuário exibe um formulário de solicitação de interação
do CA Process Automation para apresenta um prompt a um usuário e aguardar a
entrada. A última página da caixa de diálogo do formulário de solicitação de interação
solicita que o usuário aprove ou rejeite o formulário de solicitação de interação. Você
pode especificar um tempo limite ou aguardar indefinidamente. Os valores de entrada
de usuário são salvos em variáveis no conjunto de dados do operador Atribuir tarefa de
usuário.
Você também pode usar o operador Atribuir tarefa de usuário para notificar um usuário
para que ele responda a uma tarefa específica por meio de um URL incorporado.
Capítulo 13: Controle de processo 375
Operador Atribuir tarefa de usuário
O operador Atribuir tarefa de usuário tem quatro links de saída padrão (não
personalizados):
concluído
Processado quando um usuário faz o seguinte:
■
Conclui com êxito o formulário de solicitação de interação.
■
Aprova o prompt do usuário na última página do formulário de solicitação de
interação.
Os valores de parâmetro são atribuídos às variáveis do conjunto de dados do
operador. A variável Resultado é definida como 1 e a variável Motivo é definida
como CONCLUÍDO. A tarefa é exibida na Lista de tarefas na guia Operações com um
estado Concluído.
Cancelado
Processado quando:
■
Um processo tem um operador Atribuir tarefa de usuário em execução e a
tarefa aparece na Lista de tarefas e está aguardando a resposta de um usuário.
Antes que um usuário responda, o processo encontra um operador Interrupção
com falha (normalmente porque outro caminho no processo ainda está em
execução enquanto o operador Atribuir tarefa de usuário está aguardando a
resposta do usuário).
■
O operador Atribuir tarefa de usuário é cancelado (manualmente ou porque o
processo foi encerrado enquanto o operador ainda estava em execução).
■
Um processo é suspenso e o operador Atribuir tarefa de usuário cancelou a
tarefa.
■
Um processo é suspenso e o operador Atribuir tarefa de usuário é redefinido
(manual ou automaticamente).
■
A execução do processo ignora a seleção feita no prompt do usuário (no campo
Disposição do formulário).
A variável Resultado é definida como -1 e a variável Motivo é definida como
CANCELADO. Em cada caso, a tarefa é exibida na Lista de tarefas na guia Operações
com um estado Cancelado.
376 Referência do Criador de Conteúdo
Operador Atribuir tarefa de usuário
Tempo limite
Processado se o usuário não concluir o formulário de solicitação de interação
dentro de um intervalo de tempo limite especificado. Quaisquer valores de
parâmetro são atribuídos a variáveis do conjunto de dados do operador. A variável
Resultado é definida como -1 e a variável Motivo é definida como TEMPO LIMITE. A
tarefa é exibida na Lista de tarefas na guia Operações com um estado Tempo limite.
Rejeitado
Processado se o usuário selecionar Rejeitar no prompt de usuário (no campo
Disposição do formulário). A variável Resultado é definida como _ e a variável
Motivo é definida como REJEITADO. A tarefa é exibida na Lista de tarefas na guia
Operações com um estado Rejeitado.
Parâmetros de entrada
O operador Atribuir tarefa de usuário inclui os parâmetros de entrada a seguir.
Parâmetros dos responsáveis
Os parâmetros dos responsáveis especificam os usuários ou grupo autorizados do CA
Process Automation para aprovar ou rejeitar a intervenção do usuário. O operador
Atribuir tarefa de usuário só verifica as credenciais de usuário quando um usuário ou
grupo é especificado.
Usuários
Especifica nomes de usuários autorizados do CA Process Automation que podem
aprovar ou rejeitar o prompt do usuário. Delimitar vários usuários com o caractere
de dois pontos (:). Por exemplo: malcolm:samirab:sam:seren.
Para abrir a caixa de diálogo Usuários e selecionar usuários, clique em
.
Selecione pessoas na lista Usuários disponíveis para mover para a lista Usuários
selecionados usando os botões de seta (ou o contrário). Você também pode digitar
um nome de usuário a ser pesquisado na caixa de texto.
Grupos
Especifica nomes de grupos autorizados do CA Process Automation que podem
aprovar ou rejeitar o prompt do usuário. Delimitar vários grupos com o caractere de
dois pontos (:). Por exemplo: domainadmin:pamuser:envconfigadmin (ou, no caso
de uma atualização: domainadmin:pamuser:envconfigadmin).
Para abrir a caixa de diálogo Grupos e selecionar grupos, clique em
. Selecione
pessoas na lista Grupos disponíveis para mover para a lista Grupos selecionados
usando os botões de seta (ou o contrário). Você também pode digitar um nome de
grupo a ser pesquisado na caixa de texto.
Capítulo 13: Controle de processo 377
Operador Atribuir tarefa de usuário
Parâmetros do Transfer/Delegates
Os parâmetros de Transferir/delegar especificam as pessoas que estão autorizadas por
usuários ou grupos do CA Process Automation a aprovar ou rejeitar o prompt do
usuário. O operador Atribuir tarefa de usuário só verifica as credenciais de usuário
quando um usuário ou grupo é especificado.
Usuários
Especifica nomes de usuários autorizados do CA Process Automation que podem
aprovar ou rejeitar o prompt do usuário. Delimitar vários usuários com o caractere
de dois pontos (:). Por exemplo: malcolm:samirab:sam:seren.
Para abrir a caixa de diálogo Usuários e selecionar usuários, clique em
.
Selecione pessoas na lista Usuários disponíveis para mover para a lista Usuários
selecionados usando os botões de seta (ou o contrário). Você também pode digitar
um nome de grupo a ser pesquisado na caixa de texto.
Grupos
Especifica nomes de grupos autorizados do CA Process Automation que podem
aprovar ou rejeitar o prompt do usuário. Delimitar vários grupos com o caractere de
dois pontos (:). Por exemplo: domainadmin:pamuser:envconfigadmin (ou, no caso
de uma atualização: domainadmin:pamuser:envconfigadmin).
Para abrir a caixa de diálogo Grupos e selecionar grupos, clique em
. Selecione
pessoas na lista Grupos disponíveis para mover para a lista Grupos selecionados
usando os botões de seta (ou o contrário). Você também pode digitar um nome de
grupo a ser pesquisado na caixa de texto.
Parâmetros de tarefa de usuário
Título
Especifica um título para o prompt de usuário (opcional). Essa sequência de
caracteres descreve o título do formulário a ser apresentado para o usuário.
Descrição
Fornece uma descrição opcional para o prompt de usuário.
Formulário de solicitação de interação
Especifica o caminho na biblioteca do CA Process Automation para o objeto de
formulário de solicitação de interação que emite um prompt para o usuário. O
formulário de solicitação de interação deve estar na mesma biblioteca que o
processo. Por exemplo: /Backups/Forms/Input
Para localizar um formulário de solicitação de interação na biblioteca do CA Process
Automation, clique em
.
Para exibir o formulário de solicitação de interação no Navegador do formulário
depois que tiver sido selecionado, clique em Abrir.
378 Referência do Criador de Conteúdo
Operador Atribuir tarefa de usuário
Código de inicialização dos dados do formulário
Permite que você adicione o código que dinamicamente inicializa os campos de
formulário no tempo de execução. Isso permite exibir informações em campos
somente leitura ou alterar os valores padrão para campos editáveis.
Para adicionar expressões do CA Process Automation para alterar os valores de
campo, abra uma janela do editor de código.
No editor, use a palavra-chave formulário para acessar variáveis do conjunto de
dados do operador no seguinte formato:
Form.fieldname
em que:
fieldname representa o nome do campo na definição do objeto Formulário de
interação do usuário. Por exemplo:
form.DateTomorrow = System.tomorrow;
Para o operador atual.
Observação: para obter mais informações sobre a criação de expressões calculadas
no CA Process Automation, consulte os parâmetros de entrada (na página 422) do
operador Executar JavaScript.
Você também pode usar esse campo para inicializar campos de formulário
dinamicamente no tempo de execução. A inicialização não é a mesma para tipos
simples e tipos complexos.
■
Para tipos simples, se o formulário de solicitação de interação tiver um
elemento simples (campo de texto) Var_0, esse elemento poderá ser
inicializado especificando-se:
Form.Var_0='text'
■
Para um ValueMap, se o formulário de solicitação de interação tem um
ValueMap que contém ID value_map junto com ID text_field, text_field deve
ser inicializado da seguinte maneira:
Form.value_map= newValueMap();
Form.valuemap.text_field="test";
■
Se o formulário de solicitação de interação tem um ValueMap aninhado especificamente, se há um ValueMap dentro de um ValueMap com ID
value_map_nested e uma variável dentro do mesmo ValueMap aninhado com
ID text_field_nested, a inicialização deve ser:
Form.value_map.value_map_nested= newValueMap();
Form.value_map.value_map_nested.text_field_nested="test";
Mostrar página de aprovação
Se selecionado, permite aprovar ou rejeitar a tarefa. Se selecionado, o formulário
será exibido com uma inclusão de aprovação / rejeição de página no final ao
responder, para definir o resultado final de um formulário.
Capítulo 13: Controle de processo 379
Operador Atribuir tarefa de usuário
Parâmetros de saída
Título
Descrição
inputForm
showAcceptanceScreen
Userinfo
InitialAssignedUsers
initialAssignedGroups
assignedUsersFilter
assignedGroupsFilter
Aprovar
RepliedBy
ID da tarefa
initCode
dueDateTime
Exemplo:
Este exemplo explica como enviar uma notificação para um usuário responder a uma
tarefa usando um URL incorporado a um email. É possível incluir o parâmetro de saída
ID da tarefa do operador Atribuir tarefa de usuário no URL incorporado para acessar
uma tarefa direta. Você pode incluir URLs incorporados no operador Enviar email para
notificar o usuário por email para que ele responda a uma tarefa.
380 Referência do Criador de Conteúdo
Operador Atribuir tarefa de usuário
Atribuir tarefa do usuário permanecerá em um estado de espera até que o usuário
responda. É possível executar um processo de notificação em paralelo a fim de notificar
o usuário com o URL direto para que ele responda à tarefa disparada do operador
Atribuir tarefa de usuário, como mostrado aqui:
Você pode usar o operador Avaliar expressão para aguardar até que a expressão
Atribuir tarefa de usuário seja avaliada como verdadeira durante a atualização e a
avaliação da expressão a cada cinco segundos.
Os parâmetros de Avaliar expressão podem ser os seguintes:
Capítulo 13: Controle de processo 381
Operador Atribuir tarefa de usuário
Marque a caixa de seleção Sem tempo limite nos parâmetros de Atribuir tempo limite
para tarefa de usuário para evitar um limite de tempo para esse operador até que a
expressão seja avaliada como verdadeira.
Em seguida, quando ID da tarefa é calculado e não é mais zero, a expressão é avaliada
como verdadeira e o operador Enviar email envia um email com o seguinte URL
incorporado como parte da mensagem:
getOrchestratorURL() + "itpam" + "?ROID=" + Process.Assign_User_Task_1,TaskID +
"&page=replytask"
O operador E sincroniza as duas ramificações do processo em uma única.
Quando o usuário recebe o email, a tarefa é apresentada em um URL, no qual o usuário
clica para acessar a página de logon do CA Process Automation. Após a autenticação, o
usuário é levado diretamente para o formulário anexado à tarefa, onde poderá
responder diretamente á tarefa específica.
382 Referência do Criador de Conteúdo
Operador Avaliar expressão
Operador Avaliar expressão
O operador Avaliar expressão atrasa o processamento na ramificação de um processo
até que uma condição representada pela expressão booleana seja avaliada como
verdadeira. Esse operador fornece um mecanismo para pausar um processo enquanto
se aguarda que uma condição seja alterada. Normalmente, é usado para sincronizar
processos interdependentes ou controlar o uso de recursos compartilhados
representados pelas variáveis.
A condição é avaliada periodicamente, de acordo com uma taxa especificada. A taxa
deve ser longa o suficiente para aumentar o uso da CPU dentro dos limites aceitáveis.
Quando há uma condição para um tempo mínimo conhecido, pode-se reduzir ainda
mais a carga colocando-se um operador Atrasar (na página 402) antes do operador
Avaliar expressão. Um exemplo da ocorrência dessa situação é quando outro processo
usa um recurso e não o libera antes de uma determinada hora do dia.
Parâmetros de entrada
Expressão
Uma expressão booleana que especifica uma condição Verdadeiro quando alguma
condição é atendida. Aqui estão dois exemplos:
(Datasets["/exploit/variables/set_1"].var1 == 1)
System.Time >= Process.FinishTime
Observação: esse campo inclui assistência de conjunto de dados quando é usada
qualquer uma das palavras-chave.
Taxa de atualização (s)
O intervalo em segundos pelo qual se avalia se uma condição é Verdadeiro.
Capítulo 13: Controle de processo 383
Operador Gerenciar recursos
Parâmetros de saída
Expressão
RefreshRate
TimeOutSec
TimeOut
Operador Gerenciar recursos
O operador Recursos executa ações nos recursos do CA Process Automation. Essas
ações incluem obter e liberar unidades de recurso e bloquear e desbloquear recursos.
O operador Gerenciar recursos fornece uma maneira de validar e aguardar recursos
específicos e afetar seu estado. O operador pode tornar o processamento de qualquer
ramificação de um processo contingente à disponibilidade do recurso. Dentro de um
ambiente, os operadores de recursos podem ser usados para regular e coordenar o
processamento de vários processos. Os operadores garantem que processos individuais
tenham acesso exclusivo a recursos externos.
O operador Gerenciar recursos possui três possíveis links de saída:
■
Êxito quando as ações são executadas com êxito antes de qualquer tempo limite
especificado.
■
Falha quando os recursos não existem ou em caso de outra condição de erro.
■
Tempo limite quando o tempo limite especificado expira antes que os recursos
necessários se tornem válidos.
384 Referência do Criador de Conteúdo
Operador Gerenciar recursos
Os recursos são normalmente obtidos de uma cota de recursos antes do processamento
de outros operadores e, em seguida, são substituídos quando os operadores são
concluídos:
Condições sobre um recurso devem ser avaliadas periodicamente quanto a possíveis
alterações. Tome cuidado para evitar a especificação de um intervalo de atualização que
seja muito curto. Use um operador Verificar data e hora (na página 191) para adicionar
um atraso antes de executar o operador Gerenciar recursos, se os recursos necessários
não estiverem disponíveis:
■
Antes que um intervalo de tempo especificado tenha passado.
Ou
■
Antes de determinada data ou hora.
Parâmetros de entrada
Ação
Lista as ações a serem executadas. Os botões Adicionar, Excluir e Editar adicionam,
removem ou modificam as ações nessa lista. Cada ação especifica:
■
Um objeto de recursos
■
O nome do recurso no objeto a ser usado
Capítulo 13: Controle de processo 385
Operador Gerenciar recursos
■
A ação a ser executada no recurso (obter unidades de recursos, liberar
unidades, bloquear ou liberar um recurso)
■
Quantas unidades do recurso devem ser obtidas ou liberadas
Propriedades da ação
Essa caixa de diálogo define uma ação a ser executada em um recurso. Clique
no botão Adicionar ou Editar ao lado da caixa da listagem Ação. Essa caixa de
diálogo abre as propriedades de recursos para um operador Recursos.
ResourcePath
Especifica um objeto de recursos. Digite o caminho completo para o
recurso na Biblioteca do CA Process Automation ou clique em
para
localizar o objeto. Aspas duplas devem delimitar uma sequência de
caracteres literal. É possível usar uma variável do conjunto de dados ou
uma expressão para especificar o objeto de recursos. Para abrir o objeto
no editor de recursos, clique no botão Abrir.
ResourceName
Especifica o recurso no objeto de recursos no qual a ação deve ser
executada. Digite o nome exatamente como definido no objeto de
recursos. Aspas duplas devem delimitar uma sequência de caracteres
literal. É possível usar uma variável do conjunto de dados ou uma
expressão para especificar o recurso.
Ação
Selecione a ação a ser executada no recurso:
TakeUnits
Assume o número de unidades de recurso especificado no campo
Quantidade.
FreeUnits
Retorna o número de unidades de recurso especificado no campo
Quantidade.
LockResource
Bloqueia o recurso, para que outros operadores Recurso não possam obter
unidades de recurso ou bloquear o recurso. Essa ação obtém efetivamente
todas as unidades de recursos não utilizadas para um recurso. Ações ainda
podem liberar unidades de recurso que foram obtidas antes de um recurso
ser bloqueado. No entanto, as unidades liberadas ficam disponíveis apenas
quando o recurso está desbloqueado.
UnlockResource
Desbloqueia um recurso bloqueado.
386 Referência do Criador de Conteúdo
Operador Gerenciar recursos
Quantidade
Para as ações TakeUnits ou FreeUnits, esse valor especifica o número de
unidades de recurso a serem obtidas ou liberadas. Valor é desativado para
as outras duas opções, como UnlockResource e LockResource.
Todos os recursos devem estar disponíveis
Se marcada, todos os recursos exigidos pelas ações listadas em Ações deverão se
tornar disponíveis dentro das restrições impostas pelas opções de Tempo limite. O
operador terá êxito apenas se todos os recursos se tornarem disponíveis dentro das
restrições de tempo limite da configuração Tempo limite.
Se desmarcada, o operador será concluído com êxito quando os recursos exigidos
por pelo menos uma das ações listadas em Ações se tornarem disponíveis dentro
das restrições da opção Tempo limite. Se os recursos para qualquer uma das ações
listadas estiverem disponíveis, o módulo Controle de processo processará o link de
saída Êxito para esse operador.
Executar ações
Determina se as ações listadas em Ações são executadas. Para verificar apenas se
os recursos estão disponíveis sem executar ações, desmarque essa caixa de seleção.
O operador executa então o link de saída Êxito. Este link será executado somente se
os recursos estiverem disponíveis dentro das restrições das configurações "Tempo
limite" e "Todos os recursos devem estar disponíveis", sem executar qualquer ação.
Essa configuração pode ser usada com um recurso definido para ativar ou desativar
um conjunto completo de processos. Esses processos verificam se não há nenhum
bloqueio no recurso antes de iniciar as tarefas. Essa verificação de bloqueio é feita
tentando obter uma única unidade de recurso do recurso. Dependendo do
resultado do teste, outro mecanismo pode bloquear ou desbloquear o recurso,
como:
■
Tarefas de programação (em que a ativação ou a desativação dos processos se
baseiam em restrições de horário)
■
Tarefas iniciadas manualmente (usando um formulário de solicitação inicial)
■
Um processo iniciado por um aplicativo de monitoramento externo (usando o
daemon de serviços Web do CA Process Automation).
■
Um processo que monitora uma condição interna ou externa em um loop.
Capítulo 13: Controle de processo 387
Operadores de evento
Parâmetros de saída
ActionProperties
ResourcePath
ResourceName
Ação
Quantidade
Todos os recursos devem estar disponíveis
Executar ações
TimeOut
Operadores de evento
O CA Process Automation fornece gerenciamento de eventos por meio de dois
operadores:
■
Monitorar eventos
■
Send Event
Outros processos podem enviar eventos. Além disso, os serviços web expostos pelo CA
Process Automation também podem enviar eventos.
Observação: esses dois operadores são executados apenas em orquestradores, não em
agentes.
388 Referência do Criador de Conteúdo
Operadores de evento
Operador Monitorar eventos
Esse operador é usado em um processo para aguardar determinados eventos antes de
continuar o caminho de execução. Por exemplo, um processo pode aguardar um evento
que indica que um ticket foi aprovado, em vez de consultar periodicamente o ticket e
verificar o status de aprovação.
O operador Monitorar eventos consome os eventos disponíveis/correspondentes como
seu comportamento padrão.
Observação: Monitorar eventos não pode ser programado (ou seja, não pode ser usado
em programações). No entanto, um usuário pode criar um processo com Monitorar
eventos e, em seguida, programar o processo no editor de programação.
Parâmetros de entrada
Nome do evento
Especifica o nome do tipo de evento. Esta expressão é analisada em relação ao
nome do evento. Esse nome pode ser uma expressão regular, uma correspondência
parcial com base na escolha do usuário ou ambas.
Tipo de evento
Especifica o tipo de evento. Essa expressão é analisada em relação ao tipo de
evento. Esse tipo pode ser uma expressão regular, uma correspondência parcial
com base na escolha do usuário ou ambas.
Origem do evento
Specifies the urgency of the event. Esta expressão é analisada em relação a origem
do evento. Essa origem pode ser uma expressão regular, uma correspondência
parcial com base na escolha do usuário ou ambas.
Destino do evento
Especifica o nome do Destino do evento (opcional). Essa expressão é comparada ao
Destino do evento. Esse destino pode ser uma expressão regular, uma
correspondência parcial com base na escolha do usuário ou ambas.
Expressão
Especifica uma expressão booleana do CA Process Automation para outros
parâmetros de evento (opcional). Essa expressão é analisada em relação ao campo
Parâmetros de evento do evento. Esses parâmetros podem ser acessados usando
uma palavra-chave "payload" (por exemplo, payload.ticketid =="1443132").
Observação: esse campo inclui assistência de conjunto de dados quando é usada
qualquer uma das palavras-chave.
Capítulo 13: Controle de processo 389
Operadores de evento
Recuperar todos os eventos correspondentes
Quando selecionado, o operador Monitorar eventos recebe todos os eventos, em
vez do primeiro correspondente. Quando esses eventos são entregues, eles nunca
são enviados para você. Qualquer evento entregue a você e que também está
marcado como ‘Entregar para um único assinante’ é invalidado e não é entregue
para mais ninguém.
Ativar a correspondência de padrão
Permite correspondência de padrão com os respectivos atributos do evento, como
nome, tipo, origem e destino.
Permitir correspondência parcial
Permite que uma correspondência com os respectivos atributos do evento, como
nome, tipo, origem e destino.
Parâmetros de saída
eventId
eventName
EVENTTYPE
eventSource
eventDestination
toSingleSubsriber
payload
creationTime
expirationTime
usuário
390 Referência do Criador de Conteúdo
Operadores de evento
Operador Enviar evento
Esse operador é usado para publicar um evento para o orquestrador do CA Process
Automation. O gerenciador de eventos em execução no orquestrador do CA Process
Automation (que contém todos os assinantes) recebe um evento. O evento é verificado
em relação a qualquer assinante interessado, comparando os parâmetros de eventos.
Todos os assinantes que estão aguardando esse tipo de evento são notificados. Como
resultado, o operador Monitorar eventos é concluído e o processo continua o caminho
de execução.
Não é possível programar Enviar evento (ou seja, ele não pode ser usado em
programações). No entanto, um usuário pode criar um processo com Enviar evento e
programar o processo no criador de programação.
Observação: o mesmo evento nunca é entregue duas vezes ao mesmo operador, na
mesma instância do processo.
Parâmetros de entrada
Nome do evento
Especifica o nome do evento (obrigatório).
Tipo de evento
Especifica o tipo de evento.
Origem do evento
Especifica a origem do evento (opcional).
Destino do evento
Especifica o destino do evento (opcional).
Assinantes do evento correspondem a uma expressão regular em relação a esses
campos para decidir se estão interessados nesse evento.
Entregar para um assinante
Quando definida como verdadeira, indica que os eventos não são entregues a mais
de um processo de espera. O evento é "consumido" pelo primeiro manipulador de
eventos que está consumindo "eventos.
Capítulo 13: Controle de processo 391
Operadores de evento
Parâmetros do evento
Especifica parâmetros de eventos adicionais que podem ser um tipo de dados do CA
Process Automation (opcional).
O parâmetro Expressão no operador Monitorar eventos é avaliado em relação aos
Parâmetros de eventos. Esses parâmetros podem ser acessados usando uma
palavra-chave "payload" (por exemplo, payload.ticketid =="1443132").
Expira após (s)
Especifica quantos segundos um evento pode demorar para fazer correspondência
com algum assinante.
Parâmetros de saída
expirationDuration
eventId
eventName
EVENTTYPE
eventSource
eventDestination
toSingleSubsriber
payload
creationTime
expirationTime
usuário
Os padrões de uso para eventos
Os dois padrões de uso a seguir estão disponíveis para eventos:
Fila padrão
Cada evento é enviado a um único cliente. Você deve marcar o evento
correspondente no lado do envio (entregar para um assinante). Eventos desse tipo
são eliminados assim que eles são fornecidos ou expirar.
Observação: esse padrão afeta disparadores; consulte o Guia do Administrador de
Conteúdo para obter mais informações.
392 Referência do Criador de Conteúdo
Iniciar operador de processos
Mecanismo de notificação
O evento é usado para sinalizar um estado para um número arbitrário de partes
interessadas. Por exemplo, uma notificação significa que algo foi alterado, um
sistema está sendo desligado, e assim por diante. Um evento foi entregue uma vez
para todos os assinantes, até expirar o tempo limite.
Iniciar operador de processos
Use o Operador Iniciar processo para iniciar um processo de dentro de outro processo.
O operador Iniciar processo cria uma instância de um processo em um touchpoint e
enfileira uma solicitação de início com o mecanismo apropriado. Você pode fazer
referência ao conjunto de dados do processo filho pelo nome do operador no conjunto
de dados do processo para o processo pai. Use a seguinte sintaxe:
Process.OperatorName.FieldName
Operatorname representa o nome do operador Iniciar processo do sistema no processo
pai.
Fieldname é a variável do conjunto de dados que você deseja acessar no processo filho.
Parâmetros de entrada
Nome do processo
Especifica o caminho para o processo na biblioteca do CA Process Automation. O
processo deve estar na biblioteca do CA Process Automation do touchpoint em que
o operador está configurado para ser executado.
Por exemplo: "/Doc/NT_Charts/Alert"
Para selecionar um processo na biblioteca, clique em
.
Abrir
Abre o processo especificado pelo nome do processo para edição. Esse botão estará
disponível somente após você digitar o caminho para um processo na caixa
adjacente.
Capítulo 13: Controle de processo 393
Iniciar operador de processos
Código de inicialização do conjunto de dados do processo
Especifica instruções que iniciam variáveis do conjunto de dados no processo que
está sendo iniciado. Por exemplo:
■
Process.WorkDir = "C:\temp";
■
Process.User= Caller.User;
■
Process.DatabaseServer=Caller.DatabaseServer;
Nesta caixa, a palavra-chave Processo refere-se ao conjunto de dados da nova
instância do processo especificado pelo nome do processo. A palavra-chave Caller
refere-se ao conjunto de dados do processo que contém o módulo Executar
processo.
A palavra-chave Process ou Caller é obrigatória para referência ou criação de
variáveis no conjunto de dados do processo pai ou filho. Sem uma dessas
palavras-chave, o script de inicialização do conjunto de dados sempre cria ou tenta
fazer referência a uma variável de cálculo.
Modo
Selecione uma das seguintes opções:
Anexado
Executa o processo filho como um processo separado.
O operador Executar processo do PAM não é concluído até que a nova
instância termine o processamento. O processo que está executando o
operador é o processo pai.
Desvinculado
Executa um processo no modo desvinculado.
Uma instância de um processo iniciada no modo desvinculado não tem
nenhum relacionamento de pai com o processo que a iniciou e é o processo
raiz em qualquer sequência de chamadas originada desse processo.
Embutido
Executa um processo filho como parte do próprio processo pai (ou seja, ele é
expandido para o processo pai).
Herdar Manipulador de mudança de rota do processo pai
Quando selecionado, o processo filho herda o manipulador de mudança de
rota do processo pai (se já não estiver definido no processo filho).
Data de início
Especifica a data na qual iniciar uma instância desvinculada do processo. O valor
padrão é a data em que o operador é executado (System.Date). Essa opção estará
disponível apenas quando Desvinculado for selecionado como o modo de processo.
394 Referência do Criador de Conteúdo
Iniciar operador de processos
Horário de início
Especifica a hora na qual iniciar uma instância desvinculada do processo. O valor
padrão é a hora em que o operador é executado (System.Time). Essa opção estará
disponível apenas quando Desvinculado for selecionado como o modo de processo.
Combinada com a opção Data de início, Hora de início permite que um processo
programe a execução de outro processo.
Parâmetros de saída
32WorkflowName
Local (Código de inicialização do conjunto de dados do processo)
processMode (Vinculado, Desvinculado ou Embutido)
inheritLaneChangeFromParentProcess
Capítulo 13: Controle de processo 395
Capítulo 14: utilitários
Os operadores Utilitários podem ser usado para fins de utilitário nos processos.
Operador Aplicar Xpath
O operador Extração XML analisa e recupera dados de um documento XML. Esse
operador oferece suporte às seguintes funções:
■
Analisa um documento XML e recupera os dados especificados.
■
Armazena os resultados em conjuntos de dados do CA Process Automation que
podem ser acessados pelos operadores subsequentes em um processo.
Capítulo 14: utilitários 397
Operador Aplicar Xpath
Parâmetros de entrada
Origem da entrada
Selecione a origem da solicitação de entrada do serviço de SOAP: Expressão ou
Nome do arquivo de entrada.
Expressão
Especifique a expressão para carregar conteúdo XML. Por exemplo:
Process.xmlContent
ou
Conjuntos de dados [] .xmlContent xmlData
Arquivo de entrada XML
Especifica o documento XML para extrair os dados. Insira uma expressão que
retorna o caminho do arquivo XML a um documento XML válido.
Retirar espaço para nome na estrutura XML
O CA Process Automation fornece uma opção para retirar espaços para nome XML
de uma resposta, para que um usuário possa fornecer expressões XPath mais
simples para procurar um valor do elemento específico. Essa opção está disponível
em todos os operadores SOAP.
As seguintes funções JavaScript são fornecidas:
■
applyXPath(xmldata,xpath_query,namespaceAware)
■
applyXPathToUrl(urls,xpath_query,namespaceAware)
Observação: o valor padrão de namespaceAware é true. O valor de
namespaceAware é false se você deseja retirar o espaço de nome na estrutura XML
(e true nas outras situações).
Process.x="<getMatchingEventsResponse
xmlns='http://www.ca.com/itpam'><events> <event
><eventName>test</eventName></event></events></getMatchingEventsResponse>";
Process.s=applyXPath(Process.x,"//eventName",true);
Process.aa1=applyXPathToUrl("file:C:/test.xml","//message",true);
Process.aa2=applyXPathToUrl("file:C:/test.xml","//message",false);
Process.s1=applyXPath(Process.x,"//eventName",false);
Process.s2=applyXPath(Process.x,"//eventName");
Dados adicionais extraídos
Especifica expressões do XPath para extrair dados do documento XML. Para cada
expressão especificada aqui, especifique uma variável de conjunto de dados na qual
armazenar os dados extraídos e um tipo de dados.
Use a opção Adicionar, editar e excluir botões para adicionar, editar ou excluir
expressões na caixa de listagem. Os botões Adicionar e editar, abra a caixa de
diálogo Lista de parâmetros.
398 Referência do Criador de Conteúdo
Aplicar o operador XSLT
Especifique os valores para os seguintes campos:
Expressão do XPath
Especifica a expressão XPath selecionada sob os dados extraídos.
Variável do conjunto de dados
Especifica o nome de uma variável do conjunto de dados do operador na qual
salvar os valores extraídos com base na expressão do XPath selecionada.
Tipo
Especifica o tipo de elemento a ser extraído da resposta. Selecione um dos
seguintes tipos com suporte no momento:
■
Número inteiro
■
Matriz de número inteiro
■
Sequência de caracteres
■
Matriz de sequência de caracteres
■
Fragmento XML
■
Matriz de fragmento XML
Parâmetros de saída
inputSource
ExtractedVarInfo (mapa de valores)
xPathQuery
dataSetVa
tipo
expressionVal
xmlInputFileName
isStripXMLNamespaces
Aplicar o operador XSLT
O XSLT aplica uma folha de estilo predefinida para transformar um documento XML de
origem em outro formato voltado para a apresentação, como HTML, XHTML ou SVG.
Capítulo 14: utilitários 399
Aplicar o operador XSLT
Parâmetros de entrada
Inserir a origem do XML
Define o documento XML de origem a ser transformado em um dos seguintes
formatos:
Expressão
Define um padrão para identificar uma sequência de caracteres de valores. Por
exemplo, você pode definir a expressão Datasets*“/VER2_Dataset”+.srcXML
Caminho do arquivo XML
Define o caminho de um arquivo em que um operador é executado. O caminho
do arquivo pode ser um local compartilhado ou um URL.
Considere os seguintes exemplos:
■
Caminho do arquivo: C:\\XSLTV2\\books.xml
■
Local compartilhado: \\\\user-xp1\\user\\XSLTV2\\books.xml
■
URL: http://<serverName>:CA Portal/c2orepository/XSLTV2/books.xml
XML embutido
Especifica os dados XML que atuam como uma entrada.
Inserir a origem do XSLT
Especifica as informações do XSLT de origem em um dos seguintes formatos:
Expressão
Define um padrão para identificar uma sequência de caracteres de valores. Por
exemplo, você pode definir a expressão Datasets*“/VER2_Dataset”+.srcXML
Caminho do arquivo XSL
Define o caminho de um arquivo em que um operador é executado. O caminho
do arquivo pode ser um local compartilhado ou um URL.
Considere os seguintes exemplos:
■
Caminho do arquivo: C:\\XSLTV2\\books.xsl
■
Local compartilhado: \\\\user-xp1\\user\\XSLTV2\\books.xsl
■
URL: http://<serverName>:CA Portal/c2orepository/XSLTV2/books.xsl
XSL embutido
Especifica os dados XSL que atuam como uma entrada.
Versão do XSLT
Especifica uma das opções a seguir para determinar a versão do XSLT utilizada para
transformar o XML de origem:
■
Versão 1
400 Referência do Criador de Conteúdo
Aplicar o operador XSLT
■
Versão 2
■
Especificado no XSLT
Parâmetros de entrada
Especifica os parâmetros de entrada como pares de valor-chave no operador XSLT.
Você pode atribuir valores para os parâmetros de entrada (key) definidos no XSL de
maneira dinâmica.
Você pode definir uma chave (top-author) no XSL e atribuir um valor (Robert Kisosk)
a partir de um operador XSLT, conforme mostrado no exemplo a seguir:
<xsl:param name="top-author">Jasper Forde</xsl:param>
Key: top-author Value=”Robert Kisosk”
Parâmetros de saída
Exibe os parâmetros de saída predefinidos como pares de valor-chave. Os parâmetros
de saída são específicos da versão XSLT e se baseiam nos padrões de XSLT. Para obter
mais informações sobre os parâmetros de saída, consulte
http://www.w3.org/TR/xslt#output.
Saída XML
É possível exibir a saída de XML na variável do conjunto de dados ou em um arquivo
colocado no caminho do arquivo de saída.
Você pode atribuir um valor (yes) para a chave (include-content-type) a partir de
um operador XSLT, conforme exibido no exemplo a seguir:
include-content-type=”yes”
Capítulo 14: utilitários 401
Operador Atraso
Operador Atraso
O operador Atraso atrasa o processamento de ramificações subsequentes de um
processo até um intervalo específico de dias, horas, minutos e segundos ter se passado.
O atraso pode ser relativo a quando o processamento é iniciado para o operador Atraso
ou para o processo.
Parâmetros de entrada
Dias
Especifica o número de dias para atrasar o processamento das ramificações
subsequentes do processo.
Horas
Especifica as horas adicionais para atrasar o processamento das ramificações
subsequentes do processo.
Para especificar a parte de um dia em horas, digite 0 a 23.
Observação: o número de horas é uma expressão e, portanto, não há validações.
Minutos
Especifica as minutos adicionais para atrasar o processamento das ramificações
subsequentes do processo.
Para especificar a parte de uma hora em minutos, digite 0 a 59.
Observação: o número de minutos é uma expressão e, portanto, não há validações.
402 Referência do Criador de Conteúdo
Operador Atraso
Segundos
Especifica os segundos adicionais para atrasar o processamento das ramificações
subsequentes do processo.
Para especificar a parte de um minuto em segundos, digite 0 a 59.
Observação: o número de segundos é uma expressão e, portanto, não há
validações.
Relativo à hora de início do processo
Torna o atraso relativo ao início do processo.
Quando essa caixa de seleção é desmarcada, o atraso ocorre depois que o processo
começa a processar o operador. Por exemplo, essa opção poderá ser usada para
disparar um alarme se o processo não terminar (atingir um operador Parar) dentro
de um período especificado.
Parâmetros de saída
flowchart_start_time
Dias
Horas
Minutos
Segundos
Relative_to_Flowchart
TargetTime
targetDate
Capítulo 14: utilitários 403
Operador Chamar o Java
Operador Chamar o Java
O operador Chamar o Java aproveita a funcionalidade contida em arquivos JAR externos
(ou arquivos .class) no CA Process Automation. Para identificar os arquivos JAR ou
arquivos .class, especifique sua localização nos parâmetros de entrada do operador.
Depois que o arquivo JAR é localizado, você pode escrever código Java que faça
referência a classes no arquivo JAR. É possível passar variáveis para esse código usando
os parâmetros de entrada do operador Chamar o Java. O código que você escreve fica
no método principal do operador.
Você pode especificar se deseja salvar um objeto Java no conjunto de dados do
operador após a execução do código do operador. O objeto Java é salvo no CA Process
Automation sob o tipo de dados: JavaObject. Você pode tornar esse tipo de dados
JavaObject disponível para os operadores Chamar o Java subsequentes.
Por exemplo, digamos que você deseje usar o operador Chamar o Java em um processo.
Você o inclui em um processo na guia Criador e dá a ele o nome de Operador 1. Depois
que o operador é executado, o objeto Java é salvo no conjunto de dados do operador e
é exibido como um tipo de dados JavaObject. Agora você tem outro operador Chamar o
Java mais adiante no processo. Você pode usar esse mesmo JavaObject do operador
Java 1 no novo operador Java 2. Você passa o objeto salvo do operador Java 1 para o
operador Java 2 como um tipo de dados JavaObject.
O operador Chamar o Java não pode ser executado em um orquestrador. Esse operador
é executado apenas em um agente.
Parâmetros de entrada
Os parâmetros de entrada para o operador Chamar o Java são os seguintes.
Código
List External Jar Paths?
Marque para fornecer uma lista de caminhos para os JARS externos necessários no
campo Caminhos de Jar externo como expressões.
Desmarque para fornecer os caminhos para os JARs externos necessários como
expressão, ou seja, como uma variável de conjunto de dados no campo External Jar
Paths as Expression.
Essa caixa de seleção está selecionada por padrão.
404 Referência do Criador de Conteúdo
Operador Chamar o Java
External Jar Paths
Especifica a lista de caminhos para os JARs externos necessários para o código do
método principal do operador, se houver algum.
O operador Chamar o Java carrega os JARs listados nesse campo. Qualquer JAR
inserido nessa lista está disponível para o código Java executado pelo operador. As
classes definidas nos JARs no nível de operador substituem as mesmas classes
especificadas nos JARs no nível de categoria de operador.
Para cada caminho, você pode:
■
Digitar o caminho completo de um arquivo JAR que reside no host em que o
agente do CA Process Automation (mapeado para o touchpoint) está sendo
executado. O caminho completo é especificado como a seguir:
–
Começa com: /
–
Começa com: \\
–
Do formulário: ^.:.* (uma expressão regular que se inicia com um caractere
seguido por dois-pontos - : - e, em seguida, o restante da sequência de
caracteres).
■
Digite o caminho para um arquivo JAR que pode ser baixado via HTTP. Verifique
se o caminho HTTP não exige autenticação e não é realizado por meio de um
proxy HTTP. O caminho para o JAR deve se iniciar com http:// ou https://.
■
Qualquer outro caminho é presumido como um caminho relativo para um
arquivo JAR que foi carregado nos recursos de usuário do CA Process
Automation. O CA Process Automation acrescenta o caminho do arquivo JAR ao
caminho do diretório Recursos de usuário do CA Process Automation do agente
(que é mapeado para o touchpoint) que está executando o operador.
Não inicie o caminho relativo do arquivo JAR com:
–
/
–
\\
Caso contrário, o CA Process Automation presumirá que o caminho do arquivo
JAR é um caminho completo.
Recursos no CA Process Automation, incluindo recursos do usuário, são espelhados no
intervalo de espelhamento do agente. Verifique se os JARs carregados nos recursos do
usuário já estão espelhados antes de usá-los no operador Chamar o Java.
Capítulo 14: utilitários 405
Operador Chamar o Java
Arquivos de classe
Além dos JARS externos, você pode carregar arquivos .class da seguinte forma:
■
Para os arquivos .class em um pacote sem nome, digite um caminho que
termine com o diretório que contém os arquivos .class.
Por exemplo, se MyAccount.java não pertencer a um pacote e
MyAccount.class estiver localizado em:
C:\java\tests\MyAccount.class
...defina o operador para usar o seguinte caminho:
C:\\java\\tests
■
Para arquivos .class em um pacote nomeado, digite um caminho que
termine com o diretório que contém o pacote root. Esse pacote também é
conhecido como o primeiro pacote no nome completo do pacote.
Por exemplo, se MyAccount.java pertencer ao pacote com.ca.tech e
MyAccount .class estiver localizado em:
C:\java\othertests\com\ca\tech\MyAccount.class
...defina o operador para usar o seguinte caminho:
C:\\java\\othertests
Se você especificar o caminho para um diretório (para carregar arquivos .class),
digite-o como um caminho completo. Você também pode digitá-lo como um
caminho relativo aos Recursos do usuário do CA Process Automation. Não
digite o caminho como um caminho HTTP.
Especifique o caminho para um diretório para carregar arquivos .class, não
arquivos JAR. Diferentemente dos arquivos .class, cada arquivo JAR requer um
caminho separado que termine com o arquivo JAR (e não o diretório onde ele
reside).
External Jar Paths as Expression
Especifica a variável do conjunto de dados de sequência de caracteres indexada que
contém a lista de caminhos para os JARs externos necessários para o código do
método principal do operador, se houver algum.
Enter Required Main Method?
Marque para fornecer o código Java no campo Required Main Method.
Desmarque para fornecer o código Java como uma variável do conjunto de dados
no campo Required Main Method as Expression.
Essa caixa de seleção está selecionada por padrão.
406 Referência do Criador de Conteúdo
Operador Chamar o Java
Required Main Method
Especifica o texto do código Java do método principal. Você pode procurar para
localizar um arquivo que contenha esse código. O método principal consiste em
expressões e instruções Java normais. Você deve inicializar e usar objetos definidos
no Java SDK ou nos JARs externos.
Observação: o CA Process Automation analisará o código e verificará sua validação
estrutural quando você clicar em OK. Será exibida uma mensagem de erro se for
encontrado um erro na estrutura do código.
Consulte Código Java no operador Chamar o Java (na página 409).
Required Main Method as Expression
Especifica a variável do conjunto de dados que contém o conteúdo do método
principal. O método principal consiste em expressões e instruções Java normais.
Você deve inicializar e usar objetos definidos no Java SDK ou nos JARs externos.
Nenhuma validação estrutural é executada.
Consulte Código Java no operador Chamar o Java (na página 409).
Definir o carregador de classes de contexto?
Defina esse campo (como algo diferente do padrão) se o seu método principal/JARs
externos dependerem do carregador de classes de contexto Java para carregar as
classes. Defina o carregador de classe de contexto Java como o carregador de classe
do operador ou o carregador de classe do módulo para evitar uma
ClassCastException.
O operador Chamar o Java usa uma cadeia de carregadores de classe para carregar
classes ao executar o código Java. Essa cadeia foi criada como a seguir (entre outros
carregadores de classes):
1.
Carregador de classe do operador: carregador de classe que carrega as classes
fornecidas no nível do operador
2.
Carregador de classe do módulo: carregador de classe que carrega as classes
fornecidas no nível do módulo
3.
Carregador de classe de contexto
4.
Class.ForName java comum
O operador consulta cada carregador de classe antes de passar para o próximo (se a
classe que não foi localizada).
Essa cadeia funcionará desde que o código que você executa não use
explicitamente seu próprio carregador de classe para carregar uma classe. Nesse
caso, consulte nos logs uma ClassCastException '.
Capítulo 14: utilitários 407
Operador Chamar o Java
Exemplo:
Considere se a classe MyChildXMLParser estende a classe MyParentXMLParser. O
fragmento de código listado a seguir cria um MyParentXMLParser usando uma
fábrica Java. Essa fábrica realmente carrega e cria um MyChildXMLParser, que é
convertido em um objeto MyParentXMLParser:
public MyParentXMLParser() {
super((MyParentXMLParser)ObjectFactory.createObject("co
m.ca.parser.MyChildXMLParser"));
....
}
Neste exemplo, considere:
■
O método ObjectFactory.createObject () realmente chama seu próprio
carregador de classe para carregar a classe MyChildXMLParser. Esse
comportamento é normal de fábricas Java, onde eles usam o carregador de
classes do sistema, ou (se ele existir) um carregador de classe de contexto para
carregar a classe (em vez de usar o carregador de classe que é usado pelo
programa em execução).
■
A classe MyParentXMLParser é carregada pelo carregador de classe do
operador Chamar o Java (como selecionado usando a cadeia anterior).
■
O elenco: ((MyParentXMLParser)ObjectFactory.createObject) lança uma
ClassCastException. Embora MyChildXMLParser estenda MyParentXMLParser,
as duas classes foram carregadas por diferentes carregadores de classes. Como
resultado, eles são completamente diferentes uns dos outros.
Para resolver esse problema, defina o campo 'Definir carregador de classe de
contexto' como:
■
"1: Carregador de classe de operador: se o jar que contém as classes
'MyChildXMLParser' e 'MyParentXMLParser' for fornecido nas propriedades do
operador.
■
"2: Carregador de classe de módulo: se o jar que contém as classes
'MyChildXMLParser' e 'MyParentXMLParser' for fornecido nas propriedades do
módulo.
Observação: "0: Padrão" é usado em todos os outros casos em que o código Java
não carrega explicitamente classes usando seu próprio carregador de classe. Esse
valor é o valor padrão desse campo.
Ao definir o carregador de classe de contexto como o carregador de classe do
operador Chamar o Java, as fábricas Java que são chamadas pelo código do usuário
são forçadas a usar o carregador de classe do operador Chamar o Java. Essa ação
remove a ClassCastException.
408 Referência do Criador de Conteúdo
Operador Chamar o Java
Código Java no operador Chamar o Java
Ao usar o operador Chamar o Java, use as seguintes diretrizes para implementar o
código Java:
■
O CA Process Automation executa o código Java em um intérprete BeanShell. Use
esse operador com a sintaxe de código Java ou a sintaxe de scripts BeanShell sem
usar comandos BeanShell, nos seguintes casos:
–
Comandos BeanShell não funcionam corretamente no modo Java estrito
(definido no nível do módulo).
–
Comandos BeanShell que modificam o caminho da classe não são
recomendados. Eles podem afetar a maneira como o CA Process Automation
salva as instâncias de objetos Java do código Java em execução para o conjunto
de dados do operador.
–
Comandos BeanShell que modificam o caminho da classe podem afetar a
maneira como o CA Process Automation carrega as instâncias de objetos Java
de um conjunto de dados do CA Process Automation no código.
Para obter mais informações sobre a sintaxe e os comandos BeanShell, consulte o
seguinte site: http://www.beanshell.org/
■
Você pode usar os modificadores de variáveis Java padrão em variáveis digitadas:
–
privado/protegido/público
–
transitório
–
volátil
–
estático
–
final
O intérprete de BeanShell implementa somente final (e ignora os outros).
■
Você pode usar os modificadores Java padrão em métodos:
–
privado/protegido/público
–
final
–
nativo
–
abstrato
–
estático
–
sincronizado
Somente sincronizado é implementado atualmente. O intérprete de BeanShell
ignora os outros.
Capítulo 14: utilitários 409
Operador Chamar o Java
■
Preencha todas as definições de classe nos JARs externos e use-as no código do
método principal do operador.
■
O java rt.jar, que contém todas as principais bibliotecas java, é automaticamente
colocado no caminho de classe do operador em tempo de execução.
■
Os arquivos JAR usados pelo CA Process Automation estão no caminho de classe do
operador em tempo de execução. O código poderá funcionar, mesmo sem listar
todos os JARS necessários no operador/categoria se você empregar classes já
usadas pelo CA Process Automation.
■
Os principais pacotes Java comuns e algumas extensões são automaticamente
importados para o código Java em tempo de execução. Você não precisa
importá-los para o código. Os pacotes são:
–
javax.swing.event
–
javax.swing
–
java.awt.event
–
java.awt
–
java.net
–
java.util
–
java.io
–
java.lang
–
bsh.EvalError
–
bsh.Interpreter
410 Referência do Criador de Conteúdo
Operador Chamar o Java
■
O código Java pode consistir em expressões e instruções Java normais. Você
também pode definir seus próprios métodos e usá-los no código. Um exemplo é
mostrado a seguir:
// Importe as classes que deseja usar
import ca.tech.pam.MyAccount;
// Observação: não é preciso importar StringBuffer e Date, pois eles fazem parte dos
// pacotes importados automaticamente
// import java.lang.StringBuffer;
// import java.util.Date;
// Observação: o jar que contém a classe ca.tech.pam.MyAccount
// deve estar na lista de Jars externos do operador ou do módulo;
// mas java lang e java util estão em rt.jar, que é automaticamente colocado no caminho de classe
MyAccount acct = new MyAccount(newDate(),100);
// Use os métodos públicos do objeto MyAccount
acct.addFunds(34);
acct.subFunds(10);
// Defina seu próprio método
String getStatement(MyAccount acc) {
StringBuffer strBuff = new StringBuffer("Saldo da conta: " + acc.getBalance());
Date dt = new Date(System.currentTimeMillis());
strBuff.append(" na data: " + dt);
return strBuff.toString();
}
// Use o método que você definiu
// também imprima a instrução usando o objeto 'logger' que você
// configurou na página 'Logger' do operador
logger.info(getStatement(acct));
Observação: para executar essa instrução, defina o agente de log como true e
forneça o nome do arquivo de log. Caso contrário, ocorrerá um erro durante a
execução.
Ao final da execução, a mensagem de log contém:
Account Balance: 124.
na data: Qua Jul 13 12:53:37 EDT 2011
(A mensagem inclui a data e a hora de execução corretas.)
Capítulo 14: utilitários 411
Operador Chamar o Java
Entrada/saída
Parâmetros
Os parâmetros do CA Process Automation a serem passados para o método
principal. Fornece os parâmetros na ordem em que devem ser passados para o
método principal. Deixe esse campo em branco se não houver nenhum parâmetro
necessário.
Somente tipos de parâmetro simples do CA Process Automation podem ser
passados para o método principal, como é indicado a seguir:
■
PAM Booleano é transmitido como um objeto booleano.
■
PAM Data é transmitido como um objeto de data.
■
PAM Duplo é passado como um objeto duplo.
■
PAM Inteiro é passado como um objeto de número inteiro.
■
PAM Longo é passado como um objeto longo.
■
PAM Sequência de caracteres é passado como um objeto de sequência de
caracteres.
■
PAM Referência de objeto é passada como um objeto de sequência de
caracteres.
■
PAM JavaObject é desserializado e carregado em uma instância de objeto Java
do tipo de classe original e, em seguida, enviado ao código Java.
Observação: o operador (ou o módulo) deve conter o caminho do arquivo JAR que
contém a definição de classe deste objeto. Caso contrário, o operador falhará com
o motivo:
Erro de Classe não encontrada ao desserializar objeto. Verifique se a classe jar está
na lista de jars do operador ou do módulo.
Tipos de parâmetro complexos do CA Process Automation (tipos indexados, mapas
de valores, etc.) não podem ser passados para o código Java.
O método principal pode acessar os parâmetros passados por meio da matriz de
argumentos de objetos:
■
args[0] corresponde ao primeiro parâmetro na lista.
■
args[1] corresponde ao segundo parâmetro da lista e assim por diante
Nomes de variável de saída
Os nomes das variáveis que são salvas no conjunto de dados do operador ao final
da execução do método principal. Essas variáveis devem ser definidas no escopo do
método principal. Deixe esse campo em branco se não houver nenhuma variável de
saída a ser salva no conjunto de dados do operador.
As variáveis de saída são salvas da seguinte forma:
■
Objeto booleano é salvo como PAM Booleano
■
Objeto de data é salvo como PAM Data
412 Referência do Criador de Conteúdo
Operador Chamar o Java
■
Objeto inteiro é salvo como PAM Inteiro
■
Objeto de número é salvo como PAM Longo ou Objeto duplo
■
Objeto de sequência de caracteres é salvo como PAM sequência de caracteres
■
Objeto de caractere é salvo como PAM sequência de caracteres
■
Uma matriz de qualquer um desses objetos listados é salva como um tipo
indexado do CA Process Automation. O tipo do primeiro objeto na matriz de
objetos define o tipo do CA Process Automation.
■
Indefinido é salvo como sequência de caracteres do CA Process Automation
com 'indefinido’ como valor.
■
Qualquer outro objeto Java não listado aqui é serializado e salvo como um CA
Process Automation JavaObject.
Observação: o objeto Java deve ser serializável (implementa
java.io.Serializable) para ser salvo como um JavaObject do CA Process
Automation. Caso contrário, o operador falhará com o motivo:
Erro ao serializar o objeto da classe: x. O objeto não pode ser serializado.
Em que x é o nome da classe do objeto.
Agente de log
Usar Agente de log?
Defina esse campo como verdadeiro para usar uma instância de um objeto
org.apache.log4j.Logger para registrar dados no arquivo de log especificado. O
agente de log manipula a abertura e o fechamento do arquivo. O agente de log está
disponível no contexto do método principal e pode ser usado como
'logger.debug()', 'logger.info()', etc.
Verdadeiro
Solicita que o operador use verdadeiro. O operador usa uma instância de
‘logger’.
Falso
Solicita que o operador use falso. O operador não usa uma instância de
‘logger’.
Em branco
Solicita que o operador use o valor definido no campo Usar o agente de log
padrão da categoria de operador. Se esse valor estiver em branco no nível de
categoria de operador, Usar agente de log? será definido como falso por
padrão.
Qualquer outro valor solicita que o operador use falso, e o operador não usa uma
instância de ‘logger’.
Capítulo 14: utilitários 413
Operador Chamar o Java
Se uma instância de ‘logger’ for usada, ela estará disponível no contexto do método
principal do operador. 'logger' é usado da maneira indicada a seguir:
■
logger.debug("my log message")
■
logger.info("my log message")
■
logger.warn("my log message")
■
logger.error("my log message")
■
logger.fatal("my log message")
Se não for usada uma instância de ‘logger’, o objeto 'logger' não existirá no
contexto do método principal do operador.
Caminho do arquivo de log
O caminho para o arquivo de log usado pelo agente de log. Esse caminho deve
apontar para um arquivo que reside no host do agente do CA Process Automation.
Se esse campo estiver em branco, o operador herdará o valor definido no campo
Caminho do arquivo de log padrão da categoria de operador.
Nível do log
Especifique o nível de log do agente de log.
0
Solicita que o operador use DEBUG, o que faz com que o agente de log grave
mensagens de log de Depuração, Informações, Aviso, Erro e Fatal.
1
Solicita que o operador use INFO, o que faz com que o agente de log grave
mensagens de log de Informações, Aviso, Erro e Fatal.
2
Solicita que o operador use WARN, o que faz com que o agente de log grave
mensagens de log de Aviso, Erro e Fatal.
3
Solicita que o operador use ERROR, o que faz com que o agente de log grave
mensagens de log de Erro e Fatal.
4
Solicita que o operador use FATAL, o que faz com que o agente de log grave
mensagens de log de Fatal.
414 Referência do Criador de Conteúdo
Operador Chamar o Java
Em branco
Solicita que o operador herde o valor definido no Nível do log padrão da
categoria de operador. Se esse valor estiver em branco no nível de categoria de
operador, o Nível do log será definido como Depuração, por padrão.
Qualquer outro valor de número inteiro
Solicita que o operador use DEBUG.
Observação: é possível substituir o nível de log em tempo de execução no método
principal do operador. Este exemplo define o nível de log como Fatal:
import org.apache.log4j.Level;
logger.setLevel((Level) Level.FATAL);
Acrescentar ao arquivo de log?
Defina esse campo como verdadeiro para acrescentar quaisquer dados desse
operador ao arquivo de log (se existir).
Verdadeiro
Solicita que o operador use verdadeiro. O operador é acrescentado ao arquivo
de log.
Falso
Solicita que o operador use falso. O operador exclui o conteúdo do arquivo de
log existente antes de gravar os novos dados do operador.
Em branco
Solicita que o operador use o valor definido no campo Acrescentar ao arquivo
de log padrão? da categoria de operador. O operador pode acrescentar ao
arquivo de log dependendo de como o valor estiver definido. Se esse valor
também estiver em branco no nível de categoria de operador, Acrescentar ao
arquivo de log? será definido como falso por padrão.
Qualquer outro valor solicita que o operador use falso, e o operador não acrescenta
ao arquivo de log.
Capítulo 14: utilitários 415
Operador Chamar o Java
Dados de log sem informações de registro?
Defina como verdadeiro para permitir que o agente de log grave os dados sem
informações de logon adicionais. Somente a mensagem de log é gravada.
Defina como falso para gravar informações de log adicionais no seguinte formato:
Dia Mês Ano Horas:Minutos:Segundos Log_level [UUID do operador Invoke_Java que
registrou esta mensagem]: mensagem de log
Verdadeiro
Solicita que o operador use verdadeiro. O agente de log grava dados sem
informações de log adicionais.
Falso
Solicita que o operador use falso. O agente de log grava dados com
informações de log adicionais.
Em branco
Solicita que o operador use o valor definido no campo Dados de log padrão
sem informações de registro? da categoria de operador. Se esse valor estiver
em branco no nível de categoria de operador, Dados de log sem informações
de registro? será definido como falso por padrão.
Qualquer outro valor solicitará que o operador use falso. O agente de log grava
dados com informações de log adicionais.
Parâmetros de saída
ErrorLineNumber
Se ocorrer um erro devido à execução do método principal, essa variável conterá o
número da linha de código que causou um erro (se disponível). Esse campo ficará
em branco se não ocorrerem erros devido à execução de código Java.
ErrorMessage
Se ocorrer um erro devido à execução do método principal, essa variável conterá a
mensagem de erro. Esse campo ficará em branco se não ocorrerem erros devido à
execução do método principal.
ErrorRoot
Se ocorrer um erro devido à execução do método principal, essa variável conterá a
linha de código que causou o erro (se disponível). Esse campo ficará em branco se
não ocorrerem erros devido à execução do método principal.
ErrorException
Se a execução do método principal acionar uma exceção, essa variável conterá a
exceção acionada. Esse campo ficará em branco se não ocorrerem erros devido à
execução do método principal.
416 Referência do Criador de Conteúdo
Operador Chamar o Java
Resultado
1
O operador é concluído com êxito.
-1
O operador falha.
Motivo
concluído
O operador é concluído com êxito.
Mensagem de erro
O operador falha. Se ocorrer um erro devido à execução do método principal,
essa variável conterá ErrorMessage, ErrorLineNumber, ErrorRoot e
ErrorException (quando aplicável).
ResponseMessage
ResponseCode
externalOpJarsType
externalOpJars
externalOpJarsExpression
inlineScriptType
inLineScript
scriptExpression
Parâmetros
outputVariables
useLogger
logFile
logLevel
appendToLogFile
useSimpleLoggerLayout
Capítulo 14: utilitários 417
Operador Chamar o Java
Exemplo de Java
O exemplo a seguir está localizado na seção Exemplos do campo Required Main
Method.
/*
O método principal é usado para chamar métodos e objetos definidos no Java SDK ou em Jars externos.
O método principal consiste em expressões e instruções Java normais.
Também é possível:
- Definir seus próprios métodos e usá-los no método principal.
- Transmitir parâmetros de entrada para o método principal.
- Salvar as variáveis de saída no conjunto de dados do operador ao final da execução do método principal.
- Usar um objeto do agente de log no método principal.
Em geral, você pode preencher todas as definições de classe nos Jars externos, listá-las em External
Jar Paths do operador e, em seguida, inicializar e usar esses objetos no método principal.
*/
/*
Veja, a seguir, um exemplo de como inicializar e usar um objeto MyAccount, que é definido em um arquivo
Jar externo.
Configuração do operador:
1. Especifique o caminho:
“Invoke_Java_Op_Example_Jars/MyAccount.jar” na lista de External Jar Paths do operador. MyAccount.jar
contém a classe ca.tech.pam.MyAccount, a qual é usada no código a seguir. Durante a instalação do CA
Process Automation, MyAccount.jar é carregado como um recurso do usuário.
2. Especifique uma variável do conjunto de dados do tipo Data como o primeiro objeto na lista de
Parâmetros de entrada do operador.
Esse parâmetro pode ser acessado no método principal como args[0].
3. Especifique uma variável do conjunto de dados do tipo Número inteiro e o valor 100 como o segundo
objeto na lista de Parâmetros de entrada do operador.
Esse parâmetro pode ser acessado no método principal como args[1].
4. Especifique o nome da variável acct (sem aspas) como o primeiro objeto na lista de Nomes de variável
de saída do operador.
acct é criado no método principal como um objeto MyAccount; portanto, ao final da execução do
operador, acct será salvo no conjunto de dados do operador como uma variável do tipo JavaObject.
5. Configure o operador para usar um agente de log, defina Caminho do arquivo de log como um caminho
de arquivo local, Nível do log como Informações, Acrescentar ao arquivo de log como falso e Dados de
log sem informações de registro como verdadeiro.
*/
// Importe as classes que deseja usar
import ca.tech.pam.MyAccount;
// Observação: não é preciso importar StringBuffer e Date (usados a seguir), pois eles fazem parte
dos
// pacotes importados automaticamente (a lista completa desses pacotes é fornecida na documentação)
// import java.lang.StringBuffer;
// import java.util.Date;
418 Referência do Criador de Conteúdo
Operador Chamar o Java
// Inicialize o objeto MyAccount
// Observe que o construtor MyAccount é definido no jar externo como:
// public MyAccount(Date date, int balance)
MyAccount acct = new MyAccount(args[0], args[1]);
// Use os métodos públicos do objeto MyAccount
// Observe que addFunds é definido no jar externo como:
// public int addFunds (int amnt)
acct.addFunds(34);
// Observe que subFunds é definido no jar externo como:
// public int subFunds (int amnt)
acct.subFunds(10);
// Defina seu próprio método
String getStatement(MyAccount acc) {
StringBuffer strBuff = new StringBuffer("Account Balance: " + acc.getBalance());
Date dt = new Date(System.currentTimeMillis());
strBuff.append(" on date: " + dt);
return strBuff.toString();
}
// Use o método definido e imprima também a instrução usando o objeto 'logger'
// configurado na página 'Agente de log' do operador
logger.info(getStatement(acct));
// Ao final da execução do operador:
// acct será salvo no conjunto de dados do operador como uma variável do tipo JavaObject.
// O arquivo de log do agente de log conterá a mensagem:
//
Account Balance: 124 on date: Thu Aug 22 11:27:29 EDT 2013
//
(A mensagem inclui a data e a hora de execução corretas).
Recurso para executar um exemplo do operador Chamar o Java
O processo de instalação adiciona um recurso à pasta Recurso do usuário no Repositório
na paleta Gerenciar recursos de usuário, na guia Configuração. O arquivo JAR,
MyAccount.jar, está localizado na pasta Invoke_Java_Op_Example_jars. Você pode usar
o arquivo MyAccount.jar para executar o exemplo de Java fornecido no campo Required
Main Method do operador Chamar o Java.
Capítulo 14: utilitários 419
Operador Chamar o Java
Portas do operador
Êxito
O operador é concluído com êxito.
Falha
O operador falha devido a qualquer um dos seguintes motivos:
■
Você pode usar um comando BeanShell no código do operador quando o
operador é definido para ser executado em modo Java estrito. Um comando
BeanShell pode não ser suportado em modo Java estrito.
■
Você pode usar declarações de variáveis não digitadas no código do operador
quando o operador é definido para ser executado em modo Java estrito.
■
Erro devido à execução do código. Por exemplo: chamar o método incorreto
em um objeto Java.
■
O código do operador acionou uma exceção durante sua execução.
■
Não tente usar o agente de log no código do operador enquanto o operador
estiver definido para não usar o agente de log. O agente de log não está
definido no contexto do código do operador, e o operador não pode resolver
nenhum dos métodos do agente de log.
■
O agente de log está configurado para usar um arquivo somente leitura.
■
O agente de log está configurado para usar um arquivo de log que é, na
verdade, um diretório.
■
Você digitou um caminho incorreto nos arquivos JAR externos da categoria de
operador.
■
O objeto Java que o CA Process Automation tenta salvar no operador ao final
da execução não pode ser serializado. O operador falha com uma mensagem
de erro.
■
Você passa uma variável do conjunto de dados do tipo: JavaObject para o
operador. No entanto, você não especifica o arquivo JAR em que a definição de
classe do objeto Java reside. Um erro indica que o operador não conseguiu ler
o descritor de classe ao desserializar o objeto.
420 Referência do Criador de Conteúdo
Operador Chamar o Java
■
Você passa uma variável do conjunto de dados vazia do tipo: JavaObject (valor:
‘*JavaObject+’) para o operador. O operador falha com um erro que indica que
ele falhou ao desserializar o objeto Nulo.
■
A lista do JARS para o operador contém um arquivo JAR que não existe.
■
A lista do JARS para a categoria do operador contém um arquivo JAR que não
existe.
■
O operador Chamar o Java não pode ser executado em um orquestrador. Se a
entrada do campo Destino for resolvida para um orquestrador, o operador
falhará com as seguintes variáveis de saída:
■
–
ResponseMessage = O operador Chamar o Java não pode ser executado
em um orquestrador.
–
ResponseCode=SYSTEM_ERROR
Você não especificou o código Java no método principal do operador. O
método principal consiste em expressões e instruções Java normais. Você deve
inicializar e usar objetos definidos no Java SDK ou nos JARs externos.
O operador Chamar o Java geralmente é usado de uma forma em que você
especifica caminhos de jar externo no operador ou módulo. Você também deve
digitar o código Java no método principal do operador. Esse código usa os
objetos que você definiu nos arquivos jar externos.
Portas personalizadas
Disponível caso definido pelo usuário durante a criação do processo.
Capítulo 14: utilitários 421
Operador Executar o JavaScript
Operador Executar o JavaScript
O operador Cálculo executa cálculos e efetua atribuições de variáveis do conjunto de
dados. O operador executa as seguintes ações:
■
Interpreta instruções de JavaScript em seu código de origem.
■
Permite que os cálculos definam valores para as variáveis. Esses valores podem ser
usadas para configurações de parâmetros em operadores subsequentes no mesmo
processo ou em outros processos.
Parâmetros de entrada
SourceCode
Abre o editor de código.
Use o editor de código para especificar uma ou mais instruções de JavaScript. Cada
instrução termina com um ponto-e-vírgula (;). Por exemplo, as instruções a seguir
definem as variáveis de dia, mês e ano em um conjunto de dados nomeado:
Datasets["/exploit/variables/date"].day = "31";
Datasets["/exploit/variables/date"].month = "July";
Datasets["/exploit/variables/date"].year = "2013";
Observação: consulte o Guia do criador de conteúdo para obter mais informações sobre
como usar o editor de código do CA Process Automation.
Parâmetros de saída
SourceCode
422 Referência do Criador de Conteúdo
Capítulo 15: Web Services
Os operadores Serviços web oferecem suporte a chamadas para serviços remotos
usando SOAP ou XML. Esses operadores também recuperam respostas e salvam
informações da resposta para uso por outros operadores em um processo.
Ele também fornece recursos de gerenciamento de dados em uma rede usando
protocolos padrão e amplamente disponíveis, como HTTP. O suporte a serviços RESTful
também é fornecido por meio dos operadores HTTP.
Operadores HTTP: parâmetros de entrada comuns
Os parâmetros de entrada que se aplicam a todos os operadores HTTP encaixam-se em
categorias separadas, como é indicado a seguir:
■
Informações sobre o URL HTTP (na página 424)
■
Informações sobre o proxy HTTP (na página 428)
■
Informações de cabeçalhos HTTP (na página 432)
■
Informações sobre cookies HTTP (na página 433)
■
Informações sobre o conteúdo de resposta HTTP (na página 433)
■
Informações de configuração HTTP (na página 435)
As propriedades dos operadores HTTP exigem os seguintes parâmetros de entrada:
■
HTTP Delete - somente comum
■
HTTP Get - comum e Informações do HTTP Get (na página 447)
■
HTTP Head - comum e Informações do HTTP Head (na página 451)
■
HTTP Options - somente comum
■
HTTP Post - comum e Informações de HTTP Post (na página 460)
■
Formulário por HTTP Post - comum e Informações do formulário por HTTP Post (na
página 466)
■
HTTP Put - comum e Informações do HTTP Put (na página 474)
■
HTTP Trace - somente comum
Observação: a menos que especificado de outra forma, as entradas de campo
substituirão os valores de campo correspondentes herdados da configuração de nível de
categoria de operador.
Capítulo 15: Web Services 423
Operadores HTTP: parâmetros de entrada comuns
Informações sobre o URL HTTP
Informações sobre o URL HTTP inclui parâmetros de entrada que se aplicam aos
seguintes operadores:
■
HTTP Delete
■
Obter HTTP
■
HTTP Head
■
Opções HTTP
■
Registro em HTTP
■
Formulário por HTTP Post
■
Colocar HTTP
■
HTTP Trace
URL
Especifica o URL do logotipo do inquilino. O URL começa com http:// ou https://.
Certificado SSL válido?
Especifica se um certificado SSL válido é encontrado. Esse campo é relevante ao
consultar um URL HTTPS.
Valores
■
Verdadeiro - valida o certificado SSL e aciona a falha do operador se o
certificado for inválido.
■
Falso - aceita o certificado SSL, mesmo que ele seja inválido, e continua a fazer
a chamada HTTP.
■
Vazio - usa o valor definido para "Validar certificado SSL como padrão?" no
nível de categoria de operador.
424 Referência do Criador de Conteúdo
Operadores HTTP: parâmetros de entrada comuns
Tipo de autenticação
Selecione uma das seguintes opções.
Autenticação HTTP
Especifica se o servidor HTTP, no URL especificado, requer autenticação. Os
operadores HTTP oferecem suporte à autenticação HTTP básica, à autenticação
HTTP prévia ou à autenticação NTLM. Se um desses tipos de autenticação for
necessário, defina esse valor como verdadeiro.
Valores
■
Verdadeiro - especifica que o servidor HTTP exige autenticação.
■
Falso - especifica que o servidor HTTP não exige autenticação.
■
Em branco - especifica o uso do valor definido no nível de categoria de
operador.
■
Qualquer outro valor - igual a falso.
Padrão
Em branco - especifica o uso do valor definido no nível de categoria de
operador.
Observações
■
Se a autenticação HTTP for definida como falso no operador, Autenticação
NTLM, Nome de usuário, Senha e Nome do domínio serão desativados.
■
Se a autenticação HTTP não for definido como falso no operador
(verdadeiro, variável do conjunto de dados ou qualquer outro valor), as
seguintes opções serão ativadas:
- Autenticação NTLM
- Nome de usuário
- Senha
- Nome do domínio
Capítulo 15: Web Services 425
Operadores HTTP: parâmetros de entrada comuns
Autenticação HTTP prévia
Durante a interação com um serviço da web, um operador HTTP do CA Process
Automation normalmente age como um navegador da web, onde ele primeiro
negocia com o serviço da web sobre o esquema de autenticação a ser usado.
Essa negociação é feita antes de o operador emitir sua solicitação para o
serviço da web.
Em geral, para a autenticação HTTP básica, o serviço da web especifica durante
a negociação de autenticação com o operador do CA Process Automation que
ele requer a autenticação básica. Se configurado para autenticação HTTP, em
seguida, o operador do CA Process Automation concorda com o serviço da web
em usar a autenticação básica.
No entanto, alguns serviços da web não especificam durante a negociação que
eles exigem a autenticação básica. Em vez disso, eles supõem que o operador
enviará a autenticação básica previamente. Isso é normalmente feito para
reduzir a sobrecarga da conexão. Nesse caso, o operador HTTP do CA Process
Automation deve ser configurado para usar a autenticação HTTP prévia (em vez
de Autenticação HTTP), que solicita que o operador envie a autenticação HTTP
básica para o serviço da web sem negociação.
Autenticação NTLM
Especifica se o servidor HTTP no URL especificado requer autenticação do
NTLM. O CA Process Automation usará a autenticação HTTP básica se a
autenticação do NTLM não for selecionada.
Valores
■
Verdadeiro - especifica que o servidor HTTP exige autenticação do NTLM.
■
Falso - especifica que o servidor HTTP não exige autenticação do NTLM. O
servidor usa autenticação HTTP básica
■
Em branco - especifica o uso do valor definido no nível de categoria de
operador.
■
Qualquer outro valor - igual a falso.
Nome do usuário
Especifica o nome de usuário a ser usado ao autenticar em relação ao URL
especificado.
Senha
Especifica a senha para o nome do usuário especificado.
426 Referência do Criador de Conteúdo
Operadores HTTP: parâmetros de entrada comuns
Nome do domínio
Especifica o nome do domínio a ser usado ao autenticar em relação ao URL
especificado.
Use as seguintes diretrizes:
■
Digite o Nome do domínio (obrigatório) se o operador usar a autenticação
NTLM.
■
Deixe em branco se o Nome do domínio não for necessário para a
autenticação. Um nome de domínio poderá não ser necessário se o operador
usar a autenticação HTTP básica.
Observações sobre uso para Nome do domínio, Nome do usuário e Autenticação
NTLM
Um campo de nome de domínio em branco não solicita automaticamente que
o operador herde o valor de nome de domínio da categoria de operador. O
campo Nome do domínio está vinculado ao campo Nome de usuário, como é
indicado a seguir:
■
Se o Nome do domínio para o operador for especificado, o operador o
usará.
■
Se o Nome do domínio do operador estiver em branco e o nome de
usuário do operador for especificado (não estiver em branco), o operador
usará um nome de domínio em branco.
O operador usará o Nome do domínio padrão da categoria de operador se os
itens a seguir estiverem em branco (não especificados):
■
O Nome do domínio do operador.
■
O Nome de usuário do operador.
Um Nome do domínio especificado é usado da seguinte forma:
■
Se o operador usar a autenticação NTLM, o Nome do domínio será usado
da maneira como foi fornecido, sem ser acrescentado ao nome de usuário.
■
Se o operador usar a autenticação HTTP básica, o Nome do domínio será
acrescentado ao nome de usuário como: Nome de usuário = nome do
usuário@nome do domínio
Capítulo 15: Web Services 427
Operadores HTTP: parâmetros de entrada comuns
Informações sobre o proxy HTTP
A opção Informações sobre o proxy HTTP inclui parâmetros de entrada que se aplicam
aos seguintes operadores:
■
HTTP Delete
■
Obter HTTP
■
HTTP Head
■
Opções HTTP
■
Registro em HTTP
■
Formulário por HTTP Post
■
Colocar HTTP
■
HTTP Trace
Observação: a menos que o contrário seja especificado, as entradas de campo
substituirão os valores de campo correspondentes herdados da configuração de nível de
categoria de operador.
Usar proxy?
Especifica se as chamadas HTTP passam por um servidor proxy. Esse campo
substitui o campo de módulo. Se for deixado em branco, o operador usará o valor
padrão definido no nível do módulo.
Valores
Um dos seguintes:
■
Verdadeiro - indica que é preciso rotear chamadas HTTP por meio de um
servidor proxy.
■
Falso - indica que as chamadas HTTP não passam por um servidor proxy.
■
Em branco - especifica o uso do valor definido no nível do módulo.
■
Qualquer outro valor - igual a falso.
Observações:
■
Se esse campo for definido como falso, isso desativará os campos restantes em
Informações sobre o proxy HTTP.
■
Se esse campo não for definido como falso no operador (verdadeiro, variável
do conjunto de dados ou outro valor), isso ativará os campos restantes em
Informações sobre o proxy HTTP.
428 Referência do Criador de Conteúdo
Operadores HTTP: parâmetros de entrada comuns
Host do proxy
Especifica o URL (com http ou https) do servidor proxy ou o FQDN do servidor
proxy.
Observação: se o FQDN for inserido, o esquema HTTP será usado para contatar o
Servidor proxy, ou seja, http://<FQDN of proxy>:<port>.
Porta do proxy
Especifica a porta do Host do proxy especificado.
Valores
Um dos seguintes:
■
Em branco - herda o valor da Porta proxy padrão definido no nível do
módulo, se houver. Caso contrário, é usada a porta 80.
■
O número de porta especificado.
Autenticação proxy?
Especifica se o servidor proxy, no URL de proxy especificado, requer autenticação. A
autenticação proxy pode ser a autenticação HTTP básica ou a autenticação NTLM.
Se um desses tipos de autenticação for necessário, defina esse valor como
verdadeiro.
Valores
Um dos seguintes:
■
Verdadeiro - indica que o servidor proxy exige autenticação.
■
Falso - indica que o servidor proxy não exige autenticação.
■
Em branco - indica que é preciso usar o valor padrão definido no nível do
módulo.
■
Qualquer outro valor - igual a falso.
Capítulo 15: Web Services 429
Operadores HTTP: parâmetros de entrada comuns
Autenticação proxy do NTLM?
Indica se o Host do proxy especificado exige autenticação NTLM.
Valores
Um dos seguintes:
■
Verdadeiro - indica que o Host do proxy especificado exige autenticação
NTLM.
■
Falso - indica que o host do proxy especificado não exige autenticação
NTLM. O host do proxy usa a autenticação HTTP básica.
■
Em branco - especifica o uso do valor definido no nível do módulo.
■
Qualquer outro valor - igual a falso.
Observação
Se a Autenticação proxy for definida como falso no operador, os itens a seguir
serão desativados:
■
Autenticação proxy do NTLM
■
Nome de usuário proxy
■
Senha do proxy
■
Nome de domínio do proxy
Se a autenticação Proxy não for definida como falso no operador (verdadeiro,
variável do conjunto de dados ou qualquer outro valor), as seguintes opções
serão ativadas:
■
Autenticação proxy do NTLM
■
Nome de usuário proxy
■
Senha do proxy
■
Nome de domínio do proxy
Nome de usuário proxy
Especifica o nome de usuário a ser usado ao autenticar com o servidor proxy.
Senha do proxy
Especifica a senha associada ao Nome de usuário proxy especificado.
430 Referência do Criador de Conteúdo
Operadores HTTP: parâmetros de entrada comuns
Nome de domínio do proxy
Especifica o nome do domínio a ser usado ao autenticar em relação ao Servidor
proxy especificado.
Use as seguintes diretrizes:
■
Digite o nome de domínio do proxy (necessário), se o operador usar a
autenticação NTLM em relação ao Servidor proxy.
■
Deixe em branco se o Nome do domínio do proxy não for necessário para a
autenticação. Se o operador usar a autenticação HTTP básica em relação ao
Servidor proxy, um nome de domínio geralmente não será necessário.
Observações sobre uso para Nome de domínio do proxy, Nome de usuário proxy e
Autenticação proxy do NTLM
■
Um campo Nome de domínio do proxy em branco não solicita
automaticamente que o operador herde o valor de nome de domínio do proxy
do módulo.
■
O campo Nome de domínio do proxy do operador está vinculado ao campo
Nome de usuário proxy do operador, como é indicado a seguir:
■
–
Se o Nome de domínio do proxy do operador for especificado, o operador
usará esse nome.
–
Se o Nome de domínio do proxy estiver em branco e o Nome de usuário
proxy for especificado (não estiver em branco), o operador usará um
Nome de domínio do proxy em branco.
–
Se o Nome de domínio do proxy estiver em branco e o Nome de usuário
proxy não for especificado (estiver em branco), o operador usará o Nome
de domínio do proxy padrão herdado.
Um Nome de domínio do proxy especificado é usado da seguinte forma:
–
Se o operador usar a autenticação NTLM em relação ao servidor proxy, o
Nome de domínio do proxy especificado será usado conforme fornecido. O
Nome de domínio do proxy não é acrescentado ao Nome de usuário proxy.
–
Se o operador usar a autenticação HTTP básica em relação ao servidor
proxy, o Nome de domínio do proxy será acrescentado ao Nome de
usuário do proxy como:
Nome de usuário = nome de usuário@nome do domínio
Capítulo 15: Web Services 431
Operadores HTTP: parâmetros de entrada comuns
Informações de cabeçalhos HTTP
Usar mapa de valores indexados para os cabeçalhos HTTP?
Especifica se deve ser usado um mapa de valores indexados para cabeçalhos de
solicitação HTTP.
Valores:
■
Selecionado - indica que é preciso inserir cabeçalhos de solicitação HTTP
como um mapa de valores indexados no campo Mapa de valores
indexados para cabeçalhos HTTP.
■
Desmarcado - indica que é preciso inserir os cabeçalhos de solicitação
HTTP no campo Cabeçalhos HTTP.
Cabeçalhos HTTP
Especifica os nomes dos cabeçalhos HTTP na coluna Chave e os valores dos
cabeçalhos HTTP na coluna Valor. Os cabeçalhos devem estar no formato US-ASCII.
Use os botões abaixo para adicionar, remover ou reorganizar os cabeçalhos.
Observação: o operador ignorará qualquer cabeçalho que a chave esteja em
branco, ou seja, em que nenhum nome for especificado.
Mapa de valores indexados para cabeçalhos HTTP
Especifica o nome de um mapa de valores indexados que contém os nomes de
cabeçalho HTTP e os valores correspondentes. O mapa de valores indexados deve
estar no mesmo formato que o listado no campo Cabeçalhos HTTP. O mapa de
valores indexados deve ter os parâmetros de Chave e Valor.
Observação: o operador ignorará qualquer cabeçalho que a chave esteja em
branco, ou seja, em que nenhum nome for especificado.
432 Referência do Criador de Conteúdo
Operadores HTTP: parâmetros de entrada comuns
Informações sobre cookies HTTP
Mapa de valores indexados do armazenamento de cookies HTTP
Digite um mapa de valores indexados que contenha os cookies HTTP para definir
nesse operador.
Esse campo permite o gerenciamento de estado HTTP, permitindo que os usuários
passem HTTPCookiesStore de um operador para outro que esteja usando como
destino o mesmo domínio de cookie. O mapa de valores indexados deve estar no
mesmo formato que aqueles retornados na variável de saída HTTPCookiesStore de
outros operadores HTTP. Em geral, esse campo tem o seguinte formato:
PreviousHttpOperator.HTTPCookiesStore
Obtendo o HTTPCookiesStore de outro operador, esse operador pode enviar
qualquer cookie aplicável. Os cookies aplicáveis são aqueles definidos na solicitação
HTTP ou resposta HTTP do operador anterior. Esse operador envia somente os
cookies não expirados (de HTTPCookiesStore) cujos atributos são aplicáveis ao URL
desse operador. Exemplos de atributos são domain, path e isSecure.
Informações sobre o conteúdo de resposta HTTP
Salvar o conteúdo da resposta HTTP em um arquivo?
Especifica se é preciso salvar o corpo da mensagem de resposta HTTP em um
arquivo. Selecione esse campo para ativar os campos Caminho do arquivo de
conteúdo de resposta HTTP e Em caso de resposta em texto, salvar usando a
codificação.
Valores
■
Selecionado - salva o corpo da mensagem de resposta HTTP em um
arquivo.
■
Desmarcado - não salva o corpo da mensagem de resposta HTTP em um
arquivo.
Caminho do arquivo de conteúdo de resposta HTTP
Especifica onde salvar o corpo da mensagem de resposta HTTP. Digite o caminho do
arquivo local no host em que o touchpoint está em execução.
Capítulo 15: Web Services 433
Operadores HTTP: parâmetros de entrada comuns
Se o arquivo de resposta existir?
Especifica a ação a ser executada se o arquivo de resposta existir. As ações
disponíveis são criar um arquivo ou substituir o conteúdo do arquivo existente.
O caminho do arquivo está listado na variável de saída do operador
HTTPResponseContentFilePath.
Valores
Esse valor pode ser:
■
createFile - indica que é preciso criar um arquivo.
■
overwriteFile - indica que é preciso substituir o conteúdo do arquivo de
resposta pelo corpo da nova mensagem de resposta HTTP.
■
Em branco - igual a createFile.
■
Qualquer outro número inteiro - igual a createFile.
Em caso de resposta em texto, salvar usando a codificação
Especifique essa codificação se estiver esperando uma resposta em texto. O tipo de
conteúdo da resposta está no formato:
texto/XXXX
Essa codificação é usada para gravar a resposta no arquivo de resposta.
Se a resposta recebida não for do tipo texto/XXXX, o campo é ignorado.
Valores
Esse valor pode ser:
■
0: Especificado no cabeçalho da resposta HTTP - Digite 0 para usar a
codificação especificada no cabeçalho da resposta HTTP.
■
1: Codificação do sistema padrão do PAM - Digite 1 para usar a codificação
do sistema padrão do CA Process Automation.
■
2: Especificar uma codificação em 'Codificação de resposta de texto
especificado pelo usuário' - Insira 2 para especificar a codificação (a ser
usada) no campo Codificação de resposta de texto especificado pelo
usuário.
■
Em Branco - Solicita que operador use 0 (usar a codificação especificada no
Cabeçalho da resposta HTTP).
■
Qualquer outro inteiro - Solicita que operador use 0 (usar a codificação
especificada no Cabeçalho da resposta HTTP).
Se esse campo for definido como 0 ou 1, o campo Codificação de resposta de texto
especificado pelo usuário será desativado.
Codificação de resposta de texto especificado pelo usuário
Especifique a codificação que deverá ser usada para gravar a resposta de texto no
arquivo de resposta.
434 Referência do Criador de Conteúdo
Operadores HTTP: parâmetros de entrada comuns
Salvar o conteúdo da resposta HTTP em uma variável do conjunto de dados?
Especifica se é preciso salvar o corpo da mensagem de resposta HTTP na variável
HTTPResponseContent do conjunto de dados do operador. Se a opção de
salvamento for selecionada, o campo Limite de tamanho do campo do conjunto de
dados da resposta HTTP será ativado.
Valores
■
Selecionado - salva o corpo do conteúdo da resposta HTTP na variável
HTTPResponseContent do conjunto de dados do operador.
■
Desmarcado - não salva o conteúdo da resposta HTTP.
Limite de tamanho da variável do conjunto de dados da resposta HTTP (bytes)
Especifica o número máximo de bytes (do corpo da mensagem de resposta HTTP) a
serem salvos na variável do conjunto de dados HTTPResponseContent do operador.
Valor
Um valor numérico.
Padrão
4096 bytes (se deixado em branco)
Informações de configuração HTTP
Versão do HTTP
Especifica a versão do protocolo HTTP.
Valores:
Um dos seguintes:
■
1.0 - indica que o operador deve usar a versão do protocolo HTTP 1.0.
■
1.1 - indica que o operador deve usar a versão do protocolo HTTP 1.1
■
Em branco - indica que o operador deve usar o valor definido no nível da
categoria de operador, em que branco ou qualquer valor diferente de 1.1
ou 1.0 no nível de categoria solicita que o operador use 1.1.
■
Qualquer outro valor diferente de 1.0 ou 1.1 - usar o protocolo HTTP 1.1
Padrão:
Em branco
Capítulo 15: Web Services 435
Operadores HTTP: parâmetros de entrada comuns
Tempo limite de conexão (s)
Especifica o tempo de espera máximo para que uma conexão HTTP seja
estabelecida antes que o operador expire.
Valores:
Um dos seguintes:
■
Valor numérico indicando o tempo limite da conexão em segundos.
■
0 indica que não há tempo limite, ou seja, zero segundos.
■
Em branco indica o Tempo limite padrão de conexão definido no nível da
categoria de operador, se disponível; caso contrário, será 0 segundos.
Padrão:
Em branco.
Tempo limite do socket (s)
Especifica o tempo máximo para aguardar entre dois pacotes de dados de resposta
HTTP consecutivos.
Valores:
Um dos seguintes:
■
Valor numérico indicando o tempo limite de socket em segundos.
■
0 indica que não há tempo limite, ou seja, zero segundos.
■
Em branco - indica o Tempo limite padrão do socket definido no nível da
categoria de operador, se disponível; caso contrário, será 0 segundos.
Padrão:
Em branco.
Manipular redirecionamentos?
Indica se é preciso manipular redirecionamentos automaticamente.
Valores:
Um dos seguintes:
■
Verdadeiro - manipular redirecionamentos automaticamente.
■
Falso - não manipular redirecionamentos automaticamente.
■
Em branco - use o valor padrão de Redirecionamentos de manipulador
padrão? valor definido no nível da categoria de operador.
■
Qualquer outro valor - indica falso.
Padrão:
Em branco.
436 Referência do Criador de Conteúdo
Operadores HTTP: parâmetros de saída comuns
Número máximo de redirecionamentos
Especifica o número máximo de redirecionamentos a serem seguidos, quando
Manipular redirecionamentos? é definido como Verdadeiro.
Valores:
Um dos seguintes:
■
Valor numérico indicando o número máximo de redirecionamentos a
serem permitidos.
■
Em branco - o Número máximo de redirecionamentos padrão, caso
definido. Caso contrário, 100.
Padrão:
Em branco.
Operadores HTTP: parâmetros de saída comuns
Variáveis de saída não contêm dados quando o operador não recebe uma resposta HTTP
devido a um erro como os exemplos a seguir:
■
A entrada contém um URL desconhecido.
■
A conexão HTTP expira.
■
O socket expira.
HTTPRequestUrl
Especifica o URL da solicitação HTTP, incluindo quaisquer parâmetros de URL.
HTTPResponseStatusLine
Especifica a linha de status da resposta HTTP. A linha de status é a primeira linha da
mensagem de resposta HTTP. A linha de status consiste na versão de protocolo, no
código de status e na frase de motivo associada.
HTTPResponseStatusCode
Especifica o código de status da resposta HTTP. O operador falha ou tem êxito,
dependendo desse código de status.
■
O operador falhará se o código de status for maior ou igual a 300.
■
O operador terá êxito se o código de status for menor que 300.
HTTPResponseReasonPhrase
Especifica a frase de motivo da resposta HTTP.
HTTPResponseProtocolVersion
Especifica a versão de protocolo da resposta HTTP.
Capítulo 15: Web Services 437
Operadores HTTP: parâmetros de saída comuns
HTTPResponseContentType
Especifica o cabeçalho content-type do conteúdo da resposta HTTP.
HTTPResponseContentCharset
Especifica a codificação de caracteres do conteúdo da resposta HTTP. A codificação
de caracteres faz parte do cabeçalho content-type, sendo exibida no seguinte
formato:
“content-type= xxxxx; charset=xxxx”
Esse conjunto de caracteres só é definido com um content-type apenas com
caracteres, como text/xxx.
HTTPResponseContentLength
Especifica o número de bytes do conteúdo da resposta HTTP. Um número negativo
significa que o comprimento do conteúdo não é conhecido.
HTTPResponseContentEncoding
Especifica o cabeçalho de codificação de conteúdo do conteúdo da resposta HTTP.
Em branco indica que a codificação de conteúdo é desconhecida.
HTTPResponseContentIsChunked
Verdadeiro indica que o conteúdo da resposta HTTP foi recebido com codificação
em lotes. Falso será retornado se a condição Verdadeiro não for atendida.
HTTPResponseContentFilePath
Especifica o caminho para o arquivo em que o conteúdo da resposta HTTP foi salvo.
Em branco indica que o operador não está definido para salvar o conteúdo da
resposta HTTP (o corpo da mensagem) em um arquivo.
■
Se a entrada para Se o arquivo de resposta existir? foi 0 e o caminho do arquivo
especificado como entrada no Caminho do arquivo de conteúdo de resposta
HTTP existir, então o campo HTTPResponseContentFilePath contém o caminho
para o novo arquivo onde o conteúdo da resposta HTTP foi salvo.
■
Se a entrada para Se o arquivo de resposta existir? foi 1 e o caminho do arquivo
fornecido como Caminho do arquivo de conteúdo da resposta HTTP existir,
então o campo HTTPResponseContentFilePath contém o caminho fornecido no
Caminho do arquivo de conteúdo da resposta HTTP.
HTTPResponseContent
Especifica o conteúdo da resposta HTTP, até o número de bytes inserido no campo
Limite de tamanho do campo do conjunto de dados da resposta HTTP. Em branco
indica que o operador não está configurado para salvar o conteúdo da resposta
HTTP (o corpo da mensagem) em seu conjunto de dados. Em branco também pode
indicar que o conteúdo da resposta HTTP está em branco.
438 Referência do Criador de Conteúdo
Operadores HTTP: parâmetros de saída comuns
HTTPResponseHtmlContent
Especifica o conteúdo da resposta HTTP processado como HTML no conjunto de
dados do operador. O cabeçalho content-type iniciado com text/html indica que o
conteúdo da resposta HTTP é HTML. Quando o CA Process Automation detecta que
o conteúdo da resposta HTTP é HTML, o conteúdo da resposta HTTP é processado
como HTML no conjunto de dados do operador. Os dados brutos permanecem
acessíveis para o código javascript em HTTPResponseContent. Em branco pode
indicar que o operador não está configurado para salvar o conteúdo da resposta
HTTP (corpo da mensagem) em um conjunto de dados. Em branco também pode
significar que o CA Process Automation detecta que o conteúdo da resposta HTTP
não é HTML ou está em branco.
Observação: o CA Process Automation processa apenas páginas HTML básicas. O CA
Process Automation não processa páginas HTML complexas.
HTTPResponseHeaders
Especifica os cabeçalhos HTTP da resposta HTTP. Os cabeçalhos são retornados
como um mapa de valores indexados, em que cada mapa de valores contém um
único cabeçalho e os dois parâmetros a seguir:
Tecla
Especifica o nome do cabeçalho HTTP.
Valor
Especifica o valor do cabeçalho HTTP.
HTTPRequestHeaders
Especifica os cabeçalhos HTTP da solicitação HTTP que foi enviada. Esse campo
contém os cabeçalhos HTTP que foram fornecidos como entrada nos campos
Cabeçalhos HTTP ou Mapa de valores de cabeçalhos HTTP do operador. Esse campo
também contém os cabeçalhos HTTP para autenticação proxy e outros que o
operador adicionou antes de enviar a solicitação.
Os cabeçalhos são retornados como um mapa de valores indexados, em que cada
mapa de valores contém um único cabeçalho e os seguintes parâmetros:
Tecla
Especifica o nome do cabeçalho HTTP.
Valor
Especifica o valor do cabeçalho HTTP.
HTTPRequestLine
Especifica a linha de solicitação da solicitação HTTP que foi enviada. A linha de
solicitação HTTP contém o método HTTP, o URL e a versão de HTTP.
Capítulo 15: Web Services 439
Operadores HTTP: parâmetros de saída comuns
HTTPCookiesStore
Especifica a versão analisada dos cookies HTTP enviada na solicitação e os cookies
HTTP incorporados aos cabeçalhos de resposta. Os cookies são retornados como
um mapa de valores indexado, onde cada ValueMap contém um único cookie que
foi definido com os seguintes parâmetros:
Nome
Especifica o nome desse cookie HTTP.
Valor
Especifica o valor desse cookie HTTP.
Versão
Especifica a versão da especificação de cookie à qual esse cookie HTTP
obedece.
Domain
Especifica o domínio desse cookie HTTP. O cookie HTTP é válido nesse domínio.
Caminho
Especifica o caminho desse cookie HTTP. Esse valor especifica o subconjunto de
URLs aos quais esse cookie HTTP se aplica no servidor HTTP original.
ExpirationDate
Especifica a data de expiração do cookie HTTP. Alguns cookies retornam uma
data de expiração, enquanto outros retornam uma duração máxima. A data de
expiração é retornada no seguinte formato:
"aaaa.MM.dd 'em' HH:mm:ss z"
MaxAge
Especifica a duração máxima desse cookie HTTP. Alguns cookies retornam uma
duração máxima, enquanto outros retornam uma data de expiração.
Comentário
Especifica a finalidade desse cookie HTTP.
Portas
Especifica as portas desse cookie HTTP. As portas são retornadas como uma
sequência de caracteres de valores separados por vírgula. Esse valor especifica
as portas em que esse cookie HTTP pode ser enviado de volta em um cabeçalho
de solicitação.
440 Referência do Criador de Conteúdo
Operadores HTTP: portas de saída comuns
IsSecure
Uma das seguintes opções:
■
Verdadeiro - indica que esse cookie HTTP só pode ser enviado por uma
conexão segura.
■
Falso - indica que uma conexão segura não é necessária para enviar esse
cookie.
ResponseHeaderName
Especifica o nome do cabeçalho de resposta que contém esse cookie HTTP.
Esse valor pode ser “Set-Cookie”• ou “Set-Cookie2”•.
Resultado
Este valor é uma das seguintes opções:
1
Indica que o operador foi concluído com êxito.
-1
Indica que o operador falhou.
Motivo
Este valor é uma das seguintes opções:
concluído
Esse motivo é associado ao resultado de 1, conclusão com êxito.
<mensagem de erro>
Uma explicação sobre o motivo pelo qual o erro ocorreu; associada ao
resultado de -1, em que o operador falhou.
Operadores HTTP: portas de saída comuns
Êxito
O operador foi concluído com êxito.
Tempo de expiração
Ocorreu um tempo limite de conexão ou um tempo limite de socket.
Capítulo 15: Web Services 441
Operadores HTTP: portas de saída comuns
Falha
A resposta HTTP tem um código de status maior ou igual a 300.
O Conteúdo da resposta HTTP contém o código de status HTTP e o motivo da falha
de operador. HTTPResponseReasonPhrase pode conter um motivo genérico da
falha. Um motivo genérico da falha é retornado na Linha de status da resposta
HTTP. Examine HTTPResponseContent para obter detalhes.
A seguir são fornecidas descrições dos códigos de status 401 e 407 e outros motivos
de falha:
401
O código de status 401 indica uma das seguintes condições:
■
Credenciais de autenticação de URL incorretas.
■
Esquema de autenticação de URL incorreto (básico vs. NTLM)
■
Nenhuma credencial de autenticação é fornecida quando o URL HTTP exige
autenticação.
■
Falha de autenticação de URL.
Com um código de erro 401, o servidor HTTP normalmente retorna o cabeçalho
de resposta WWW-Authenticate. O cabeçalho de resposta contém o esquema
de autenticação que o servidor HTTP está usando. Use essa informação para
determinar o esquema de autenticação a ser usado em relação ao URL. A
autenticação HTTP básica e a autenticação NTLM são os dois esquemas aos
quais operadores HTTP oferecem suporte.
407
O código de status 407 indica uma das seguintes condições:
■
Credenciais de autenticação de proxy incorretas.
■
Esquema de autenticação de proxy incorreto (básico vs. NTLM)
■
Nenhuma credencial de autenticação é fornecida quando o proxy exige
autenticação.
■
Falha de autenticação de proxy.
Com um código de erro 407, o proxy HTTP normalmente retorna o cabeçalho
de resposta Proxy-Authenticate. Esse cabeçalho de resposta contém o esquema
de autenticação que o servidor proxy está usando. Use essa informação para
determinar o esquema de autenticação a ser usado em relação ao proxy. A
autenticação HTTP básica e a autenticação NTLM são os dois esquemas aos
quais operadores HTTP oferecem suporte.
442 Referência do Criador de Conteúdo
Operador HTTP Delete
■
O URL ou Host de proxy especificado como entrada é desconhecido.
■
A chamada HTTP passa por um proxy, mas a entrada não incluía a especificação
de um proxy. Nesse caso, o operador pode especificar que a conexão com o
URL HTTP é recusada.
■
A entrada incluía uma porta de proxy inválida. Nesse caso, o operador pode
especificar que a conexão com ‘ProxyHost:ProxyPort’ é recusada.
■
Entrada inválida detectada, como as informações a seguir:
–
Conexão negativa ou o socket expira.
–
Número máximo de redirecionamentos negativo.
–
Limite de tamanho do campo do conjunto de dados de resposta negativo.
–
Salvar resposta em arquivo sem um caminho de arquivo fornecido.
Portas personalizadas
Se definido pelo usuário durante a criação do processo.
Operador HTTP Delete
O operador HTTP Delete envia um HTTP Delete a um URL. A operação HTTP Delete faz
com que o servidor HTTP exclua o recurso que está localizado no URL solicitado.
O operador HTTP Delete pode ser usado para serviços RESTful.
Importante! Use o operador HTTP Options para determinar se o método HTTP Delete é
suportado. Normalmente, o método HTTP Delete é desativado em servidores HTTP
públicos para impedir a exclusão de arquivos nos servidores HTTP.
Capítulo 15: Web Services 443
Operador HTTP Delete
Parâmetros de entrada
Consulte as seções a seguir para obter as descrições dos parâmetros de entrada para o
operador HTTP Delete:
Informações sobre o URL HTTP
Consulte Informações sobre o URL HTTP (na página 424) para obter as descrições dos
parâmetros de entrada.
Informações sobre o proxy HTTP
Consulte Informações sobre o proxy HTTP (na página 428) para obter as descrições dos
parâmetros de entrada.
Informações de cabeçalhos HTTP
Consulte Informações de cabeçalhos HTTP (na página 432) para obter as descrições dos
parâmetros de entrada.
Informações sobre cookies HTTP
Consulte Informações sobre cookies HTTP (na página 433) para obter as descrições dos
parâmetros de entrada.
Informações sobre o conteúdo de resposta HTTP
Consulte Informações sobre o conteúdo de resposta HTTP (na página 433) para obter as
descrições dos parâmetros de entrada.
Informações de configuração HTTP
Consulte Informações de configuração HTTP (na página 435) para obter as descrições
dos parâmetros de entrada.
444 Referência do Criador de Conteúdo
Operador HTTP Delete
Parâmetros de saída
HttpRemoteURL
HttpValidateSSLCert
HttpSvrAuth
HttpSvrNtlmAuth
HttpAuthUser
HttpAuthPwd
HttpAuthDomain
HttpProxy
HttpProxyHost
HttpProxyPort
HttpProxyAuth
HttpProxyNtlmAuth
HttpProxyUser
HttpProxyPwd
HttpProxyDomain
HttpHeaderFieldsType
HttpHeaderFieldsValueMap
HttpHeaderFieldsVarValueMap
HttpCookieFieldsVarValueMap
HttpRespSaveToFile
HttpRespLocalFile
HttpRespLocalFileExists
HttpRespSaveToDataset
HttpRespDatasetVarLimit
HttpVersion
HttpConnectionTimeout
HttpSocketTimeout
HttpHandleRedirects
HttpMaxRedirects
HTTPRequestUrl
HTTPResponseStatusLine
HTTPResponseStatusCode
Capítulo 15: Web Services 445
Operador Obter HTTP
HTTPResponseReasonPhrase
HTTPResponseProtocolVersion
HTTPResponseContentType
HTTPResponseContentCharset
HTTPResponseContentLength
HTTPResponseContentEncoding
HTTPResponseContentFilePath
HTTPResponseContent
HTTPResponseHtmlContent
HTTPResponseHeaders
HTTPResponseContentIsChunked
HTTPRequestHeaders
HTTPRequestLine
HTTPCookiesStore
Consulte Operadores HTTP: parâmetros de saída comuns (na página 437) para obter
mais informações.
Portas de saída
As portas de saída para o operador HTTP Delete consistem apenas na porta de saída
comum (na página 441)para os operadores HTTP.
Operador Obter HTTP
O operador HTTP Get envia uma solicitação HTTP Get para um URL.
Se o URL especificado apontar para um recurso, o operador HTTP Get recuperará o
recurso. Use o operador HTTP Get para fazer download de um arquivo de um servidor
HTTP especificando o URL do arquivo.
Se o URL especificado apontar para um processo que produza dados, o operador HTTP
Get recuperará os dados produzidos pelo processo. O operador HTTP Get não recupera
dados da origem do processo.
O operador HTTP Get pode ser usado para serviços RESTful.
446 Referência do Criador de Conteúdo
Operador Obter HTTP
Parâmetros de entrada
Informações sobre o URL HTTP
Consulte Informações sobre o URL HTTP (na página 424)para obter as descrições dos
parâmetros de entrada.
Informações de HTTP Get
Codificação de parâmetros de URL
Especifica a codificação de caracteres a ser usada para codificar os parâmetros do
URL. ASCII é a codificação recomendada para os parâmetros de URL em uma
operação HTTP Get. Os parâmetros de URL são transferidos no URL. Codificações
que não sejam ASCII, UTF-8 e ISO-8859-1 normalmente não funcionam.
Valores
Um dos seguintes:
■
ASCII
■
UTF-8
■
ISO-8859-1
Padrão
Em branco - igual a ASCII.
Usar mapa de valores indexados para os cabeçalhos URL?
Indica qual dos campos a seguir deve ser usado para a entrada dos parâmetros de
URL: Mapa de valores indexados de parâmetros de URL ou Parâmetros de URL.
Valores
Selecionado - digite os parâmetros do URL como um mapa de valores
indexados no campo Mapa de valores indexado de parâmetros de URL.
Desmarcado - digite os parâmetros de URL no campo Parâmetros de URL.
Parâmetros do URL
Especifica os nomes dos parâmetros de URL na coluna Chave e os valores dos
parâmetros de URL na coluna Valor.
Use os botões abaixo para adicionar, remover ou reorganizar os parâmetros.
Observação: o operador ignora qualquer parâmetro de URL em que a chave esteja
em branco, ou seja, em que nenhum nome de parâmetro de URL seja especificado.
Capítulo 15: Web Services 447
Operador Obter HTTP
Mapa de valores indexados de parâmetros de URL
Identifica o nome de um mapa de valores indexados. Esse nome é uma variável do
conjunto de dados do tipo mapa de valores indexados com chaves e valores, em
que as chaves são nomes de parâmetros de URL. O mapa de valores indexados deve
consistir nos parâmetros Chave e Valor. O mapa de valores indexados deve estar no
mesmo formato que aquele listado no campo Cabeçalhos de URL. O operador
ignora qualquer parâmetro de URL com uma Chave em branco.
Informações sobre o proxy HTTP
Consulte Informações sobre o proxy HTTP (na página 428) para obter as descrições dos
parâmetros de entrada.
Informações de cabeçalhos HTTP
Consulte Informações de cabeçalhos HTTP (na página 432) para obter as descrições dos
parâmetros de entrada.
Informações sobre cookies HTTP
Consulte Informações sobre cookies HTTP (na página 433) para obter as descrições dos
parâmetros de entrada.
Informações sobre o conteúdo de resposta HTTP
Consulte Informações sobre o conteúdo de resposta HTTP (na página 433) para obter as
descrições dos parâmetros de entrada.
Informações de configuração HTTP
Consulte Informações de configuração HTTP (na página 435) para obter as descrições
dos parâmetros de entrada.
448 Referência do Criador de Conteúdo
Operador Obter HTTP
Parâmetros de saída
HttpRemoteURL
HttpValidateSSLCert
HttpSvrAuth
HttpSvrNtlmAuth
HttpAuthUser
HttpAuthPwd
HttpAuthDomain
HttpReqUrlParamsEncoding
HttpReqUrlParamsType
HttpReqUrlParamsValueMap
HttpReqUrlParamsVarValueMap
HttpProxy
HttpProxyHost
HttpProxyPort
HttpProxyAuth
HttpProxyNtlmAuth
HttpProxyUser
HttpProxyPwd
HttpProxyDomain
HttpHeaderFieldsType
HttpHeaderFieldsValueMap
HttpHeaderFieldsVarValueMap
HttpCookieFieldsVarValueMap
HttpRespSaveToFile
HttpRespLocalFile
HttpRespLocalFileExists
HttpRespSaveToDataset
HttpRespDatasetVarLimit
HttpVersion
HttpConnectionTimeout
HttpSocketTimeout
HttpHandleRedirects
Capítulo 15: Web Services 449
Operador Obter HTTP
HttpMaxRedirects
HTTPRequestUrl
HTTPResponseStatusLine
HTTPResponseStatusCode
HTTPResponseReasonPhrase
HTTPResponseProtocolVersion
HTTPResponseContentType
HTTPResponseContentCharset
HTTPResponseContentLength
HTTPResponseContentEncoding
HTTPResponseContentFilePath
HTTPResponseContent
HTTPResponseHtmlContent
HTTPResponseHeaders
TTPResponseContentIsChunked
HTTPRequestHeaders
HTTPRequestLine
HTTPCookiesStore
Consulte Operadores HTTP: parâmetros de saída comuns (na página 437) para obter
mais informações.
Portas de saída
As portas de saída para o operador HTTP Get são as portas de saída comuns para
operadores HTTP, além de um caso de falha adicional.
Falha do operador
O operador HTTP Get pode falhar pelos seguintes motivos:
■
Falhas que são comuns a portas de saída para todos os operadores HTTP.
Observação: consulte Operadores HTTP: portas de saída comuns (na página 441)
para obter as descrições.
■
Você especificou uma codificação inválida no campo Codificação de parâmetros de
URL.
450 Referência do Criador de Conteúdo
Operador HTTP Head
Operador HTTP Head
O operador HTTP Head envia uma solicitação HTTP Head para um URL. O método HTTP
Head é semelhante ao método HTTP Get. A diferença entre os dois métodos é que, com
HTTP Head, o servidor HTTP não retorna o recurso localizado no URL. Os cabeçalhos
HTTP da resposta são os mesmos para o método Head e o método Get.
Em geral, o método HTTP Head é usado para obter informações sobre um recurso sem
realmente obtê-lo (transferi-lo).
Parâmetros de entrada
Informações sobre o URL HTTP
Consulte Informações sobre o URL HTTP (na página 424)para obter as descrições dos
parâmetros de entrada.
Informações de HTTP Head
Codificação de parâmetros de URL
Especifica a codificação de caracteres a ser usada para codificar os parâmetros do
URL. ASCII é a codificação recomendada para os parâmetros de URL em uma
operação HTTP Head. Os parâmetros de URL são transferidos no URL. Codificações
que não sejam ASCII, UTF-8 e ISO-8859-1 normalmente não funcionam.
Valores
Um dos seguintes:
■
ASCII
■
UTF-8
■
ISO-8859-1
Padrão
Em branco - igual a ASCII.
Capítulo 15: Web Services 451
Operador HTTP Head
Usar mapa de valores indexados para os cabeçalhos URL?
Indica quais dos campos a seguir devem ser usados para a entrada de parâmetros
de URL. Especificamente, indica se os parâmetros de URL serão especificados como
um mapa de valores indexado no campo Mapa de valores indexado de Parâmetros
de URL ou se os parâmetros de URL serão inseridos no campo Parâmetros de URL.
Valores
Selecionado - insira os parâmetros de URL como um mapa de valores indexado
no campo Mapa de valores indexado de Parâmetros de URL.
Desmarcado - digite os parâmetros de URL no campo Parâmetros de URL.
Parâmetros do URL
Especifica os nomes dos parâmetros de URL na coluna Chave e os valores dos
parâmetros de URL na coluna Valor.
Use os botões abaixo para adicionar, remover ou reorganizar os parâmetros.
Observação: o operador ignora qualquer parâmetro de URL em que a Chave esteja
em branco, ou seja, onde nenhum nome de parâmetro de URL seja especificado.
Mapa de valores indexados de parâmetros de URL
Identifica o nome de um mapa de valores indexados. Esse nome é uma variável do
conjunto de dados de mapa de valores indexado por tipo com chaves e valores,
onde as chaves são nomes de parâmetro de URL. O mapa de valores indexados
deve consistir nos parâmetros Chave e Valor. O mapa de valores indexados deve
estar no mesmo formato que aquele listado no campo Cabeçalhos de URL. O
operador ignora qualquer parâmetro de URL com uma Chave em branco.
Informações sobre o proxy HTTP
Consulte Informações sobre o proxy HTTP (na página 428) para obter as descrições dos
parâmetros de entrada.
Informações de cabeçalhos HTTP
Consulte Informações de cabeçalhos HTTP (na página 432) para obter as descrições dos
parâmetros de entrada.
Informações sobre cookies HTTP
Consulte Informações sobre cookies HTTP (na página 433) para obter as descrições dos
parâmetros de entrada.
Informações sobre o conteúdo de resposta HTTP
Consulte Informações sobre o conteúdo de resposta HTTP (na página 433) para obter as
descrições dos parâmetros de entrada.
452 Referência do Criador de Conteúdo
Operador HTTP Head
Informações de configuração HTTP
Consulte Informações de configuração HTTP (na página 435) para obter as descrições
dos parâmetros de entrada.
Capítulo 15: Web Services 453
Operador HTTP Head
Parâmetros de saída
HttpRemoteURL
HttpValidateSSLCert
HttpSvrAuth
HttpSvrNtlmAuth
HttpAuthUser
HttpAuthPwd
HttpAuthDomain
HttpReqUrlParamsEncoding
HttpReqUrlParamsType
HttpReqUrlParamsValueMap
HttpReqUrlParamsVarValueMap
HttpProxy
HttpProxyHost
HttpProxyPort
HttpProxyAuth
HttpProxyNtlmAuth
HttpProxyUser
HttpProxyPwd
HttpProxyDomain
HttpHeaderFieldsType
HttpHeaderFieldsValueMap
HttpHeaderFieldsVarValueMap
HttpCookieFieldsVarValueMap
HttpRespSaveToFile
HttpRespLocalFile
HttpRespLocalFileExists
HttpRespSaveToDataset
HttpRespDatasetVarLimit
HttpVersion
HttpConnectionTimeout
HttpSocketTimeout
HttpHandleRedirects
454 Referência do Criador de Conteúdo
Operador HTTP Head
HttpMaxRedirects
HTTPRequestUrl
HTTPResponseStatusLine
HTTPResponseStatusCode
HTTPResponseReasonPhrase
HTTPResponseProtocolVersion
HTTPResponseContentType
HTTPResponseContentCharset
HTTPResponseContentLength
HTTPResponseContentEncoding
HTTPResponseContentFilePath
HTTPResponseContent
HTTPResponseHtmlContent
HTTPResponseHeaders
HTTPResponseContentIsChunked
HTTPRequestHeaders
HTTPRequestLine
HTTPCookiesStore
Consulte Operadores HTTP: parâmetros de saída comuns (na página 437) para obter
mais informações.
Observação: o operador HTTP não transfere o recurso localizado no URL especificado.
Portanto, as variáveis de saída, como HTTPResponseContentType e
HTTPResponseContentLength, estão em branco. Para obter informações sobre o recurso
no URL especificado, exiba os HTTPResponseHeaders. HTTPResponseHeaders contém
informações sobre cabeçalhos, como content-type e content-length. Trata-se de
informações retornadas pelo servidor HTTP sobre esse recurso.
Portas de saída
As portas de saída para o operador HTTP Head consistem em portas de saída comuns
para operadores HTTP, além de um caso de falha adicional.
Capítulo 15: Web Services 455
Operador HTTP Options
Falha do operador
O operador HTTP Head pode falhar pelos seguintes motivos:
■
Falhas que são comuns a portas de saída para todos os operadores HTTP.
Observação: consulte Operadores HTTP: portas de saída comuns (na página 441)
para obter as descrições.
■
O usuário especificou uma codificação inválida no campo Codificação de
parâmetros de URL.
Operador HTTP Options
O operador HTTP Options envia uma solicitação HTTP Options para um URL. O HTTP
Options permite determinar os métodos HTTP aos quais o servidor HTTP oferece
suporte.
Os métodos HTTP com suporte são listadas na variável de saída HTTPAllowedMethods
ao final da execução do operador.
Parâmetros de entrada
Consulte as seções a seguir para obter as descrições dos parâmetros de entrada para o
operador HTTP Options:
Informações sobre o URL HTTP
Consulte Informações sobre o URL HTTP (na página 424)para obter as descrições dos
parâmetros de entrada.
Informações sobre o proxy HTTP
Consulte Informações sobre o proxy HTTP (na página 428) para obter as descrições dos
parâmetros de entrada.
Informações de cabeçalhos HTTP
Consulte Informações de cabeçalhos HTTP (na página 432) para obter as descrições dos
parâmetros de entrada.
456 Referência do Criador de Conteúdo
Operador HTTP Options
Informações sobre cookies HTTP
Consulte Informações sobre cookies HTTP (na página 433) para obter as descrições dos
parâmetros de entrada.
Informações sobre o conteúdo de resposta HTTP
Consulte Informações sobre o conteúdo de resposta HTTP (na página 433) para obter as
descrições dos parâmetros de entrada.
Informações de configuração HTTP
Consulte Informações de configuração HTTP (na página 435) para obter as descrições
dos parâmetros de entrada.
Capítulo 15: Web Services 457
Operador HTTP Options
Parâmetros de saída
HttpRemoteURL
HttpValidateSSLCert
HttpSvrAuth
HttpSvrNtlmAuth
HttpAuthUser
HttpAuthPwd
HttpAuthDomain
HttpProxy
HttpProxyHost
HttpProxyPort
HttpProxyAuth
HttpProxyNtlmAuth
HttpProxyUser
HttpProxyPwd
HttpProxyDomain
HttpHeaderFieldsType
HttpHeaderFieldsValueMap
HttpHeaderFieldsVarValueMap
HttpCookieFieldsVarValueMap
HttpRespSaveToFile
HttpRespLocalFile
HttpRespLocalFileExists
HttpRespSaveToDataset
HttpRespDatasetVarLimit
HttpVersion
HttpConnectionTimeout
HttpSocketTimeout
HttpHandleRedirects
HttpMaxRedirects
HTTPRequestUrl
HTTPResponseStatusLine
HTTPResponseStatusCode
458 Referência do Criador de Conteúdo
Operador HTTP Options
HTTPResponseReasonPhrase
HTTPResponseProtocolVersion
HTTPResponseContentType
HTTPResponseContentCharset
HTTPResponseContentLength
HTTPResponseContentEncoding
HTTPResponseContentFilePath
HTTPResponseContent
HTTPResponseHtmlContent
HTTPResponseHeaders
HTTPResponseContentIsChunked
HTTPRequestHeaders
HTTPRequestLine
HTTPCookiesStore
HTTPAllowedMethods
Especifica uma sequência de caracteres indexada que contêm os nomes dos
métodos que são suportados pelo recurso ou servidor localizado no URL
especificado.
Consulte Operadores HTTP: parâmetros de saída comuns (na página 437) para obter
mais informações.
Portas de saída
As portas de saída para o operador HTTP Options consistem apenas nas portas de saída
comuns para os operadores HTTP.
Consulte Operadores HTTP: portas de saída comuns (na página 441) para obter as
descrições.
Capítulo 15: Web Services 459
Operador HTTP Post
Operador HTTP Post
O operador HTTP Post envia uma solicitação HTTP Post para um URL. O operador HTTP
Post normalmente solicita que o servidor HTTP armazene o recurso que é incluído como
o conteúdo da solicitação HTTP. O processo do servidor HTTP no URL especificado
processa então o do recurso.
Observação: diferentemente do operador HTTP Put, o URL de um operador HTTP Post
aponta para o processo que pode manipular o recurso incluído.
O operador HTTP Post pode ser usado para serviços RESTful.
Parâmetros de entrada
Informações sobre o URL HTTP
Consulte Informações sobre o URL HTTP (na página 424)para obter as descrições dos
parâmetros de entrada.
Informações de HTTP Post
Informações de HTTP Post especifica o corpo da solicitação HTTP.
Está fragmentado?
Especifica se a solicitação HTTP deve ser enviada fragmentada.
Quando a codificação de fragmentação é definida, a solicitação HTTP não contém o
cabeçalho "content-length".
Observação: o HTTP 1.0 não oferece suporte à codificação em lotes. O operador
HTTP Post falhará com um 'erro de protocolo de cliente HTTP' se a codificação de
fragmentação for definida e a versão do HTTP for 1.0.
Valores
Um dos seguintes:
■
Verdadeiro - indica que é preciso enviar a solicitação HTTP fragmentada.
■
Falso - indica que a solicitação HTTP não é enviada fragmentada.
■
Qualquer outro valor - igual a falso.
Padrão
Em branco - igual a Falso.
460 Referência do Criador de Conteúdo
Operador HTTP Post
Tipo de conteúdo
Especifica o tipo de conteúdo que compõe o corpo da solicitação HTTP, que é
definido como um cabeçalho (content-type) na solicitação HTTP.
Valores
Esse valor é um dos seguintes:
■
Um tipo de mídia selecionado na lista suspensa.
■
Em branco, em que o conteúdo é recuperado de um arquivo especificado
no ‘Caminho de arquivo de conteúdo’.
O CA Process Automation define o valor para o aplicativo/fluxo de octetos.
O servidor HTTP é responsável pela interpretação desse content-type
genérico.
■
Em branco, em que o conteúdo é recuperado do campo ‘Conteúdo’.
O CA Process Automation não define content-type. O servidor HTTP é
responsável pela interpretação do cabeçalho content-type.
■
Um tipo de mídia válido que você digita nesse campo.
Para saber quais os tipos de mídia válidos, consulte as páginas do site do
IANA (Internet Assigned Numbers Authority), na seção sobre
atribuições/tipos de mídia.
Observação: não deixe de definir o content-type correto, principalmente
quando o conteúdo não for recuperado de um arquivo.
Codificação de caracteres de conteúdo
Especifica a codificação de caracteres do conteúdo do corpo da solicitação HTTP.
Defina esse campo apenas se o tipo de conteúdo for do tipo todos os caracteres;
por exemplo: ‘text/XXX’.
Valores
Esse valor é um dos seguintes:
■
Um conjunto de caracteres selecionado na lista suspensa.
■
Um conjunto de caracteres (codificação) válido que você digita para o
campo.
Para saber quais codificações são válidas, consulte as páginas do site do
IANA (Internet Assigned Numbers Authority), na seção sobre
atribuições/conjuntos de caracteres.
Observação: não deixe de definir a codificação de caracteres correta,
principalmente quando o conteúdo não for recuperado de um arquivo.
Capítulo 15: Web Services 461
Operador HTTP Post
Recuperar conteúdo do arquivo?
Especifica se é preciso recuperar o corpo da solicitação HTTP de um arquivo local no
host em que o touchpoint está em execução.
Valores
Esse valor é um dos seguintes:
■
Selecionado - indica que é preciso recuperar o corpo da solicitação HTTP
de um arquivo local no host em que o touchpoint está em execução.
■
Desmarcado - indica que é preciso recuperar o corpo da solicitação HTTP
do campo Conteúdo.
Caminho de arquivo de conteúdo
Especifica o caminho de um arquivo local no host em que o touchpoint está em
execução. O arquivo local contém o corpo da solicitação HTTP.
Conteúdo
Especifica o corpo da solicitação HTTP.
Informações sobre o proxy HTTP
Consulte Informações sobre o proxy HTTP (na página 428) para obter as descrições dos
parâmetros de entrada.
Informações de cabeçalhos HTTP
Consulte Informações de cabeçalhos HTTP (na página 432) para obter as descrições dos
parâmetros de entrada.
Informações sobre cookies HTTP
Consulte Informações sobre cookies HTTP (na página 433) para obter as descrições dos
parâmetros de entrada.
Informações sobre o conteúdo de resposta HTTP
Consulte Informações sobre o conteúdo de resposta HTTP (na página 433) para obter as
descrições dos parâmetros de entrada.
Informações de configuração HTTP
Consulte Informações de configuração HTTP (na página 435) para obter as descrições
dos parâmetros de entrada.
462 Referência do Criador de Conteúdo
Operador HTTP Post
Parâmetros de saída
HttpRemoteURL
HttpValidateSSLCert
HttpSvrAuth
HttpSvrNtlmAuth
HttpAuthUser
HttpAuthPwd
HttpAuthDomain
HttpReqIsChunked
HttpReqContentType
HttpReqContentCharset
HttpReqContentFromFile
HttpReqContentFilePath
HttpReqContent
HttpProxy
HttpProxyHost
HttpProxyPort
HttpProxyAuth
HttpProxyNtlmAuth
HttpProxyUser
HttpProxyPwd
HttpProxyDomain
HttpHeaderFieldsType
HttpHeaderFieldsValueMap
HttpHeaderFieldsVarValueMap
HttpCookieFieldsVarValueMap
HttpRespSaveToFile
HttpRespLocalFile
HttpRespLocalFileExists
HttpRespSaveToDataset
HttpRespDatasetVarLimit
HttpVersion
HttpConnectionTimeout
Capítulo 15: Web Services 463
Operador HTTP Post
HttpSocketTimeout
HttpHandleRedirects
HttpMaxRedirects
HTTPRequestUrl
HTTPResponseStatusLine
HTTPResponseStatusCode
HTTPResponseReasonPhrase
HTTPResponseProtocolVersion
HTTPResponseContentType
HTTPResponseContentCharset
HTTPResponseContentLength
HTTPResponseContentEncoding
HTTPResponseContentFilePath
HTTPResponseContent
HTTPResponseHtmlContent
HTTPResponseHeaders
HTTPResponseContentIsChunked
HTTPRequestHeaders
HTTPRequestLine
HTTPCookiesStore
Consulte Operadores HTTP: parâmetros de saída comuns (na página 437) para obter
mais informações.
Portas de saída
As portas de saída para o operador HTTP Post consistem nas portas de saída comuns
para operadores HTTP, além de um caso de falha adicional.
464 Referência do Criador de Conteúdo
Operador Formulário por HTTP Post
Falha do operador
O operador HTTP Post pode falhar pelos seguintes motivos:
■
Falhas que são comuns a portas de saída para todos os operadores HTTP.
Observação: consulte Operadores HTTP: portas de saída comuns (na página 441)
para obter as descrições.
■
O ‘Erro de protocolo de cliente HTTP’ poderá ocorrer se a codificação fragmentada
for definida e a versão do HTTP for 1.0. Isso pode causar um
ClientProtocolException.
■
A entrada contém codificação inválida no campo Codificação de caracteres de
conteúdo.
Observação: o CA Process Automation não verificará se o valor de Tipo de conteúdo
especificado na entrada é válido quando o conteúdo for recuperado de um arquivo.
O servidor HTTP de recebimento é responsável pelo retorno de um código de erro,
caso detecte um Tipo de conteúdo inválido.
Operador Formulário por HTTP Post
O formulário Publicação HTTP operador envia dados a um formulário de HTTP. Os dados
são do tipo de pares de nome-valor, podendo incluir valores que são arquivos.
Diferentemente do operador HTTP Post, o operador Formulário por HTTP Post envia a
solicitação HTTP Post a um formulário HTTP. O URL do operador é o elemento de ação
do formulário. Por exemplo:
<form name=”myForm” method=”post” action =”XXXXXXXX”>
Expresse o URL de destino como o caminho completo do script ou processo no servidor
HTTP para o qual o elemento de ação aponta. Não use um caminho relativo para o URL
de destino.
O script ou processo para o qual o elemento de ação aponta deve estar publicamente
disponível para que o operador Formulário por HTTP Post o chame.
Capítulo 15: Web Services 465
Operador Formulário por HTTP Post
Parâmetros de entrada
Informações sobre o URL HTTP
Consulte Informações sobre o URL HTTP (na página 424)para obter as descrições dos
parâmetros de entrada.
Informações sobre Formulário por HTTP Post
Codificação de campo de formulário
Especifica a codificação de caracteres a ser usada para codificar os parâmetros dos
campos do formulário. Os dados do operador Formulário por HTTP Post vão para o
corpo da solicitação.
Valores
Esse campo aceita os seguintes valores:
■
Um valor da lista suspensa.
■
Um valor digitado pelo usuário.
■
Em branco - ISO-8859-1
Padrão
ISO-8859-1
Usar mapa de valores indexados para os campos do formulário?
Especifica se é necessário especificar campos de formulário no campo Mapa de
valores indexados para campos de formulário ou no campo Campos do formulário.
A opção ativa a entrada para o campo correspondente.
Valores
■
Selecionado - indica que os campos do formulário são especificados como
um mapa de valores indexados no campo Mapa de valores indexados para
campos de formulário.
■
Desmarcado - indica que os campos do formulário são especificados no
campo Campos do formulário.
Campos do Formulário
Especifica a combinação de tecla e valor para cada campo do formulário.. A coluna
Chave contém os nomes dos campos do formulário e a coluna Valor contém os
valores dos campos do formulário.
Use os botões abaixo para adicionar, remover ou reorganizar os parâmetros.
Observação: o operador Formulário por HTTP Post ignora qualquer campo de
formulário com uma chave em branco.
466 Referência do Criador de Conteúdo
Operador Formulário por HTTP Post
Mapa de valores indexados para campos de formulário
Identifica o nome de um mapa de valores indexados.
Esse mapa de valores consiste em Chave e Valor. Uma entrada de Chave é o nome
de um campo do formulário; a entrada de Valor correspondente é o valor desse
campo do formulário. O mapa de valores indexados está no mesmo formato que
aquele listado no campo Campos do formulário.
Observação: o operador Formulário por HTTP Post ignora qualquer campo de
formulário com uma chave em branco.
Capítulo 15: Web Services 467
Operador Formulário por HTTP Post
Campos de arquivo no formulário?
Indica se o formulário contém campos que permitem que arquivos sejam
carregados para o formulário. Se você marcar essa caixa de seleção, poderá digitar
dados relacionados nos campos a seguir: Usar mapa de valores indexados para os
arquivos de formulário?, Arquivos de formulário e Mapa de valores indexados para
arquivos de formulário.
Observação: o content-type do cabeçalho da solicitação HTTP depende de como o
campo Campos de arquivo no formulário? é definido.
Valores
Esse campo é definido de uma das seguintes maneiras:
■
Selecionado - o tipo de conteúdo da solicitação HTTP vem a seguir, em que
XXXXXXX é a sequência de caracteres de limite que separa as diferentes partes
da solicitação HTTP. Cada parte do corpo da solicitação HTTP pode ter seu
próprio content-type.
content-type=multipart/form-data;boundary=XXXXXXX
■
–
Os campos do formulário são codificados usando a codificação especificada
em Codificação de campo de formulário. Cada campo do formulário é
incluído como uma parte separada no corpo da solicitação.
–
Cada parte de um campo do formulário contém um
content-type=text/plain; charset=’encoding’, em que ‘encoding’ é o valor
(ou valor padrão) de Codificação de campo de formulário.
–
Os arquivos do formulário são codificados usando a codificação
especificada nas colunas ContentType e ContentCharacterEncoding (caso
aplicável) associadas a cada arquivo de formulário. Cada arquivo do
formulário é incluído como uma parte separada no corpo da solicitação.
–
O content-type de cada parte de arquivo do formulário é especificado na
coluna ContentType de Arquivos de formulário ou Mapa de valores de
arquivos de formulário. Se aplicável, essa especificação é combinada a
ContentCharacterEncoding.
Desmarcado - o tipo de conteúdo da solicitação HTTP a vem a seguir, em que
‘encoding’ é o tipo de codificação especificado em Codificação de campo de
formulário.
content-type=application/x-www-form-urlencoded;charset='enc
oding'
–
Os campos do formulário são codificados por URL (usando ‘encoding’).
–
Os campos do formulário são colocados no corpo da solicitação.
468 Referência do Criador de Conteúdo
Operador Formulário por HTTP Post
Usar mapa de valores indexados para os arquivos de formulário?
Indica se é preciso especificar os campos de arquivo de formulário no campo
Arquivos de formulário ou no campo Mapa de valores indexados para arquivos de
formulário.
■
Selecionado - indica que os campos de arquivos do formulário são
especificados como um mapa de valores indexados no campo Mapa de valores
indexados para campos de formulário.
■
Desmarcado - indica que os campos de arquivos do formulário são
especificados no campo Campos do formulário.
Arquivos de formulário
Especifica cada arquivo do formulário com quatro campos chave: Chave, Caminho
do arquivo, Tipo de conteúdo e Codificação de caracteres de conteúdo. A seguir são
fornecidas descrições de cada campo de um arquivo de formulário:
Tecla
Especifica os nomes dos campos de arquivos de formulário.
Caminho do arquivo
Especifica o caminho relativo para o arquivo. (Esse campo é obrigatório.) O
operador ignora qualquer campo de arquivo de formulário com um FilePath em
branco.
ContentType
Especifica o tipo de conteúdo do arquivo a ser carregado. Os content-types
válidos são listados no site do IANA na seção sobre atribuições/tipos de mídia.
Se deixado em branco, o content-type da parte do arquivo correspondente no
corpo da solicitação HTTP será definido como aplicativo/fluxo de octetos. Em
seguida, cabe ao servidor HTTP interpretar esse content-type genérico.
ContentCharacterEncoding
Especifica o conjunto de caracteres do conteúdo dos arquivos a serem
carregados, se o tipo de conteúdo for de todos os caracteres, como ‘text/XXX’.
Deixe em branco para outros tipos de conteúdo.
Observação: para obter uma lista de diferentes conjuntos de caracteres
(codificações), consulte as páginas do site da IANA em atribuições/conjuntos de
caracteres.
Mapa de valores indexados para arquivos de formulário
Especifica o nome de um mapa de valores indexados que contém os nomes de
campos de arquivos do formulário e os valores correspondentes. O mapa de valores
indexados deve estar no mesmo formato que aquele listado no campo Arquivos de
formulário. Isto é, ele deve ser composto de Key, FilePath, ContentType e
ContentCharacterEncoding.
Capítulo 15: Web Services 469
Operador Formulário por HTTP Post
Informações sobre o proxy HTTP
Consulte Informações sobre o proxy HTTP para obter as descrições dos parâmetros de
entrada.
Informações de cabeçalhos HTTP
Consulte Informações de cabeçalhos HTTP (na página 432) para obter as descrições dos
parâmetros de entrada.
Informações sobre cookies HTTP
Consulte Informações sobre cookies HTTP (na página 433) para obter as descrições dos
parâmetros de entrada.
Informações sobre o conteúdo de resposta HTTP
Consulte Informações sobre o conteúdo de resposta HTTP (na página 433) para obter as
descrições dos parâmetros de entrada.
Informações de configuração HTTP
Consulte Informações de configuração HTTP (na página 435) para obter as descrições
dos parâmetros de entrada.
470 Referência do Criador de Conteúdo
Operador Formulário por HTTP Post
Parâmetros de saída
HttpRemoteURL
HttpValidateSSLCert
HttpSvrAuth
HttpSvrNtlmAuth
HttpAuthUser
HttpAuthPwd
HttpAuthDomain
HttpFormFieldsEncoding
HttpFormFieldsType
HttpFormFieldsValueMap
HttpFormFieldsVarValueMap
HttpFormMultipartPost
HttpFormFilesToMultipartType
HttpFormFilesToMultipartValueMap
HttpFormFilesToMultipartVarValueMap
HttpProxy
HttpProxyHost
HttpProxyPort
HttpProxyAuth
HttpProxyNtlmAuth
HttpProxyUser
HttpProxyPwd
HttpProxyDomain
HttpHeaderFieldsType
HttpHeaderFieldsValueMap
HttpHeaderFieldsVarValueMap
HttpCookieFieldsVarValueMap
HttpRespSaveToFile
HttpRespLocalFile
HttpRespLocalFileExists
HttpRespSaveToDataset
HttpRespDatasetVarLimit
Capítulo 15: Web Services 471
Operador Formulário por HTTP Post
HttpVersion
HttpConnectionTimeout
HttpSocketTimeout
HttpHandleRedirects
HttpMaxRedirects
HTTPRequestUrl
HTTPResponseStatusLine
HTTPResponseStatusCode
HTTPResponseReasonPhrase
HTTPResponseProtocolVersion
HTTPResponseContentType
HTTPResponseContentCharset
HTTPResponseContentLength
HTTPResponseContentEncoding
HTTPResponseContentFilePath
HTTPResponseContent
HTTPResponseHtmlContent
HTTPResponseHeaders
HTTPResponseContentIsChunked
HTTPRequestHeaders
HTTPRequestLine
HTTPCookiesStore
Consulte Operadores HTTP: parâmetros de saída comuns (na página 437) para obter
mais informações.
Portas de saída
As portas de saída para o operador HTTP Post consistem nas portas de saída comuns
para operadores HTTP, além de um caso de falha adicional.
472 Referência do Criador de Conteúdo
Operador HTTP Put
Falha do operador
O operador Formulário por HTTP Post pode falhar pelos seguintes motivos:
■
Falhas que são comuns a portas de saída para todos os operadores HTTP.
Observação: consulte Operadores HTTP: portas de saída comuns (na página 441)
para obter as descrições.
■
A entrada contém codificação inválida nos campos Codificação de campo de
formulário ou Codificação de caracteres de conteúdo.
Observação: o CA Process Automation não verificará se a entrada de Tipo de
conteúdo é válida quando o conteúdo for recuperado de um arquivo. O servidor
HTTP de recebimento é responsável pelo retorno de um código de erro, caso
detecte um tipo de conteúdo inválido.
Operador HTTP Put
O operador HTTP Put envia uma solicitação HTTP Put para um URL. O operador HTTP
Put solicita que o recurso, incluído como conteúdo da solicitação HTTP, seja
armazenado no URL especificado no servidor HTTP. O URL deve permitir que o CA
Process Automation crie um recurso ou substitua um já existente.
Se o URL apontar para um recurso existente, o servidor HTTP manipulará o recurso
incluído como uma versão modificada do recurso existente.
Se o URL não apontar para um recurso existente, o servidor HTTP criará um recurso com
o conteúdo da solicitação HTTP. O servidor HTTP salva então o novo recurso no URL
especificado.
Observação: diferentemente do operador HTTP Post, o URL de um operador HTTP Put
identifica o recurso incluído no conteúdo da solicitação HTTP.
O operador HTTP Put pode ser usado para serviços RESTful.
Importante! Use o operador HTTP Options para determinar se é possível usar o
operador HTTP Put. O método HTTP Put normalmente é desativado em servidores HTTP
públicos.
Capítulo 15: Web Services 473
Operador HTTP Put
Parâmetros de entrada
Informações sobre o URL HTTP
Consulte Informações sobre o URL HTTP (na página 424)para obter as descrições dos
parâmetros de entrada.
Informações do HTTP Put
Informações do HTTP Put especifica o corpo da solicitação HTTP.
Está fragmentado?
Especifica se a solicitação HTTP deve ser enviada fragmentada.
Quando a codificação de fragmentação é definida, a solicitação HTTP não contém o
cabeçalho "content-length".
Observação: o HTTP 1.0 não oferece suporte à codificação em lotes. O operador
HTTP Put falhará com um 'erro de protocolo de cliente HTTP' se a codificação de
fragmentação for definida e a versão do HTTP for 1.0.
Valores
■
Verdadeiro - indica que é preciso enviar a solicitação HTTP fragmentada.
■
Falso - indica que a solicitação HTTP não é enviada fragmentada.
■
Qualquer outro valor - igual a falso.
Padrão
Em branco - igual a Falso.
Tipo de conteúdo
Especifica o tipo de conteúdo que compõe o corpo da solicitação HTTP, que é
definido como um cabeçalho (content-type) na solicitação HTTP.
Valores
Esse valor é um dos seguintes:
■
Um valor selecionado na lista suspensa de diferentes tipos de mídia.
■
Em branco, em que o conteúdo é recuperado de um arquivo especificado
no ‘Caminho de arquivo de conteúdo’.
O CA Process Automation define o valor para o aplicativo/fluxo de octetos.
O servidor HTTP é então responsável pela interpretação desse
content-type genérico.
■
Em branco, em que o conteúdo é recuperado do campo ‘Conteúdo’.
O CA Process Automation não define content-type. O servidor HTTP é
então responsável pela interpretação do cabeçalho sem content-type.
474 Referência do Criador de Conteúdo
Operador HTTP Put
■
Um tipo de mídia válido que você digita manualmente nesse campo.
Para saber quais os tipos de mídia válidos, consulte as páginas do site do
IANA (Internet Assigned Numbers Authority), na seção sobre
atribuições/tipos de mídia.
Observação: não deixe de definir o content-type correto, principalmente
quando o conteúdo não for recuperado de um arquivo.
Codificação de caracteres de conteúdo
Especifica a codificação de caracteres do conteúdo do corpo da solicitação HTTP.
Defina esse campo apenas se o tipo de conteúdo for do tipo todos os caracteres;
por exemplo: ‘text/XXX’.
Valores
Esse valor é um dos seguintes:
■
Um valor selecionado na lista suspensa de diferentes conjuntos de
caracteres (codificações).
■
Um conjunto de caracteres (codificação) válido que você digita
manualmente no campo.
Você pode encontrar codificações válidas nas páginas do site do IANA, na
seção sobre atribuições/conjuntos de caracteres.
Observação: não deixe de definir a codificação de caracteres correta,
principalmente quando o conteúdo não for recuperado de um arquivo.
Recuperar conteúdo do arquivo?
Especifica se é preciso recuperar o corpo da solicitação HTTP de um arquivo local no
host em que o touchpoint está em execução.
Valores
■
Selecionado - indica que é preciso recuperar o corpo da solicitação HTTP
de um arquivo local no host em que o touchpoint está em execução.
■
Desmarcado - indica que é preciso recuperar o corpo da solicitação HTTP
do campo Conteúdo.
Caminho de arquivo de conteúdo
Especifica o caminho de um arquivo local no host em que o touchpoint está em
execução. O arquivo local contém o corpo da solicitação HTTP.
Conteúdo
Especifica o corpo da solicitação HTTP.
Informações sobre o proxy HTTP
Consulte Informações sobre o proxy HTTP para obter as descrições dos parâmetros de
entrada.
Capítulo 15: Web Services 475
Operador HTTP Put
Informações de cabeçalhos HTTP
Consulte Informações de cabeçalhos HTTP (na página 432) para obter as descrições dos
parâmetros de entrada.
Informações sobre cookies HTTP
Consulte Informações sobre cookies HTTP (na página 433) para obter as descrições dos
parâmetros de entrada.
Informações sobre o conteúdo de resposta HTTP
Consulte Informações sobre o conteúdo de resposta HTTP (na página 433) para obter as
descrições dos parâmetros de entrada.
Informações de configuração HTTP
Consulte Informações de configuração HTTP (na página 435) para obter as descrições
dos parâmetros de entrada.
476 Referência do Criador de Conteúdo
Operador HTTP Put
Parâmetros de saída
HttpRemoteURL
HttpValidateSSLCert
HttpSvrAuth
HttpSvrNtlmAuth
HttpAuthUser
HttpAuthPwd
HttpAuthDomain
HttpReqIsChunked
HttpReqContentType
HttpReqContentCharset
HttpReqContentFromFile
HttpReqContentFilePath
HttpReqContent
HttpProxy
HttpProxyHost
HttpProxyPort
HttpProxyAuth
HttpProxyNtlmAuth
HttpProxyUser
HttpProxyPwd
HttpProxyDomain
HttpHeaderFieldsType
HttpHeaderFieldsValueMap
HttpHeaderFieldsVarValueMap
HttpCookieFieldsVarValueMap
HttpRespSaveToFile
HttpRespLocalFile
HttpRespLocalFileExists
HttpRespSaveToDataset
HttpRespDatasetVarLimit
HttpVersion
HttpConnectionTimeout
Capítulo 15: Web Services 477
Operador HTTP Put
HttpSocketTimeout
HttpHandleRedirects
HttpMaxRedirects
HTTPRequestUrl
HTTPResponseStatusLine
HTTPResponseStatusCode
HTTPResponseReasonPhrase
HTTPResponseProtocolVersion
HTTPResponseContentType
HTTPResponseContentCharset
HTTPResponseContentLength
HTTPResponseContentEncoding
HTTPResponseContentFilePath
HTTPResponseContent
HTTPResponseHtmlContent
HTTPResponseHeaders
HTTPResponseContentIsChunked
HTTPRequestHeaders
HTTPRequestLine
HTTPCookiesStore
Consulte Operadores HTTP: parâmetros de saída comuns (na página 437) para obter
mais informações.
Portas de saída
As portas de saída para o operador HTTP Post consistem nas portas de saída comuns
para operadores HTTP, além de um caso de falha adicional.
478 Referência do Criador de Conteúdo
Operador HTTP Trace
Operador HTTP Trace
O operador HTTP Trace envia um HTTP Trace a um URL. O método de rastreamento
solicita que o servidor HTTP envie de volta a solicitação que recebeu. Esse processo
pode ser útil para fins de teste e para identificar as alterações na solicitação feitas por
proxies. A solicitação é enviada de volta como o conteúdo de resposta.
Use o operador HTTP Options para verificar se HTTP está ativado.
Parâmetros de entrada
Consulte as seções a seguir para obter as descrições dos parâmetros de entrada para o
operador HTTP Options:
Informações sobre o URL HTTP
Consulte Informações sobre o URL HTTP (na página 424)para obter as descrições dos
parâmetros de entrada.
Informações sobre o proxy HTTP
Consulte Informações sobre o proxy HTTP (na página 428) para obter as descrições dos
parâmetros de entrada.
Informações de cabeçalhos HTTP
Consulte Informações de cabeçalhos HTTP (na página 432) para obter as descrições dos
parâmetros de entrada.
Informações sobre cookies HTTP
Consulte Informações sobre cookies HTTP (na página 433) para obter as descrições dos
parâmetros de entrada.
Informações sobre o conteúdo de resposta HTTP
Consulte Informações sobre o conteúdo de resposta HTTP (na página 433) para obter as
descrições dos parâmetros de entrada.
Capítulo 15: Web Services 479
Operador HTTP Trace
Informações de configuração HTTP
Consulte Informações de configuração HTTP (na página 435) para obter as descrições
dos parâmetros de entrada.
480 Referência do Criador de Conteúdo
Operador HTTP Trace
Parâmetros de saída
HttpRemoteURL
HttpValidateSSLCert
HttpSvrAuth
HttpSvrNtlmAuth
HttpAuthUser
HttpAuthPwd
HttpAuthDomain
HttpProxy
HttpProxyHost
HttpProxyPort
HttpProxyAuth
HttpProxyNtlmAuth
HttpProxyUser
HttpProxyPwd
HttpProxyDomain
HttpHeaderFieldsType
HttpHeaderFieldsValueMap
HttpHeaderFieldsVarValueMap
HttpCookieFieldsVarValueMap
HttpRespSaveToFile
HttpRespLocalFile
HttpRespLocalFileExists
HttpRespSaveToDataset
HttpRespDatasetVarLimit
HttpVersion
HttpConnectionTimeout
HttpSocketTimeout
HttpHandleRedirects
HttpMaxRedirects
HTTPRequestUrl
HTTPResponseStatusLine
HTTPResponseStatusCode
Capítulo 15: Web Services 481
Operador Solicitar método SOAP
HTTPResponseReasonPhrase
HTTPResponseProtocolVersion
HTTPResponseContentType
HTTPResponseContentCharset
HTTPResponseContentLength
HTTPResponseContentEncoding
HTTPResponseContentFilePath
HTTPResponseContent
HTTPResponseHtmlContent
HTTPResponseHeaders
HTTPResponseContentIsChunked
HTTPRequestHeaders
HTTPRequestLine
HTTPCookiesStore
Consulte Operadores HTTP: parâmetros de saída comuns (na página 437) para obter
mais informações.
Operador Solicitar método SOAP
O operador Solicitar método SOAP chama os métodos de serviço Web com base em
SOAP para disparar uma ação ou recuperar informações. Uma solicitação SOAP também
pode ser gerada com o uso de um WSDL.
482 Referência do Criador de Conteúdo
Operador Solicitar método SOAP
Parâmetros de entrada
Os parâmetros de entrada para o operador Chamar método SOAP são os seguintes.
WSDL Explorer
Assistente do WSDL
Um assistente que permite selecionar métodos de SOAP. Clique para abrir a janela
do Explorer do WSDL, onde é possível digitar:
URL da WSDL
■
Digite um URL do WSDL, em seguida, clique em Carregar. Exemplos:
http://server:8080/itpam/soap?wsdl
https://server:8443/itpam/soap?wsdl
■
Selecione um URL do WSDL digitado recentemente na lista suspensa e, em
seguida, clique em Carregar.
Observação: a lista suspensa do URL do WSDL contém as últimas dez entradas
aplicadas.
O assistente preenche os campos restantes. Revise, conforme necessário,
selecionando outras entradas nas listas suspensas e, em seguida, clique em Aplicar.
Serviços do WSDL
Portas do WSDL
Operações do WSDL
■
Use a entrada padrão que foi carregada
■
Selecione uma entrada na lista suspensa.
Para obter detalhes sobre os métodos de serviços web listados, consulte a
Referência da API de serviços web.
Área de resposta, por exemplo:
<tns:AsyncSoapResponse xmlns:tns="http://www.ca.com/itpam">
<tns:MessageID>MessageID__</tns:MessageID>
<!--xsd:Qualquer tipo aqui-->
</tns:AsyncSoapResponse>
Parâmetros de dados de chamada SOAP
URL de serviço
Especifica o URL para o serviço SOAP. O URL é geralmente acessado por HTTP ou
HTTPS. Em geral, ele é um ponto de entrada para um ou mais métodos.
Nome do método
Define o método ou a função para execução no servidor SOAP. O produto passa
este método para o serviço SOAP como um cabeçalho MIME SOAPAction.
Capítulo 15: Web Services 483
Operador Solicitar método SOAP
Tipo de autenticação
Especifica a maneira como autenticar a chamada no servidor SOAP.
Este parâmetro pode ter um dos seguintes valores:
Sem autenticação
Não autenticar a chamada de SOAP.
SOAP básico
Use o nome de usuário autorizado e a senha para a autenticação de SOAP
básico.
Autenticação HTTP
Use o nome de usuário autorizado e a senha para a autenticação de HTTP
básico. Se este recurso estiver ativado, e o nome de usuário e a senha
autorizados forem fornecidos, o produto usará essas credenciais para
autenticação HTTP básica. A Segurança do WS se aplica se o usuário fornecê-la
na página de entrada da Segurança do WS (na página 489).
Autenticação NTLM
Use o nome de usuário autorizado, a senha e o nome do domínio que estão
associados ao servidor do serviço web SOAP para se conectar ao servidor SOAP
usando a autenticação do NTLM.
Versão do SOAP
Especifica a versão do servidor SOAP em que a chamada foi feita. Essa opção
fornece uma dica para a lógica subjacente que usa o SOAP MessageFactory
apropriado ao fazer a solicitação SOAP.
Este parâmetro pode ter um dos seguintes valores:
■
SOAP 1.1
■
SOAP 1.2
484 Referência do Criador de Conteúdo
Operador Solicitar método SOAP
Origem da entrada
Define a origem da solicitação de entrada do serviço SOAP.
A solicitação de entrada pode conter macros e atribuições XPath que modificam
dinamicamente a solicitação do SOAP no tempo de execução. Se necessário, essas
atribuições XPath permitem que a solicitação do SOAP seja atualizada com valores
obtidos no tempo de execução.
Os seguintes métodos incluem uma mensagem em XML completa, devidamente
formatada, que pode incluir um envelope SOAP:
Texto embutido
Esta opção permite usar o operador Solicitar método SOAP para especificar a
solicitação de entrada. Para especificar a mensagem de entrada SOAP
formatada, use o parâmetro Texto embutido.
Arquivo SOAP pré-formatado
Esta opção permite especificar a solicitação de entrada em um arquivo SOAP
pré-formatado. Para especificar o caminho para um arquivo que contém uma
mensagem em um documento XML válido, use o parâmetro Nome do arquivo.
Expressão
Selecione esta opção se uma expressão do CA Process Automation contiver a
solicitação de SOAP. Defina a expressão do CA Process Automation no
parâmetro Expressão.
Texto embutido
Execute uma das seguintes ações se definir o parâmetro Origem da entrada como
Texto embutido:
■
Para usar uma mensagem de entrada SOAP formatada, clique em (...) para abrir
a caixa de diálogo Texto embutido e, em seguida, digite a mensagem.
■
Para ler uma mensagem SOAP a partir de um arquivo de texto, clique em (...),
Importar a partir do arquivo e, em seguida, selecione o arquivo em uma
unidade local ou de rede.
Nome de arquivo
Define o nome totalmente qualificado de um arquivo apropriado. Para usar este
parâmetro, defina a Origem da entrada como Arquivo SOAP pré-formatado. O
produto qualifica o nome do arquivo em relação ao touchpoint que executa os
operadores Serviços web.
Capítulo 15: Web Services 485
Operador Solicitar método SOAP
Expressão
Especifica uma expressão do CA Process Automation da qual extrair a solicitação
SOAP.
Arquivo de chamada salvo
Especifica o caminho completo para o arquivo no qual gravar a solicitação SOAP de
saída final. Use esse arquivo para validar o envio dos dados para os operadores de
Serviços web. Se a chamada rejeitar a solicitação devido a valores incorretos, use o
arquivo para depurar a solicitação antes de retransmitir para os operadores de
Serviços web.
Parâmetros dinâmicos
Os parâmetros dinâmicos fornecem valores atualizados em uma solicitação SOAP.
Estilo do parâmetro
Especifica o método usado para atualizar os valores em uma solicitação SOAP. Os
operadores Serviços web oferecem suporte aos seguintes métodos em tempo de
execução:
Atribuições do XPath
Especifica que expressões do XPath no parâmetro Lista de parâmetros
atualizam os valores em uma solicitação de SOAP.
Expansões de macro
Especifica que as macros no parâmetro Lista de parâmetros atualizam os
valores em uma solicitação de SOAP.
Lista de parâmetros
Especifica as entradas de dados exclusivos na solicitação de SOAP.
■
Clique em Adicionar para adicionar um parâmetro.
■
Clique em Editar para modificar o parâmetro selecionado no momento.
■
Clique em Excluir para excluir o parâmetro selecionado no momento.
A melhor prática é adicionar os parâmetros na mesma ordem especificada pelo
WSDL para a chamada de SOAP.
486 Referência do Criador de Conteúdo
Operador Solicitar método SOAP
Cada parâmetro contém os seguintes valores:
Nome da macro/consulta XPath
Define o nome da macro ou a consulta XPath. Se o valor for o nome de uma
macro, o valor substitui o nome da macro. Se o valor for uma consulta XPath, o
valor atualiza o nó que a consulta retorna.
Valor
Especifica um valor de tempo de execução para o parâmetro.
Tipo
Especifica um dos seguintes tipos de dados para o parâmetro:
■
Valor de número inteiro
■
Valor de sequência de caracteres
■
MapaDeValor
■
Fragmento XML
Parâmetros da opção Resultados da chamada
Os parâmetros a seguir da opção Resultados da chamada determinam como salvar os
resultados de uma chamada de SOAP:
Arquivo de resposta salvo
Define o caminho totalmente qualificado para o arquivo que restaura a resposta à
solicitação de SOAP. Os arquivos existentes são substituídos por uma nova resposta.
Extrair elementos de primeiro nível do conteúdo de resposta de SOAP para variáveis
individuais do conjunto de dados
Salva o elemento do primeiro nível no conteúdo de resposta do SOAP em uma
variável do conjunto de dados separada, caso a resposta do SOAP ultrapasse 12 KB.
Extrair conteúdo de resposta do SOAP para a variável do conjunto de dados
Salva o corpo da resposta em uma variável do conjunto de dados.
Extrair cabeçalho do SOAP para variável do conjunto de dados
Salva o cabeçalho da resposta em uma variável do conjunto de dados.
Extrair os elementos do primeiro nível de cabeçalho SOAP para variáveis de conjuntos
de dados individuais
Salva os cabeçalhos do primeiro nível da resposta em uma variável do conjunto de
dados individual.
Faixa de namespaces XML da resposta
Remove os espaços para nomes de uma resposta para que um usuário possa
fornecer expressões do XPath mais simples para encontrar um valor do elemento
específico. Essa opção está disponível em todos os operadores SOAP.
Capítulo 15: Web Services 487
Operador Solicitar método SOAP
Outros dados extraídos (de resposta completa)
Especifica as expressões do XPath para extrair dados do conteúdo de resposta do
SOAP. Para cada expressão especificada, defina uma variável de conjunto de dados
na qual armazenar os dados extraídos e um tipo de dados. Clique em Adicionar para
adicionar uma expressão, Editar, para modificar uma expressão selecionada ou
Excluir para excluir uma expressão selecionada. A ordem das expressões não faz
diferença para o CA Process Automation.
Cada parâmetro contém os seguintes valores:
Expressão do XPath
Especifica a expressão do XPath.
Variável do conjunto de dados
Especifica o nome de uma variável do conjunto de dados do operador na qual
salvar os valores extraídos com base na expressão do XPath selecionada.
Tipo
Especifica o tipo de elemento a ser extraído da resposta. Selecione um dos
seguintes tipos com suporte no momento:
■
Número inteiro
■
Sequência de caracteres
■
Matriz de número inteiro
■
Matriz de sequência de caracteres
■
Fragmento XML
■
Matriz de fragmento XML
488 Referência do Criador de Conteúdo
Operador Solicitar método SOAP
Anexos de MIME
Se o conteúdo que você deseja enviar já estiver em uma variável do conjunto de dados,
use o campo Expressão.
É uma expressão?
Se selecionada, uma expressão deve resolver o anexo.
Expressão
Define a expressão MIME (Multipurpose Internet Mail Extensions) que extrai o
anexo do conteúdo da resposta do SOAP. Para cada expressão definida, especifique
uma variável de conjunto de dados na qual armazenar os dados extraídos e um tipo
de dados. A ordem das expressões não faz diferença para o CA Process Automation.
Clique em Adicionar para adicionar um anexo, Editar para modificar um anexo
selecionado ou Excluir para excluir um anexo selecionado.
Tipo de conteúdo
Define o tipo de conteúdo do anexo em MIME (por exemplo, texto).
ID do conteúdo
Define o identificador exclusivo do anexo em MIME.
URL do arquivo
Define o URL do anexo em MIME.
Segurança do WS
A segurança dos serviços web (WS) permite que o CA Process Automation realize trocas
de mensagens SOAP seguras com um serviço web que exija mais segurança.
Recursos de segurança do WS:
■
Marcas de data e hora
■
UsernameTokens
■
Assinaturas
■
Criptografia
Observação: os parâmetros de segurança do WS só podem ser definidos nos
operadores. Não há parâmetros de categoria de operador disponíveis para a segurança
do WS.
Após serem definidos, a tag <wsse:Security> do cabeçalho da solicitação de SOAP inclui
os parâmetros a seguir (ou partes dos parâmetros). Em seguida, o serviço da Web:
■
Examina os parâmetros para a autenticação.
■
Verifica se a solicitação de SOAP não foi modificada durante o trânsito entre o
cliente e o servidor.
Capítulo 15: Web Services 489
Operador Solicitar método SOAP
Parâmetros comuns da Segurança do WS
Representante
Define o atributo representante do cabeçalho de <wsse:Security> da solicitação de
SOAP. Se você definir qualquer um dos seguintes atributos, o produto definirá o
atributo representante:
■
Adicionar criptografia
■
Adicionar assinatura
■
Adicionar marca de data e hora
■
Adicionar token de nome de usuário
Observação: deixe esse parâmetro em branco se não for especificado um
representante ou se você usar o SOAP 1.2.
É necessário entender
Se você definir qualquer um dos seguintes atributos, esse parâmetro definirá o
atributo mustUnderstand do cabeçalho de <wsse:Security> como verdadeiro:
■
Adicionar criptografia
■
Adicionar assinatura
■
Adicionar marca de data e hora
■
Adicionar token de nome de usuário
Observação: o atributo mustUnderstand especifica se a entrada do cabeçalho de
<wsse:Security> é obrigatória ou opcional para o destinatário processar.
Marca de data e hora
Adicionar marca de data e hora
Adiciona uma marca de data e hora ao cabeçalho de <wsse:Security> e ativa todos
os parâmetros de marca de data e hora.
Parâmetros de marca de data e hora
Inclui os seguintes valores:
Tempo de vida (s)
Define a diferença de horário entre a criação da solicitação do SOAP e sua
expiração (em segundos). Se você deixar esse campo em branco, o padrão será
0 e o produto não definirá a hora de expiração. Se a marca de data e hora
expirar, o serviço web rejeitará a solicitação do SOAP.
Definir a precisão da marca de data e hora em milissegundos
Se essa opção estiver selecionada, o produto definirá a precisão da marca de
data e hora em milissegundos.
490 Referência do Criador de Conteúdo
Operador Solicitar método SOAP
Token de nome de usuário
Adicionar token de nome de usuário
Adiciona um token de nome de usuário ao cabeçalho de <wsse:Security> e ativa
todos os parâmetros de token de nome de usuário.
Parâmetros de token de nome de usuário
Inclui os seguintes valores:
Nome de usuário
Define o valor do token de nome de usuário.
Senha
Define a senha associada ao token de nome de usuário.
Tipo de senha
Especifica o tipo de senha.
Valores:
■
0: o produto fornece a senha em texto não criptografado.
■
1: o produto fornece a senha em forma de resumo (a senha é
criptografada e não é fornecida em texto não criptografado).
■
2: o produto não fornece senha.
Adicionar nonce?
Se essa opção estiver selecionada, o produto adicionará um elemento nonce
(como um valor de hash) ao token de nome de usuário. O serviço web talvez
não exija esse elemento.
Adicionar item criado?
Se essa opção estiver selecionada, o produto adicionará um elemento Criado
que indica quando o token de nome de usuário foi criado. O serviço web talvez
não exija esse elemento.
Observação: se você definir o Tipo de senha como Resumo, o produto
automaticamente adicionará os elementos Nonce e Criado ao token de nome de
usuário.
Parâmetros de armazenamento de chaves
Ao assinar ou criptografar uma solicitação de SOAP, o produto exige muitas chaves para
processar várias responsabilidades. O produto usa chaves na Segurança do WS para
assinar ou criptografar a solicitação de SOAP e para validar a assinatura ou a
descriptografia da resposta do SOAP (se aplicável).
Capítulo 15: Web Services 491
Operador Solicitar método SOAP
O CA Process Automation usa um armazenamento de chaves (um repositório de
certificados de segurança) para manter as chaves usadas na Segurança do WS. Os
armazenamentos de chaves fornecem organização e consolidação de chaves e impedem
que outros usuários acessem as chaves particulares exclusivas. O produto exige que
você crie um armazenamento de chaves (na página 492) ou use um existente.
A Segurança do WS inclui as seguintes opções de armazenamento de chaves:
■
Assinar a solicitação de SOAP (ou partes dela). O armazenamento de chaves contém
os seguintes itens:
–
A chave privada a ser usada para assinar a solicitação.
–
A chave pública associada com a qual o receptor valida a assinatura. O produto
adiciona uma referência a essa chave pública à solicitação do SOAP assinada.
■
Criptografar a solicitação de SOAP (ou partes dela). O armazenamento de chaves
contém a chave pública para criptografar a chave simétrica. O produto usa a chave
simétrica para criptografar a solicitação.
■
Validar a assinatura da resposta de SOAP. O armazenamento de chaves contém a
chave pública para validar a assinatura (se aplicável).
■
Descriptografar a resposta de SOAP. O armazenamento de chaves contém a chave
privada para descriptografar a resposta.
Os parâmetros a seguir definem o armazenamento de chaves para assinar ou
criptografar uma solicitação de SOAP:
Caminho do armazenamento de chaves de criptografia/assinatura
Define o caminho para o armazenamento de chaves.
Senha do armazenamento de chaves de criptografia/assinatura
Define a senha em texto não criptografado para acessar o armazenamento de
chaves.
Observação: esse parâmetro não é a senha para acessar uma chave privada do
armazenamento de chaves, mas, em vez disso, a senha para acessar o próprio
armazenamento de chaves.
Tipo de armazenamento de chaves de criptografia/assinatura
Especifica o tipo de armazenamento de chaves.
Valores:
■
JKS
■
PKCS12 (que geralmente tem uma extensão .p12)
■
Em branco (o produto usará o valor padrão)
Padrão: JKS.
Criar um armazenamento de chaves
492 Referência do Criador de Conteúdo
Operador Solicitar método SOAP
Você pode usar uma ferramenta de terceiros para criar seu armazenamento de chaves
ou importar novos certificados/chaves privadas para um armazenamento de chaves
existente. Uma ferramenta de gerenciamento de armazenamento de chaves é Keytool,
fornecido com o Java JRE ou JDK. Alguns comandos de Keytool podem ser encontradas
aqui:
■
http://download.oracle.com/javase/1,5.0/docs/tooldocs/solaris/keytool.html
■
http://download.oracle.com/javase/1,5.0/docs/tooldocs/windows/keytool.html
Você também pode executar:
keytool –help
Assinatura
Adicionar assinatura
Se essa opção estiver selecionada, o produto assinará a solicitação de SOAP e
adicionará uma assinatura ao cabeçalho de <wsse:Security>. Uma chave privada no
armazenamento de chaves assina o conteúdo da solicitação de SOAP. O produto
também ativa todos os campos de Parâmetros de assinatura.
Parâmetros de assinatura
Os parâmetros a seguir definem a assinatura:
Alias de chave privada
Define o alias da chave no armazenamento de chaves que o produto usará para
assinatura.
Senha da chave privada
Define a senha da chave no armazenamento de chaves.
Algoritmo de conversão em formato canônico
Define o método de conversão em formato canônico que é usado para
serializar os dados (corpo da solicitação de SOAP ou partes especificadas para
serem assinadas) antes de aplicar a assinatura. Deixe esse campo em branco
para usar o algoritmo de conversão em formato canônico XML exclusivo
padrão xml-exc-c14n#.
Algoritmo de assinatura
Define o algoritmo para definir a assinatura. Deixe esse campo em branco se
desejar que o produto tente detectar e usar um algoritmo de assinatura que
corresponda aos dados na chave.
Capítulo 15: Web Services 493
Operador Solicitar método SOAP
Tipo de identificador de chave pública'
Especifica o identificador de chave que configura os elementos de identificação
(chave pública) do certificado na assinatura. O receptor usa esse valor para
identificar o certificado de assinatura (chave pública) que valida a assinatura da
solicitação de SOAP.
Valores:
■
1 (Token de segurança binário): o produto adiciona
<wsse:SecurityTokenReference> ao elemento de assinatura. O elemento
de assinatura usa um fragmento de URI em um elemento
<wsse:Reference> para fazer referência ao certificado de assinatura (chave
pública). O fragmento de URI faz referência à chave pública da assinatura.
O produto inclui a chave pública da assinatura como dados binários no
elemento <wsse:BinarySecurityToken> de cabeçalho de <wsse:Security>.
■
2 (Nome do emissor e número de série): o produto adiciona
<wsse:SecurityTokenReference> ao elemento de assinatura. O elemento
de assinatura usa um elemento <ds:X509Data><ds:X509:IssuerSerial> para
fazer referência ao certificado de assinatura (chave pública). Esse
elemento identifica de maneira exclusiva um certificado por seu nome de
emissor X.509 e seu número de série.
■
3 (Identificador de certificado X509): o produto adiciona
<wsse:SecurityTokenReference> ao elemento de assinatura. O elemento
de assinatura usa um elemento <wsse:KeyIdentifier
ValueType="oasis-200401-wss-x509-token-profile-1.0#X509v3"> para fazer
referência ao certificado de assinatura (chave pública).
■
4 (Identificador de assunto principal): o produto adiciona
<wsse:SecurityTokenReference> ao elemento de assinatura. O elemento
de assinatura usa um elemento <wsse:KeyIdentifier
ValueType="#oasis-200401-wss-x509-token-profile-1.0#X509SubjectKeyIde
ntifier"> para fazer referência ao certificado de assinatura (chave pública).
Padrão: 0. O operador usa o identificador de chave padrão (Nome do emissor e
número de série) da implementação.
494 Referência do Criador de Conteúdo
Operador Solicitar método SOAP
Partes para assinar
Especifica as partes da solicitação do SOAP a serem assinadas. Clique em
Adicionar parâmetro para inserir uma ID de segurança ou uma combinação de
Nome/espaço para nome do elemento a ser assinado.
Valores:
■
ID do WSU: define o atributo wsu:id do elemento a ser assinado. Você
pode adicionar wsu:id como um atributo de um elemento na solicitação
SOAP, além de poder especificar seu próprio valor. Por exemplo:
<token wsu:id="123"> </token>
A instrução a seguir mostra a definição do espaço para nome do WSU:
xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200
401-wss-wssecurity-utility-1,0.xsd"
■
Nome: define o nome do elemento a ser assinado.
■
Espaço para nome: define o URI do espaço para nome (não o nome local
do espaço para nome) do elemento a ser assinado. Por exemplo:
"http://www.ca.com/itpam"
Observação: deixe esse parâmetro em branco para assinar o corpo da
solicitação de SOAP. Se você especificar a ID do WSU, o produto ignora os
valores Nome e Espaço para nome.
Criptografia
Adicionar criptografia
Criptografa a solicitação de SOAP e adiciona uma nova chave simétrica
criptografada ao cabeçalho de <wsse:Security> da solicitação de SOAP. O CA
Process Automation usa uma chave simétrica para criptografar o conteúdo da
solicitação do SOAP. O certificado (chave pública), fornecida no armazenamento de
chaves, criptografa a própria chave simétrica e a inclui no cabeçalho
<wsse:Security>. Se esse campo for selecionado, todos os campos de Parâmetros de
criptografia serão ativados.
Parâmetros de criptografia
Os parâmetros a seguir definem a criptografia:
Alias de chave pública
Define o alias do certificado (chave pública) que deve ser usado para
criptografar a chave simétrica no armazenamento de chaves.
Algoritmo de conversão em formato canônico
Define o método de conversão em formato canônico usado para serializar os
dados antes de aplicar a criptografia. Deixe esse campo em branco para usar
uma serialização padrão.
Capítulo 15: Web Services 495
Operador Solicitar método SOAP
Algoritmo de criptografia simétrica
Especifica o tipo de algoritmo simétrico para criptografar os dados.
Valores:
■
Tripledes-cbc: usar DES triplo. Esse método usa uma chave com 8 bytes 24 bits.
■
aes128-cbc: usar AES com uma chave de 128 bits.
■
aes192-cbc: usar AES com uma chave de 192 bits.
■
aes256-cbc: usar AES com uma chave de 256 bits.
Padrão: AES128
Observação: se definir este parâmetro como aes192-cbc ou aes256-cbc, o
seguinte erro pode ocorrer:
Tamanho de chave inválido ou parâmetros padrão.
Se esse erro ocorrer, faça download dos seguintes arquivos de diretiva de
jurisdição de força ilimitada do JCE (Java Cryptography Extension - Extensão de
Criptografia Java) no site da Oracle:
■
US_export_policy.jar
■
local_policy.jar
Substitua os jars existentes com o mesmo nome em
C:path_to_JRE_used_by_PAM\lib\security pelos novos.
Criptografar a chave simétrica?
Criptografa a chave simétrica com a qual os dados foram criptografados. O
produto, em seguida, inclui a chave no cabeçalho de
<wsse:security><xenc:EncryptedKey>.
Algoritmo de criptografia de chave simétrica
Define o algoritmo de compilação que deve ser usado para criptografar a chave
simétrica. Esse parâmetro é aplicável somente se a chave precisar ser
criptografada.
Padrão: RSA15.
496 Referência do Criador de Conteúdo
Operador Solicitar método SOAP
Tipo de identificador de chave pública'
Especifica o identificador de chave que configura os elementos de identificação
(chave pública) do certificado no elemento <xenc:EncryptedKey>. O receptor
usa a chave privada que corresponde a esse certificado (chave pública) para
descriptografar a chave simétrica. O produto, em seguida, usa a chave
simétrica para criptografar a solicitação de SOAP.
Valores:
■
1 (Token de segurança binário): o produto adiciona
<wsse:SecurityTokenReference> ao elemento <xenc:EncryptedKey>. O
elemento <xenc:EncryptedKey> usa um fragmento de URI em um
elemento <wsse:Reference> para fazer referência ao certificado (chave
pública). O fragmento de URI faz referência à chave pública. O produto
inclui a chave pública como dados binários no elemento
<wsse:BinarySecurityToken> de cabeçalho de <wsse:Security>.
■
2 (Nome do emissor e número de série): o produto adiciona
<wsse:SecurityTokenReference> ao elemento <xenc:EncryptedKey>. O
elemento <xenc:EncryptedKey> usa um elemento
<ds:X509Data><ds:X509:IssuerSerial> para fazer referência ao certificado
(chave pública). Esse elemento identifica de maneira exclusiva um
certificado por seu nome de emissor X.509 e seu número de série.
■
3 (Identificador de certificado X509): o produto adiciona
<wsse:SecurityTokenReference> ao elemento <xenc:EncryptedKey>. O
elemento <xenc:EncryptedKey> usa um elemento <wsse:KeyIdentifier
ValueType="oasis-200401-wss-x509-token-profile-1.0#X509v3"> para fazer
referência ao certificado (chave pública).
■
4 (Identificador de assunto principal): o produto adiciona
<wsse:SecurityTokenReference> ao elemento <xenc:EncryptedKey>. O
elemento <xenc:EncryptedKey> usa um elemento <wsse:KeyIdentifier
ValueType="#oasis-200401-wss-x509-token-profile-1.0#X509SubjectKeyIde
ntifier"> para fazer referência ao certificado (chave pública).
■
8 (Identificador de SHA1 de impressão digital): o produto adiciona
<wsse:SecurityTokenReference> ao elemento <xenc:EncryptedKey>. O
elemento <xenc:EncryptedKey> usa um elemento <wsse:KeyIdentifier
ValueType="#oasis-wss-soap-message-security-1.1#ThumbprintSHA1">
para fazer referência ao certificado (chave pública).
Padrão: 0. O operador usa o identificador de chave padrão (Nome do emissor e
número de série) da implementação.
Capítulo 15: Web Services 497
Operador Solicitar método SOAP
Parts para criptografar
Especifica as partes da solicitação do SOAP a serem criptografadas. Clique em
Adicionar parâmetro para inserir uma ID de segurança (ID do WSU) ou uma
combinação de Nome/espaço para nome do elemento a ser criptografado.
Valores:
■
ID do WSU: define o atributo wsu:id do elemento a ser criptografado. Você
pode adicionar wsu:id como um atributo de um elemento na solicitação
SOAP, além de poder especificar seu próprio valor. Por exemplo:
<token wsu:id="123"> </token>
A instrução a seguir mostra a definição do espaço para nome do WSU:
xmlns:wsu=http://docs.oasis-open.org/wss/2004/01/oasis-2004
01-wss-wssecurity-utility-1.0.xsd
■
Nome: define o nome do elemento a ser criptografado.
■
Espaço para nome: define o URI do espaço para nome (não o nome local
do espaço para nome) do elemento a ser criptografado. Por exemplo:
http://www.ca.com/pam
■
Codificação: selecione Conteúdo para criptografar o conteúdo do
elemento ou Elemento para criptografar todo o elemento.
Observação: deixe esse campo em branco para criptografar o conteúdo do
corpo da solicitação do SOAP. Se você especificar a ID do WSU, o produto
ignora os valores Nome e Espaço para nome.
Assinatura primeiro?
Especifica se é necessário aplicar a assinatura antes de criptografar os dados. Esse
parâmetro é útil se o produto criptografar e assinar os mesmos dados na solicitação
do SOAP.
Descriptografar e validar assinatura da resposta SOAP
Especifica se é necessário descriptografar o conteúdo da resposta do SOAP (se
aplicável) e valida a assinatura. Quando essa opção é selecionada, o produto ativa o
parâmetro Senha da chave privada de descriptografia.
Senha da chave privada de descriptografia
Define a senha para acessar a chave privada de descriptografia no armazenamento
de chaves. Use essa senha para acessar a chave privada a ser usada para
descriptografar uma resposta do SOAP criptografada.
Processo de criptografia/assinatura para a solicitação do SOAP
O operador Solicitar método SOAP e o operador Chamar método SOAP assíncrono
assinam ou criptografam todo ou parte do corpo da solicitação do SOAP.
498 Referência do Criador de Conteúdo
Operador Solicitar método SOAP
Criptografia
1.
O CA Process Automation usa o Algoritmo de conversão em formato canônico
para serializar os dados a serem criptografados. Esses dados incluem o corpo
inteiro da solicitação ou as partes especificadas em Partes para criptografar.
2.
O CA Process Automation usa uma chave simétrica (dependendo do Algoritmo
de criptografia simétrica) para criptografar os dados. Esses dados incluem o
corpo inteiro da solicitação ou as partes especificadas em Partes para
criptografar.
3.
O CA Process Automation usa o Alias de chave pública para recuperar a chave
pública do alias do armazenamento de chaves. A chave pública, em seguida,
usa o algoritmo especificado no Algoritmo de criptografia de chave simétrica
para criptografar a chave simétrica.
4.
O CA Process Automation adiciona a chave simétrica criptografada à a
solicitação do SOAP no elemento <xenc:EncryptedKey>.
5.
Dependendo do tipo de referência especificado no Tipo de identificador de
chave pública, o CA Process Automation adiciona à solicitação do SOAP uma
referência à chave pública usada para criptografar a chave simétrica.
6.
O receptor descriptografa a chave simétrica e, em seguida, usa a chave
simétrica descriptografada para descriptografar a solicitação do SOAP.
Assinatura
1.
O CA Process Automation usa o Alias de chave privada e a Senha da chave
privada para recuperar a chave privada do armazenamento de chaves.
2.
O CA Process Automation usa o Algoritmo de conversão em formato canônico
para serializar os dados a serem assinados. Esses dados incluem o corpo inteiro
da solicitação ou as partes especificadas em Partes para assinar.
3.
O CA Process Automation usa a chave privada do armazenamento de chaves
para assinar o conteúdo da solicitação do SOAP usando o Algoritmo de
assinatura que o usuário especificar. O produto assina o corpo da solicitação
inteiro ou as partes especificadas em Partes para assinar.
4.
O CA Process Automation adiciona à solicitação do SOAP uma referência ao
certificado/chave pública associada à chave privada. O usuário especifica o tipo
de referência no Tipo de identificador de chave pública.
5.
O receptor usa a chave pública para validar a assinatura na solicitação do SOAP.
Solução de problemas da segurança do WS
Os operadores Solicitar método SOAP e Chamar método SOAP assíncrono poderão
falhar quando a Segurança do WS for aplicada nos casos a seguir.
Capítulo 15: Web Services 499
Operador Solicitar método SOAP
Não é possível criar uma criptografia para gerenciar o armazenamento de chaves
Uma mensagem de erro será exibida se o operador não puder criar uma criptografia
para gerenciar o armazenamento de chaves:
Falha ao chamar o SOAP: não é possível criar uma criptografia para o armazenamento
de chaves que contém as chaves de assinatura/criptografia…
Esse erro pode ser causado por:
■
Senha incorreta do armazenamento de chaves
■
Tipo incorreto de armazenamento de chaves
■
O caminho do armazenamento de chaves aponta para um arquivo que não é um
armazenamento de chaves.
Monitore os logs do CA Process Automation, na pilha de erros, para obter uma
indicação da natureza do problema. Por exemplo:
■
Senha incorreta do armazenamento de chaves: o armazenamento de chaves foi
violado ou a senha estava incorreta.
■
Tipo incorreto de armazenamento de chaves: java.security.KeyStoreException: x
não encontrado (em que x é o tipo fornecido)
■
O caminho do armazenamento de chaves aponta para um arquivo que não é um
armazenamento de chaves: formato de armazenamento de chaves inválido
Erros de assinatura
Ao ser assinada a solicitação do SOAP, podem ocorrer problemas quando:
■
O caminho do armazenamento de chaves não existe no computador que contém o
touchpoint.
■
O caminho do armazenamento de chaves está ausente.
■
O alias da chave privada está ausente.
■
Você tenta assinar uma parte inexistente da solicitação do SOAP. O motivo pelo
qual o campo contém uma mensagem:
Elemento para criptografar/assinar não encontrado…
■
O alias da chave privada não existe no armazenamento de chaves. O motivo pelo
qual o campo contém uma mensagem:
Nenhum certificado para o usuário x foi encontrado para assinatura…
Em que x é o alias da chave privada fornecida.
■
A senha da chave privada é necessária, mas não foi fornecida, ou a senha fornecida
está incorreta. O motivo contém uma mensagem:
Não é possível recuperar a chave…
500 Referência do Criador de Conteúdo
Operador Solicitar método SOAP
■
Você forneceu um algoritmo de conversão em formato canônico incorreto. O
motivo pelo qual o campo contém uma mensagem:
Conversão em formato canônico desconhecido. Nenhum manipulador instalado para o
URI x…
Em que x é o nome do algoritmo de conversão em formato canônico fornecido.
■
Você forneceu um algoritmo de assinatura incorreto. O motivo pelo qual o campo
contém uma mensagem:
O algoritmo x solicitado não existe...
Em que x é o nome do algoritmo de assinatura fornecido.
■
Você forneceu um tipo de identificador de chave pública incorreto. O motivo pelo
qual o campo contém uma mensagem:
Identificação de chave sem suporte…
Erros de criptografia
Ao ser criptografada a solicitação do SOAP, podem ocorrer problemas quando:
■
O caminho do armazenamento de chaves não existe no computador que contém o
touchpoint.
■
O caminho do armazenamento de chaves está ausente.
■
Você tenta criptografar uma parte inexistente da solicitação do SOAP. O motivo
pelo qual o campo contém uma mensagem:
Elemento para criptografar/assinar não encontrado…
■
Você tenta usar o algoritmo de criptografia simétrica aes192-cbc ou aes256-cbc
sem atualizar para os jars de diretiva de jurisdição de força ilimitada. O motivo pelo
qual o campo contém uma mensagem:
Tamanho de chave inválido ou parâmetros padrão.
■
O alias da chave pública não existe no armazenamento de chaves. O motivo pelo
qual o campo contém uma mensagem:
Nenhum certificado para o usuário x foi encontrado para criptografia…
Em que x é o alias da chave pública fornecida.
■
Você forneceu um algoritmo de criptografia incorreto. O motivo pelo qual o campo
contém uma mensagem:
Falha ao chamar o SOAP: não é possível criptografar message.null do SOAP.
A biblioteca WSS4J aciona um erro de ponteiro nulo nesse caso.
Capítulo 15: Web Services 501
Operador Solicitar método SOAP
■
Você forneceu um algoritmo de criptografia de chave simétrica incorreto. O motivo
pelo qual o campo contém uma mensagem:
algoritmo de criptografia de transporte de chave sem suporte: x
Em que x é o algoritmo de criptografia de chave simétrica fornecido.
■
Você forneceu um tipo de identificador de chave pública incorreto. O motivo pelo
qual o campo contém uma mensagem:
Identificação de chave sem suporte…
Observação: se você estiver criptografando uma parte da solicitação do SOAP e, depois,
assinando-a, não deixe de criptografá-la como conteúdo. Essa ação garante que seu
wsu:id (ou nome e espaço para nome) permaneça na solicitação SOAP após a
criptografia e antes da assinatura. Do contrário, essa parte não será encontrada durante
a tentativa de assiná-la.
Erros de descriptografia
Uma senha incorreta especificada no campo Senha da chave privada de descriptografia
causa a falha do operador. O motivo pelo qual o campo contém uma mensagem:
Não é possível aplicar a segurança do WSS na mensagem de entrada (resposta do SOAP).
A assinatura ou a descriptografia é inválida. A exceção aninhada é: java.security.
UnrecoverableKeyException: falha ao obter chave:
O bloco final fornecido não está corretamente preenchido.
Parâmetros de saída
O operador Chamar método SOAP tem os seguintes parâmetros de saída.
Dados de chamada SOAP
serviceURL
Retonar o URL do serviço que a chamada de SOAP usa.
methodName
Retorna o nome do método a ser chamado.
502 Referência do Criador de Conteúdo
Operador Solicitar método SOAP
userName
Retorna o nome de usuário para autenticação HTTP básica.
password
Retorna a senha para autenticação HTTP básica.
httpAuth
Exibe verdadeiro ou falso, dependendo da seleção de Usar autenticação básica
HTTP? .
soapVersion
Retorna a versão do SOAP que o produto usa para fazer chamadas SOAP,
independentemente se for SOAP 1.1 ou SOAP 1.2.
inputSource
Retorna um dos seguintes valores para a entrada de origem da chamada de SOAP:
■
InlineText
■
Arquivo SOAP pré-formatado
■
Expressão
inlineText
Retorna os dados de texto embutido que serão usados para a chamada de SOAP.
Essa variável é preenchida apenas quando você seleciona Registro de Texto
embutido como a origem de entrada.
Exemplo:
<checkServerStatus xmlns="http://www.ca.com/itpam">
CA AuthMinder
<token>token__</token>
<user>usuário__</user>
<password>senha__</password>
</auth>
</checkServerStatus>
FileName
Retorna os dados de texto embutido que serão usados para a chamada de SOAP.
Essa variável só é preenchida quando se seleciona Arquivo SOAP pré-formatado
como a origem de entrada.
Capítulo 15: Web Services 503
Operador Solicitar método SOAP
valor |
Retorna os dados de texto embutido que serão usados para a chamada de SOAP.
Essa variável só é preenchido quando você seleciona como a origem de entrada de
expressão.
SavedCallFileName
Retorna o nome do arquivo no campo Arquivo de chamada salvo. Este arquivo
contém o número real de envelope SOAP que o produto usa para fazer uma
chamada de SOAP.
Exemplo:
<?xml version="1.0" encoding="UTF-8"?><SOAP-ENV:Envelope
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><SOAP-ENV
:Header/><SOAP-ENV:Body><checkServerStatus
xmlns="http://www.ca.com/itpam">
CA
AuthMinder<token>token__</token><user>user__</user><password>pa
ssword__</password></auth></checkServerStatus></SOAP-ENV:Body><
/SOAP-ENV:Envelope>
Parâmetros dinâmicos
Paramsyle
Retorna o estilo de parâmetro selecionado no campo Parâmetro dinâmico:
Atribuições do XPath ou MacroExpansion.
DynamicParamsInfo
Uma matriz de mapas de valores; exibe o número de mapas de valores que ela
contém.
DynamicParamsdata
Retorna a consulta, o valor e o tipo.
Parâmetros da opção Resultados da chamada
responseFileName
Retorna o nome de arquivo fornecido no campo Arquivo de resposta. Este arquivo
contém a resposta recebida de uma chamada de SOAP.
xPathQuery
Retorna a consulta XPath para extrair os dados dos resultados de chamada.
504 Referência do Criador de Conteúdo
Operador Solicitar método SOAP
datasetVar
Retorna a variável que é criada para armazenar os resultados de chamada
extraídos.
Tipo
Retorna a variável que contém o tipo de dados que o usuário definiu para
armazenar os resultados de chamada.
isExtractToDataSet
Retorna verdadeiro quando você marcar Extrair conteúdo de resposta do SOAP
para a variável do conjunto de dados ou, caso contrário, retorna falso.
isExtractHeadersToDataSet
Retorna verdadeiro quando você marcar Extrair cabeçalho do SOAP para variável do
conjunto de dados ou, caso contrário, retorna falso.
isExtractHeadersToIndividualDataSet
Retorna verdadeiro quando você marcar Extrair elementos de primeiro nível do
cabeçalho do SOAP para variáveis individuais do conjunto de dados ou, caso
contrário, retorna falso.
isExtractToIndividualDataSet
Retorna verdadeiro quando você marcar Extrair elementos de primeiro nível do
cabeçalho do SOAP para variáveis individuais do conjunto de dados ou, caso
contrário, retorna falso.
isStripXMLNamespaces
Retorna verdadeiro quando você marcar Faixa de namespaces XML da resposta ou,
caso contrário, retorna falso.
Resultados da operação
Os resultados da operação retornam a saída dos resultados de chamada de SOAP,
dependendo dos parâmetros Resultados da chamada selecionados.
SOAPResponseBody
Armazena todo o conteúdo de resposta do SOAP.
SOAPResponseHeaderData
Armazena o cabeçalho de resposta.
SoapResponseHeader
Retorna os dados eliminados do cabeçalho de resposta do SOAP.
SOAPResponseData
Retorna os dados eliminados dos resultados de chamada de SOAP.
Capítulo 15: Web Services 505
Operador Solicitar método SOAP
Anexos de MIME
isResolvedByExpression
Retorna verdadeiro quando você marcar a opção É uma expressão? para o anexo
em MIME ou, caso contrário, retorna falso. A seleção da opção É uma expressão?
indica que o anexo em MIME é fornecido como uma expressão e que essa
expressão refere-se ao anexo em MIME.
Expressionfield
Retorna a expressão que se refere ao anexo em MIME.
attachmentFields
Retorna uma matriz de mapa de valores com o número de elementos que ela
contém.
Tipo de conteúdo
Retorna o tipo de conteúdo do anexo em MIME.
contentID
Retorna a ContentID com a qual o anexo em MIME é identificado de forma
exclusiva.
fileURL
Retorna o caminho do anexo em MIME.
506 Referência do Criador de Conteúdo
Operador Chamar método SOAP assíncrono
Operador Chamar método SOAP assíncrono
O operador Chamar método SOAP assíncrono oferece suporte a métodos assíncronos
de serviços web com base em SOAP. Nesse caso, o operador envia uma mensagem de
maneira assíncrona a um receptor, esperando uma resposta posteriormente. O
remetente marca a solicitação com um identificador, permitindo que resposta seja
correlacionada com solicitação que a originou. Esse operador é usado e configurado de
maneira muito semelhante ao operador Solicitar método SOAP.
Parâmetros de entrada
O operador Chamar método SOAP assíncrono oferece os seguintes parâmetros de
entrada:
Capítulo 15: Web Services 507
Operador Chamar método SOAP assíncrono
WSDL Explorer
Assistente do WSDL
Um assistente que permite selecionar métodos de SOAP. Clique para abrir a janela
do Explorer do WSDL, onde é possível digitar:
URL da WSDL
■
Digite um URL do WSDL, em seguida, clique em Carregar. Exemplos:
http://server:8080/itpam/soap?wsdl
https://server:8443/itpam/soap?wsdl
■
Selecione um URL do WSDL digitado recentemente na lista suspensa e, em
seguida, clique em Carregar.
Observação: a lista suspensa do URL do WSDL contém as últimas dez entradas
aplicadas.
O assistente preenche os campos restantes. Revise, conforme necessário,
selecionando outras entradas nas listas suspensas e, em seguida, clique em Aplicar.
Serviços do WSDL
Portas do WSDL
Operações do WSDL
■
Use a entrada padrão que foi carregada
■
Selecione uma entrada na lista suspensa.
Para obter detalhes sobre os métodos de serviços web listados, consulte a
Referência da API de serviços web.
Área de resposta, por exemplo:
<tns:AsyncSoapResponse xmlns:tns="http://www.ca.com/itpam">
<tns:MessageID>MessageID__</tns:MessageID>
<!--xsd:Qualquer tipo aqui-->
</tns:AsyncSoapResponse>
Propriedades da opção Dados de chamada de SOAP
URL de serviço
Especifica o URL para o serviço SOAP. O URL é geralmente acessado por HTTP ou
HTTPS. Em geral, ele é um ponto de entrada para um ou mais métodos.
Nome do método
Define o método ou a função a ser iniciada. O produto passa o método para o
serviço SOAP como um cabeçalho MIME SOAPAction.
508 Referência do Criador de Conteúdo
Operador Chamar método SOAP assíncrono
Tipo de autenticação
Especifica um dos seguintes tipos de autenticação que deve ser usado para chamar
o servidor SOAP:
Sem autenticação
Não autenticar.
SOAP básico
Use o nome de usuário autorizado e a senha para a autenticação de SOAP
básico.
Autenticação HTTP
Use o nome de um usuário autorizado e a senha para autenticação HTTP básica
se esse recurso estiver ativado. A Segurança do WS se aplica se o usuário
fornecê-la na página de entrada da Segurança do WS (na página 490).
Autenticação NTLM
Use o nome de usuário autorizado, a senha e o nome do domínio para se
conectar ao servidor SOAP com autenticação NTLM.
Importante: o nome de usuário, a senha e o nome de domínio fornecidos são
aqueles para o servidor do serviço web do SOAP.
Versão do SOAP
Especifica a versão do servidor SOAP que o produto usa para fazer chamadas SOAP,
independentemente se for SOAP 1.1 ou SOAP 1.2. Essa opção fornece uma dica
para a lógica subjacente que usa o SOAP MessageFactory apropriado para fazer a
solicitação de SOAP.
Origem da entrada
Especifica a origem de entrada do serviço de SOAP. Cada um dos seguintes métodos
inclui uma mensagem em XML completa, devidamente formatada, que pode incluir
um envelope SOAP:
Texto embutido
O operador Chamada do cliente SOAP define a solicitação de entrada. Se você
selecionar essa opção, use a opção Texto embutido para especificar a
mensagem de entrada SOAP formatada.
Arquivo SOAP pré-formatado
Um arquivo SOAP pré-formatado define a solicitação de entrada. Se você
selecionar essa opção, especifique o caminho para o arquivo no campo Nome
do arquivo. Verifique se o arquivo contém uma mensagem em um documento
XML válido.
Capítulo 15: Web Services 509
Operador Chamar método SOAP assíncrono
Expressão
Uma expressão do CA Process Automation define a solicitação de SOAP. Se
você selecionar essa opção, especifique a expressão do CA Process Automation
no campo Expressão.
A solicitação de entrada pode conter macros e atribuições XPath que
dinamicamente modificam a solicitação SOAP em tempo de execução. Essas macros
e atribuições do XPath permitem que o produto atualize a solicitação de SOAP, se
necessário, com valores obtidos em tempo de execução.
Texto embutido
Clique em (...) para abrir a caixa de diálogo Texto embutido se você definir Origem
da entrada como Texto embutido. Digite uma mensagem de entrada SOAP
formatada. Para ler uma mensagem SOAP a partir de um arquivo de texto em uma
unidade local ou de rede, clique em Importar a partir do arquivo na caixa de diálogo
Texto embutido.
Nome de arquivo
Define o nome totalmente qualificado do arquivo relativo ao touchpoint que estiver
executando os operadores Serviços web. O produto usa esta propriedade quando
você definir a Origem da entrada como Arquivo SOAP pré-formatado.
Expressão
Especifica uma expressão do CA Process Automation da qual extrair a solicitação
SOAP.
Arquivo de chamada salvo
Define o caminho completo para o envelope SOAP que o produto usa para fazer
uma chamada de SOAP. Use esta opção para validar o envio dos dados para os
operadores de Serviços web pelo produto. Se a solicitação de SOAP for rejeitada, o
arquivo salvo poderá ajudar a depurar a solicitação antes de enviá-la novamente
aos operadores Serviços web.
510 Referência do Criador de Conteúdo
Operador Chamar método SOAP assíncrono
Parâmetros dinâmicos
Os parâmetros dinâmicos especificam os valores para atualizar em uma solicitação
SOAP.
Estilo do parâmetro
Especifica o método usado pela Lista de parâmetros para atualizar os valores em
uma solicitação de SOAP em tempo de execução.
Expansão de macro
A Lista de parâmetros usa macros para atualizar os valores em uma solicitação
de SOAP.
Atribuições do XPath
A Lista de parâmetros usa expressões do XPath para atualizar os valores em
uma solicitação de SOAP.
Lista de parâmetros
Especifica os parâmetros que especificam as entradas de dados exclusivo na
solicitação SOAP. Clique em Adicionar para adicionar um parâmetro, Editar para
editar o parâmetro selecionado no momento, ou Excluir para excluir o parâmetro
selecionado no momento. A melhor prática é adicionar os parâmetros na ordem
especificada pelo WSDL para a chamada de SOAP.
Para abrir a caixa de diálogo Parâmetros dinâmicos, clique em Adicionar ou Editar e
defina os seguintes valores de parâmetros:
X-Path do nome da macro
Define o nome da macro ou a consulta XPath usada para extrair dados do
conteúdo de resposta do SOAP.
■
Se o parâmetro definir um nome de macro, o valor substituirá o nome da
macro.
■
Se o parâmetro definir uma consulta XPath, o valor atualizará o nó que a
consulta retorna.
Valor
Define uma expressão que retorna um valor de tempo de execução para o
parâmetro.
Tipo
Especifica um dos seguintes tipos de dados para o parâmetro:
■
Valor de número inteiro
■
Valor de sequência de caracteres
■
Fragmento XML
Capítulo 15: Web Services 511
Operador Chamar método SOAP assíncrono
Propriedades de resultados da chamada
Os parâmetros a seguir da opção Resultados da chamada determinam como salvar os
resultados de uma chamada de SOAP.
Arquivo de resposta salvo
Especifica o caminho totalmente qualificado para o arquivo que restaura a resposta
à solicitação de SOAP. A nova resposta substitui um arquivo de resposta existente.
Extrair elementos de primeiro nível de resposta de SOAP para variáveis individuais do
conjunto de dados
Se a resposta do SOAP ultrapassar 12 KB, esse parâmetro salvará o elemento do
primeiro nível no conteúdo de resposta do SOAP em uma variável do conjunto de
dados separada.
Extrair conteúdo de resposta do SOAP para a variável do conjunto de dados
Salva o conteúdo de resposta em uma variável do conjunto de dados.
Extrair cabeçalho do SOAP para variável do conjunto de dados
Salva o cabeçalho da resposta em uma variável do conjunto de dados.
Extrair elementos de primeiro nível do cabeçalho do SOAP para variáveis individuais
do conjunto de dados
Salva o cabeçalho da resposta em variáveis individuais do conjunto de dados.
Faixa de namespaces XML da resposta
Elimina os espaços para nome XML da resposta, de modo que você não precise usar
a função de nome local ().
Outros dados extraídos (de resposta completa)
Define expressões do XPath para extrair dados do conteúdo de resposta do SOAP.
Para cada expressão especificada, especifique um tipo de dados e uma variável do
conjunto de dados na qual armazenar os dados extraídos. Clique em Adicionar para
adicionar uma expressão, Editar para editar uma expressão selecionada ou Excluir
para excluir uma expressão selecionada. A ordem de expressões não faz diferença
para o CA Process Automation.
512 Referência do Criador de Conteúdo
Operador Chamar método SOAP assíncrono
Para modificar os parâmetros a seguir, clique em Adicionar ou em Editar:
Expressão do XPath
Define a expressão do XPath.
Variável do conjunto de dados
Define o nome de uma variável do conjunto de dados do operador na qual salvar os
valores extraídos com base na expressão do XPath selecionada.
Tipo
Especifica o tipo de elemento a ser extraído da resposta:
■
Número inteiro
■
Sequência de caracteres
■
Matriz de número inteiro
■
Matriz de sequência de caracteres
■
Fragmento XML
■
Matriz de fragmento XML
Anexos de MIME
Se o conteúdo que você deseja enviar já estiver em uma variável do conjunto de dados,
use o campo Expressão.
É uma expressão?
Se selecionada, uma expressão deve resolver o anexo.
Expressão
Define a expressão MIME (Multipurpose Internet Mail Extensions) que extrai o
anexo do conteúdo da resposta do SOAP. Para cada expressão definida, especifique
uma variável de conjunto de dados na qual armazenar os dados extraídos e um tipo
de dados. A ordem das expressões não faz diferença para o CA Process Automation.
Clique em Adicionar para adicionar um anexo, Editar para modificar um anexo
selecionado ou Excluir para excluir um anexo selecionado.
Tipo de conteúdo
Define o tipo de conteúdo do anexo em MIME (por exemplo, texto).
ID do conteúdo
Define o identificador exclusivo do anexo em MIME.
URL do arquivo
Define o URL do anexo em MIME.
Capítulo 15: Web Services 513
Operador Chamar método SOAP assíncrono
Segurança do WS
A segurança dos serviços web (WS) permite que o CA Process Automation realize trocas
de mensagens SOAP seguras com um serviço web que exija mais segurança.
Recursos de segurança do WS:
■
Marcas de data e hora
■
UsernameTokens
■
Assinaturas
■
Criptografia
Observação: os parâmetros de segurança do WS só podem ser definidos nos
operadores. Não há parâmetros de categoria de operador disponíveis para a segurança
do WS.
Após serem definidos, a tag <wsse:Security> do cabeçalho da solicitação de SOAP inclui
os parâmetros a seguir (ou partes dos parâmetros). Em seguida, o serviço da Web:
■
Examina os parâmetros para a autenticação.
■
Verifica se a solicitação de SOAP não foi modificada durante o trânsito entre o
cliente e o servidor.
Parâmetros comuns da Segurança do WS
Representante
Define o atributo representante do cabeçalho de <wsse:Security> da solicitação de
SOAP. Se você definir qualquer um dos seguintes atributos, o produto definirá o
atributo representante:
■
Adicionar criptografia
■
Adicionar assinatura
■
Adicionar marca de data e hora
■
Adicionar token de nome de usuário
Observação: deixe esse parâmetro em branco se não for especificado um
representante ou se você usar o SOAP 1.2.
514 Referência do Criador de Conteúdo
Operador Chamar método SOAP assíncrono
É necessário entender
Se você definir qualquer um dos seguintes atributos, esse parâmetro definirá o
atributo mustUnderstand do cabeçalho de <wsse:Security> como verdadeiro:
■
Adicionar criptografia
■
Adicionar assinatura
■
Adicionar marca de data e hora
■
Adicionar token de nome de usuário
Observação: o atributo mustUnderstand especifica se a entrada do cabeçalho de
<wsse:Security> é obrigatória ou opcional para o destinatário processar.
Marca de data e hora
Adicionar marca de data e hora
Adiciona uma marca de data e hora ao cabeçalho de <wsse:Security> e ativa todos
os parâmetros de marca de data e hora.
Parâmetros de marca de data e hora
Inclui os seguintes valores:
Tempo de vida (s)
Define a diferença de horário entre a criação da solicitação do SOAP e sua
expiração (em segundos). Se você deixar esse campo em branco, o padrão será
0 e o produto não definirá a hora de expiração. Se a marca de data e hora
expirar, o serviço web rejeitará a solicitação do SOAP.
Definir a precisão da marca de data e hora em milissegundos
Se essa opção estiver selecionada, o produto definirá a precisão da marca de
data e hora em milissegundos.
Token de nome de usuário
Adicionar token de nome de usuário
Adiciona um token de nome de usuário ao cabeçalho de <wsse:Security> e ativa
todos os parâmetros de token de nome de usuário.
Parâmetros de token de nome de usuário
Inclui os seguintes valores:
Nome de usuário
Define o valor do token de nome de usuário.
Senha
Define a senha associada ao token de nome de usuário.
Capítulo 15: Web Services 515
Operador Chamar método SOAP assíncrono
Tipo de senha
Especifica o tipo de senha.
Valores:
■
0: o produto fornece a senha em texto não criptografado.
■
1: o produto fornece a senha em forma de resumo (a senha é
criptografada e não é fornecida em texto não criptografado).
■
2: o produto não fornece senha.
Adicionar nonce?
Se essa opção estiver selecionada, o produto adicionará um elemento nonce
(como um valor de hash) ao token de nome de usuário. O serviço web talvez
não exija esse elemento.
Adicionar item criado?
Se essa opção estiver selecionada, o produto adicionará um elemento Criado
que indica quando o token de nome de usuário foi criado. O serviço web talvez
não exija esse elemento.
Observação: se você definir o Tipo de senha como Resumo, o produto
automaticamente adicionará os elementos Nonce e Criado ao token de nome de
usuário.
Parâmetros de armazenamento de chaves
Ao assinar ou criptografar uma solicitação de SOAP, o produto exige muitas chaves para
processar várias responsabilidades. O produto usa chaves na Segurança do WS para
assinar ou criptografar a solicitação de SOAP e para validar a assinatura ou a
descriptografia da resposta do SOAP (se aplicável).
O CA Process Automation usa um armazenamento de chaves (um repositório de
certificados de segurança) para manter as chaves usadas na Segurança do WS. Os
armazenamentos de chaves fornecem organização e consolidação de chaves e impedem
que outros usuários acessem as chaves particulares exclusivas. O produto exige que
você crie um armazenamento de chaves (na página 492) ou use um existente.
A Segurança do WS inclui as seguintes opções de armazenamento de chaves:
■
■
Assinar a solicitação de SOAP (ou partes dela). O armazenamento de chaves contém
os seguintes itens:
–
A chave privada a ser usada para assinar a solicitação.
–
A chave pública associada com a qual o receptor valida a assinatura. O produto
adiciona uma referência a essa chave pública à solicitação do SOAP assinada.
Criptografar a solicitação de SOAP (ou partes dela). O armazenamento de chaves
contém a chave pública para criptografar a chave simétrica. O produto usa a chave
simétrica para criptografar a solicitação.
516 Referência do Criador de Conteúdo
Operador Chamar método SOAP assíncrono
■
Validar a assinatura da resposta de SOAP. O armazenamento de chaves contém a
chave pública para validar a assinatura (se aplicável).
■
Descriptografar a resposta de SOAP. O armazenamento de chaves contém a chave
privada para descriptografar a resposta.
Os parâmetros a seguir definem o armazenamento de chaves para assinar ou
criptografar uma solicitação de SOAP:
Caminho do armazenamento de chaves de criptografia/assinatura
Define o caminho para o armazenamento de chaves.
Senha do armazenamento de chaves de criptografia/assinatura
Define a senha em texto não criptografado para acessar o armazenamento de
chaves.
Observação: esse parâmetro não é a senha para acessar uma chave privada do
armazenamento de chaves, mas, em vez disso, a senha para acessar o próprio
armazenamento de chaves.
Tipo de armazenamento de chaves de criptografia/assinatura
Especifica o tipo de armazenamento de chaves.
Valores:
■
JKS
■
PKCS12 (que geralmente tem uma extensão .p12)
■
Em branco (o produto usará o valor padrão)
Padrão: JKS.
Criar um armazenamento de chaves
Você pode usar uma ferramenta de terceiros para criar seu armazenamento de chaves
ou importar novos certificados/chaves privadas para um armazenamento de chaves
existente. Uma ferramenta de gerenciamento de armazenamento de chaves é Keytool,
fornecido com o Java JRE ou JDK. Alguns comandos de Keytool podem ser encontradas
aqui:
■
http://download.oracle.com/javase/1,5.0/docs/tooldocs/solaris/keytool.html
■
http://download.oracle.com/javase/1,5.0/docs/tooldocs/windows/keytool.html
Você também pode executar:
keytool –help
Capítulo 15: Web Services 517
Operador Chamar método SOAP assíncrono
Assinatura
Adicionar assinatura
Se essa opção estiver selecionada, o produto assinará a solicitação de SOAP e
adicionará uma assinatura ao cabeçalho de <wsse:Security>. Uma chave privada no
armazenamento de chaves assina o conteúdo da solicitação de SOAP. O produto
também ativa todos os campos de Parâmetros de assinatura.
Parâmetros de assinatura
Os parâmetros a seguir definem a assinatura:
Alias de chave privada
Define o alias da chave no armazenamento de chaves que o produto usará para
assinatura.
Senha da chave privada
Define a senha da chave no armazenamento de chaves.
Algoritmo de conversão em formato canônico
Define o método de conversão em formato canônico que é usado para
serializar os dados (corpo da solicitação de SOAP ou partes especificadas para
serem assinadas) antes de aplicar a assinatura. Deixe esse campo em branco
para usar o algoritmo de conversão em formato canônico XML exclusivo
padrão xml-exc-c14n#.
Algoritmo de assinatura
Define o algoritmo para definir a assinatura. Deixe esse campo em branco se
desejar que o produto tente detectar e usar um algoritmo de assinatura que
corresponda aos dados na chave.
518 Referência do Criador de Conteúdo
Operador Chamar método SOAP assíncrono
Tipo de identificador de chave pública'
Especifica o identificador de chave que configura os elementos de identificação
(chave pública) do certificado na assinatura. O receptor usa esse valor para
identificar o certificado de assinatura (chave pública) que valida a assinatura da
solicitação de SOAP.
Valores:
■
1 (Token de segurança binário): o produto adiciona
<wsse:SecurityTokenReference> ao elemento de assinatura. O elemento
de assinatura usa um fragmento de URI em um elemento
<wsse:Reference> para fazer referência ao certificado de assinatura (chave
pública). O fragmento de URI faz referência à chave pública da assinatura.
O produto inclui a chave pública da assinatura como dados binários no
elemento <wsse:BinarySecurityToken> de cabeçalho de <wsse:Security>.
■
2 (Nome do emissor e número de série): o produto adiciona
<wsse:SecurityTokenReference> ao elemento de assinatura. O elemento
de assinatura usa um elemento <ds:X509Data><ds:X509:IssuerSerial> para
fazer referência ao certificado de assinatura (chave pública). Esse
elemento identifica de maneira exclusiva um certificado por seu nome de
emissor X.509 e seu número de série.
■
3 (Identificador de certificado X509): o produto adiciona
<wsse:SecurityTokenReference> ao elemento de assinatura. O elemento
de assinatura usa um elemento <wsse:KeyIdentifier
ValueType="oasis-200401-wss-x509-token-profile-1.0#X509v3"> para fazer
referência ao certificado de assinatura (chave pública).
■
4 (Identificador de assunto principal): o produto adiciona
<wsse:SecurityTokenReference> ao elemento de assinatura. O elemento
de assinatura usa um elemento <wsse:KeyIdentifier
ValueType="#oasis-200401-wss-x509-token-profile-1.0#X509SubjectKeyIde
ntifier"> para fazer referência ao certificado de assinatura (chave pública).
Padrão: 0. O operador usa o identificador de chave padrão (Nome do emissor e
número de série) da implementação.
Capítulo 15: Web Services 519
Operador Chamar método SOAP assíncrono
Partes para assinar
Especifica as partes da solicitação do SOAP a serem assinadas. Clique em
Adicionar parâmetro para inserir uma ID de segurança ou uma combinação de
Nome/espaço para nome do elemento a ser assinado.
Valores:
■
ID do WSU: define o atributo wsu:id do elemento a ser assinado. Você
pode adicionar wsu:id como um atributo de um elemento na solicitação
SOAP, além de poder especificar seu próprio valor. Por exemplo:
<token wsu:id="123"> </token>
A instrução a seguir mostra a definição do espaço para nome do WSU:
xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200
401-wss-wssecurity-utility-1,0.xsd"
■
Nome: define o nome do elemento a ser assinado.
■
Espaço para nome: define o URI do espaço para nome (não o nome local
do espaço para nome) do elemento a ser assinado. Por exemplo:
"http://www.ca.com/itpam"
Observação: deixe esse parâmetro em branco para assinar o corpo da
solicitação de SOAP. Se você especificar a ID do WSU, o produto ignora os
valores Nome e Espaço para nome.
Criptografia
Adicionar criptografia
Criptografa a solicitação de SOAP e adiciona uma nova chave simétrica
criptografada ao cabeçalho de <wsse:Security> da solicitação de SOAP. O CA
Process Automation usa uma chave simétrica para criptografar o conteúdo da
solicitação do SOAP. O certificado (chave pública), fornecida no armazenamento de
chaves, criptografa a própria chave simétrica e a inclui no cabeçalho
<wsse:Security>. Se esse campo for selecionado, todos os campos de Parâmetros de
criptografia serão ativados.
Parâmetros de criptografia
Os parâmetros a seguir definem a criptografia:
Alias de chave pública
Define o alias do certificado (chave pública) que deve ser usado para
criptografar a chave simétrica no armazenamento de chaves.
Algoritmo de conversão em formato canônico
Define o método de conversão em formato canônico usado para serializar os
dados antes de aplicar a criptografia. Deixe esse campo em branco para usar
uma serialização padrão.
520 Referência do Criador de Conteúdo
Operador Chamar método SOAP assíncrono
Algoritmo de criptografia simétrica
Especifica o tipo de algoritmo simétrico para criptografar os dados.
Valores:
■
Tripledes-cbc: usar DES triplo. Esse método usa uma chave com 8 bytes 24 bits.
■
aes128-cbc: usar AES com uma chave de 128 bits.
■
aes192-cbc: usar AES com uma chave de 192 bits.
■
aes256-cbc: usar AES com uma chave de 256 bits.
Padrão: AES128
Observação: se definir este parâmetro como aes192-cbc ou aes256-cbc, o
seguinte erro pode ocorrer:
Tamanho de chave inválido ou parâmetros padrão.
Se esse erro ocorrer, faça download dos seguintes arquivos de diretiva de
jurisdição de força ilimitada do JCE (Java Cryptography Extension - Extensão de
Criptografia Java) no site da Oracle:
■
US_export_policy.jar
■
local_policy.jar
Substitua os jars existentes com o mesmo nome em
C:path_to_JRE_used_by_PAM\lib\security pelos novos.
Criptografar a chave simétrica?
Criptografa a chave simétrica com a qual os dados foram criptografados. O
produto, em seguida, inclui a chave no cabeçalho de
<wsse:security><xenc:EncryptedKey>.
Algoritmo de criptografia de chave simétrica
Define o algoritmo de compilação que deve ser usado para criptografar a chave
simétrica. Esse parâmetro é aplicável somente se a chave precisar ser
criptografada.
Padrão: RSA15.
Capítulo 15: Web Services 521
Operador Chamar método SOAP assíncrono
Tipo de identificador de chave pública'
Especifica o identificador de chave que configura os elementos de identificação
(chave pública) do certificado no elemento <xenc:EncryptedKey>. O receptor
usa a chave privada que corresponde a esse certificado (chave pública) para
descriptografar a chave simétrica. O produto, em seguida, usa a chave
simétrica para criptografar a solicitação de SOAP.
Valores:
■
1 (Token de segurança binário): o produto adiciona
<wsse:SecurityTokenReference> ao elemento <xenc:EncryptedKey>. O
elemento <xenc:EncryptedKey> usa um fragmento de URI em um
elemento <wsse:Reference> para fazer referência ao certificado (chave
pública). O fragmento de URI faz referência à chave pública. O produto
inclui a chave pública como dados binários no elemento
<wsse:BinarySecurityToken> de cabeçalho de <wsse:Security>.
■
2 (Nome do emissor e número de série): o produto adiciona
<wsse:SecurityTokenReference> ao elemento <xenc:EncryptedKey>. O
elemento <xenc:EncryptedKey> usa um elemento
<ds:X509Data><ds:X509:IssuerSerial> para fazer referência ao certificado
(chave pública). Esse elemento identifica de maneira exclusiva um
certificado por seu nome de emissor X.509 e seu número de série.
■
3 (Identificador de certificado X509): o produto adiciona
<wsse:SecurityTokenReference> ao elemento <xenc:EncryptedKey>. O
elemento <xenc:EncryptedKey> usa um elemento <wsse:KeyIdentifier
ValueType="oasis-200401-wss-x509-token-profile-1.0#X509v3"> para fazer
referência ao certificado (chave pública).
■
4 (Identificador de assunto principal): o produto adiciona
<wsse:SecurityTokenReference> ao elemento <xenc:EncryptedKey>. O
elemento <xenc:EncryptedKey> usa um elemento <wsse:KeyIdentifier
ValueType="#oasis-200401-wss-x509-token-profile-1.0#X509SubjectKeyIde
ntifier"> para fazer referência ao certificado (chave pública).
■
8 (Identificador de SHA1 de impressão digital): o produto adiciona
<wsse:SecurityTokenReference> ao elemento <xenc:EncryptedKey>. O
elemento <xenc:EncryptedKey> usa um elemento <wsse:KeyIdentifier
ValueType="#oasis-wss-soap-message-security-1.1#ThumbprintSHA1">
para fazer referência ao certificado (chave pública).
Padrão: 0. O operador usa o identificador de chave padrão (Nome do emissor e
número de série) da implementação.
522 Referência do Criador de Conteúdo
Operador Chamar método SOAP assíncrono
Parts para criptografar
Especifica as partes da solicitação do SOAP a serem criptografadas. Clique em
Adicionar parâmetro para inserir uma ID de segurança (ID do WSU) ou uma
combinação de Nome/espaço para nome do elemento a ser criptografado.
Valores:
■
ID do WSU: define o atributo wsu:id do elemento a ser criptografado. Você
pode adicionar wsu:id como um atributo de um elemento na solicitação
SOAP, além de poder especificar seu próprio valor. Por exemplo:
<token wsu:id="123"> </token>
A instrução a seguir mostra a definição do espaço para nome do WSU:
xmlns:wsu=http://docs.oasis-open.org/wss/2004/01/oasis-2004
01-wss-wssecurity-utility-1.0.xsd
■
Nome: define o nome do elemento a ser criptografado.
■
Espaço para nome: define o URI do espaço para nome (não o nome local
do espaço para nome) do elemento a ser criptografado. Por exemplo:
http://www.ca.com/pam
■
Codificação: selecione Conteúdo para criptografar o conteúdo do
elemento ou Elemento para criptografar todo o elemento.
Observação: deixe esse campo em branco para criptografar o conteúdo do
corpo da solicitação do SOAP. Se você especificar a ID do WSU, o produto
ignora os valores Nome e Espaço para nome.
Assinatura primeiro?
Especifica se é necessário aplicar a assinatura antes de criptografar os dados. Esse
parâmetro é útil se o produto criptografar e assinar os mesmos dados na solicitação
do SOAP.
Descriptografar e validar assinatura da resposta SOAP
Especifica se é necessário descriptografar o conteúdo da resposta do SOAP (se
aplicável) e valida a assinatura. Quando essa opção é selecionada, o produto ativa o
parâmetro Senha da chave privada de descriptografia.
Senha da chave privada de descriptografia
Define a senha para acessar a chave privada de descriptografia no armazenamento
de chaves. Use essa senha para acessar a chave privada a ser usada para
descriptografar uma resposta do SOAP criptografada.
Processo de criptografia/assinatura para a solicitação do SOAP
O operador Solicitar método SOAP e o operador Chamar método SOAP assíncrono
assinam ou criptografam todo ou parte do corpo da solicitação do SOAP.
Capítulo 15: Web Services 523
Operador Chamar método SOAP assíncrono
Criptografia
1.
O CA Process Automation usa o Algoritmo de conversão em formato canônico
para serializar os dados a serem criptografados. Esses dados incluem o corpo
inteiro da solicitação ou as partes especificadas em Partes para criptografar.
2.
O CA Process Automation usa uma chave simétrica (dependendo do Algoritmo
de criptografia simétrica) para criptografar os dados. Esses dados incluem o
corpo inteiro da solicitação ou as partes especificadas em Partes para
criptografar.
3.
O CA Process Automation usa o Alias de chave pública para recuperar a chave
pública do alias do armazenamento de chaves. A chave pública, em seguida,
usa o algoritmo especificado no Algoritmo de criptografia de chave simétrica
para criptografar a chave simétrica.
4.
O CA Process Automation adiciona a chave simétrica criptografada à a
solicitação do SOAP no elemento <xenc:EncryptedKey>.
5.
Dependendo do tipo de referência especificado no Tipo de identificador de
chave pública, o CA Process Automation adiciona à solicitação do SOAP uma
referência à chave pública usada para criptografar a chave simétrica.
6.
O receptor descriptografa a chave simétrica e, em seguida, usa a chave
simétrica descriptografada para descriptografar a solicitação do SOAP.
Assinatura
1.
O CA Process Automation usa o Alias de chave privada e a Senha da chave
privada para recuperar a chave privada do armazenamento de chaves.
2.
O CA Process Automation usa o Algoritmo de conversão em formato canônico
para serializar os dados a serem assinados. Esses dados incluem o corpo inteiro
da solicitação ou as partes especificadas em Partes para assinar.
3.
O CA Process Automation usa a chave privada do armazenamento de chaves
para assinar o conteúdo da solicitação do SOAP usando o Algoritmo de
assinatura que o usuário especificar. O produto assina o corpo da solicitação
inteiro ou as partes especificadas em Partes para assinar.
4.
O CA Process Automation adiciona à solicitação do SOAP uma referência ao
certificado/chave pública associada à chave privada. O usuário especifica o tipo
de referência no Tipo de identificador de chave pública.
5.
O receptor usa a chave pública para validar a assinatura na solicitação do SOAP.
Solução de problemas da segurança do WS
Os operadores Solicitar método SOAP e Chamar método SOAP assíncrono poderão
falhar quando a Segurança do WS for aplicada nos casos a seguir.
524 Referência do Criador de Conteúdo
Operador Chamar método SOAP assíncrono
Não é possível criar uma criptografia para gerenciar o armazenamento de chaves
Uma mensagem de erro será exibida se o operador não puder criar uma criptografia
para gerenciar o armazenamento de chaves:
Falha ao chamar o SOAP: não é possível criar uma criptografia para o armazenamento
de chaves que contém as chaves de assinatura/criptografia…
Esse erro pode ser causado por:
■
Senha incorreta do armazenamento de chaves
■
Tipo incorreto de armazenamento de chaves
■
O caminho do armazenamento de chaves aponta para um arquivo que não é um
armazenamento de chaves.
Monitore os logs do CA Process Automation, na pilha de erros, para obter uma
indicação da natureza do problema. Por exemplo:
■
Senha incorreta do armazenamento de chaves: o armazenamento de chaves foi
violado ou a senha estava incorreta.
■
Tipo incorreto de armazenamento de chaves: java.security.KeyStoreException: x
não encontrado (em que x é o tipo fornecido)
■
O caminho do armazenamento de chaves aponta para um arquivo que não é um
armazenamento de chaves: formato de armazenamento de chaves inválido
Erros de assinatura
Ao ser assinada a solicitação do SOAP, podem ocorrer problemas quando:
■
O caminho do armazenamento de chaves não existe no computador que contém o
touchpoint.
■
O caminho do armazenamento de chaves está ausente.
■
O alias da chave privada está ausente.
■
Você tenta assinar uma parte inexistente da solicitação do SOAP. O motivo pelo
qual o campo contém uma mensagem:
Elemento para criptografar/assinar não encontrado…
■
O alias da chave privada não existe no armazenamento de chaves. O motivo pelo
qual o campo contém uma mensagem:
Nenhum certificado para o usuário x foi encontrado para assinatura…
Em que x é o alias da chave privada fornecida.
■
A senha da chave privada é necessária, mas não foi fornecida, ou a senha fornecida
está incorreta. O motivo contém uma mensagem:
Não é possível recuperar a chave…
Capítulo 15: Web Services 525
Operador Chamar método SOAP assíncrono
■
Você forneceu um algoritmo de conversão em formato canônico incorreto. O
motivo pelo qual o campo contém uma mensagem:
Conversão em formato canônico desconhecido. Nenhum manipulador instalado para o
URI x…
Em que x é o nome do algoritmo de conversão em formato canônico fornecido.
■
Você forneceu um algoritmo de assinatura incorreto. O motivo pelo qual o campo
contém uma mensagem:
O algoritmo x solicitado não existe...
Em que x é o nome do algoritmo de assinatura fornecido.
■
Você forneceu um tipo de identificador de chave pública incorreto. O motivo pelo
qual o campo contém uma mensagem:
Identificação de chave sem suporte…
Erros de criptografia
Ao ser criptografada a solicitação do SOAP, podem ocorrer problemas quando:
■
O caminho do armazenamento de chaves não existe no computador que contém o
touchpoint.
■
O caminho do armazenamento de chaves está ausente.
■
Você tenta criptografar uma parte inexistente da solicitação do SOAP. O motivo
pelo qual o campo contém uma mensagem:
Elemento para criptografar/assinar não encontrado…
■
Você tenta usar o algoritmo de criptografia simétrica aes192-cbc ou aes256-cbc
sem atualizar para os jars de diretiva de jurisdição de força ilimitada. O motivo pelo
qual o campo contém uma mensagem:
Tamanho de chave inválido ou parâmetros padrão.
■
O alias da chave pública não existe no armazenamento de chaves. O motivo pelo
qual o campo contém uma mensagem:
Nenhum certificado para o usuário x foi encontrado para criptografia…
Em que x é o alias da chave pública fornecida.
■
Você forneceu um algoritmo de criptografia incorreto. O motivo pelo qual o campo
contém uma mensagem:
Falha ao chamar o SOAP: não é possível criptografar message.null do SOAP.
A biblioteca WSS4J aciona um erro de ponteiro nulo nesse caso.
526 Referência do Criador de Conteúdo
Operador Chamar método SOAP assíncrono
■
Você forneceu um algoritmo de criptografia de chave simétrica incorreto. O motivo
pelo qual o campo contém uma mensagem:
algoritmo de criptografia de transporte de chave sem suporte: x
Em que x é o algoritmo de criptografia de chave simétrica fornecido.
■
Você forneceu um tipo de identificador de chave pública incorreto. O motivo pelo
qual o campo contém uma mensagem:
Identificação de chave sem suporte…
Observação: se você estiver criptografando uma parte da solicitação do SOAP e, depois,
assinando-a, não deixe de criptografá-la como conteúdo. Essa ação garante que seu
wsu:id (ou nome e espaço para nome) permaneça na solicitação SOAP após a
criptografia e antes da assinatura. Do contrário, essa parte não será encontrada durante
a tentativa de assiná-la.
Erros de descriptografia
Uma senha incorreta especificada no campo Senha da chave privada de descriptografia
causa a falha do operador. O motivo pelo qual o campo contém uma mensagem:
Não é possível aplicar a segurança do WSS na mensagem de entrada (resposta do SOAP).
A assinatura ou a descriptografia é inválida. A exceção aninhada é: java.security.
UnrecoverableKeyException: falha ao obter chave:
O bloco final fornecido não está corretamente preenchido.
Parâmetros de saída
serviceURL
methodName
userName
password
httpAuth
soapVersion
inputSource
inlineText
Capítulo 15: Web Services 527
Operador Chamar método SOAP assíncrono
Dados de chamada SOAP
serviceURL
Retonar o URL do serviço que a chamada de SOAP usa.
methodName
Retorna o nome do método a ser chamado.
userName
Retorna o nome de usuário para autenticação HTTP básica.
password
Retorna a senha para autenticação HTTP básica.
httpAuth
Exibe verdadeiro ou falso, dependendo da seleção de Usar autenticação básica
HTTP? .
soapVersion
Retorna a versão do SOAP que o produto usa para fazer chamadas SOAP,
independentemente se for SOAP 1.1 ou SOAP 1.2.
inputSource
Retorna um dos seguintes valores para a entrada de origem da chamada de SOAP:
■
InlineText
■
Arquivo SOAP pré-formatado
■
Expressão
inlineText
Retorna os dados de texto embutido que serão usados para a chamada de SOAP.
Essa variável é preenchida apenas quando você seleciona Registro de Texto
embutido como a origem de entrada.
Exemplo:
<checkServerStatus xmlns="http://www.ca.com/itpam">
CA AuthMinder
<token>token__</token>
<user>usuário__</user>
<password>senha__</password>
</auth>
</checkServerStatus>
FileName
Retorna os dados de texto embutido que serão usados para a chamada de SOAP.
Essa variável só é preenchida quando se seleciona Arquivo SOAP pré-formatado
como a origem de entrada.
528 Referência do Criador de Conteúdo
Operador Chamar método SOAP assíncrono
valor |
Retorna os dados de texto embutido que serão usados para a chamada de SOAP.
Essa variável só é preenchido quando você seleciona como a origem de entrada de
expressão.
SavedCallFileName
Retorna o nome do arquivo no campo Arquivo de chamada salvo. Este arquivo
contém o número real de envelope SOAP que o produto usa para fazer uma
chamada de SOAP.
Exemplo:
<?xml version="1.0" encoding="UTF-8"?><SOAP-ENV:Envelope
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><SOAP-ENV
:Header/><SOAP-ENV:Body><checkServerStatus
xmlns="http://www.ca.com/itpam">
CA
AuthMinder<token>token__</token><user>user__</user><password>pa
ssword__</password></auth></checkServerStatus></SOAP-ENV:Body><
/SOAP-ENV:Envelope>
Parâmetros dinâmicos
Paramsyle
Retorna o estilo de parâmetro selecionado no campo Parâmetro dinâmico:
Atribuições do XPath ou MacroExpansion.
DynamicParamsInfo
Uma matriz de mapas de valores; exibe o número de mapas de valores que ela
contém.
DynamicParamsdata
Retorna a consulta, o valor e o tipo.
Parâmetros da opção Resultados da chamada
responseFileName
Retorna o nome de arquivo fornecido no campo Arquivo de resposta. Este arquivo
contém a resposta recebida de uma chamada de SOAP.
xPathQuery
Retorna a consulta XPath para extrair os dados dos resultados de chamada.
Capítulo 15: Web Services 529
Operador Chamar método SOAP assíncrono
datasetVar
Retorna a variável que é criada para armazenar os resultados de chamada
extraídos.
Tipo
Retorna a variável que contém o tipo de dados que o usuário definiu para
armazenar os resultados de chamada.
isExtractToDataSet
Retorna verdadeiro quando você marcar Extrair conteúdo de resposta do SOAP
para a variável do conjunto de dados ou, caso contrário, retorna falso.
isExtractHeadersToDataSet
Retorna verdadeiro quando você marcar Extrair cabeçalho do SOAP para variável do
conjunto de dados ou, caso contrário, retorna falso.
isExtractHeadersToIndividualDataSet
Retorna verdadeiro quando você marcar Extrair elementos de primeiro nível do
cabeçalho do SOAP para variáveis individuais do conjunto de dados ou, caso
contrário, retorna falso.
isExtractToIndividualDataSet
Retorna verdadeiro quando você marcar Extrair elementos de primeiro nível do
cabeçalho do SOAP para variáveis individuais do conjunto de dados ou, caso
contrário, retorna falso.
isStripXMLNamespaces
Retorna verdadeiro quando você marcar Faixa de namespaces XML da resposta ou,
caso contrário, retorna falso.
Resultados da operação
Dependendo das caixas de seleção marcadas em Resultados da chamada parâmetros, os
resultados da operação armazena a saída dos resultados de chamada de SOAP.
Corpo da resposta do Soap
Armazena todo o conteúdo de resposta do SOAP.
Dados de Cabeçalho de Resposta do SOAP
Armazena o cabeçalho de resposta.
SoapResponseHeader
Contém os dados eliminados do cabeçalho de resposta.
Dados de Resposta do SOAP
Contém os dados eliminados dos resultados de chamada de SOAP.
530 Referência do Criador de Conteúdo
Operador Chamar método SOAP assíncrono
AsyncSoapIntermediateResponse
Contém a resposta completa juntamente com os cabeçalhos recebidos da chamada
de SOAP.
Por exemplo (usando o método CheckServerStatus):
<SOAP-ENV:Envelope
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<checkServerStatusResponse xmlns="http://www.ca.com/itpam">
<serverStatus>Status do servidor ok.</serverStatus>
</checkServerStatusResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
AsyncSoapInterimResponseBody
Contém o corpo da resposta da chamada de SOAP.
Por exemplo (usando o método CheckServerStatus):
<checkServerStatusResponse xmlns="http://www.ca.com/itpam">
<serverStatus>Status do servidor ok.</serverStatus>
</checkServerStatusResponse>
AsyncSoapInterimResponseHeader
Contém o cabeçalho da resposta da chamada de SOAP.
Por exemplo (usando o método CheckServerStatus):
<SOAP-ENV:Header xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"/>
Anexos de MIME
isResolvedByExpression
Retorna verdadeiro quando você marcar a opção É uma expressão? para o anexo
em MIME ou, caso contrário, retorna falso. A seleção da opção É uma expressão?
indica que o anexo em MIME é fornecido como uma expressão e que essa
expressão refere-se ao anexo em MIME.
Expressionfield
Retorna a expressão que se refere ao anexo em MIME.
attachmentFields
Retorna uma matriz de mapa de valores com o número de elementos que ela
contém.
Tipo de conteúdo
Retorna o tipo de conteúdo do anexo em MIME.
Capítulo 15: Web Services 531
Operador Chamar método SOAP assíncrono
contentID
Retorna a ContentID com a qual o anexo em MIME é identificado de forma
exclusiva.
fileURL
Retorna o caminho do anexo em MIME.
532 Referência do Criador de Conteúdo
Capítulo 16: Funções do sistema do CA
Process Automation
As funções do sistema podem ser usadas em:
■
Execução anterior e posterior de qualquer operador.
■
O código de origem do operador Executar o JavaScript.
■
Qualquer campo que aceita uma expressão.
Em cada uma dessas áreas, as funções do sistema podem ser acessadas pressionando-se
Ctrl + Alt.
Tipos de retorno
As funções do sistema retornam valores de vários tipos. Em alguns casos, o tipo de
retorno depende dos parâmetros de entrada ou se a função está retornando um nulo.
Na maioria dos casos, as funções do sistema retornam tipos Java, em vez de valores de
Javascript puro. Por exemplo, as funções do sistema que são descritas como retornando
uma Sequência de caracteres, na verdade, estão retornando uma Java.lang.String. Em
geral, você pode ignorar a diferença entre Java.lang.String e Sequência de caracteres.
Em alguns casos, essa diferença afeta o comportamento durante a execução de uma
expressão ou script. No caso de typeof x, onde x é uma variável que armazena o valor
retornado de uma função do sistema, o tipo de retorno é objeto, em vez de sequência
de caracteres.
Para cada tipo de retorno de função do sistema, a tabela a seguir descreve o efeito nas
seguintes variáveis:
■
Uma variável Javascript à qual valor de retorno está sendo atribuído
■
Uma variável do conjunto de dados do CA Process Automation que está sendo
criada
Tipo de retorno de função do
sistema
Tipo de variável Javascript depois da
atribuição
Tipo de variável do conjunto de dados
criado
boolean
boolean
Booleano
C2OString
object
Sequência de caracteres
C2OValue
object
MapaDeValor
C2OValueArray
object
MapaDeValor
Capítulo 16: Funções do sistema do CA Process Automation 533
absPath
Tipo de retorno de função do
sistema
Tipo de variável Javascript depois da
atribuição
Tipo de variável do conjunto de dados
criado
C2OValueMap
object
MapaDeValor
Data
object
Data
int
number
Número inteiro
Sequência de caracteres
object
Sequência de caracteres
Sequência de caracteres []
object
Sequência de caracteres []
void
indefinido/a
n/d
absPath
A função absPath retorna o caminho absoluto criado com a ajuda do caminho base e do
caminho relativo. Se o caminho base não for fornecido, o caminho base para o processo
atual será usado.
Sintaxe
sAbsPath = absPath (path2).
sAbsPath = absPath (path1, path2).
Argumentos
path1 (Sequência de caracteres)
Especifica o caminho base.
path2 (Sequência de caracteres)
Especifica o caminho relativo.
Valor de retorno
sAbsPath (Sequência de caracteres)
O caminho absoluto será retornado como uma sequência de caracteres.
534 Referência do Criador de Conteúdo
adjustDate
Exemplos
1.
Há um processo "Process" em uma pasta "Folder". Para obter o caminho completo
de um objeto "Process1" (presente na mesma pasta) dentro do objeto "Process",
use o absPath ('Process1'). Nesse caso, o caminho base é tomado automaticamente
como o caminho base do objeto "Process".
sPath = absPath ('Process1')
2.
Aqui, o primeiro caminho é o caminho base do objeto e o segundo é o caminho
relativo para o caminho base. A resposta, nesse caso, é /folder1/process.
sPath = absPath("/folder1/folder2","../process");
adjustDate
A função adjustDate ajusta uma data por um número especificado de dias, semanas,
meses ou anos.
Sintaxe
newDt = adjustDate(dt, number, type)
Argumentos
dt (java.util.Date)
Especifica a data que precisa ser ajustada.
number (Int)
Especifica o valor que precisa ser ajustado.
tipo
Especifica o tipo de valor a ser ajustado. Pode ser um dos seguintes tipos:
■
y (ano)
■
d (dias)
■
w (semana)
■
m (mensal)
Valor de retorno
newDt (java.util.Date)
A data ajustada é retornada como java.util.Date.
Capítulo 16: Funções do sistema do CA Process Automation 535
adjustResourceVals
Exemplos
Suponha que hoje seja 16/02/2012.
1.
O exemplo a seguir retorna 18/02/2012, a data que é dois dias após a data de hoje.
adjustDate(today(),2,'d')
2.
O exemplo a seguir retorna 16/02/2013, a data em que é um ano após a data de
hoje.
adjustDate(today(),1'y')
3.
O exemplo a seguir retorna 09/02/2012, a data que é uma semana antes da data de
hoje.
adjustDate(today(),-1,'w')
4.
O exemplo a seguir retorna 16/01/2012, a data em que é um mês antes da data de
hoje.
adjustDate(today(),-1,'m')
adjustResourceVals
A função adjustResourceVals modifica os valores e o estado de um recurso.
Para obter mais informações sobre os recursos, consulte o Guia do Criador de Conteúdo.
Sintaxe
bSuccess =
adjustResourceVals(resPath,resName,freeAmount,total,lock,unlock,re
set)
Argumentos
resPath (sequência de caracteres)
Especifica o caminho do objeto de recursos.
resName (sequência de caracteres)
Especifica o nome do recurso no objeto de recursos que precisa ser ajustado.
freeAmount (Int)
Especifica a quantidade de recursos livres.
total (int)
O valor fornecido nesse argumento adiciona até o número total de recursos.
536 Referência do Criador de Conteúdo
applyXPath
bloquear (booleano)
Especificará Verdadeiro se o recurso precisar ser bloqueado. Quando Bloquear é
definido como verdadeiro, os valores freeAmount e total para esse recurso não
podem ser definidos, e a função do sistema retorna falso.
desbloquear (booleano)
Especificará Verdadeiro se o recurso precisar ser desbloqueado.
Observação: não é possível bloquear e desbloquear o mesmo recurso. Alterne
entre bloquear e desbloquear ao usar essa função do sistema.
redefinir (booleano)
Especificará Verdadeiro se o objeto de recursos precisar ser redefinido.
Observação: a especificação de verdadeiro tem precedência sobre todos os outros
operadores. Todos os parâmetros do respectivo recurso são redefinidos para os
valores padrão (independentemente das entradas fornecidas na função do
sistema).
Valor de retorno
bSuccess (booleano)
Essa função retornará verdadeiro se tiver êxito ou falso se falhar.
Exemplo
bSuccess =
adjustResourceVals("\Resources","LockResource",20,20,false,true,fa
lse);
Neste exemplo, as variáveis são definidas da seguinte maneira:
respath = "\Resources"
renName = "LockResource"
freeAmount = 20;
total = 20
lock = false
unlock = true
reset = false
applyXPath
A função applyPath usa uma consulta XPath para extrair dados XML e retorna um
fragmento XML que lista os nós que resultam da consulta.
Sintaxe
sXML = applyXPath(xmlData, xpathQuery, namespaceAware, returnArray)
Capítulo 16: Funções do sistema do CA Process Automation 537
applyXPath
Argumentos
xmlData (sequência de caracteres)
Define o XML no qual executar a consulta XPath.
xpathQuery (sequência de caracteres)
Define a consulta XPath a ser executada.
namespaceAware (Boolean)
(Opcional) Especifica se deseja remover espaços de nome antes de aplicar a
consulta XPath.
Valores:
True: o CA Process Automation não remove espaços de nome antes de aplicar
a consulta XPath.
False: o CA Process Automation remove espaços de nome antes de aplicar a
consulta XPath, tornando a consulta simples.
Padrão: True
returnArray (Booleano)
(Opcional) Especifica se deve retornar ma matriz de resultados ou uma única
sequência de caracteres.
Valores:
True: a função retorna uma matriz de resultados.
False: a função retorna uma única sequência de caracteres com vários
resultados concatenados na sequência de caracteres.
Padrão: False
Observação: se a consulta XPath não encontrar uma correspondência, retornará
uma matriz vazia.
538 Referência do Criador de Conteúdo
applyXPathToUrl
Valores de retorno e exemplos
Um dos seguintes valores de retorno, com base no valor do argumento returnArray.
■
Quando returnArray for falso:
sXML (sequência de caracteres)
Se você omitir esse argumento returnArray ou defini-lo como false, a consulta
retornará esse valor. O valor retornado é um fragmento XML que lista os nós.
Por exemplo:
Process.xpathResult = applyXPath(Process.bookXML,
"/bookstore/book[2]", true, false);
■
Quando returnArray for verdadeiro:
sXMLArray (C2OValueArray)
Se você definir o argumento returnArray como true, a consulta retornará esse
valor. O valor que é retornado é uma C2OValueArray na qual cada elemento é
um fragmento XML de um nó. Por exemplo:
Process.xpathArrayResult = applyXPath(Process.bookXML,
"/bookstore/book", true, true);
applyXPathToUrl
A função applyXPathToUrl usa uma consulta XPath para extrair dados XML a partir de
um URL especificado. A função retorna um fragmento XML com a lista de nós que
resultam da consulta.
Sintaxe
sXML = applyXPathToUrl(url, xpathQuery, namespaceAware, returnArray)
Argumentos
url (sequência de caracteres)
Define o URL do documento XML no qual executar o XPath.
xpathQuery (sequência de caracteres)
Define a consulta XPath a ser executada.
Capítulo 16: Funções do sistema do CA Process Automation 539
applyXPathToUrl
namespaceAware (Boolean)
(Opcional) Especifica se deseja remover espaços de nome antes de aplicar a
consulta XPath.
Valores:
True: o CA Process Automation não remove espaços de nome antes de aplicar
a consulta XPath.
False: o CA Process Automation remove espaços de nome antes de aplicar a
consulta XPath, tornando a consulta simples.
Padrão: True
returnArray (Booleano)
(Opcional) Especifica se deve retornar ma matriz de resultados ou uma única
sequência de caracteres.
Valores:
True: a função retorna uma matriz de resultados.
False: a função retorna uma única sequência de caracteres com vários
resultados concatenados na sequência de caracteres.
Padrão: False
Observação: se a consulta XPath não encontrar uma correspondência, retornará
uma matriz vazia.
Valores de retorno e exemplos
Um dos seguintes valores de retorno, com base no valor do argumento returnArray.
■
Quando returnArray for falso:
sXML (sequência de caracteres)
Se você omitir o argumento returnArray ou defini-lo como falso, a consulta
retornará um fragmento XML que lista os nós. Por exemplo:
sXML =
applyXPathToUrl("http://localhost:8080/itpam_tutorials/book
.xml", "/bookstore/book[2]", true, false);
■
Quando returnArray for verdadeiro:
sXMLArray (C2OValueArray)
Se você definir o argumento returnArray como verdadeiro, a consulta retornará
uma C2OValueArray na qual cada elemento é um fragmento XML de um nó.
Por exemplo:
sXMLArray =
applyXPathToUrl("http://localhost:8080/itpam_tutorials/book
.xml", "/bookstore/book", true, true);
540 Referência do Criador de Conteúdo
checkCalendarDate
checkCalendarDate
A função checkCalendarDate verifica se a data especificada está dentro da condição
definida. A condição inclui incluir calendário, excluir calendário, delta, abrir dias e
mudanças máx. Consulte Propriedades do calendário para obter mais informações sobre
esses parâmetros.
Sintaxe
bIsAvail = checkCalendarDate(date, includeCalendar, excludeCalendar,
delta, openDays, maxShifts)
Argumentos
data (java.util.Date)
Especifica a data de entrada.
includeCalendar (sequência de caracteres)
Especifica o caminho do objeto Incluir calendário.
excludeCalendar (sequência de caracteres)
Especifica o caminho do objeto Excluir calendário.
delta (Int)
Especifica o delta.
openDays (Int)
Especifica o valor de openDays.
maxShifts (Int)
Especifica o valor de maxshifts.
Valor de retorno
bIsAvail (Booleano)
Essa função retorna o valor verdadeiro se a data especificada está aberta e falso se
não.
Exemplo
Process.sIncCal=absPath ("incCal");
Process.sExcCal=absPath("ExcCal");Process.bCaldate =
checkCalendarDate(today(),sIncCal,sExcCal,0,false,0);
Capítulo 16: Funções do sistema do CA Process Automation 541
convertJson
convertJson
A função convertJson converte uma sequência de caracteres JSON válida em ValueMap.
Use este método para converter uma resposta JSON de um serviço REST em um objeto
ValueMap. O objeto Valuemap pode então ser atravessado e acessado com o uso das
expressões padrão.
Sintaxe
vmResult = convertJson(jsonString)
Argumentos
jsonString (Sequência de caracteres)
Especifica a sequência de caracteres JSON que precisa ser analisada.
Valor de retorno
MapaDeValor
Representação ValueMap dos dados contidos na sequência de caracteres JSON que
pode ser atravessada ou referenciada com expressões.
Se você passar um valor nulo, ele retornará um valor nulo sem uma exceção. Se você
passar uma sequência de caracteres JSON inválida, o método retornará um valor Null e
as exceções serão registradas nos logs do servidor.
542 Referência do Criador de Conteúdo
convertJson
Exemplo
vmResult = convertJson(Process.jsonString)
Considere um exemplo em que você chamou um serviço REST. A resposta a seguir
recebida é armazenada em um nome de variável restResponse em um conjunto de
dados do processo:
{
"UserName": "pamadmin",
"age": 25,
"address": {
"streetAddress": "CA Technologies, 115, IT Park Area",
"city": "Hyderabad",
"state": "AP",
"postalCode": "500084"
},
"phoneNumber": [
{
"type": "Office",
"number": "04066812345"
},
{
"type": "Home",
"number": "04066854321"
}
]
}
Para acessar os valores de UserName, streetAddress e phoneNumber, escreva o
seguinte código:
// Início do código
// Analisar a resposta REST usando o método convertJson() e armazená-la
em uma variável do conjunto de dados do processo chamada “resultData”
Process.resultData=convertJson(Process.restResponse);
// Acessar “UserName” na variável resultData
Process.userName = Process.resultData.UserName;
//O Street Address está dentro do objeto de endereço, portanto, será
acessado com o uso da sintaxe a seguir
Process.streetAddress = Process.resultData.address.streetAddress;
//Phone Number é uma matriz e Office number está armazenado no primeiro
elemento, portanto, index [0] é usado.
Process.officePhoneNumber =
Process.resultData.phoneNumber[0].number;
//Fim do código
Capítulo 16: Funções do sistema do CA Process Automation 543
convertValueToXml
convertValueToXml
A função convertValueToXml retorna um fragmento XML com base em uma série de
tipos simples ou em um mapa de valores de tipos simples.
Quando um mapa de valores é usado, os elementos XML são criados usando os nomes
de campo como tags e os valores de campo como o conteúdo. Você pode especificar
uma sequência de caracteres ou um valor nulo para o parâmetro de tag ao usar mapas
de valores. Se você especificar uma sequência de caracteres, a sequência de caracteres
é usada para criar um elemento raiz com o nome especificado. Os elementos criados no
mapa de valores estão contidos nesse elemento raiz. Se você especificar o valor nulo, os
elementos estarão no nível raiz.
Ao usar uma matriz, especifique uma sequência de caracteres para o parâmetro de tag.
Ela é usada para criar as tags de elemento com os valores de matriz como o conteúdo
do elemento.
Sintaxe
sXML = convertValueToXml(arrayOrVmap, tag)
Argumentos
arrayOrVmap (Sequência de caracteres)
Especifica uma matriz ou um mapa de valores.
tag (sequência de caracteres)
Especifica a tag obrigatória a ser usada com uma matriz ou a tag opcional a ser
usada com um mapa de valores.
544 Referência do Criador de Conteúdo
convertXml
Valor de retorno
sXML (sequência de caracteres)
O tipo de retorno é Sequência de caracteres.
Exemplos
1.
Nesse exemplo, Process.array contém valores 1, 2 e 3.
Process.xml = convertValueToXml(Process.array, "test")
Process.xml contém o fragmento XML a seguir:
<test>1<test><test>2<test><test>3<test>
2.
Neste exemplo, o Process.valuemap tem dois campos com os nomes "field1" e
"field2" e valores ''value1' e 'value2'.
Process.xml = convertValueToXml (Process.valuemap, null)
Process.xml contém o fragmento XML a seguir:
<field1>value1</field1><field2>value2</field2>
convertXml
A função convertXML converte um fragmento XML em um mapa de valores.
Sintaxe
vmResult = convertXml(xmlString)
Argumentos
xmlString (sequência de caracteres)
Especifica o XML que precisa ser analisado.
Valor de retorno
vmResult (mapa de valores)
Representação ValueMap dos dados contidos em uma sequência de caracteres
XML.
Exemplo
vmResult = convertXml(Process.xmlString)
Capítulo 16: Funções do sistema do CA Process Automation 545
convertXmlURL
convertXmlURL
A função convertXmlUrl converte o documento XML acessado por meio de um URL em
um mapa de valores.
Sintaxe
vmResult = convertXmlUrl(url)
Argumentos
url (sequência de caracteres)
Especifica o URL do documento XML que precisa ser analisada.
Valor de retorno
vmResult (mapa de valores)
Representação, no mapa de valores, dos dados recuperados do documento XML
que o URL identifica.
Exemplo
vmResult = convertXmlUrl("
http://localhost:8080/itpam_tutorials/book.xml");
createHyperLink
A função createHyperLink cria um elemento de hiperlink HTML com os parâmetros
especificados e retorna uma sequência de caracteres que será formatada como "<a href
=\""+url+"\">"+nome+"</a>".
Sintaxe
sLink = createHyperLink(url, name)
Argumentos
url (sequência de caracteres)
Especifica o URL HTTP cujo hiperlink precisa ser criado.
name (sequência de caracteres)
Especifica o nome do hyperlink.
546 Referência do Criador de Conteúdo
createResourceObject
Valor de retorno
sLink (sequência de caracteres)
Um hiperlink com um URL e nome como definido pelo argumentos passados para a
função.
Exemplo
sLink = createHyperLink("http://www.ca.com","CA Technologies");
createResourceObject
A função createResourceObject cria um objeto de recursos.
Sintaxe
bSuccess = createResourceObject(resourcePath)
Argumentos
resourcePath (sequência de caracteres)
Especifica o caminho do objeto de recursos.
Valor de retorno
bSuccess (booleano)
Essa função retornará verdadeiro se tiver êxito ou falso se falhar.
Exemplo
bSuccess = createResourceObject("SyncRes")
deleteAttachments
A função deleteAttachments exclui anexos do bando de dados do CA Process
Automation que receberam uma matriz de IDs exclusivas.
Sintaxe
bSuccess = deleteAttachments(AttachmentIDArray)
Argumentos
AttachmentIDArray (matriz)
Especifica uma matriz de IDs exclusivas. As IDs podem ser sequências de caracteres,
extensões ou números inteiros.
Capítulo 16: Funções do sistema do CA Process Automation 547
deleteObject
Valor de retorno
bSuccess (booleano)
■
Essa função retornará falso apenas se os argumentos forem uma matriz vazia.
■
Essa função acionará uma exceção (ou seja, o operador falha) caso não possa
excluir anexos ou se argumentos inválidos forem passados.
■
Essa função retornará verdadeiro se puder processar a solicitação de exclusão
de anexos com êxito (incluindo o caso em que a função não pode excluir alguns
dos anexos ou todos eles).
Exemplos
Process.rglAttachIDs = nova Matriz (1,2,3,4,5);
Process.del = deleteAttachments (Process.rglAttachIDs);
deleteObject
A função deleteObject exclui e elimina o objeto da biblioteca especificado pelo
parâmetro objectName. O parâmetro de entrada pode ser um caminho completo ou
relativo. O caminho relativo é relativo ao processo em que o script é executado.
Sintaxe
bSuccess = deleteObject(objectName)
Argumentos
objectName (sequência de caracteres)
Especifica o caminho completo/relativo do objeto de biblioteca que precisa ser
excluído e eliminado.
Valor de retorno
bSuccess (booleano)
Essa função retornará verdadeiro se tiver êxito ou falso se falhar.
Exemplos
1.
Esse exemplo exclui o objeto de processo encontrado no caminho /folder/Process e
retorna o valor Verdadeiro.
bSuccess = deleteObject('/folder/Process')
2.
Esta função está sendo executada dentro do processo "Process_1" e o Process_1
está na pasta "Folder1" que está presente dentro da pasta raiz. Essa função exclui o
processo com o caminho completo /Folder1/Process e retorna o valor Verdadeiro.
bSuccess = deleteObject('Process')
548 Referência do Criador de Conteúdo
deleteResource
deleteResource
A função deleteResource exclui um recurso de um objeto de recursos.
Sintaxe
bSuccess = deleteResource(resourcePath, resourceName)
Argumentos
resourcePath (sequência de caracteres)
Especifica o caminho do objeto de recursos.
resourceName (sequência de caracteres)
Especifica o nome do recurso no objeto de recursos que precisa ser excluído.
Valor de retorno
bSuccess (booleano)
Essa função retornará verdadeiro se tiver êxito ou falso se falhar.
Exemplo
bSuccess = deleteResource("/folder/ResObject", "fileLock");
deleteValueMapField
A função deleteValueMapField exclui um campo de um mapa de valores.
Sintaxe
bSuccess = deleteValueMapField(vMap, fieldName)
Argumentos
vMap (mapa de valores)
Especifica o mapa de valores cujo campo precisa ser excluído.
fieldname (sequência de caracteres)
Especifica o nome do campo que precisa ser excluído.
Valor de retorno
bSuccess (booleano)
Retornará verdadeiro se a exclusão tiver sido concluída com êxito; caso contrário,
retornará falso.
Capítulo 16: Funções do sistema do CA Process Automation 549
existsCalendar
Exemplo
bSuccess = deleteValueMapField (process.vMap, "preço");
existsCalendar
A função existsCalendar verifica se um objeto de calendário existe no caminho
especificado. O caminho pode ser um caminho absoluto/relativo. O caminho relativo é
relativo ao processo em que o script é executado.
Sintaxe
bExists = existsCalendar(calendarPath);
Argumentos
calendarpath (Sequência de caracteres)
Especifica o caminho completo/relativo do objeto de calendário cuja existência
precisa ser verificada.
Valor de retorno
bExists (Boolean)
Retornará verdadeiro se o objeto de calendário existir. ou falso, caso contrário.
Exemplo
bExists = existsCalendar ("WorkCalendar");
existsCustomIcon
A função existsCustomIcon verifica se um objeto de ícone personalizado existe no
caminho especificado. O caminho pode ser um caminho absoluto/relativo. O caminho
relativo é relativo ao processo em que o script é executado.
Sintaxe
bExists = existsCustomIcon(customIconPath)
Argumentos
customIconPath (sequência de caracteres)
Especifica o caminho completo/relativo do objeto de ícone personalizado cuja
existência precisa ser verificada.
550 Referência do Criador de Conteúdo
existsCustomOperator
Valor de retorno
bExists (Boolean)
Retornará verdadeiro se o objeto de ícone personalizado existir, ou falso, caso
contrário.
Exemplo
se (existsCustomIcon (customIconPath))
{
Process.mseg_custom_icon = "CustomIcon existe";
}
else
{
Process.mseg_custom_icon = "CustomIcon não existe";
}
existsCustomOperator
A função existsCustomOperator verifica se um objeto de operador personalizado existe
no caminho especificado. O caminho pode ser um caminho absoluto/relativo. O
caminho relativo é relativo ao processo em que o script é executado.
Sintaxe
bExists = existsCustomOperator(customOperatorPath)
Argumentos
customOperatorPath (sequência de caracteres)
Especifica o caminho completo/relativo do objeto de operador personalizado cuja
existência precisa ser verificada.
Valor de retorno
bExists (Boolean)
Retornará verdadeiro se o objeto de operador personalizado existir, ou falso, caso
contrário.
Capítulo 16: Funções do sistema do CA Process Automation 551
existsDataset
Exemplo
se (existsCustomOperator (customOperatorpath))
{
Process.mseg_custom_operator= "CustomOperator existe";
}
else
{
Process.mseg_custom_operator= "CustomOperator não existe";
}
existsDataset
A função existsDataset verifica se um objeto de conjunto de dados existe no caminho
especificado. O caminho pode ser um caminho absoluto/relativo. O caminho relativo é
relativo ao processo em que o script é executado.
Sintaxe
bExists = existsDataset(datasetPath)
Argumentos
datasetPath (sequência de caracteres)
Especifica o caminho completo/relativo do conjunto de dados cujo existência
precisa ser verificada.
Valor de retorno
bExists (Boolean)
Retornará verdadeiro se o objeto de conjunto de dados existir, ou falso, caso
contrário.
Exemplo
se (existsDataset (datasetPath))
{
Process.mseg_dataset ="Conjunto de dados comuns existe";
}
else
{
Process.mseg_dataset ="Conjunto de dados comuns não existe";
}
552 Referência do Criador de Conteúdo
existsFolder
existsFolder
A função existsFolder verifica se um objeto de pasta existe no caminho especificado. O
caminho pode ser um caminho absoluto/relativo. O caminho relativo é relativo ao
processo em que o script é executado.
Sintaxe
bExists = existsFolder(folderPath)
Argumentos
folderPath (sequência de caracteres)
Especifica o caminho completo/relativo da pasta cuja existência precisa ser
verificada.
Valor de retorno
bExists (Boolean)
Retornará verdadeiro se o objeto de pasta existir, ou falso, caso contrário.
Exemplo
if(existsFolder(folderpath))
{
Process.mesg_folder = "Teste de pasta existe";
}
else
{
Process.mesg_folder = "Teste de pasta não existe";
}
existsInteractionRequestForm
A função existsInteractionRequestForm verifica se um objeto de formulário de
solicitação de interação existe no caminho especificado. O caminho pode ser um
caminho absoluto/relativo. O caminho relativo é relativo ao processo em que o script é
executado.
Sintaxe
bExists = existsInteractionRequestForm(irfPath)
Capítulo 16: Funções do sistema do CA Process Automation 553
existsProcess
Argumentos
irfpath (Sequência de caracteres)
Especifica o caminho completo/relativo do objeto Formulário de solicitação de
interação cuja existência precisa ser verificada.
Valor de retorno
bExists (Boolean)
Retorna verdadeiro se o objeto Formulário de solicitação de interação existe ou
falso se não existe.
Exemplo
se (existsInteractionRequestForm (irfPath))
{
Process.mseg_irf ="Formulário da solicitação de interação
existe";
}
else
{
Process.mseg_irf ="Formulário da solicitação de interação não
existe";
}
existsProcess
A função existsProcess verifica se um objeto de processo existe no caminho
especificado. O caminho pode ser um caminho absoluto/relativo. O caminho relativo é
relativo ao processo em que o script é executado.
Sintaxe
bExists = existsProcess(processPath)
Argumentos
processPath (sequência de caracteres)
Especifica o caminho completo/relativo do objeto de processo cuja existência
precisa ser verificada.
Valor de retorno
bExists (Boolean)
Retornará verdadeiro se o objeto de processo existir, ou falso, caso contrário.
554 Referência do Criador de Conteúdo
existsProcessWatch
Exemplo
se (existsProcess (processPath))
{
Process.mseg_process = "\'Transferir o controle para o operador
anterior\' existe";
}
else
{
Process.mseg_process ="\ 'Transferir o controle para o operador
anterior\' não existe";
}
existsProcessWatch
A função existsProcessWatch verifica se um objeto de exibição de processos existe no
caminho especificado. O caminho pode ser um caminho absoluto/relativo. O caminho
relativo é relativo ao processo em que o script é executado.
Sintaxe
bExists = existsProcessWatch(processWatchPath)
Argumentos
processwatchpath (sequência de caracteres)
Especifica o caminho completo/relativo do objeto de exibição de processos cuja
existência precisa ser verificada.
Valor de retorno
bExists (Boolean)
Retornará verdadeiro se objeto de exibição de processos existir, ou falso, caso
contrário.
Exemplo
se (existsProcessWatch (processWatchPath))
{
Process.mseg_process_watch = "ProcessWatch existe";
}
else
{
Process.mseg_process_watch = "ProcessWatch não existe";
}
Capítulo 16: Funções do sistema do CA Process Automation 555
existsResource
existsResource
A função existsResource verifica se um objeto de recursos existe no caminho
especificado. O caminho pode ser um caminho absoluto/relativo. O caminho relativo é
relativo ao processo em que o script é executado.
Sintaxe
bExists = existsResource(resourcePath)
Argumentos
resourcePath (String)
Especifica o caminho completo/relativo do objeto de recursos cuja existência
precisa ser verificada.
Valor de retorno
bExists (Boolean)
Retornará verdadeiro se o objeto de recursos existir, ou falso, caso contrário.
Exemplo
bExists = existsResource ("Resources/Locks");
existsSchedule
A função existsSchedule verifica se um objeto de programação existe no caminho
especificado. O caminho pode ser um caminho absoluto/relativo. O caminho relativo é
relativo ao processo em que o script é executado.
Sintaxe
bExists = existsSchedule(schedulepath)
Argumentos
schedulepath (String)
Especifica o caminho completo/relativo do objeto de programação cuja existência
precisa ser verificada.
Valor de retorno
bExists (Boolean)
Retorna verdadeiro se scheduleobject existe ou falso se não existe.
556 Referência do Criador de Conteúdo
formatDate
Exemplo
if (existsSchedule("testSchedule"))
{Process.mseg_schedule= "testSchedule
else
{Process.mseg_schedule= "testSchedule
if (existsSchedule("testSchedule"))
{Process.mseg_schedule= "testSchedule
else
{Process.mseg_Schedule= "testSchedule
exists" ;}
does not exist" ;}
exists" ;}
does not exist" ;}
formatDate
A função formatDate retorna uma sequência de caracteres com base em uma data e um
especificador de formato. Consulte essa lista para obter padrões de data e hora
permitidos.
Sintaxe
dateString = formatDate(dt, format)
Argumentos
dt (java.util.Date)
Especifica o objeto de data a ser formatado.
format (String)
Especifica o formato necessário (por exemplo, MM/dd/aaaa).
Valor de retorno
dateString (sequência de caracteres)
Essa função retorna a data como uma sequência de caracteres usando o
especificador de formato.
Exemplos
Process.logMessage = "O valor de data é " + formatDate
(Process.CurrentFootprintDate, 'aaaa-mm-dd hh:mm:ss');
Capítulo 16: Funções do sistema do CA Process Automation 557
formatString
formatString
A função formatString retorna uma sequência de caracteres após a formatação da
sequência de caracteres especificada com os argumentos mencionados.
Sintaxe
resultString = formatString(format, args)
Argumentos
format (String)
Especifica a sequência de caracteres de formato.
argumentos (matriz)
Especifica os argumentos para a formatação.
Valor de retorno
resultString (sequência de caracteres)
Essa função retorna uma sequência de caracteres, formatada de acordo com os
argumentos fornecidos nos argumentos da função.
Exemplo
var myArray = nova Matriz ();
myArray[0] ="a";
myArray[1] = "b";
myArray[2] = "c";
myArray[3] = "d";
sString = formatString ("%4$s %3$2s %2$2s %1$2s", myArray);
Isso resulta em sString ="d c b a".
getAllAttachments
A função getAllAttachments retorna informações para todos os anexos que estão
presentes no banco de dados do CA Process Automation.
Sintaxe
vmArrayAttachments = getAllAttachments ()
558 Referência do Criador de Conteúdo
getAttachmentContent
Valor de retorno
vmArrayAttachments (C2OvalueArray)
Essa função retorna uma matriz que contém as informações a seguir para todos os
anexos que estão presentes no banco de dados do CA Process Automation:
contentType
Tipo de conteúdo dos anexos.
contentID
Anexo contentID, se houver.
fileURL
O URL que pode ser usada para exibir ou baixar o anexo.
name
Nome do anexo.
attachmentID
ID exclusiva para este anexo. Essa ID pode ser passada para outras funções do
sistema.
Exemplo
Process.attachments = getAllAttachments ();
getAttachmentContent
A função getAttachmentContent recupera o conteúdo de um anexo e o coloca em uma
variável do conjunto de dados do CA Process Automation. Esta função tem um limite de
64KB para o tamanho do conteúdo que pode recuperar.
Sintaxe
sAttachment = getAttachmentContent(lAttachmentID)
Argumentos
lAttachmentID (longo)
A ID exclusiva que identifica o anexo em que se encontra o conteúdo que está
sendo recuperado.
Valor de retorno
sAttachment (C2OString)
O conteúdo é retornado como uma C2OString.(com.optinuity.c2o.bean.C2OString).
Capítulo 16: Funções do sistema do CA Process Automation 559
getCountOfProcessStates
Exemplo
var i = Process.attachments[0].attachmentID;
Process.cont = getAttachmentContent (i);
getCountOfProcessStates
A função getCountOfProcessStates retorna a contagem de processos em todos os
estados possíveis.
Sintaxe
Process.processStates = getCountOfProcessStates();
Valor de retorno
processStates (ValueMap)
Retorna um ValueMap formado por todos os estados e o número de processos
nesse estado. Se nenhum processo estiver no estado especificado, a contagem será
0.
Exemplo
Process.processStates = getCountOfProcessStates();
getEEMArtifactToken
A função getEEMArtifactToken gera um token de artefato do CA EEM, normalmente
para uso único.
Sintaxe
getEEMArtifactToken (certificateFilePath, {certificatePassword |
KeyFilePath})
560 Referência do Criador de Conteúdo
getEEMArtifactTokenForUser
Argumentos
certificateFilePath
O caminho relativo (caminho do arquivo) para o arquivo de certificado. O arquivo
de certificado é carregado usando Gerenciar recursos de usuário na guia
Configuração.
certificatePassword (Sequência de caracteres) | KeyFilePath (Sequência de caracteres)
Um dos seguintes argumentos:
■
Quando o suporte ao FIPS estiver ativado no CA EEM, defina este argumento
como o caminho relativo do arquivo de chave (KeyFilePath). O arquivo de
chave é carregado no CA Process Automation usando Gerenciar recursos de
usuário na guia Configuração.
■
Quando o suporte ao FIPS não estiver ativado no CA EEM, defina este
argumento como a senha do certificado. Esta senha é usada como uma
sequência de caracteres para o certificado que é referenciado no argumento
certificateFilePath.
Valor de retorno
O token de artefato do CA EEM (Sequência de caracteres)
Exemplos
O exemplo a seguir mostra que o suporte ao FIPS está ativado no CA EEM:
Process.artifactToken = getEEMArtifactToken
(".c2ouserresources/mycerts/pam.12", "mypassword")
Process.artifactToken = getEEMArtifactToken
(".c2ouserresources/mycerts/upload/pam.cer",
".c2ouserresources/mycerts/keys/pam.key")
getEEMArtifactTokenForUser
A função getEEMArtifact gera um token do CA EEM para uso único.
Sintaxe
getEEMArtifactTokenForUser (username , password)
Argumentos
username
O nome de usuário de um usuário do CA EEM.
password
A senha de um usuário do CA EEM.
Capítulo 16: Funções do sistema do CA Process Automation 561
getEEMCredentialsToken
Valor de retorno
O token de artefato do CA EEM (Sequência de caracteres)
Exemplo
Process.artifactToken = getEEMArtifactTokenForUser ("pamadmin",
"pamadmin")
getEEMCredentialsToken
A função getEEMCredentialsToken gera um token de credencial do CA EEM,
normalmente para vários usos. O argumento certificateFilePath espera um caminho
relativo (Caminho do arquivo) do arquivo de certificado. Esse arquivo é carregado
usando Gerenciar recursos de usuário na guia Configuração.
Caso FIPS não esteja ativado, o segundo argumento será a senha do certificado. Essa
senha é usada como uma Sequência de caracteres para o certificado mencionado no
primeiro argumento (certificateFilePath).
Caso o suporte para FIPS esteja ativado no CA EEM, o segundo argumento será
KeyFilePath. KeyFilePath é o caminho relativo do arquivo de chave. Esse arquivo é
carregado no CA Process Automation usando Gerenciar recursos de usuário.
Sintaxe
getEEMCredentialsToken (certificateFilePath, {certificatePassword |
KeyFilePath})
Argumentos
certificateFilePath
O caminho relativo do arquivo de certificado.
certificatePassword (Sequência de caracteres) | KeyFilePath (Sequência de caracteres)
Um dos seguintes argumentos:
■
Para modo não-FIPS, esse argumento deve ser a senha do certificado.
■
Para modo FIPS ativado, esse argumento deve ser KeyFilePath do certificado.
KeyFilePath é carregado no CA Process Automation usando Gerenciar recursos
de usuário.
Valor de retorno
O token de artefato do CA EEM (Sequência de caracteres)
562 Referência do Criador de Conteúdo
getEEMCredentialsTokenForUser
Exemplo
Antes de criar o código, primeiro verifique se o CA EEM está habilitado para FIPS ou não
usando a função isFIPSMode (na página 572) (), assim você poderá passar
certificateFilePath, certificatePassword ou certificatepath e KeyFilePath.
Por exemplo:
If (isFIPSMode ().equals(„true‟)){
Process.credentialToken =
getEEMCredentialsToken("/mycerts/upload/pam.cer",
"/mycerts/keys/pam.key")
} else {
Process.credentialToken = getEEMCredentialsToken("/mycerts/pam.12",
"mypassword")
}
getEEMCredentialsTokenForUser
A função getEEMCredentialsTokenForUser gera um token do CA EEM para vários usos.
Sintaxe
getEEMCredentialsTokenForUser (username , password)
Argumentos
username
O nome de usuário de um usuário do CA EEM.
password
A senha de um usuário do CA EEM.
Valor de retorno
O token de artefato do CA EEM (Sequência de caracteres)
Exemplo
Process.credentialToken =
getEEMCredentialsTokenForUser("pamadmin","pamadmin")
Capítulo 16: Funções do sistema do CA Process Automation 563
getEnvVar
getEnvVar
A função getEnvVar retorna o valor da variável de ambiente obtida do ambiente (SO),
que deverá ter sido configurado antes de iniciar o JVM.
Sintaxe
sEnvValue = getEnvVar(vname)
Argumentos
vname (sequência de caracteres)
Especifica o nome da variável de ambiente cujo valor é exigido.
Valor de retorno
sEnvValue (sequência de caracteres)
O valor da variável de ambiente especificada, no formato de sequência de
caracteres.
Exemplo
Process.username=getEnvVar("username");
Process.path = getEnvVar("path");
getOrchestratorURL
A função getOrchestratorURL retorna o nome do orquestrador.
Sintaxe
getOrchestratorURL()
Valor de retorno
URL do Orquestrador (Sequência de caracteres)
Especifica o URL do Orquestrador e do Balanceador de carga (no caso de um
cluster).
Exemplo
Process.x = getOrchestratorURL();
onde x é o nome do processo. Depois que o processo for executado, a variável x dentro
do conjunto de dados do processo incluirá o nome do orquestrador.
564 Referência do Criador de Conteúdo
getPartialAttachmentContent
getPartialAttachmentContent
A função getPartialAttachmentContent é usada para recuperar o conteúdo de um
anexo. Ela tem um limite de 64 KB para a quantidade de conteúdo que pode recuperar.
Seu objetivo é permitir a recuperação de um subconjunto do conteúdo.
Sintaxe
sContent = getPartialAttachmentContent(lAttachmentID,nStartIndex,
nRetrieveLength)
Argumentos
lAttachmentID (longo)
A ID exclusiva que identifica o anexo em que se encontra o conteúdo que está
sendo recuperado.
nStartIndex (Int)
O local, em bytes
nRetrieveLength (Int)
Valor de retorno
sContent (C2OString)
Contém o conteúdo do anexo especificado, começando com o byte nStartIndex e
com no máximo de bytes nRetrieveLength. O tipo de retorno é C2OString
(com.optinuity.c2o.bean.C2OString).
Exemplo
var i = Process.attachments[0].attachmentID;
Process.part = getPartialAttachmentContent (i,i+1,100000);
getResourceAvail
A função getResourceAvail retorna o valor do campo livre de um recurso em um objeto
de recursos.
Sintaxe
nAvail = getResourceAvail(resourcePath, resourceName)
Argumentos
resourcePath (String)
Especifica o caminho do objeto de recursos.
Capítulo 16: Funções do sistema do CA Process Automation 565
getResourceName
resourceName (sequência de caracteres)
Especifica o nome do recurso no objeto de recursos cujo campo livre precisa ser
retornado.
Valor de retorno
nAvail (int)
Essa função retorna o número de recursos disponíveis do recurso especificado no
objeto de recursos encontrado no caminho especificado.
Exemplo
nAvail = getResourceAvail ("/Resources/Locks", "DiskLock");
getResourceName
A função getResourceName retorna uma matriz de sequências de caracteres que
contém os nomes dos recursos dentro de um objeto de recursos.
Sintaxe
resourceNames = getResourceNames(resourcePath)
Argumentos
resourcePath (String)
Especifica o caminho do objeto de recursos.
Valor de retorno
resourceNames (matriz da sequência de caracteres)
Matriz de nomes de recursos contidos no objeto de recurso especificado.
Exemplo
rgsNames = getResourceNames ("/Resources/Locks");
getResourceTotal
A função getResourceTotal retorna o valor da quantidade total de um determinado
recurso em um objeto de automação de recursos.
Sintaxe
nTotal = getResourceTotal(resourcePath, resourceName)
566 Referência do Criador de Conteúdo
getTouchpoints
Argumentos
resourcePath (String)
Especifica o caminho do objeto de recursos.
resourceName (String)
Especifica o nome do recurso no objeto de recursos cujo valor total precisa ser
retornado.
Valor de retorno
nTotal (Int)
Retorna o total do recurso especificado. Se o recurso não existir, -1 será retornado.
Exemplo
nTotal = getResourceTotal ("/Resources/Locks", "DiskLock");
getTouchpoints
A função getTouchpoint retorna uma lista de touchpoints referenciada por um nome de
touchpoint ou um nome de grupo de touchpoints. Esse método retorna uma matriz de
sequências de caracteres. Uma matriz vazia significa que o grupo de touchpoints está
vazio ou que o touchpoint com o nome fornecido não existe.
Sintaxe
rgsTouchpoints = getTouchpoints(TouchpointOrGroupName)
Argumentos
TouchpointOrGroupName (sequência de caracteres)
Especifica o nome do touchpoint ou do grupo de touchpoints.
Valor de retorno
rgsTouchpoints (matriz de sequências de caracteres)
Uma matriz de nomes de sequências de caracteres de touchpoint.
Exemplo
rgsTouchpoints = getTouchpoints ("localhost");
Capítulo 16: Funções do sistema do CA Process Automation 567
getValueFromValueMapArray()
getValueFromValueMapArray()
A função getValueFromValueMapArray retorna um campo ou uma coluna de uma
matriz que tem como base os parâmetros fornecidos.
Sintaxe
getValueFromValueMapArray(groupName, arrName, fieldName,
fieldValue, requiredFieldName)
Argumentos
groupName (Sequência de caracteres)
Define o nome do grupo personalizado publicado por você.
arrName (Sequência de caracteres)
Define o nome de uma matriz C2OValueMap.
fieldname (sequência de caracteres)
Define o nome do campo para o qual recuperar valores de outras colunas ou outros
campos de uma matriz.
fieldValue (Sequência de caracteres)
Define o valor real do campo para o qual recuperar valores de outras colunas ou
outros campos de uma matriz.
requiredFieldName (Sequência de caracteres)
Define o nome do campo ou da coluna exigido por você. Por exemplo, nome de
usuário, senha ou URL.
Valor de retorno
O valor de retorno é um Tipo de retorno C2OValue.
568 Referência do Criador de Conteúdo
getValueMapFields
Exemplo
Considere um grupo chamado DemoGroup e uma matriz, conforme mostrado na
ilustração a seguir:
A sintaxe a seguir recupera o valor do campo mUsername a partir da matriz da conexão
nomeada DemoGroup:
getValueFromValueMapArray("DemoGroup", "MailServerCredentials",
"mNamedConnection", "demo", "mUsername")
A saída é um C2OValue, onde:
■
O valor de fieldName é mUsername
■
O valor de fieldName é [email protected]
getValueMapFields
A função getValueMapFields retorna a lista de nomes de campo dentro de um mapa de
valores como uma matriz de variáveis de sequência de caracteres.
Sintaxe
fieldNames = getValueMapFields(vmap)
Argumentos
vmap (ValueMap)
Especifica o objeto ValueMap cujo nomes do campo precisam ser retornados.
Valor de retorno
fieldNames (matriz da sequência de caracteres)
Uma matriz da sequência de caracteres que contém os nomes dos campos
encontrados no ValueMap.
Capítulo 16: Funções do sistema do CA Process Automation 569
getValuesFromValueMapArray()
Exemplo
fieldNames = getValueMapFields(Process.vmBooks);
getValuesFromValueMapArray()
getValuesFromValueMapArray retorna todas as colunas ou campos de uma matriz.
Sintaxe
getValuesFromValueMapArray(groupName, arrName, fieldName,
fieldValue)
Argumentos
groupName (Sequência de caracteres)
Define o nome do grupo personalizado publicado por você.
arrName (Sequência de caracteres)
Define o nome de uma matriz de C2OValueMap.
fieldname (sequência de caracteres)
Define o nome do campo do qual você recupera o valor de outras colunas ou outros
campos de uma matriz.
fieldValue (Sequência de caracteres)
Define o valor real do campo do qual você recupera o valor de outras colunas ou
outros campos de uma matriz.
Valores de retorno
O valor de retorno é um Tipo de retorno C2OValue.
hasField
A função hasField determina se existe um campo em um mapa de valores.
Sintaxe
bHasField = hasField(valuemap, fieldName)
Argumentos
valuemap (mapa de valores)
Especifica o ValueMap de entrada.
570 Referência do Criador de Conteúdo
incluir
fieldname (sequência de caracteres)
Especifica o nome do campo.
Valor de retorno
bHasField (Booleano)
Retornará verdadeiro se o campo existir no mapa de valores ou, caso contrário,
retornará falso.
Exemplo
bHasField = hasField (vmbooks, "author");
incluir
A função incluir carrega o código JavaScript que é definido em um arquivo para uso na
seção de execução anterior e posterior para qualquer operador ou na seção SourceCode
(na página 422) do operador Executar o JavaScript. O código JavaScript carregado
somente é válida para o período de execução anterior / posterior ou SourceCode seção
que está carregado.
Sintaxe
include(jsFile)
Argumentos
jsFile (Sequência de caracteres)
Esse parâmetro deve fazer referência a um arquivo JavaScript. Ele pode ser um URL
HTTP, caso em que o parâmetro deve iniciar com um URL de arquivo, ou pode ser
um caminho dentro da pasta c2ouserresources. O caminho deve ser relativo à
própria pasta”.c2ouserresources". c2ouserresources está presente na pasta
.c2orepository da pasta de instalação do CA Process Automation.
Capítulo 16: Funções do sistema do CA Process Automation 571
isFIPSMode
Valor de retorno
Nenhum valor retornado (void).
Exemplos
O exemplo a seguir é um URL HTTP; o parâmetro começa com um URL do arquivo.
incluir ('http://test.ca.com/test.js')
Os seguintes exemplos carregam o arquivo de teste de um caminho relativo para a
pasta .c2ouserresources.
incluir ('file://c:/test.js')
Incluir ('test.js')
isFIPSMode
A função isFIPSMode permite determinar por programação se o modo FIPS está ativado
no servidor do CA EEM. Essa função retorna verdadeiro se o servidor do CA EEM está
em execução quando o modo FIPS está ativado e falso se o servidor não está em
execução.
Sintaxe
isFIPSMode()
Valor de retorno
Verdadeiro
Retornado se o servidor do CA EEM está em execução quando o modo FIPS está
ativado. (Seqüência de caracteres)
Falso
Retornado se o servidor do CA EEM está em execução quando o modo FIPS não está
ativado. (Seqüência de caracteres)
isTouchpointUp
A função isTouchpointUp determina se um touchpoint está ativo.
Sintaxe
bIsUp = isTouchpointUp(touchpointName)
572 Referência do Criador de Conteúdo
carregar
Argumentos
touchpointName (sequência de caracteres)
Especifica o nome do touchpoint.
Valor de retorno
bIsUP (Booleano)
Retorna verdadeiro se o touchpoint está ativo ou, caso contrário, retorna falso.
Exemplo
bIsUp = isTouchpointUp ("AccountingTouch")
carregar
A função carregar carrega o código JavaScript que é definido em uma variável de
conjunto de dados para uso na seção de execução anterior ou posterior de qualquer
operador ou na seção SourceCode (na página 422) do operador Executar o JavaScript. O
código JavaScript carregado somente é válido durante o período de execução
anterior/posterior ou na seção SourceCode em que está carregado.
Sintaxe
load(jsCode)
Argumentos
jsCode (sequência de caracteres)
Especifica o código JavaScript a ser carregado.
Valor de retorno
Nenhum valor retornado (void).
Exemplos
1.
Defina um objeto de conjunto de dados denominado Common com um parâmetro
jsCode contendo o seguinte JavaScript:
function convertToUpperCase (sValue) {return sValue.toUpperCase
()};
2.
Use a função load para carregar essa parte do código e disponibilizar as funções
desse código:
load(Datasets["Common"].convertUC);
Process.ucValue = convertToUpperCase("helloworld");
Capítulo 16: Funções do sistema do CA Process Automation 573
lockResource
lockResource
A função lockResource bloqueia ou desbloqueia um ou mais recursos em um objeto de
recurso. Se você especificar um valor para resourceName, ele redefinirá apenas esse
recurso. Se você deixar resourceName vazio, ele redefinirá todos os recursos no objeto
de recursos.
Observações:
■
Se recursos que não existem forem fornecidos como entrada, recursos ainda serão
criados.
■
Se você especificar um valor para resourceName e se o recurso não existir, ele será
criado com um valor zero e definido para o estado especificado.
Sintaxe
bSuccess = lockResource(resourcePath, resourceName, state)
Argumentos
resourcePath (String)
Especifica o caminho do objeto de recursos.
resourceName (String)
Especifica o nome do recurso no objeto de recursos.
state (booleano)
Especifica se o recurso deve ser bloqueado ou desbloqueado. Defina como
verdadeiro para bloqueado e falso para desbloqueado.
Valor de retorno
bSuccess (booleano)
Retorna verdadeiro caso a função obtenha êxito ou falso se falhar.
Exemplo
bSuccess = lockResource ("/Resources/Locks","InvLock", true);
logEvent
A função logEvent insere uma mensagem personalizada nos logs de uma instância do
processo.
Sintaxe
logEvent(level, category, msg)
574 Referência do Criador de Conteúdo
newValueMap
Argumentos
nível (Int)
Especifica um dos seguintes níveis de log:
4 = "ERROR"
3 = "WARNING"
2 = "NOTICE"
1 = "NORMAL"
categoria (sequência de caracteres) (esse valor é opcional)
Especifica uma das seguintes categorias de log:
■
"CUSTOM" (padrão)
■
"FLOW_CATEGORY"
■
"AGENDA_CATEGORY"
■
"ICON_CATEGORY"
■
"HANDLERS_CATEGORY"
■
"RESPONSE_CATEGORY"
■
"OTHERS_CATEGORY" (PROCESS,AGENDA,OPERATOR,HANDLER,
RESPONSE,OTHERS, CUSTOM,OTHERS)
msg (sequência de caracteres)
Especifica a mensagem de log real.
Valores de retorno
Nenhum valor retornado (void).
Exemplo
logEvent(1, "FLOW_CATEGORY", "Start New Hire Process has completed");
newValueMap
A função newValueMap cria e retorna um novo mapa de valores.
Sintaxe
vmData = newValueMap ()
Argumentos
Nenhum.
Capítulo 16: Funções do sistema do CA Process Automation 575
newDataset
Valor de retorno
vmData (ValueMap)
Exemplo
Process.myVmap = newValueMap()
newDataset
A função newDataset dinamicamente cria e retorna um mapa de valores que pode ser
atribuído a um objeto do conjunto de dados. Se você criar um conjunto de dados que já
existe com esta função, o conjunto de dados existente não será afetado.
Sintaxe
Datasets["/mydataset"]=newDataset()
Argumentos
Nenhum.
Valor de retorno
MapaDeValor
Exemplo
Datasets["/mydataset"]=newDataset()
nextOpenDate
A função nextOpenDate retorna uma data em aberto relativa a uma targetDate,
considerando includeCalendar, excludeCalendar e maxShifts. Se nenhuma data de
abertura foi encontrado com as entradas, o resultado é nulo.
Sintaxe
dtNextOpenDate = nextOpenDate(targetDate, includeCalendar,
excludeCalendar, maxshift)
576 Referência do Criador de Conteúdo
agora
Argumentos
dtToday (java.util.Date)
Especifica a data de entrada.
include_calendar (sequência de caracteres)
Especifica o caminho do objeto Incluir calendário.
exclude_calendar (sequência de caracteres)
Especifica o caminho do objeto Excluir calendário.
maxshifts (Int)
Especifica o número máximo de alternâncias aceitáveis ao pesquisar uma data de
abertura. Especifique números positivos para incrementar a data e os números
negativos para diminuir a data. O sistema caps o número máximo de mudanças em
5.
Valor de retorno
dtNextOpenDate (java.util.Date)
agora
A função agora retorna a data atual incluindo a hora.
Sintaxe
dtNow = now()
Argumentos
Nenhum.
Valor de retorno
dtNow (java.util.Date)
O valor de retorno é a data e hora atuais.
parseDate
A função parseDate retorna um objeto de data após analisar a sequência de caracteres
especificada no formato necessário.
Sintaxe
dtDate = parseDate(dateStr, format)
Capítulo 16: Funções do sistema do CA Process Automation 577
resetResource
Argumentos
dateStr (sequência de caracteres)
Especifica a sequência de caracteres que precisa ser analisada como uma data.
format (String)
Especifica o formato necessário para interpretar a sequência de caracteres da data
fornecida; por exemplo:dd/mm/aaaa.
Valor de retorno
dtDate (Data)
Equivalente de data da sequência de caracteres de entrada de dateStr, conforme
analisado usando a sequência de caracteres de formato de entrada.
Exemplos
1.
Define dtDate com um valor de 10 de dezembro de 2009 12:00:00 AM, quando o
formato é mm/dd/aaaa.
dtDate = parseDate('12/10/2009','MM/dd/yyyy')
2.
Define dtDate com um valor de 12 de outubro de 2009 12:00:00 AM, quando o
formato é dd/mm/aaaa.
dtDate = parseDate('12/10/2009','dd/MM/yyyy')
3.
Falha a seguinte entrada porque a sequência de caracteres de entrada de data não
corresponde ao formato de entrada.
dtDate = parseDate('12-10-/2009','dd/MM/yyyy')
resetResource
A função resetResource redefine um ou mais recursos em um objeto de recurso com
desbloqueio e a configuração da contagem de uso para zero. Se você especificar um
valor para o recurso nomeRecurso, apenas esse recurso será redefinido. Se você deixar
o recurso nomeRecurso vazio, todos os recursos no objeto de recursos serão
redefinidos.
Observação: se você especificar um valor para o recurso nomeRecurso e se o recurso
não existir, ele será criado com um valor de zero e definido como um estado bloqueado.
Sintaxe
bSuccess = resetResource(resourcePath, resourceName)
578 Referência do Criador de Conteúdo
rolldate
Argumentos
resourcePath (String)
Especifica o caminho do objeto de recursos.
resourceName (String)
Especifica o nome do recurso no objeto de recursos.
Valor de retorno
bSuccess (booleano)
Retorna verdadeiro caso a função chamada tiver êxito e falso se falhar.
rolldate
A função rollDate é usada para registrar um determinado valor com base em uma data.
Por exemplo, talvez você queira enviar um email de feedback um dia depois após o
fechamento de uma solicitação da central de serviço. Nesse caso, para criar a lógica de
automação, use essa função.
Quando essa função é executada, o valor numérico é adicionado à data dt com base no
tipo.
Sintaxe
dtRollDate = rollDate(dt, num, type)
Argumentos
dt (java.util.Date)
Especifica o objeto Data com base no registro que acontecerá.
num (Int)
Especifica o valor que precisa ser registrado.
type (String)
Especifica um dos seguintes valores:
■
y (ano)
■
d (dias)
■
w (semana)
■
m (mensal)
Valor de retorno
dtRollDate (java.util.Date)
Capítulo 16: Funções do sistema do CA Process Automation 579
rolltime
Exemplos
1.
Retorna a data que é dois dias a partir de hoje.
dtRollDate = rollDate(today(),2,'d')
2.
Retorna o próximo ano a partir de hoje; por exemplo, se hoje é 12 de novembro de
2009, este exemplo retornará 1 de janeiro de 2010.
dtRollDate = rollDate(today(),1 'y')
3.
Retorna o primeiro dia da semana anterior.
dtRollDate = rollDate(today(), -1,'w')
4.
Retorna o primeiro dia do mês anterior.
dtRollDate = rollDate(today(),-1 ,'m')
rolltime
A função rollType registra a hora atual no valor fornecido e retorna o valor em horas
com base em um relógio de 24 horas. Nessa convenção de cronometragem, o dia se
estende de meia-noite a meia-noite, sendo dividido em 24 horas, numeradas de 0 a 23.
Sintaxe
nHTime = rollTime(num, type)
Argumentos
num (Int)
Especifica o valor que precisa ser ajustado.
type (String)
Este valor pode ser apenas "h".
Valor de retorno
nHTime (Int)
Exemplo
Retorna o tempo de três horas antes da hora atual. Por exemplo, se for 21 h no
momento, este exemplo retornará 18, que corresponde a 6 horas da noite em um
relógio de 24 horas.
nHTime = rollTime (-3, 'h')
580 Referência do Criador de Conteúdo
saveAttachmentToFile
saveAttachmentToFile
A função saveAttachmentToFile salva o conteúdo de um anexo, identificado por uma ID
exclusiva, no local do arquivo especificado. A função retorna o caminho absoluto do
novo arquivo com o conteúdo do anexo.
Sintaxe
sFileName = saveAttachmentToFile(nAttachmentID, sFileDirName)
Argumentos
lAttachmentID (longo)
Especifica uma ID exclusiva que identifica o anexo que contém o conteúdo
desejado.
sFileDirName (sequência de caracteres)
O caminho completo e o nome do arquivo referentes ao local onde o arquivo será
gravado.
Se um caminho de arquivo não for fornecido, o arquivo será gravado no diretório
install_dir/server/c2o.
Se um arquivo não for especificado um arquivo exclusivo será gerado.
Se somente um caminho é especificado, o caminho deve incluir o caractere
separador de caminho no final do caminho (‘\ ’ para Windows ou ‘/’ para UNIX).
Valor de retorno
sFileName (C2OString)
O caminho completo para o arquivo, incluindo o nome do arquivo, é retornado se a
função tiver êxito. Se a função falhar, NULL é retornado. O tipo de retorno é
C2OString.
Exemplo
var i = Process.attachments[0].attachmentID;
Process.save =
saveAttachmentToFile (i, "attach.txt");
setOperatorStatus
A função setOperatorStatus é usada para forçar a falha ou forçar a passagem do
operador.
Sintaxe
setOperatorStatus (operatorStatus, operationResult, reason)
Capítulo 16: Funções do sistema do CA Process Automation 581
setProcessProgress
Argumentos
Status do operador (sequência de caracteres)
Especifica o estado do operador. Esse argumento aceita somente os valores sucesso
ou falha.
Resultado da operação (Int)
Especifica o resultado da operação. Esse argumento substitui o resultado do
operador no conjunto de dados do operador.
Motivo (Sequência de caracteres)
Especifica o motivo que substitui o motivo do operador no conjunto de dados do
operador.
Valor de retorno
Nenhum valor retornado (void).
Exemplo
O exemplo a seguir força o sucesso no operador com o resultado 1 da operação e o
motivo como "force success" (forçado com sucesso).
setOperatorStatus("success",1,"force success")
setProcessProgress
A função setProcessProgress define o andamento de um processo nas seguintes áreas:
■
Código do operador de execução anterior ou posterior
■
Um operador RunJavaScript
Sintaxe
setProcessProgress (ProcessProgress)
Argumentos
ProcessProgress
Especifica a porcentagem de conclusão de um processo.
Valor de retorno
Nenhum valor retornado (void).
582 Referência do Criador de Conteúdo
setResourceTotal
Exemplo
Use o método setProcessProgress para definir o andamento do processo como 30%,
conforme mostrado a seguir:
setProcessProgress(30)
Quando um processo atinge o operador, o painel da operação ou o conjunto de dados
do processo exibe o progresso como 30.
setResourceTotal
A função setResourceTotal define a quantidade total de recursos com o nome resName
como a quantidade especificada no objeto de recurso no caminho resPath.
Observações:
■
Se você fornecer recursos que não existem como entrada, essa função criará os
recursos.
■
Se o parâmetro resName estiver em branco, essa função definirá a quantidade total
de todos os recursos no objeto de recursos.
Sintaxe
bSuccess = setResourceTotal(resPath, resName, amount)
Argumentos
resPath (sequência de caracteres)
Especifica o caminho do objeto de recursos.
resName (sequência de caracteres)
Especifica o nome do recurso definido no objeto de recursos.
amount (int)
Especifica a quantidade total definida no recurso.
Valor de retorno
bSuccess (booleano)
Retorna true caso a função seja executada com êxito ou false se falhar.
Capítulo 16: Funções do sistema do CA Process Automation 583
hoje
Exemplo
bSuccess1=setResourceTotal(Process.ResObjName, Process.ResName_1,
1);
bSuccess2=setResourceTotal(Process.ResObjName, Process.ResName_3,
3);
hoje
A função hoje retorna a data e a hora atuais. O tempo retornado é 12h.
Sintaxe
dtToday = today()
Argumentos
Nenhum.
Valor de retorno
dtToday (java.util.Date)
Retorna a data atual.
Exemplo
Se hoje é 12 de dezembro de 2009, retorna a data 12 de dezembro de 2009 às 12h.
584 Referência do Criador de Conteúdo