Usando a API de texto › API de texto › Formato de entrada

Formato de entrada

A entrada para a API de texto é especifica das seguintes formas:

• Na interface de linha de comando, a entrada é tipicamente especificada em um arquivo de texto passado para o comando pdm_text_cmd.
• Na interface de email, a entrada é especificada no texto do email. Você especifica uma expressão comum para localizar os identificadores do objeto de destino.

Você formata a entrada da API de texto da mesma forma, não importa a interface que usar.

O formato básico da entrada é o seguinte:

%palavra-chave=valor

ou

PROPERTY={{rótulo_propriedade}}valor

O comportamento normal dos comandos da API de texto tem as seguintes exceções, onde a última ocorrência de dois ou mais comandos conflitantes tem precedência:

• Quando uma mensagem contém vários objetos ID de ticket válidos que correspondem à sequência de caracteres de filtro da caixa de correio, ou vários comandos da ID de ticket da API de texto, o primeiro encontrado é usado. Além disso, um objeto ID de ticket, que é identificado usando a sequência de caracteres de filtro de caixa de correio, sobrescreve qualquer comando da ID de ticket da API de texto, independentemente de qual aparecer primeiro.
• Quando uma mensagem contém vários comandos da API de texto de comentário de log, todos os comentários são publicados, apesar de que a ordem em que aparecem no log de atividade do ticket pode variar.

Todos os objetos ID de ticket que correspondem ao filtro, válidos ou não, e os comandos da ID de ticket da API de texto dentro da mensagem, aplicáveis ou não, são comentados antes que a mensagem seja publicada. Os objetos ID de ticket identificados por meio de filtros de regra de caixa de correio aparecem como -((...))-. Sinais de porcentagem à esquerda (%) em comandos da ID de ticket da API de texto são convertidos em dois parênteses de abertura ((, e dois parênteses de fechamento )) seguem-se ao comando. Se o comando da ID de ticket da API de texto aparecer depois de outro comando da API de texto com um comentário de log (%LOG=…), então o comando comentado da ID de ticket da API de texto é feito em um comentário de log separado.

Observação: o comentário de log é o único comando da API de texto que pode aparecer várias vezes em uma mensagem e ainda assim ter cada ocorrência aplicada. Para qualquer outro comando, a API de texto usa somente a última ocorrência, porque várias ocorrências de outros comandos conflitam entre si. Vários comandos de comentário de log publicam mensagens de comentário de log separadas para o ticket, e não necessariamente em qualquer ordem particular.

Adicionalmente, se um comando da ID de ticket da API de texto aparecer na mensagem, seja no início da mensagem ou entre dois outros comandos da API de texto, ele é convertido em um comentário de log. Se o comando anterior é um comentário de log (%LOG=…) ou descrição de atualização (%DESCRIPTION=…), ele é anexado a aquele comando, em vez de tornar-se um comentário de log separado.

Mensagens de entrada que são enviadas somente como HTML, sem uma versão em texto sem formatação incluída, perdem seu corpo de mensagem. Se a mensagem coincidir com qualquer filtro de regra de caixa de correio com um corpo de mensagem vazio, um ticket pode ser criado com uma Descrição vazia, ou com o assunto da mensagem como toda a descrição do ticket.