Informações adicionais

Esta seção fornece informações adicionais sobre métodos, eventos, parâmetros e metadados.
  • Você pode definir um destino específico onde implementar a receita. A estrutura do destino deve ser a mesma que a estrutura salva no esquema de receita.
  • Você pode usar receitas com uma ExibiçãoEmLista ou usando NetLogic.
  • Um parâmetro de receita é um Item ou ItemDeDados selecionado no editor EsquemaDeReceita. Os parâmetros de receita representados em uma ExibiçãoEmLista são sempre apresentados como somente leitura.
  • As receitas introduzem um número elevado de operações de inserção/atualização/exclusão para determinadas tarefas. Isso pode aumentar o tempo necessário para concluir as operações, especialmente para bancos de dados remotos e alta latência. Para evitar a perda de dados, é oferecido suporte ao gerenciamento mínimo de transações. O gerenciamento de transações não é personalizável.
    IMPORTANTE: Para evitar a perda de dados ao trabalhar com RegistradorDeDados e RegistradorDeEventos, é altamente recomendável não usar o mesmo banco de dados que é usado para receitas.
  • Você pode usar o esquema de receita legado e o novo esquema de receita no mesmo projeto, mas isso pode exigir ajustes manuais.
  • Exemplo de consulta ao
    EmbeddedDatabase
    :
    SELECT R.*, M.* FROM Recipes AS R LEFT JOIN "RecipeMetadata_RecipeSchema1" AS M ON R.Id = M.RecipeId WHERE R.RecipeSchemaName = 'RecipeSchema1' ORDER BY R.Name

Métodos

As tabelas a seguir descrevem métodos e parâmetros relacionados:
Método disponível no IDE e por meio da API C#
Método
Argumentos de entrada
Argumentos de saída
CreateRecipe
  • IDDaReceita [IDDaReceita]
  • Resultado [CódigoDeResultadoDaCriaçãoDeReceita]
    • Sucesso: a receita foi criada com sucesso
    • IDDaReceitaAusente: o método foi chamado com um IDDaReceita vazio
    • RecipeAlreadyExist: uma receita com o mesmo nome e versão já existe
    • ErroDeArmazenamento: ocorreu um erro ao acessar o armazenamento
    • Erro: ocorreu um erro
DuplicateRecipe
  • IDDaReceita [IDDaReceita]
  • NewRecipeId [IDDaReceita]
  • Resultado [CódigoDeResultadoDaDuplicaçãoDeReceita]
    • Sucesso: a receita foi duplicada com sucesso
    • ErroGenérico: ocorreu um erro geral durante a duplicação de receitas
    • ErroDeArmazenamento: ocorreu um erro ao acessar o armazenamento (por exemplo, erro de banco de dados)
    • NomeDeReceitaDeOrigemVazioInesperado: o nome de receita de origem fornecido está vazio ou nulo
    • NomeDeReceitaDeDestinoVazioInesperado: o nome de receita de destino fornecido está vazio ou nulo
    • ReceitaDeOrigemNãoExiste: a receita de origem não foi encontrada no armazenamento
    • ReceitaDeDestinoJáExiste: já existe uma receita com o nome de destino
    • DestinoNãoEncontrado: o nó de destino para duplicação de receita não foi encontrado
RenameRecipe
  • IDDaReceita [IDDaReceita]
  • NewName [String]
  • Resultado [CódigoDeResultadoDaRenomeaçãoDeReceita]
    • Sucesso: a receita foi renomeada com sucesso
    • ErroGenérico: ocorreu um erro geral durante a renomeação da receita
    • ErroDeArmazenamento: ocorreu um erro ao acessar o armazenamento (por exemplo, erro de banco de dados)
    • NomeDeReceitaVazioInesperado: o nome da receita fornecido está vazio ou nulo
    • ReceitaDeOrigemNãoExiste: a receita de origem não foi encontrada no armazenamento
    • ReceitaDeDestinoJáExiste: já existe uma receita com o nome de destino
DeleteRecipe
  • IDDaReceita [IDDaReceita]
  • Resultado [CódigoDeResultadoDaExclusãoDeReceita]
    • Sucesso: a receita foi excluída com sucesso
    • ErroGenérico: ocorreu um erro geral durante a exclusão da receita
    • ErroDeArmazenamento: ocorreu um erro ao acessar o armazenamento (por exemplo, erro de banco de dados)
    • NomeDeReceitaVazioInesperado: o nome da receita fornecido está vazio ou nulo
    • ReceitaNãoExiste: a receita especificada não foi encontrada no armazenamento
Refatorar
  • Nenhum
Nenhum. Este é o único método assíncrono. Quando a operação é concluída, um evento (RefatoraçãoConcluída) é despachado.
GetDataItems
  • IDDaReceita [IDDaReceita]
  • Resultado [CódigoDeResultadoDeGetdataitems]
    • Sucesso: os itens de dados foram recuperados com sucesso
    • ReceitaNãoEncontrada: a receita especificada não foi encontrada no armazenamento
    • ErroDeArmazenamento: ocorreu um erro ao acessar o armazenamento (por exemplo, erro de banco de dados)
    • ErroGenérico: ocorreu um erro geral ao recuperar os itens de dados
SetRecipeDataItemValue
  • IDDaReceita [IDDaReceita]
  • ItemRelativeBrowsePath [String]
  • DataItemRelativeBrowsePath [String]
  • ElementAccess [ElementAccess]
  • Valor [BaseDataType]
  • Resultado [CódigoDeResultadoDaDefiniçãoDoValorDoItemDeDadosDaReceita]
    • Sucesso: o valor do item de dados da receita foi definido com sucesso
    • ErroGenérico: ocorreu um erro geral ao definir o valor do item de dados
    • ErroDeArmazenamento: ocorreu um erro ao acessar o armazenamento (por exemplo, erro de banco de dados)
    • ItemDeDadosNãoEncontrado: o item de dados especificado não foi encontrado na receita
    • NomeDeReceitaVazioInesperado: o nome da receita fornecido está vazio ou nulo
    • ReceitaNãoEncontrada: a receita especificada não foi encontrada no armazenamento
SetRecipeMetadataValue
  • IDDaReceita [IDDaReceita]
  • MetadataName [String]
  • Valor [BaseDataType]
  • Resultado [CódigoDeResultadoDaDefiniçãoDoValorDeMetadadosDaReceita]
    • Sucesso: o valor dos metadados da receita foi definido com sucesso
    • ErroGenérico: ocorreu um erro geral ao definir o valor de metadados
    • ErroDeArmazenamento: ocorreu um erro ao acessar o armazenamento (por exemplo, erro de banco de dados)
    • NomeDeReceitaVazioInesperado: o nome da receita fornecido está vazio ou nulo
    • ReceitaNãoEncontrada: a receita especificada não foi encontrada no armazenamento
    • MetadadosNãoEncontrados: o campo de metadados especificado não foi encontrado na receita
TransferFromEditModelToStore
  • RequesterNodeId [NodeId]
  • IDDaReceita [IDDaReceita]
  • Resultado [CódigoDeResultadoDaTransferênciaDoModeloDeEdiçãoParaOArmazenamento]
    • SucessoReceitaCriada: a receita foi criada com sucesso e transferida do modelo de edição para o armazenamento
    • SucessoReceitaAtualizada: a receita foi atualizada com sucesso e transferida do modelo de edição para o armazenamento
    • ErroGenérico: ocorreu um erro geral durante a transferência do modelo de edição para o armazenamento
    • ErroDeArmazenamento: ocorreu um erro ao acessar o armazenamento (por exemplo, erro de banco de dados)
    • NóDoSolicitanteNãoEncontrado: o nó do solicitante não foi encontrado
    • NomeDeReceitaVazioInesperado: o nome da receita fornecido está vazio ou nulo
    • DestinoNãoEncontrado: o nó de destino da transferência não foi encontrado
    • NóDoModeloDeEdiçãoNãoEncontrado: o nó do modelo de edição não foi encontrado
TransferFromEditModelToTarget
  • RequesterNodeId [NodeId]
  • TargetNodeId [NodeId]
  • PolíticaDeErro [DatatypeDaPolíticaDeErro]
  • Resultado [CódigoDeResultadoDaTransferênciaDoModeloDeEdiçãoParaODestino]
    • Sucesso: a receita foi transferida do modelo de edição para o destino com sucesso
    • ErroGenérico: ocorreu um erro geral durante a transferência do modelo de edição para o destino
    • ErroDeArmazenamento: ocorreu um erro ao acessar o armazenamento (por exemplo, erro de banco de dados)
    • NóDoSolicitanteNãoEncontrado: o nó do solicitante não foi encontrado
    • DestinoNãoEncontrado: o nó de destino da transferência não foi encontrado
    • NóDoModeloDeEdiçãoNãoEncontrado: o nó do modelo de edição não foi encontrado
    • IncompatibilidadeDeDados: há uma incompatibilidade entre os dados do modelo de edição e a estrutura de destino
TransferFromStoreToEditModel
  • RequesterNodeId [NodeId]
  • IDDaReceita [IDDaReceita]
  • Resultado [CódigoDeResultadoDaTransferênciaDoModeloDeEdiçãoParaODestino]
    • Sucesso: a receita foi transferida do modelo de edição para o destino com sucesso
    • ErroGenérico: ocorreu um erro geral durante a transferência do modelo de edição para o destino
    • ErroDeArmazenamento: ocorreu um erro ao acessar o armazenamento (por exemplo, erro de banco de dados)
    • NóDoSolicitanteNãoEncontrado: o nó do solicitante não foi encontrado
    • DestinoNãoEncontrado: o nó de destino da transferência não foi encontrado
    • NóDoModeloDeEdiçãoNãoEncontrado: o nó do modelo de edição não foi encontrado
    • IncompatibilidadeDeDados: há uma incompatibilidade entre os dados do modelo de edição e a estrutura de destino
TransferFromStoreToTarget
  • IDDaReceita [IDDaReceita]
  • TargetNodeId [NodeId]
  • PolíticaDeErro [DatatypeDaPolíticaDeErro]
  • Resultado [TransferFromStoreToTargetResultCode]
    • Sucesso: a receita foi transferida do armazenamento para o destino com sucesso
    • ErroGenérico: ocorreu um erro geral durante a transferência do armazenamento para o destino
    • ErroDeArmazenamento: ocorreu um erro ao acessar o armazenamento (por exemplo, erro de banco de dados)
    • NomeDeReceitaVazioInesperado: o nome da receita fornecido está vazio ou nulo
    • ReceitaNãoEncontrada: a receita especificada não foi encontrada no armazenamento
    • DestinoNãoEncontrado: o nó de destino da transferência não foi encontrado
    • IncompatibilidadeDeDados: há uma incompatibilidade entre os dados da receita e a estrutura de destino
TransferFromTargetToEditModel
  • RequesterNodeId [NodeId]
  • TargetNodeId [NodeId]
  • PolíticaDeErro [DatatypeDaPolíticaDeErro]
  • Resultado [CódigoDeResultadoDaTransferênciaDoDestinoParaOModeloDeEdição]
    • Sucesso: a receita foi transferida do destino para o modelo de edição com sucesso
    • ErroGenérico: ocorreu um erro geral durante a transferência do destino para o modelo de edição
    • ErroDeArmazenamento: ocorreu um erro ao acessar o armazenamento (por exemplo, erro de banco de dados)
    • NóDoSolicitanteNãoEncontrado: o nó do solicitante não foi encontrado
    • DestinoNãoEncontrado: o nó de destino da transferência não foi encontrado
    • NóDoModeloDeEdiçãoNãoEncontrado: o nó do modelo de edição não foi encontrado
    • IncompatibilidadeDeDados: há uma incompatibilidade entre os dados de destino e a estrutura do modelo de edição
TransferFromTargetToStore
  • IDDaReceita [IDDaReceita]
  • TargetNodeId [NodeId]
  • Overwrite [Bool]
  • PolíticaDeErro [DatatypeDaPolíticaDeErro]
  • Resultado [TransferFromTargetToStoreResultCode]
    • SucessoReceitaCriada: a receita foi criada e transferida com sucesso do destino para o armazenamento
    • SucessoReceitaAtualizada: a receita foi atualizada com sucesso e transferida do destino para o armazenamento
    • ErroGenérico: ocorreu um erro geral durante a transferência do destino para o armazenamento
    • ErroDeArmazenamento: ocorreu um erro ao acessar o armazenamento (por exemplo, erro de banco de dados)
    • NomeDeReceitaVazioInesperado: o nome da receita fornecido está vazio ou nulo
    • AReceitaJáExiste: uma receita com o mesmo nome já existe no armazenamento
    • DestinoNãoEncontrado: o nó de destino da transferência não foi encontrado
    • IncompatibilidadeDeDados: há uma incompatibilidade entre os dados de destino e a estrutura do armazenamento
Métodos disponíveis apenas por meio da API C#
Método
Argumentos de entrada
Argumentos de saída
GetRecipes
Nenhum argumento de entrada
  • Resultado [ResultadoDeGetrecipes] (Matriz)
    • Sucesso: as receitas foram recuperadas com sucesso
    • ErroDeArmazenamento: ocorreu um erro ao acessar o armazenamento
    • ErroGenérico: ocorreu um erro geral ao recuperar as receitas
GetRecipeMetadataValue
  • IDDaReceita [IDDaReceita]
  • MetadataName [String]
  • Resultado [ResultadoDaObtençãoDoValorDeMetadadosDaReceita]
    • Sucesso: o valor dos metadados da receita foi recuperado com sucesso
    • ErroGenérico: ocorreu um erro geral ao recuperar o valor de metadados
    • ErroDeArmazenamento: ocorreu um erro ao acessar o armazenamento
    • NomeDeReceitaVazioInesperado: o nome da receita fornecido está vazio ou nulo
    • ReceitaNãoEncontrada: a receita especificada não foi encontrada no armazenamento
    • MetadadosNãoEncontrados: o campo de metadados especificado não foi encontrado na receita
GetRecipeMetadataValues
IDDaReceita [IDDaReceita]
  • Resultado [ResultadoDaObtençãoDosValoresDeMetadadosDaReceita]
    • Sucesso: os valores dos metadados da receita foram recuperados com sucesso
    • ErroGenérico: ocorreu um erro geral ao recuperar os valores de metadados
    • ErroDeArmazenamento: ocorreu um erro ao acessar o armazenamento
    • NomeDeReceitaVazioInesperado: o nome da receita fornecido está vazio ou nulo
    • ReceitaNãoEncontrada: a receita especificada não foi encontrada no armazenamento
GetRecipeDataItemValue
  • IDDaReceita [IDDaReceita]
  • ItemRelativeBrowsePath [String] (Matriz)
  • DataItemRelativeBrowsePath [String] (Matriz)
  • ElementAccess [ElementAccess]
  • Resultado [ResultadoDaObtençãoDoValorDoItemDeDadosDaReceita]
    • Sucesso: o valor do item de dados da receita foi recuperado com sucesso
    • ErroGenérico: ocorreu um erro geral ao recuperar o valor do item de dados
    • ErroDeArmazenamento: ocorreu um erro ao acessar o armazenamento
    • ItemDeDadosNãoEncontrado: o item de dados especificado não foi encontrado na receita
    • NomeDeReceitaVazioInesperado: o nome da receita fornecido está vazio ou nulo
    • ReceitaNãoEncontrada: a receita especificada não foi encontrada no armazenamento
CreateEditModel
  • ParentNodeId [NodeId]
  • RequesterNodeId [NodeId]
  • TargetNodeId [NodeId]
  • IDDaReceita [IDDaReceita]
  • Resultado [CódigoDeResultadoDaCriaçãoDeModeloDeEdição]
    • Sucesso: o modelo de edição foi criado com sucesso
    • ErroGenérico: ocorreu um erro geral ao criar o modelo de edição
    • ErroDeArmazenamento: ocorreu um erro ao acessar o armazenamento
    • NóPaiNãoEncontrado: o nó pai do modelo de edição não foi encontrado
    • NóDoSolicitanteNãoEncontrado: o nó do solicitante não foi encontrado
TransferFromStores
IDDaReceita [IDDaReceita]
  • Resultado [CódigoDeResultadoDaTransferênciaDoArmazenamento]
    • Sucesso: a receita foi transferida do armazenamento com sucesso
    • ErroGenérico: um erro geral ocorreu durante a transferência do armazenamento
    • ErroDeArmazenamento: ocorreu um erro ao acessar o armazenamento
    • ReceitaNãoEncontrada: a receita especificada não foi encontrada no armazenamento
    • DestinoNãoEncontrado: o nó de destino da transferência não foi encontrado
TransferToStore
  • IDDaReceita [IDDaReceita]
  • Resultado [CódigoDeResultadoDaTransferênciaParaOArmazenamento]
    • Sucesso: a receita foi transferida para o armazenamento com sucesso
    • ErroGenérico: um erro geral ocorreu durante a transferência para o armazenamento
    • ErroDeArmazenamento: ocorreu um erro ao acessar o armazenamento
TransferirParaODestino
  • TargetNodeId [NodeId]
  • ErrorPolicy [ErrorPolicy]
  • Resultado [CódigoDeResultadoDaTransferênciaParaODestino]
    • Sucesso: a receita foi transferida para o destino com sucesso
    • ErroGenérico: um erro geral ocorreu durante a transferência para o destino
    • ErroDeArmazenamento: ocorreu um erro ao acessar o armazenamento
    • DestinoNãoEncontrado: o nó de destino da transferência não foi encontrado
    • IncompatibilidadeDeDados: há uma incompatibilidade entre os dados da receita e a estrutura de destino
TransferFromTarget
  • TargetNodeId [NodeId]
  • ErrorPolicy [ErrorPolicy]
  • Resultado [CódigoDeResultadoDaTransferênciaDoDestino]
    • Sucesso: a receita foi transferida do destino com sucesso
    • ErroGenérico: ocorreu um erro geral durante a transferência do destino
    • ErroDeArmazenamento: ocorreu um erro ao acessar o armazenamento
    • DestinoNãoEncontrado: o nó de destino da transferência não foi encontrado
    • IncompatibilidadeDeDados: há uma incompatibilidade entre os dados de destino e a estrutura da receita
SetDataItemValue
  • ItemId [NodeId]
  • DataItemRelativeBrowsePath [String] (Matriz)
  • ElementAccess [ElementAccess]
  • DataTypeId [NodeId]
  • Valor [BaseDataType]
  • Resultado [CódigoDeResultadoDaDefiniçãoDoValorDoItemDeDados]
    • Sucesso: o valor do item de dados foi definido com sucesso
    • ErroGenérico: ocorreu um erro geral ao definir o valor do item de dados
    • ErroDeArmazenamento: ocorreu um erro ao acessar o armazenamento
    • ItemDeDadosNãoEncontrado: o item de dados especificado não foi encontrado

Eventos

O esquema de receita inclui os seguintes eventos:
RefatoraçãoConcluída
Acionado quando o método Refatoração é concluído.
EventoDeAplicaçãoDeReceita
Acionado quando TransferFromStoreToTarget ou TransferEditModelToTarget são concluídos.

Parâmetros e metadados

Você pode criar, editar e armazenar esquemas de receita com parâmetros e metadados ilimitados. Você pode definir e armazenar metadados personalizados, como autor ou data de criação ou uma imagem associada, o que melhora a rastreabilidade e a compreensão contextual das receitas.

Tabelas do banco de dados

A estrutura do modelo do esquema de receita pode ser armazenada no banco de dados, preservando as informações se uma variável estiver sozinha ou fizer parte de um objeto. Os parâmetros da receita são exibidos em linhas organizadas da seguinte forma:
  • Receitas:
    • Id (Chave primária) [UInt32]
    • Nome [String]
    • Versão [String]
    • RecipeSchemaName [String]
    • RecipeSchemaNamespaceUri [String]
    • RecipeSchemaTimestamp [DataEHora]
    • CreatedAt [DataEHora]
    • ModifiedAt [DataEHora]
  • RecipeItems:
    • Id (Chave primária) [UInt32]
    • IDDaReceita [UInt32]
    • RelativeBrowsePath [String]
    • TypeId [String]
  • RecipeDataItems:
    • Id (Chave primária) [UInt32]
    • RecipeItemId [UInt32]
    • RelativeBrowsePath [String]
    • ElementAccess [String]
    • DataTypeId [String]
    • Valor [String]
  • MetadadosDaReceita:
    • Metadata1 [UserDefined]
    • Metadata2 [UserDefined]
    • Metadata_n [UserDefined]
Dê sua opinião
Tem dúvidas ou comentários sobre esta documentação? Por favor, envie seu comentário aqui.
Normal