Propriedades
| Nome | Tipo | Nível de acesso | Descrição |
|---|---|---|---|
| CheckSucceeded | bool | Leitura e gravação | Indica se a condição da regra foi atendida. O valor padrão é true. Seu script deve defini-la como false se a condição não for atendida. Nesse caso, a mensagem de erro padrão será exibida ao operador: “Error in the rule <rule_name>: <field_name>”. Se preferir outra mensagem, defina-a usando a propriedade ErrorMessage. Importante! Um erro só é gerado se CheckSucceeded estiver definido como false. Se o script não alterar o valor de CheckSucceeded para false, nenhuma mensagem de erro será exibida, mesmo que as condições não tenham sido atendidas. |
| CurrentField | Field | Somente leitura | O campo verificado pela regra. Para campos repetidos verificados por regras repetidas: a instância específica do campo que está sendo verificada na chamada atual. Se a regra fizer referência ao documento como um todo, retorna um valor nulo. |
| Document | Document | Somente leitura | O documento para o qual a regra é executada. |
| ErrorMessage | string | Leitura e gravação | Mensagem definida pelo usuário a ser exibida se o script definir CheckSucceeded como false. Se você não definir essa propriedade, a mensagem exibida em caso de erro será “Error in the rule <rule_name>: <field_name>”. |
| Transaction | Transaction | Somente leitura | A transação atual. |
Métodos
| Nome | Descrição |
|---|---|
| Field GetField(string fieldName); | Obtém o campo pelo nome ou identificador. Importante! Passe o nome do campo como string diretamente para este método: uma variável com o mesmo valor de string não funcionará. O pré-processador que analisa o código do script antes da execução substituirá o nome do campo por seu identificador, mas não conseguirá processar uma variável. Use o caminho completo para referenciar campos contidos em um grupo de campos, por exemplo, BusinessUnit/Address. Quando usado em uma regra repetitiva, este método retornará, em sequência, cada instância de campo processada. Caso contrário, ao referenciar um campo repetitivo, este método retorna a primeira instância. |
| Field[] GetFields(string fieldName); | Retorna uma lista de campos que têm o nome especificado. Este método pode ser usado para obter todas as instâncias de um campo repetitivo, incluindo todas as células de uma coluna de tabela. Este método facilita o acesso a campos repetitivos ao usar loops. Importante! Passe o nome do campo como string diretamente para este método: uma variável com o mesmo valor de string não funcionará. O pré-processador que analisa o código do script antes da execução substituirá o nome do campo por seu identificador, mas não conseguirá processar uma variável. |
| Record GetCatalogRecord(string catalogId, string externalId); | Obtém um registro de um catálogo (banco de dados externo). Use este método para obter informações de um catálogo e comparar os valores de campos no documento com os valores de campos no catálogo. O nome do catálogo (catalogId) e o identificador do registro no catálogo (externalId) são passados como argumentos. Este método só pode ser usado se o identificador apropriado tiver sido configurado no catálogo (por exemplo, o identificador do Fornecedor). |
| SkillParameter SkillParameter(string ParameterName); | Obtém um valor do parâmetro da Skill. Este método só pode ser usado se a Skill de Documento tiver pelo menos um parâmetro. |