Criando e Registrando Metadados de Dashlet
É possível criar e registrar metadados do painel especificando sua definição XML e chamando o registerDashboard.
A definição de metadados de painel baseia-se em XML.
- Para criar metadados do painel, é necessário definir o XML da definição de metadados do painel.
- Para registrar os metadados do painel, chame o método registerDashboard( ) da classe SCUIDashboardManager (que é descrita no recurso Javadoc).
Amostra de XML: Definição de Metadados de Dashlet
<Dashboards>
<Dashboard id="myhomepage" title="My Homepage" tag="tag_1,tag_n"
version="0.0.1">
<Config>
<Layouts currentLayoutId="twoEqualColumn">
<Layout id="twoEqualColumn" type="column"
previewIconUrl="/stk/img/dashboard/2col_preview.png">
<Column id="d_one" width=".49"/>
<Column id="d_two" width=".49"/>
</Layout>
</Layouts>
</Config>
<Dashlets>
<Dashlet id="dashlet_one" parent="d_one" >
</Dashlet>
<Dashlet id="dashlet_two" parent="d_two">
<Config numberOfColumns="1" >
</Config>
</Dashlet>
</Dashlets>
</Dashboard>
</Dashboards>
As descrições dos atributos e elementos da amostra acima
são fornecidas a seguir.
- ID
- Um identificador exclusivo do painel. Esse id é usado para verificar permissões e autorização de recursos. Se um painel contiver um dashlet para o qual o usuário não possui permissão, esse dashlet não será mostrado para o usuário.
- título
- O título do painel. Pode ser uma chave de pacote configurável que pode ser localizada.
- identificação
- Um valor separado por vírgula de nomes de tag do painel. Essas tags são usadas para localizar dashlets que possuem tags correspondentes. Esses dashlets relacionados estão disponíveis quando você customizar o painel.
- versão
- A versão dos metadados do painel. Ela pode ser usada no caso de ocupação variada para suportar diferentes versões dos metadados de painel.
- Configuração
- O elemento Config é usado para definir opções de configuração usadas para renderizar o painel. Uma opção de configuração assim é o layout de dashlets em um painel.
- Dashlets
- Uma lista de todos os dashlets a serem exibidos no painel. Cada dashlet pode ter o seguinte conjunto de atributos e de elementos:
- id. ID de referência do dashlet a ser incluído no painel.
- Parent. O id do contêiner do layout no qual o dashlet será incluído.