Introdução
As ferramentas do Studio permitem que você personalize as informações mostradas nos módulos e como elas são exibidas. Para acessar o Studio, faça login como usuário Administrador.

No canto superior direito da tela, você encontra um menu com o ícone de uma figura de perfil.

Clique neste ícone e selecione “Admin”. Role a página para baixo e clique em “Studio”.

Quando o Studio é aberto, ele exibe uma lista de todos os módulos que podem ser personalizados.

Clique para selecionar o módulo necessário.

Para cada módulo, existem vários componentes que podem ser editados.

Rótulos: visualizar / editar rótulos de campo e o nome do módulo

Campos: Exibir / editar propriedades de campo e adicionar novos campos

Relacionamentos: Ver / editar / adicionar relacionamentos entre módulos

Layouts: personalizar as visualizações de edição / detalhe / lista e filtro

Subpainéis: defina quais colunas são exibidas nos subpainéis do módulo

Etiquetas
Selecionar o componente Rótulos lista todos os rótulos de campo para o módulo. As edições nos rótulos serão refletidas nos layouts dos módulos.

Clique e digite para fazer as alterações necessárias nos rótulos e, em seguida, clique em SALVAR E IMPLANTAR.

Uma mensagem de confirmação aparecerá assim que as alterações forem salvas. Agora você deve conseguir ver as alterações nos rótulos ao navegar para o módulo.

Clicar em ALTERAR NOME DO MÓDULO permitirá que você altere o rótulo do próprio módulo. Consulte a seção Renomear Módulos da documentação das Ferramentas de Desenvolvedor para obter mais detalhes.

 

Campos
Selecionar o componente Campos exibe todos os campos disponíveis para o módulo, com seu rótulo de exibição e tipo de dados.

 

Adicionando um Campo
Você pode adicionar um campo personalizado ao módulo selecionado clicando em ADICIONAR CAMPO.

Insira os detalhes para o novo campo. Dependendo do tipo de dados selecionado para o campo, algumas ou todas as propriedades a seguir podem ser definidas para o campo:

Tipo de dados:
O tipo que você seleciona determina quais tipos de caracteres podem ser inseridos no campo. Por exemplo, apenas números inteiros podem ser inseridos em campos do tipo de dados Inteiro.

Nome do campo:
O nome do campo deve ser alfanumérico e não deve conter espaços. Os sublinhados são válidos.

Etiqueta de exibição:
O rótulo que será exibido ao lado do campo nas visualizações.

Etiqueta do sistema:
Este rótulo é usado para se referir ao campo no código.

Texto de ajuda:
Texto explicativo opcional a ser exibido temporariamente quando o usuário passa o mouse sobre o campo.

Texto do comentário:
Isso só é visível no Studio e no Module Builder, como uma descrição para uso do administrador.

Valor padrão:
O campo terá o valor definido aqui, a menos que o usuário insira um novo valor.

Tamanho máximo:
O número máximo de caracteres que podem ser inseridos no campo.

Atualização em massa:
Habilite o recurso de atualização em massa para este campo.

Campo obrigatório:
Se um valor deve ou não ser inserido para o campo antes que um registro contendo o campo possa ser salvo.

Auditoria:
Se for selecionado, as alterações feitas no valor do campo podem ser rastreadas a partir do Log de alterações do registro.

Edição inline:
Se o campo pode ou não ser editado em linha, quando esta opção está habilitada nas Configurações do sistema.

Importável:
Selecione uma opção para permitir, proibir ou exigir que o campo seja importado ao usar o Assistente de Importação.

DuplicateMerge:
Selecione uma opção para ativar ou desativar os recursos Merge Duplicates e Find Duplicates.

 

Tipos de Campo
O Studio vem pronto para uso com muitos tipos diferentes de campos que podem ser criados no SuiteCRM.

Os seguintes tipos de dados estão disponíveis ao criar campos no Studio:

Tipos de dados

Descrição:

Endereço
Cria campos para rua, cidade, código postal, estado e país.
Os campos de endereço personalizado não podem ser agrupados como campos de endereço de estoque (por exemplo, endereço de cobrança)

 

Caixa de seleção
Cria uma caixa de seleção para campos de dados com uma ação Sim / Não

 

Moeda
Cria um campo para inserir um valor de moeda. O sistema cria automaticamente uma lista suspensa do tipo de moeda se o campo ainda não existir nesse módulo

 

Encontro
Cria um campo para inserir uma data. Inclui um botão para um pop-up de calendário

 

Data hora
Cria um campo para inserir a data e a hora. Inclui um botão de ícone de calendário para escolher uma data através do calendário pop-up, bem como uma lista suspensa para selecionar a hora

 

Decimal
Cria um campo para conter um número arredondado para uma precisão decimal especificada. SuiteCRM armazena a representação exata do número no banco de dados (por exemplo, para uma precisão de 2: 2,539 é armazenado como 2,60)

 

Suspenso
Cria um campo onde você pode associar uma lista suspensa de valores

 

DynamicDropdown
Cria uma lista suspensa a partir da qual você pode relacionar um único registro de uma variedade de módulos.

 

Flex Relate
Para especificar uma relação um-para-muitos com outro módulo, mas permite a vinculação a vários tipos de módulos. Por exemplo, o Notes usa um Flex Relate para que possa ser relacionado a Contas, Contatos, Leads, etc. Apenas um campo do tipo Flex Relate é permitido por módulo, o que explica por que você não pode adicionar outro campo desse tipo às Contas Módulos de chamadas, reuniões, notas e tarefas.

 

Float
Cria um campo para conter um número arredondado para uma precisão decimal especificada. SuiteCRM armazena o valor de forma diferente com base na plataforma de banco de dados em que SuiteCRM está sendo executado

 

HTML
Cria texto formatado em HTML estático para exibir em visualizações de registro

 

IFrame
Cria um campo para armazenar um URL a ser exibido em um iframe nas visualizações de registro. Este URL também pode ser gerado dinamicamente a partir de dados em outros campos.

 

Imagem
Cria um campo de imagem para fazer upload de uma imagem para exibir em um registro

 

Inteiro
Cria um campo para especificar números positivos ou negativos sem casas decimais

 

Seleção múltipla
Cria uma lista suspensa de valores onde vários valores podem ser selecionados de uma vez

 

Telefone
Cria um campo para inserir um número de telefone

 

Rádio
Cria um botão de opção para um usuário selecionar um valor de uma lista suspensa

 

Relacionar
Cria um campo para associar um registro ao registro de outro módulo como um relacionamento unilateral. Você pode adicionar vários campos Relacionar a um módulo.
Os campos relacionados e os relacionamentos personalizados são independentes uns dos outros. As alterações feitas em um deles não são refletidas no outro. Os campos relacionados podem ser adicionados a um relatório, mas nenhum dado no registro relacionado pode ser acessado no relatório. Para acessar os dados de registro relacionados em um relatório, você precisará criar um relacionamento personalizado

 

TextArea
Cria um campo de área de texto aberto para várias linhas de texto

 

URL
Cria um campo para armazenar um URL e exibir como um link clicável. Este URL também pode ser gerado dinamicamente a partir de dados em outros campos.

 

Campo de texto
Cria um campo para uma única linha de texto

 

 

Adicionando um Campo Suspenso
Ao adicionar um campo do tipo DropDown, você precisa especificar adicionalmente a lista suspensa. Contém os itens da lista que serão exibidos no menu suspenso.

Você pode selecionar uma lista suspensa existente, se apropriado, ou clicar em ADICIONAR para criar uma nova.

Para cada item a incluir na lista, digite:

Nome do item
Usado para se referir ao item suspenso no código, deve ser alfanumérico, começar com uma letra e não conter espaços.

 

Nome em Exibição
O texto mostrado ao usuário. Isso pode conter espaços e caracteres especiais
Clique em ADICIONAR para adicionar cada nova entrada.

Para adicionar um item em branco, clique em ADICIONAR sem inserir nenhum valor em Nome do item e Rótulo de exibição. Não é possível adicionar um nome em branco, mas com uma etiqueta não em branco.

A lista pode ser opcionalmente classificada em ordem alfabética pelo rótulo de exibição clicando no botão CLASSIFICAR apropriado. Se você deseja definir um item padrão, este não é o lugar para configurá-lo; em vez disso, procure uma opção de “valor padrão” nas configurações do campo que usará esta lista suspensa.

Clique em SALVAR para salvar a nova lista suspensa e retornar às propriedades do campo.

Os itens da lista suspensa que você criou agora estarão visíveis. Se desejar, você pode selecionar um valor padrão para o menu suspenso.

 

Editando um campo
Clique em um campo para visualizar as propriedades do campo. Eles podem ser editados da mesma maneira detalhada acima para adicionar um novo campo.

 

Excluindo um Campo
Somente campos que foram criados no Studio podem ser excluídos por meio do Studio. Os campos principais não podem ser excluídos.

Selecione o campo que deseja excluir e clique em EXCLUIR. Uma mensagem de aviso aparecerá solicitando que você confirme a exclusão, pois tanto o campo quanto os dados relacionados ao campo personalizado serão excluídos do banco de dados e o campo não aparecerá mais nas visualizações do módulo.

 

 

Relacionamentos
Um relacionamento representa um link bidirecional entre dois módulos. Selecionar o componente Relacionamentos exibe todos os relacionamentos entre o módulo atualmente selecionado e outros módulos implantados.

Clique em um relacionamento para visualizar as propriedades do relacionamento.

Clique em ADICIONAR RELACIONAMENTO para adicionar um novo relacionamento para o módulo selecionado.

O Módulo Primário será definido para o módulo atualmente selecionado.

Especifique o tipo de relacionamento:

Um a um
Com um relacionamento Um para Um, cada registro no módulo principal pode ter apenas um registro relacionado no módulo relacionado e vice-versa. Este tipo de relacionamento adicionará um campo relacionado aos registros de ambos os módulos.

 

Um para muitos
Com um relacionamento Um-para-Muitos, os registros no módulo primário podem estar relacionados a um ou mais registros no módulo relacionado, mas cada registro de módulo relacionado está relacionado apenas a um registro do módulo primário. Isso adicionará um campo relacionado aos registros do módulo relacionado, mas o módulo primário exibirá um subpainel onde mais de um registro do módulo relacionado pode ser adicionado.

 

Muitos para muitos
Com um relacionamento muitos para muitos, os registros no módulo principal podem ser relacionados a um ou mais registros no módulo relacionado e vice-versa. Os registros de cada módulo conterão um subpainel para os registros relacionados.
Selecione o Módulo relacionado na lista suspensa.
Onde houver subpainéis, as exibições de subpainéis para o (s) módulo (s) podem ser selecionadas.
Clique em SALVAR E IMPLANTAR para salvar o relacionamento.

 

Layouts
Os layouts podem ser editados no Studio para personalizar as visualizações do módulo mostradas aos usuários.

 

Editar visualização
A visualização de edição é exibida ao editar um registro ou criar um novo.

O layout atual é exibido no painel principal do lado direito. Os campos não utilizados são mostrados na lista do lado esquerdo.

 

Adicionando Campos
Os campos podem ser adicionados à visualização como uma nova linha em um painel existente (seção) ou adicionando um novo painel.

Clique e arraste o elemento Nova linha ou Novo painel para o local desejado no layout do lado direito.

Se você adicionou um novo painel, ele pode ser renomeado clicando no ícone de lápis. Isso abrirá a visualização de edição do rótulo do painel.

Edite o rótulo e clique em SALVAR para retornar ao layout.

Uma nova linha será criada automaticamente com duas colunas.

Arraste e solte os campos obrigatórios para a nova linha. Clicar no botão + irá abranger o campo em ambas as colunas.

Clique em SALVAR E IMPLANTAR para salvar as alterações de layout. Eles agora devem estar visíveis quando você navegar para a visualização de edição do módulo.

 

Excluindo Campos
Exclua campos, linhas ou painéis do layout arrastando-os para a área Excluir no lado esquerdo.

Clique em SALVAR E IMPLANTAR para salvar as alterações de layout.

 

Visualização de detalhes
A Visualização de detalhes é uma visualização somente leitura, mostrada quando um registro é aberto.

O layout de visualização de detalhes pode ser editado exatamente da mesma maneira que para a visualização de edição. Observe que se você selecionou Sincronizar para visualização de detalhes na visualização de edição, não será possível fazer alterações na visualização de detalhes.

 

Exibição de lista
A visualização em lista é mostrada quando um módulo é aberto e lista todos os registros no módulo.

Personalize quais campos são mostrados na visualização de lista e a ordem em que são exibidos aqui.

 

Padrão
Os campos nesta coluna serão mostrados por padrão na visualização de lista. Reordene arrastando e soltando os nomes dos campos.

 

Acessível
Os campos nesta coluna estão disponíveis para os usuários adicionarem à exibição de lista usando o botão Seletor de coluna na exibição de lista.

 

Escondido
Esses campos são ocultados dos usuários e não podem ser adicionados à visualização.

Arraste e solte os campos do módulo entre as colunas para personalizar a exibição de lista.

 

Subpainéis
Use esta seção para personalizar quais campos são mostrados em um subpainel específico.

Selecione o subpainel. Os campos mostrados na coluna Padrão serão mostrados no subpainel. Arraste e solte os campos obrigatórios entre as duas colunas.

Clique em SALVAR E IMPLANTAR.

 

Exportar personalizações
Você pode exportar personalizações de módulo feitas no Studio e carregá-las em outra instância do SuiteCRM através do Module Loader

Insira um nome para o pacote e detalhes opcionais do autor e da descrição. Selecione o (s) módulo (s) que contêm as personalizações que deseja exportar.

Apenas módulos contendo personalizações aparecerão para você selecionar.

Clique em EXPORT.

Isso criará e fará o download de um arquivo .zip contendo as personalizações do módulo.

Use o Module Loader para fazer upload e instalar as personalizações em outra instância do SuiteCRM.