Como usar campos e entidades personalizadas?

Este documento descreve o conceito de atributos e entidades personalizadas e explica como se adiciona/remove atributos personalizados a uma determinada entidade. O manuseamento de atributos e entidades personalizadas é realizado dentro das próprias aplicações ou através da Web API. Neste artigo iremos apenas cobrir a utilização através da Web API.

Atributos Personalizados

Os atributos personalizados permitem que sejam adicionados novos atributos às entidades de sistema de forma ir de encontro a uma necessidade específica de negócio. Sobre estes atributos podem ser definidas regras básicas de validação (Obrigatório, Visível, Só Leitura) assim como um outro conjunto de regas mais avançadas de acordo com o tipo de dados, por exemplo, num atributo do tipo ShortText para além das validações básicas podem ser definidas outras como por exemplo um tamanho máximo ou mínimo, a existência de carateres inválidos ou mesmo a aplicação de uma expressão regular.

Todos os atributos das entidades estão disponíveis através do modulo "CorePatterns" e entidade "SchemaAttributes".

Listar todos os atributos

https://baseurl/api/AccountKey/SubscriptionKey/corepatterns/schemaAttributes/odata?$filter=IsCustomAttribute eq true

Listar propriedade de um atributo

https://baseurl/api/AccountKey/SubscriptionKey/corepatterns/schemaAttributes/{schemaEntity}/{key}

Criar um atributo

Para criar um atributo personalizado são necessárias duas condições:

• Escolha da entidade onde será criado e que pode ser uma entidade de sistema ou uma entidade personalizada
• Adicionar o prefixo "custom_" ao nome do atributo.

https://baseurl/api/AccountKey/SubscriptionKey/corepatterns/schemaAttributes

BODY
{
    "key":"custom_NomeFiscal",
    "visible": true,
    "label": "Nome Fiscal",
    "isRequired": false,
    "attributeType":"LongText",
    "schemaEntity": "PARTIES.BUSINESSCORE"
}

No exemplo acima estamos a criar um novo atributo do tipo texto na entidade Parties do modulo BusinessCore.

Entidades Personalizadas

As entidades personalizadas permitem que sejam adicionadas novas entidades ao sistema de forma ir de encontro a uma necessidade específica de negócio. A estas entidades é possível depois adicionar atributos personalizados.

Todos as entidades estão disponíveis através do modulo "CorePatterns" e entidade "SchemaEntities".

Listar todos as entidades

https://baseurl/api/AccountKey/SubscriptionKey/corepatterns/schemaentities/extensible/odata?$filter=ModuleName eq 'CUSTOMENTITIES'

Listar uma entidade

https://baseurl/api/AccountKey/SubscriptionKey/corepatterns/schemaentities/{EntityKey}/Customentities

Criar uma entidade

Para criar um atributo personalizado é necessário indicar no atributo ModuleName o valor "CUSTOMENTITIES"

https://baseurl/api/AccountKey/SubscriptionKey/corepatterns/schemaentities/

BODY
{
    "key": "DEMO",
    "title": "DEMO",
    "allowExtensibility": true,
    "moduleName": "CUSTOMENTITIES",
    "isCompanyDependent": false,
    "keyLabel": "My Entity",
    "descriptionLabel": "Demo criação de entidades"
}

No exemplo acima estamos a criar uma nova entidade ao sistema chamada "Demo"