Ejemplos de configuración del proveedor de Google OneBox

Ejemplo: Configurar un proveedor de OneBox para que devuelva un informe

Dispone de dos informes que desea utilizar como resultados de Google OneBox, Informe de ingresos e Informe de inventario. Desea que se devuelva uno de los informes cuando una consulta de búsqueda incluya la palabra clave informe y una o más de las palabras clave siguientes: ingresos e inventario. La GSA incluye un módulo de OneBox denominado cognos_report. La palabra clave informe es uno de los activadores de este módulo.

Modifique el archivo map.xml para que incluya la siguiente entrada de módulo:

<module oneboxName="cognos_report">
	<mapEntries>
		<mapEntry provider="cm">
			<regex>.*revenue.*</regex>
			<path type="output">/content/package
       [@name='Onebox Reports']/query[@name='RevenueReport']
      </path>
		</mapEntry>
		<mapEntry provider="cm">
			<regex>.*inventory.*</regex>
			<path type="output">/content/package
       [@name='Onebox Reports']/query[@name='InventoryReport']
      </path>
		</mapEntry>
	</mapEntries>
</module>

El flujo de comunicación siguiente tiene lugar cuando un usuario escribe inventario informe como término de búsqueda.

1. La GSA recibe la consulta de búsqueda y solicita un conjunto de resultados a su propia prestación de índice y a la prestación OneBox.
2. La prestación OneBox identifica el término de búsqueda informe como un activador para el módulo cognos_report y pasa la consulta a este módulo como una solicitud de búsqueda.
3. El módulo cognos_report pasa la consulta al proveedor de OneBox.
4. El proveedor evalúa la solicitud de búsqueda y, basándose en las entradas del archivo map.xml, determina que Informe de inventario debe devolverse como resultado de la búsqueda.

   Si la consulta de la búsqueda incluyera los términos ingresos e inventario, el Informe de ingresos se devolvería como resultado de la búsqueda porque es la primera mapEntry.

5. El proveedor devuelve el Informe de inventario a la GSA.
6. La GSA da formato al informe utilizando la hoja de estilo XSL incluida con el módulo cognos_report.
7. El Informe de inventario aparece como un resultado de OneBox junto con los resultados de la búsqueda devueltos desde el índice de Google.

Ejemplo: Configurar un proveedor de OneBox para que devuelva un gráfico

Además de los informes de listas y de tablas de referencias cruzadas, dispone de informes de gráficos. Para devolver un gráfico cuando una solicitud de búsqueda incluya el término margen, añada una entrada <mapEntry> al archivo map.xml. Como en el ejemplo de map.xml para informes, el orden de <mapEntry> es importante. Si la solicitud de búsqueda incluye los términos ingresos y margen, se devuelve el Informe de ingresos porque ingresos es la primera <mapEntry>. El Gráfico de margen sólo se devuelve cuando la solicitud de búsqueda incluye el término margen, pero no el término ingresos o inventario.

La GSA incluye un módulo de OneBox denominado cognos_report. El término de búsqueda informe es uno de los activadores de este módulo.

Modifique el archivo map.xml para que incluya la siguiente entrada de módulo:

<module oneboxName="cognos_report">
	<mapEntries>
		<mapEntry provider="cm">
			<regex>.*revenue.*</regex>
			<path type="output">/content/package
       [@name='Onebox Reports']/query[@name='RevenueReport']
      </path>
		</mapEntry>
		<mapEntry provider="cm">
			<regex>.*inventory.*</regex>
			<path type="output">/content/package
       [@name='Onebox Reports']/query[@name='InventoryReport']
      </path>
		</mapEntry>
		<mapEntry provider="cm">
			<regex>.*margin.*</regex> 
			<path type="image">/content/package
       [@name='Onebox Reports']/query[@name='MarginChart']
       </path>
     </mapEntry>
	</mapEntries>
</module>

El flujo de comunicación siguiente tiene lugar cuando un usuario introduce el término margen informe como consulta de búsqueda.

1. La GSA recibe la consulta de búsqueda y solicita un conjunto de resultados a su propia prestación de índice y a la prestación OneBox.
2. La prestación OneBox identifica el término de búsqueda informe como un activador para el módulo cognos_report y pasa la consulta a este módulo como una solicitud de búsqueda.
3. El módulo cognos_report pasa la consulta al proveedor de OneBox.
4. El proveedor evalúa la solicitud de búsqueda y, basándose en las entradas del archivo map.xml, determina que Gráfico de margen debe devolverse como resultado de la búsqueda.

   Si la consulta de búsqueda incluía el término ingresos o inventario, se devuelve un informe porque los elementos <mapEntry> para esa palabra clave aparecen antes que la <mapEntry> para margen.

5. El proveedor devuelve el Gráfico de margen a la GSA.
6. La GSA da formato al informe utilizando la hoja de estilo XSL incluida con el módulo cognos_report.
7. El Gráfico de margen aparece como un resultado de OneBox junto con los resultados de la búsqueda devueltos desde el índice de Google.

Otra opción de configuración es añadir un módulo de OneBox para procesar las solicitudes de búsqueda que incluyan un activador para gráficos. En este caso, el archivo map.xml incluye elementos <module_OneBox name> independientes. El proveedor de OneBox procesa las solicitudes desde cada módulo por separado. El orden de los módulos en el archivo map.xml no afecta a los resultados. Una ventaja de utilizar más de un módulo es que los resultados de OneBox para un único término de búsqueda pueden devolver tanto un informe como un gráfico.

Ejemplo: Configurar el proveedor de OneBox para que devuelva un informe y un gráfico

Desea devolver tanto un informe de tabla de referencias cruzadas como un gráfico cuando una solicitud de búsqueda incluya inventario. Utilice dos elementos <path type> en la misma <mapEntry>.

Modifique el archivo map.xml para que incluya la siguiente entrada de módulo:

<module oneboxName="cognos_report">
	<mapEntries>
		<mapEntry provider="cm">
			<regex>.*revenue.*</regex>
			<path type="output">/content/package
       [@name='Onebox Reports']/query[@name='RevenueReport']
      </path>
		</mapEntry>
		<mapEntry provider="cm">
			<regex>.*inventory.*</regex>
			<path type="image">/content/package
       [@name='Onebox Reports']/query[@name='InventoryChart']
      </path>
			<path type="output">/content/package
       [@name='Onebox Reports']/query[@name='InventoryReport']
      </path> 
    </mapEntry>
	</mapEntries>
</module>

El flujo de comunicación siguiente tiene lugar cuando un usuario introduce el término inventario informe como consulta de búsqueda.

1. La GSA recibe la consulta de búsqueda y solicita un conjunto de resultados a su propia prestación de índice y a la prestación OneBox.
2. La prestación OneBox identifica el término de búsqueda informe como un activador para el módulo cognos_report y pasa la consulta a este módulo como una solicitud de búsqueda.
3. El módulo cognos_report pasa la consulta al proveedor de OneBox.
4. El proveedor evalúa la solicitud de búsqueda y, basándose en las entradas del archivo map.xml, determina que han de devolverse Gráfico de inventario e Informe de inventario como resultado de la búsqueda.

   Si la consulta de la búsqueda incluyera los términos ingresos e inventario, el Informe de ingresos se devolvería como resultado de la búsqueda porque es la primera mapEntry.

5. El proveedor devuelve el Gráfico de inventario y el Informe de inventario a la GSA.
6. La GSA da formato a los informes utilizando la hoja de estilo XSL incluida con el módulo cognos_report.
7. El Gráfico de inventario y el Informe de inventario aparecen como un resultado de OneBox junto con los resultados de la búsqueda devueltos desde el índice de Google.

Otra opción de configuración es añadir un módulo de OneBox para procesar las solicitudes de búsqueda que incluyan un activador para gráficos. En este caso, el archivo map.xml incluye elementos <module_OneBox name> independientes. El proveedor de OneBox procesa las solicitudes desde cada módulo por separado. El orden de los módulos en el archivo map.xml no afecta a los resultados.

Ejemplo: Configurar el proveedor de OneBox para que devuelva una métrica

Puede configurar el proveedor de OneBox para que devuelva el gráfico y los datos de una métrica especificada. El nombre de paquete se especifica en el archivo map.xml con el atributo <path>. Especifique un <mapEntry provider> distinto en el archivo map.xml en comparación con los informes, <mapEntry provider="mm"> en lugar de <mapEntry provider="cm">.

Puede instalar y configurar uno o más módulos de OneBox para procesar solicitudes para informes y métricas. Desea devolver tanto un informe como una métrica para una única solicitud de búsqueda. Para dar soporte a este tipo de resultado de OneBox, instale un módulo de OneBox adicional en la GSA y configure el módulo para utilizar métrica como activador. La GSA incluye dos módulos de OneBox, cada uno con un nombre exclusivo, cognos_report y cognos_metric.

Modifique el archivo map.xml para que incluya la siguiente entrada de módulo:

<module oneboxName="cognos_report">
	<mapEntries>
		<mapEntry provider="cm">
			<regex>.*revenue.*</regex>
			<path type="output">/content/package
       [@name='Onebox Reports']/query[@name='RevenueReport']
      </path>
		</mapEntry>
		<mapEntry provider="cm">
			<regex>.*inventory.*</regex>
			<path type="output">/content/package
       [@name='Onebox Reports']/query[@name='InventoryReport']
      </path>
		</mapEntry>
	</mapEntries>
</module>
<module oneboxName="cognos_metric">
  <mapEntries> 
	   <mapEntry provider="mm">
      <regex>.*</regex>
      <path>International Sales</path>
    </mapEntry>
  </mapEntries>
</module> 

El flujo de comunicación siguiente tiene lugar cuando un usuario introduce el término ingresos métrica o métrica ingresos como consulta de búsqueda.

1. La GSA recibe la consulta de búsqueda y solicita un conjunto de resultados a su propia prestación de índice y a la prestación OneBox.
2. La prestación OneBox identifica el término de búsqueda métrica como un activador para el módulo cognos_metric y pasa la consulta a este módulo como una solicitud de búsqueda.
3. El módulo cognos_metric pasa la consulta al proveedor de OneBox.
4. El proveedor evalúa la solicitud de búsqueda y, basándose en las entradas del archivo map.xml, solicita resultados al proveedor utilizado para las métricas.
5. El proveedor de métricas busca en el paquete International Sales y devuelve el gráfico y los datos para una métrica cuyo nombre coincida mejor con ingresos.
6. El proveedor de OneBox devuelve la métrica a la GSA.
7. La GSA da formato la métrica utilizando la hoja de estilo XSL incluida con el módulo cognos_metric.
8. La métrica aparece como resultado de OneBox junto con los resultados de la búsqueda devueltos desde el índice de Google.

Otra opción de configuración es utilizar un único módulo de OneBox y añadir entradas <mapEntry provider="mm"> al archivo map.xml. Con esta configuración, los resultados de OneBox pueden incluir contenido de solamente uno de los tipos de proveedor, cm o mm, pero no de ambos.