English Version
BI Web Services
Tipos de Dato
GXBI.Services
Tipo de dato creado por el WSDL inspector para interactuar con los servicios. Se proveen los métodos detallados aqui.
GXBIBusinessElement
Contiene información de Dimensiones, Indicadores o Atributos dependiendo del paradigma de la metadata abierta. Compuesto por los siguientes campos:
| Nombre |
Tipo de Dato |
Descripción |
| Type |
Character(9999) |
Tipo de Business Element. Puede tomar uno de los siguientes valores:
Measure
Dimension
Attribute |
| Name |
Character(9999) |
Nombre (valor interno) del Business Element. |
| Description |
Character(9999) |
Descripción del Business Element. Es el valor que se permite modificar desde la interfaz del Manager y Settings |
| Available |
Numeric(6) |
Indica si esta disponible o no a los usuarios finales.
0: Not Available.
1: Available. |
| Cardinality |
Character(9999) |
Cardinalidad de la dimensión:
Low: baja cardinalidad (valor predeterminado).
High: Alta cardinalidad. |
| NodeType |
Character(9999) |
Indica el tipo de Nodo retornado.
Individual: es un Business Element.
Group: es un grupo o folder. |
GXBIChart
Gráfica asociada a una consulta. Compuesto por:
| Nombre |
Tipo de Dato |
Descripción |
| Name |
Character(9999) |
Nombre (identificador) de la gráfica. |
| Title |
Character(9999) |
Título de la gráfica. |
| TitleVisible |
Numeric(6) |
Indica si esta visible o no el título.
0: No visible.
1: Visible. |
| Legend |
Character(9999) |
Leyenda de la gráfica. |
| LegendVisible |
Numeric(6) |
Indica si esta visible o no la leyenda.
0: No visible.
1: Visible. |
| Type |
Character(9999)
|
Tipo de gráfica. |
GXBIFilter
Filtro que se aplica para evaluar un BusinessElement; ver servicio EvalBusinesElement en la lista de métodos.
| Nombre |
Tipo de Dato |
Descripción |
| BusinessElementName |
Character(9999) |
Nombre del Business Element filtro. |
| Values |
ArrayOfGXBIValue |
Colección de valores utilizados para filtrar. |
GXBIMessage
Mensaje retornado por el motor cuando hay Warning o Error.
| Nombre |
Tipo de Dato |
Descripción |
| Id |
Numeric(11) |
Identificador del mensaje |
| Description |
Character(9999) |
Descripción del mensaje. |
| Type |
Character(9999) |
Tipo de mensaje:
Warning.
Error. |
| CallStack |
Character(9999) |
Detalle del stack donde se produce el error. Utilizado para troubleshooting. |
GXBIMetadata
Información de la metadata.
| Nombre |
Tipo de Dato |
Descripción |
|
Character(9999) |
Nombre de la metadata. |
| Paradigm |
Character(9999) |
Paradigma de la metadata:
Measures_Dimensions.
Attributes. |
| UserOwnerName |
Character(9999) |
Usuario creador de la metadata. |
| DateofUpdate |
Character(9999) |
Fecha de actualización. Formato: dd/mm/yyyy |
| DateofCreation |
Character(9999) |
Fecha de creación. Formato: dd/mm/yyyy |
| Version |
Character(9999) |
Versión de la metadata. |
GXBIParameter
Estructura para almacenar los parámetros para ejecutar una consulta en caso que tenga definidos.
| Nombre |
Tipo de Dato |
Descripción |
| Name |
Character(9999) |
Nombre del parámetro. |
| Description |
Character(9999) |
Descripción del parámetro. |
| Value |
GXBIValue |
Valor del parámetro. |
| Required |
Numeric(6.0) |
Indica si es requerido o no.
0: no requerido.
1: requerido. |
GXBIProperty
Propiedad configurable en tiempo de ejecución.
| Nombre |
Tipo de Dato |
Descripción |
| Name |
Character(9999) |
Nombre de la propiedad. |
| Value |
Character(9999) |
Valor asignado a la propiedad Name. |
Se soportan las siguientes propiedades:
| Propiedad |
Descripción |
| executeQuery |
Indica si se refresca o no la consulta.
0: no se refrescan la información; retornando los datos de la última ejecución de la misma.
1: se refresca la información. |
| queryDestination |
Tipo de salida de la consulta.
DynamicTable: Trae el resultado como tabla dinámica.
StaticTable: Trae el resultado como tabla estática.
NombreDeGrafica: Trae el resultado con la especificación de la gráfica guardada. |
| queryFormat |
Formato del resultado de la ejecución de la consulta deseado.
XmlAbstract: Si se desea ver la consulta en formato abstracto; es decir retorna un XML con la estructura descripta en el Apéndice I.
HtmlOWC: Si se desea ver la consulta en formato HTML utilizando los Office Web Components. Devuelve el resultado como HTML para ser embebido en cualquier objeto Web.
HtmlCrossBrowserControls: Si se desea ver la consulta en formato HTML utilizando el componente propietario. Devuelve una URL para ser ejecutada. |
| Version |
Versión del componente con la que se quiere presentar la consulta; aplica solamente si query_format= HtmlOWC | HtmlCrossBrowserControls.
1.0: Componente Cross-browser controls, valor predeterminado.
9.0: Componentes Office 2000.
10.0: Componente Office XP.
11.0: Componente Office 2003. |
| componentId |
Nombre interno del componente; aplica solamente si query_format= HtmlOWC | HtmlCrossBrowserControls. |
queryFormat
Dependiendo del formato seleccionado el cliente que ejecuta los servicios debe procesar diferente el resultado de la ejecución de la consulta. Cuando se trabaja con el formato XmlAbstract, se retorna un XML abstracto donde se detalla la especificación de la consulta junto con los datos retornados. La estructura retornada se describe en el siguiente link.
Para presentar la información directamente en un componente se disponen de dos opciones: HtmlOWC y HtmlCrossBrowserControls.
Si se trabaja con la opción HtmlOWC, simplemente se tiene que asignar el resultado de la ejecución de la consulta al Caption de un TextBlock GeneXus. Recordar que éste componente solo funciona con Internet Explorer 5.5 o superior.
El formato HtmlCrossBrowserControls, retorna una URL donde se deja disponible la consulta ejecutada. Se recomienda utilizar un control Embedded Page, asignando a la propiedad Source el resultado de la ejecución de la consulta. Por más información consulte el siguiente ejemplo.
No todas las combinaciones de los valores queryDestination-queryFormat son válidos:
queryDestination
queryFormat |
DynamicTable |
StaticTable |
NombreDeGrafica |
| XmlAbstract |
Aplica |
Aplica |
Aplica |
| HtmlOWC |
Aplica |
No Aplica |
Aplica |
| HtmlCrossBrowserControls |
Aplica |
No Aplica |
Aplica |
Nota: Si no se especifica correctamente el parámetro queryFormat la consulta no se ejecuta detallando un error asociado.
GXBIQuery
Información de una Consulta.
| Nombre |
Tipo de Dato |
Descripción |
| Open |
Numeric(6.0) |
Indica si la consulta se encuentra abierta.
0: Consulta cerrada.
1: Consulta abierta. |
| QueryInfo |
GXBIQueryInfo |
Cabezal de consulta. |
| QueryOpenInfo |
GXBIQueryOpenInfo |
Identificador de la consulta de trabajo. Parámetro requerido en los servicios SaveQuery y CloseQuery. |
GXBIQueryInfo
Cabezal de una consulta.
| Nombre |
Tipo de Dato |
Descripción |
| Title |
Character(9999) |
Título de la consulta. |
| Name |
Character(9999) |
Nombre de la consulta. |
| Description |
Character(9999) |
Descripción de la consulta. |
| UpdateInImpact |
Numeric(6.0) |
Indica si la consulta fue actualizada en el último impacto.
0: No actualizada.
1: actualizada. |
| OwnerUser |
Character(9999) |
Dueño de la consulta. |
| HourOfUpdate |
Character(9999) |
Hora de actualización.
Formato: HH:MM:SS |
| DateOfUpdate |
Character(9999) |
Fecha de actualización.
Formato: dd/mm/yyyy |
| Parameters |
ArrayOfGXBIParameter |
Colección de parámetros. |
| Charts |
ArrayOfGXBIChart |
Colección de gráficas. |
| NodeType |
Character(9999) |
Retorna el tipo de nodo:
Individual: consulta.
Group: carpeta de consulta |
GXBIQueryOpenInfo
Información de una consulta abierta.
| Nombre |
Tipo de Dato |
Descripción |
| Id |
Numeric(11.0) |
ID interno de consulta de trabajo utilizado por los servicios SaveQuery y CloseQuery. |
GXBISession
Información de la sesión.
| Nombre |
Tipo de Dato |
Descripción |
| Security |
Character(9999) |
Identificador interno de seguridad. |
| Id |
Numeric(11.0) |
Identificador de sesión. |
| ExecutionMode |
Character(9999) |
Modo de ejecución:
Normal
Trial |
| ProductMode |
Character(9999) |
Producto utilizado:
Full
Lite |
| CurrentUserName |
Character(9999) |
Usuario logueado. |
| OpenMetadata |
Numeric(6.0) |
Identificador de metadata abierta. |
| OpenMetadataName |
Character(9999) |
Nombre de metadata abierta |
GXBIStatus
Detalla posibles mensajes de error al llamar a cualquier servicio.
| Nombre |
Tipo de Dato |
Descripción |
| Error |
Numeric(6.0) |
Indica si la ejecución del servicio dio error.
0: OK.
1: Error. |
| MessageCollection |
ArrayOfGXBIMessage |
Colección de mensajes. |
| ErrorId |
Numeric(11) |
Identificador del primer Error. |
| ErrorDescription |
Character(9999) |
Descripción asociada a ErrorId. |
| ErrorCallStack |
Character(9999) |
Detalle del stack donde se produce el error; útil para troubleshooting. |
Campo Error
Se debe chequear el campo Error para verificar si hubo errores o no. En caso afirmativo se dispone de una colección de mensajes (parámetro MessageCollection). En el Apéndice II se puede ver una lista de los posibles códigos de error retornados en este campo.
GXBIUda
Definición de un Atributo definido por el usuario (User Defined Attribute).
| Nombre |
Tipo de Dato |
Descripción |
| Name |
Character(9999) |
Nombre del atributo (valor interno). |
| Description |
Character(9999) |
Descripción del atributo. |
| UdaFilters |
ArrayOfGXBIUdaFilter |
Lista de filtros que definen como se calcula el atributo definido por el usuario. |
| ValueAttributeName |
Character(9999) |
Descripción del atributo dinámico. |
AdvancedCondition
|
Character(9999) |
Lista de filtros que definen el atributo definido por el usuario especificado en forma libre; por ejemplo:
ExtensionTypeId = "Customer" And CustomerId = ExtensionId And ExtensionAttributeId = "uda_1"
|
GXBIUdaFilter
Definición de un filtro sobre la definición de un atributo definido por el usuario. (más información)
| Nombre |
Tipo de Dato |
Descripción |
| IdAttributeName |
Character(9999) |
Nombre del atributo sobre el cual se realiza un filtro. |
| Value |
GXBIValue |
Valor a Filtrar; se debe utilizar el elemento "Id" de éste tipo de dato para especificar el identificador asociado. |
GXBIUser
Información del usuario o grupo de usuarios.
| Nombre |
Tipo de Dato |
Descripción |
| Name |
Character(9999) |
Nombre del usuario. |
| NodeType |
Character(9999) |
Tipo de Nodo:
Individual: Usuario.
Group: Grupo de usuario |
| IsSupervisor |
Numeric(6) |
0: Usuario estándar.
1: Usuario Supervisor. |
| Password |
Character(9999) |
Parámetro no disponible. |
| NewPassword |
Character(9999) |
Parámetro no disponible. |
| FullName |
Character(9999) |
Nombre completo del usuario. |
GXBIValue
Información de un valor.
| Nombre |
Tipo de Dato |
Descripción |
| Id |
Character(9999) |
Identificador del valor. |
| Description |
Character(9999) |
Descripción del valor. |
GXBIValuesRestriction
Restriccion sobre un Business Element.
| Nombre |
Tipo de Dato |
Descripción |
| User |
Character(9999) |
Usuario al cual aplica la restricción. |
| BERestricted |
Character(9999) |
Nombre de indicador o atributo. |
| RestrictedByBE |
Character(9999) |
Nombre de dimensión o atributo. |
| Required |
Numeric(6) |
Indica si la restricción es requerida:
0: no requerida.
1: requerida. |
| RestrictionType |
Character(9999) |
Tipo de restricción:
Total: Total.
Partial: Parcial. |
| AllowedValues |
ArrayOfGXBIValue |
Colección de valores permitidos. |
Colecciones