Ampliación de un panel de instrumentos existente mediante la adición de nuevos dashlets en la infraestructura de interfaz de usuario web

Puede personalizar o ampliar un panel de instrumentos existente mediante la adición de dashlets.

Acerca de esta tarea

A continuación se muestra un XML de ejemplo, con definiciones de metadatos de dashlet:


<Dashlets>
			<Dashlet id="dashlet_one" title="Dashlet One" type="html" tag="tag_1">
						<Url>/stk/dashboard/dashlet_one.jsp</Url>
						<Imgurl>/stk/img/dashboard/dashlet_one_preview.png</Imgurl>
						<Description>
									Dashlet one description bundle key
						</Description>
						<Config numberOfColumns="3">
						</Config>
			</Dashlet>
			<Dashlet id="dashlet_two" title="Dashlet Two" type="extscreen" tag="tag_2"
												multiInstance="true" refreshable="Y">
						<Url>/stk/dashboard/dashlet_two.jsp</Url>
						<Imgurl>/stk/img/dashboard/dashlet_two_preview.png</Imgurl>
						<Description>
									Dashlet two description bundle key
						</Description>
						<Config numberOfColumns="2">
						</Config>
						<!-- Other metadata relevant to the dashlet can be added based on type
						and url of the dashlet -->						
			</Dashlet>
			<Dashlet id="dashlet_three" title="Dashlet Three" type="html" tag="tag_3">
						<Url>/stk/dashboard/dashlet_three.jsp</Url>
						<Imgurl>/stk/img/dashboard/dashlet_three_preview.png</Imgurl>
						<Description>
									Dashlet three description bundle key
						</Description>
						<Config>
						</Config>
			</Dashlet>
</Dashlets>

A continuación se muestran las descripciones de los atributos y elementos del ejemplo anterior.

ID

Identificador exclusivo del dashlet. Este ID se utiliza para consultar un dashlet y sus propiedades. Lo utiliza una definición de panel de instrumentos para añadir un dashlet.

título

Título del dashlet. Puede ser una clave de paquete que se puede localizar.

tipo

El tipo de dashlet es un metadatos sobre el tipo de contenido devuelto por un URL de dashlet. De forma predeterminada, la infraestructura de interfaz de usuario web da soporte a los siguientes tipos de dashlet:

HTML. La respuesta de tipo HTML debe ser un fragmento de documento de HTML válido. Los ejemplos siguientes ilustran diversas formas en la que se puede utilizar para representar la IU del dashlet: (1) Un fragmento de HTML totalmente representado se puede ver en un navegador sin más proceso. (2) Un iframe que se puede utilizar para incluir de forma segura un widget de sitios web externos. (3) Un scriptlet que puede representar dinámicamente el contenido del contenedor.
extscreen. Un extscreen es un script de renderizado de UI JavaScript ExtJS-based. Se puede utilizar para representar componentes de IU dinámicos e interactivos.

etiqueta

Valor de nombres de código del dashlet separados por coma.

refreshable

Si establece este valor en Y, el panel de instrumentos se puede renovar y se muestra un icono renovar en la caja de herramientas del dashlet. Al pulsar el icono renovar, se renueva el dashlet individual.

multiInstance

Si establece esto en true, se permite añadir el dashlet al panel de instrumentos varias veces. Es un parámetro opcional y su valor predeterminado es false.

URL

URL que se utiliza para obtener el contenido para representar un dashlet. Para representar un dashlet en un panel de instrumentos, se debe realizar una solicitud en el servidor. La solicitud se realiza en este URL y la respuesta se representa en la IU.

Imgurl

URL de la imagen que se va a mostrar en la que se ve una vista previa del contenido visualizado por el dashlet.

Descripción

Descripción del dashlet. Puede ser una clave de paquete que se puede localizar.

Configurar

El elemento Config se utiliza para definir opciones de configuración utilizadas para representar el dashlet en la IU. Algunos dashlets que no necesitan una opción de configuración pueden optar por no especificar el elemento Config.

Nota: Además del elemento Config, un dashlet puede tener otros elementos de metadatos. En general, Config se utiliza para definir las propiedades de la IU, pero se puede utilizar para contener cualquier tipo de metadatos.

Para personalizar o ampliar un panel de instrumentos existente mediante la adición de dashlets, siga estos pasos:

Procedimiento

Cree el nuevo archivo XML para los dashlets utilizando el código de ejemplo anterior como guía.
Lleve a cabo una de las acciones siguientes:
- Vaya a la carpeta << DIR_INSTALACIÓN>> /extensions/ <nombre-app> /webpages. Cree la estructura de directorios que prefiera y coloque ahí los archivos XML de dashlet.
  Los archivos XML definidos aquí se copian en la carpeta < application-war> /extn/ < su estructura de directorios >.
- Vaya a la carpeta << DIR_INSTALACIÓN>> /repository/eardata/ <nombre-app> /extn. Cree la estructura de directorios que prefiera y coloque ahí los archivos XML de dashlet.
  Los archivos XML definidos aquí se copian en la carpeta < application-war>/< su estructura de directorios >.

Cree un nuevo servlet para cargar los archivos XML y añadirlos al panel de instrumentos del usuario.

Código de ejemplo:

//<dirPath> = <your directory structure> or extn/<your directory 
structure> depending on procedure used.
String appId = SCUIUtils.getApplicationId(config.getServletContext());
String dashletsFilePath = “<dirPath>/dashlets.xml";
InputStream isDlts = servletContext.getResourceAsStream(dashletsFilePath);
SCUIDashboardManager.getInstance(appId).registerDashlet(isDlts);

Empaquete este servlet en un archivo jar y utilice el segundo método en caso de despliegue de varios war. En otros casos, puede utilizar cualquier método.
- Ejecute el script Install3rdParty.sh desde << INSTALL_DIR>>/bin para incluir este archivo JAR en la aplicación.
- Vaya a << DIR_INSTALACIÓN>> /repository/eardata/ <nombre-app> /extn folder. Cree la carpeta WEB-INF/lib. Copie en ella el archivo jar.
Vaya a la carpeta << DIR_INSTALACIÓN>> /repository/eardata/ <nombre-app> /extn. Haga una entrada en el archivo web.xml para cargar el servlet y compruebe que se carga después del servlet inicializador de la aplicación; para ello, asigne un valor a load-on-startup de aproximadamente 1000 o superior.
Ejecute el mandato buildwar/buildear.
Al iniciarse la aplicación, los nuevos dashlets se cargarán y podrá verlos al seleccionar el enlace personalizar en el panel de instrumentos.
Nota: La configuración y los diseños del panel de control existentes no se pueden cambiar durante la extensibilidad del panel de control. Sólo se pueden asociar los nuevos dashlets de un panel de instrumentos.
Nota: Para añadir un panel de control a una aplicación, es necesario seguir pasos similares. A continuación se muestra un XML de ejemplo, con definiciones de metadatos de panel de instrumentos:
```
<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>
```
ID

Identificador exclusivo del panel de instrumentos. Este ID se utiliza para comprobar permisos de recursos y autorización. Si un panel de instrumentos contiene un dashlet para el que el usuario no tiene permiso, dicho dashlet no se mostrará al usuario.

título

Título del panel de instrumentos. Puede ser una clave de paquete que se puede localizar.

etiqueta

Valor de nombres de código del panel de instrumentos separados por coma. Estos códigos se utilizan para encontrar dashlets que tengan códigos coincidentes. Estos dashlets relacionados están disponibles al personalizar el panel de instrumentos.
Nota: También podrá ver otras etiquetas, pero de forma predeterminada, sólo se mostrarán los dashlets con etiquetas coincidentes.

versión

Versión de metadatos del panel de instrumentos. Se puede utilizar en caso de multitenencia para dar soporte a diferentes versiones de los metadatos de panel de instrumentos.

Configurar

El elemento Config se utiliza para definir opciones de configuración utilizadas para representar el panel de instrumentos. Una de dichas opciones de configuración es el diseño de los dashlets de un panel de instrumentos.
Los diseños se utilizan para definir estrategias de diseño admitidas por un panel de instrumentos. Contiene elementos hijo que definen las estrategias de diseño individual. Actualmente, sólo se admite un diseño de columna como diseño estándar del panel de instrumentos.

Dashlets
Lista de todos los dashlets que se van a mostrar en el panel de instrumentos. Cada dashlet puede tener el conjunto de atributos y elementos siguiente:

id. ID de referencia del dashlet que se añadirá al panel de instrumentos.

Parent. ID de contenedor de diseño al que se añadirá el dashlet.