Funções JavaScript predefinidas

O CA Service Catalog fornece várias opções para executar tarefas automatizadas em campos de formulários, incluindo objetos de dados de relatório, expressões JavaScript e funções JavaScript. Este tópico relaciona as funções JavaScript predefinidas e fornece uma visão geral de como é possível usá-las opcionalmente para automatizar tarefas em campos.

Use as seguintes diretrizes para especificar valores para os operandos usados em várias das funções JavaScript predefinidas. Para a maioria das funções, os dois primeiros operandos da lista a seguir são obrigatórios e os outros são opcionais. Verifique a sintaxe da função individual para ver que operandos se aplicam a ela.

• Para formId, especifique o valor do atributo _id do formulário no qual deseja executar a função.
• Para _id, especifique o valor do atributo _id do elemento dentro daquele formulário no qual você deseja executar a função.
• Para nome, valor e índice, especifique o valor desses atributos para o elemento no qual a função está sendo executada.
• Mais operandos são mencionados, conforme aplicável, para funções específicas. Por exemplo, o atributo de índice é aplicável somente para certos elementos, como um grupo de seleção

_.serviceoption.status( )

Retorna o status do item de linha ao qual o formulário atual pertence. Use essa função para especificar atributos de formulário de modo dinâmico, dependendo do status do item de linha. Por exemplo, para ocultar determinados campos de formulário quando seu status de linha for concluído, defina o atributo oculto como “_.serviceoption.status() == 200”.

Observação: também é possível usar essa função para ocultar ou desativar um elemento de opção de serviço. Para fazer isso, use essa função na caixa de texto oculto ou desativado.

Essa função também é especialmente útil para os status Pausado e Retomar. É possível fornecer motivos em mensagens de texto para ambos.

Observação: essa função não aceita parâmetros.

ca_fdDoFieldLookup(fieldId, reportId),

Executa o objeto de dados de relatório, associa-o ao campo de pesquisa e copia os dados retornados para os campos correspondentes no formulário. É possível usar essas ações para ajudar a preencher campos com base na entrada do usuário em um objeto de dados de relatório.

Para fieldId, especifique o valor do atributo _id do campo de consulta.

Para reportId, especifique o valor do objeto de dados criado anteriormente.

ca_reportQuery(reportId, variables, onSuccess, onFailure)

Executa um objeto de dados de relatório (objeto de dados) que consulta na origem de dados (como o MDB) os dados especificados e retorna o resultado.

• Para reportId, especifique o objeto de dados que você deseja para consulta.
• Para variáveis, especifique o mapa JavaScript com os nomes de variáveis e os valores. Exemplos incluem {“var1”:”foo”,”var2”:”bar”,”var3”:_.user.id}. Essas variáveis correspondem às consultadas no objeto de dados de relatório.
• Para onSuccess, especifique a função JavaScript a ser executada quando a consulta retornar com êxito. A função onSuccess deve ter um operando. O operando é definido com uma matriz de mapas, cada um representando uma linha, retornada pela consulta.
• Para onFailure, especifique a função JavaScript a ser executada se a chamada falhar.

Você pode preencher previamente os campos com base em um objeto de dados de relatório e funções JavaScript.

ca_fdValidateCC(credit card number, credit card type)

Valida o formato de número de cartão de crédito digitado pelo usuário no formulário que você criar.

ca_fdShowField(formId, _id)

Aplica-se a um único campo.

Localiza o formulário (formId) e o campo (_id) especificados. Além disso, torna esse campo visível, caso ainda não esteja visível.

ca_fdShowFields(formId, _ids)

Aplica-se a vários campos.

Localiza o formulário (formId) e o campo (_ids) especificados. Além disso, torna os campos visíveis, caso ainda não estejam visíveis.

O segundo parâmetro é uma matriz que contém os _ids de vários campos no formulário, como mostrado no exemplo para ca_fdHideFields(formId, _ids).

ca_fdHideField(formId, _id)

Aplica-se a um único campo.

Localiza o formulário (formId) e o campo (_id) especificados. Também oculta esse campo, caso ainda não esteja oculto.

ca_fdHideFields(formId, _ids)

Aplica-se a vários campos.

Localiza o formulário (formId) e os campos (_ids) especificados. Também oculta os campos, caso ainda não estejam ocultos.

O segundo parâmetro é uma matriz que contém os _ids de vários campos no formulário. Por exemplo, você deseja ocultar os campos de nome e sobrenome em um formulário. Além disso, a _id do formulário é name_form, e os valores de _id dos campos são first_name e last_name. Nesse caso, use o seguinte código:

ca_fdHideFields("name_form", ["first_name","last_name"]

ca_fdDisableField(formId, _id)

Aplica-se a um único campo.

Localiza o formulário (formId) e o campo (_id) especificados. Também desativa o campo, caso ainda não esteja desativado.

ca_fdDisableFields(formId, _ids)

Aplica-se a vários campos.

Localiza o formulário (formId) e os campos (_ids) especificados. Também desativa os campos, caso ainda não estejam desativados.

O segundo parâmetro é uma matriz que contém os _ids de vários campos no formulário, como mostrado no exemplo para ca_fdHideFields(formId, _ids).

ca_fdEnableField(formId, _id)

Aplica-se a um único campo.

Localiza o formulário (formId) e o campo (_id) especificados. Também ativa o campo, caso ainda não esteja ativado.

ca_fdEnableFields(formId, _ids)

Aplica-se a vários campos.

Localiza o formulário (formId) e os campos (_ids) especificados. Também ativa os campos, caso ainda não estejam ativados.

O segundo parâmetro é uma matriz que contém os _ids de vários campos no formulário, como mostrado no exemplo para ca_fdHideFields(formId, _ids).

ca_fdSelectOption(formId, _id, name, value) e ca_fdSelectOptionByIndex(formId, _id, index)

É possível usar qualquer dessas funções para selecionar um valor em uma caixa de seleção de forma programática. Essas funções têm o mesmo efeito e diferem somente na forma como são chamadas:

• ca_fdSelectOption seleciona a opção com o atributo _id, nome e valor especificados no campo de seleção.
• ca_fdSelectOptionByIndex seleciona a opção com o atributo _id e o valor de índice especificados no campo de seleção.

Considere os seguintes exemplos:

Exemplo 1

Este exemplo seleciona a primeira opção da caixa de seleção. Este exemplo usa os seguintes valores:

• Atributo _id do formulário: form_id
• Atributo _id da caixa de seleção: memory_select

  ca_fdSelectOption(‘form_id’, ‘memory_select’, 1) :
  

Exemplo 2

Este exemplo seleciona a primeira opção na caixa de seleção do formulário atual. Este exemplo usa os seguintes valores:

• Atributo _id do formulário: ca_fd.formId
• Atributo _id da caixa de seleção: memory_select

  ca_fdSelectOption(ca_fd.formId, ‘memory_select’, 1) :
  

Se não for possível localizar a caixa de seleção especificada, a chamada será ignorada e nenhum erro será informado.

Exemplo 3

Você pode reescrever os exemplos anteriores com valores explícitos para as opções, como a seguir:

ca_fdSelectOption(‘form_id’, ‘memory_select’, ‘option1’, ‘option1_value’), ca_fdSelectOption(ca_fd.formId, ‘memory_select’, ‘option1’, ‘option1_value’):

option1

Especifica o nome de uma opção como exibido na árvore do Criador de formulários. O valor dessa opção é option1_value.

ca_fdUnselectOption(formId, _id, name, value)

Desmarca a opção com o nome e o valor especificados no campo de seleção com o atributo _id correspondente.

ca_fdUnselectOptionByIndex(formId, _id, index)

Desmarca a opção do índice correspondente no campo de seleção com o atributo _id correspondente.

ca_fdUnselectAllOptions(formId, _id)

Desmarca todas as opções no campo de seleção com o atributo _id correspondente.

ca_fdGetSelectedOptions(formId, _id)

Retorna uma matriz de inteiros que indica os índices das opções selecionadas.

ca_fdGetSelectedOptionValues (formId, _id)

Retorna uma matriz de sequências de caracteres que indicam os valores das opções selecionadas. Selecione o primeiro valor da opção da seguinte maneira:

ca_fdGetSelectedOptionValues(formId, _id)[0]

Selecione o segundo valor da opção, alterando de 0 para 1; selecione o terceiro valor da opção alterando de 1 para 2 e assim por diante.

Essa função é especialmente útil para usar a entrada do usuário para preencher previamente uma caixa de seleção.

ca_fdSelectRadio(formId, name, _id)

Seleciona o botão de opção com _id correspondente no grupo de botões de opção com atributo de nome correspondente.

ca_fdIsSelectRadio (formId, name, _id)

Retorna se o botão de opção indicado está selecionado.

ca_fdSelectCheckBox(formId,_id)

Seleciona a caixa de seleção com atributo _id correspondente.

ca_fdUnselectCheckBox(formId, _id)

Desmarca a caixa de seleção com atributo _id correspondente.

ca_fdIsSelectedCheckBox(formId,_id)

Retorna se a caixa de seleção está selecionada.

ca_fdSetDateFieldValue(formId, _id, date) e funções relacionadas

Define o valor do campo de data especificado com o atributo _id correspondente. Essa função pode adotar valores inteiros Null, String ou Long para o parâmetro denominado date.

Para limpar o valor do campo, use a sequência de caracteres vazia e nula.

Especifique sequências de caracteres não vazias no formato especificado para o campo Data e hora (um elemento do formulário) da seguinte maneira:

• Se a parte de hora do campo Data e hora estiver oculta, especifique a sequência de caracteres somente no formato de data. Use o atributo de formato do campo Data e hora ou o formato de Data da unidade de negócios.
• Se a parte de hora do campo Data e hora estiver visível, especifique as sequências de caracteres no formato de data e hora especificado por esse campo.

Em ambos os casos, separe várias sequências de caracteres com um espaço.

As funções JavaScript relacionadas para definir a data são mostradas a seguir. O texto anterior para a função ca_fdSetDateFieldValue(formId, _id, date) também se aplica a essas funções.

• ca_fdSetDateFieldMinValue(formId, _id, date) – define o valor mínimo da data.
• ca_fdSetDateFieldMaxValue(formId, _id, date) – define o valor máximo da data.

Além disso, para todas as funções JavaScript ca_fdSetDateField*, você pode definir a data no número de milésimos de segundo desde a "hora de referência". A hora de referência é a hora base padrão de meia-noite (00:00:00) GMT, em 1 de janeiro de 1970. Para obter detalhes sobre como definir a data dessa maneira, consulte a referência de programação Java padrão, por exemplo, o site da Oracle, oracle.com.

ca_fdGetDateFieldValue(formId, _id, date) e funções relacionadas

Obtém o valor do campo de data especificado como uma sequência de caracteres formatada de acordo com a formatação especificada para o campo de data.

As informações sobre o campo Data e hora da função anterior (ca_fdSetDateFieldValue(formId, _id, date)) também se aplicam a esta função.

As funções JavaScript relacionadas para definir a data são as seguintes. O texto anterior para a função ca_fdGetDateFieldValue(formId, _id, date) também se aplica a essas funções.

• ca_fdGetDateFieldValueInMillis(formId, _id, date) – obtém o valor da data em milésimos de segundo.
• ca_fdGetDateFieldMinValue(formId, _id, date) – obtém o valor mínimo da data.
• ca_fdGetDateFieldMinValueInMillis(formId, _id, date) – obtém o valor mínimo da data em milésimos de segundo.
• ca_fdGetDateFieldMaxValue(formId, _id, date) – obtém o valor máximo da data.
• ca_fdGetDateFieldMaxValueInMillis(formId, _id, date) – obtém o valor máximo da data em milésimos de segundo.

Além disso, para todas as funções JavaScript ca_fdGetDateField*, você pode obter a data no número de milésimos de segundo desde a "hora de referência". A hora de referência é a hora base padrão de meia-noite (00:00:00) GMT, em 1 de janeiro de 1970. Para obter detalhes sobre como obter a data dessa maneira, consulte a referência de programação Java padrão, por exemplo, o site da Oracle, oracle.com.

ca_fdSetTextFieldValue(formId, _id, text)

Define o texto do campo de texto com atributo _id correspondente, que pode ser campo de texto e área de texto.

ca_fdGetTextFieldValue(formId, _id)

Obtém o texto do campo de texto com atributo _id correspondente, que pode ser campo de texto e área de texto.

ca_fdFetchSelectData(formId,_id)

Faz com que a caixa de seleção com o parâmetro _id especificado busque o objeto de dados do relatório novamente. Essa função é especialmente útil quando o objeto de dados do relatório usa a entrada do usuário. Como uma prática recomendada, execute essa função quando tal entrada for alterada, para certificar-se de que a caixa de seleção exibe os dados corretos.

Essa função também é especialmente útil para usar a entrada do usuário para preencher previamente uma caixa de seleção.

As funções a seguir são somente para formulários de sistema:

• custom_onPriorityChange(newPriority)
• custom_onDateRequiredChange(newDateRequired)
• custom_onRequestedForChange(type, id, name, shippingAddress)