Creación y registro de metadatos de dashlet

El registro de dashlet contiene la lista de todas las definiciones de dashlets disponibles en una aplicación. Debe registrar la definición de metadatos de dashlet en el registro de dashlet para poder añadir el dashlet al panel de instrumentos. Mediante el registro de dashlet, primero puede registrar sus dashlets personalizados y añadirlos después a un panel de instrumentos.

La definición de metadatos de dashlet se basa en XML.
  • Para crear metadatos de dashlet, defina el XML de definición de metadatos de dashlet.
  • Para registrar los metadatos del dashlet, llame al método registerDashlet( ) de la clase SCUIDashboardManager (que se describe en el recurso Javadoc).

Ejemplo de XML: definición 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"
												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 ofthe dashlet -->
						<Group>
									<Section id="Airports" title="Airports" Icon="/stk/img/cog.png">
												<Link linkId="manage_airport" name="Manage Airports"
																		url="/stk/airport.do" />
									</Section>
									<Section id="Flights" title="Flight" icon="/stk/img/phone-icon.jpg">
												<Link linkid="manage_airport" name="Flights" url="/stk/flight.do" />
												<Link linkid="manage_airport" name="Flight Services"
																		url="/stk/flightService.do"/>
									</Section>
						</Group>
			</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.

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.