BIServices-Methods

English Version

BI Web Services

Métodos

Los métodos disponibles se agrupan en las siguientes categorías:

• Administración de sesión
• Administración de usuarios
• Trabajar con Metadatas
• Trabajar con consultas catalogadas
• Trabajar con Dimensiones, Indicadores y Atributos
• Test

Administración de sesión

Servicios necesarios para establecer una sesión con los motores.

StartSession
Permite iniciar una sesión con el servidor. Primer Web Service que se debe llamar siempre para establecer una sesión con el servidor.

Sintaxis:
void StartSession (in: Character userName, in: Character userPassword, out :GXBISession session, out: GXBIStatus status )

Parámetros:

CloseSession
Cierra una sesión previamente establecida con el servidor. En caso de tener una metadata abierta la cierra.

Sintaxis:
void CloseSession (in: GXBISession session, out: GXBIStatus status )

Parámetros:

Administración de usuarios

Administración de usuarios en el catálogo.

GetUser
Permite obtener información del usuario de nombre userName de la colección de usuarios del catálogo.

Sintaxis:
void GetUser (in: GXBISession session, in: Character userName, out: GXBIUser user, out: GXBIStatus status )

Parámetros:

GetUserCollection
Obtiene la colección de usuarios del catálogo.

Sintaxis:
void GetUserCollection (in: GXBISession session, out: ArrayOfGXBIUser userCollection, out: GXBIStatus status )

Parámetros:

Trabajar con Metadatas

Acceso a las metadatas de un catálogo.

GetMetadata
Permite obtener información de la metadata de nombre metadataName de la colección de metadatas del catálogo.

Sintaxis:
void GetMetadata (in: GXBISession session, in: Character metadataName, out: GXBIMetadata metadata, out: GXBIStatus status )

Parámetros:

GetMetadataCollection
Obtiene la colección de metadatas del catálogo.

Sintaxis:
void GetMetadataCollection (in: GXBISession session, out: ArrayOfGXBIMetadata metadataCollection, out: GXBIStatus status )

Parámetros:

OpenMetadata
Abre la metadata metadataName. Es importante resaltar que para trabajar con entidades dependientes de una metadata (indicadores, dimensiones, atributos, consultas) siempre es necesario abrirla previamente utilizando éste método.

Sintaxis:
void OpenMetadata (in: GXBISession session, in: Character metadataName, out: GXBIStatus status )

Parámetros:

CloseMetadata
Cierra la conexión a la metadata previamente abierta.

Sintaxis:
void CloseMetadata (in: GXBISession session, out: GXBIStatus status )

Parámetros:

Trabajar con consultas catalogadas

Administración de las consultas catalogadas de una metadata.

GetQueryCollection
Obtiene la colección de consultas.

Sintaxis:
void GetQueryCollection (in: GXBISession session, in: Numeric onlyOwnerQueries, out: ArrayOfGXBIQuery queryCollection, out: GXBIStatus status )

Parámetros:

GetQuery
Obtiene información de una consulta.

Sintaxis:
void GetQuery (in: GXBISession session, in: Character queryName, out :GXBIQuery query, out: GXBIStatus status )

Parámetros:

GetQueryData
Abre y Ejecuta una consulta utilizando la sesión abierta.

Sintaxis:
void GetQueryData (in: GXBISession session, in: Character queryName, in: ArrayOfGXBIParameter parameterCollection, in: ArrayOfGXBIProperty serviceProperties, out: Character specificResult, out: Character xmlData, out: GXBIQuery query, out: GXBIStatus status )

Parámetros:

GetQueryHtmlData
Ejecuta una consulta y retorna el HTML para ser embebido en cualquier aplicación Web o una URL referenciando la consulta ejecutada.
No se necesita establecer previamente una session con el motor.

Sintaxis:
Character GetQueryHtmlData (in: Character userName, in: Character userPassword, in: Character metadataName, in: Character queryName, in: ArrayOfGXBIParameter parameterCollection, in: ArrayOfGXBIProperty serviceProperties, out: GXBIStatus status )

Parámetros:

CloseQuery
Cierra una consulta previamente abierta con el método GetQueryData

Sintaxis:
void CloseQuery (in: GXBISession session, in: Numeric queryId, out : GXBIStatus status )

Parámetros:

SaveQuery
Salva una consulta previamente abierta con el método GetQueryData

Sintaxis:
void SaveQuery (in: GXBISession session, in: Numeric queryId, out: GXBIStatus status )

Parámetros:

Trabajar con Dimensiones, Indicadores y Atributos

Administración de Business Elements (Dimensiones, Indicadores o Atributos) de una metadata.

GetBusinessElementCollection
Obtiene una colección de Business Elements.

Sintaxis:
void GetBusinessElementCollection (in: GXBISession session, in: Character businessElementType, out: ArrayOfGXBIBusinessElement businessElementCollection, out: GXBIStatus status )

Parámetros:

GetBusinessElement
Obtiene información de un Business Element, cuyo nombre es businessElementName.

Sintaxis:
void GetBusinessElement (in: GXBISession session, in: Character businessElementName, out: GXBIBusinessElement businessElement, out: GXBIStatus status )

Parámetros:

GetBusinessElementValueCollection
Obtiene la colección de valores para el Business Element de nombre businessElementName.

Sintaxis:
void GetBusinessElementValueCollection (in: GXBISession session, in: Character businessElementName, in: Character valuesLike, in: Numeric notLike, out :ArrayOfGXBIValue values, out: GXBIStatus status )

Parámetros:

GetRelatedBusinessElementCollection
Obtiene la colección de Business Elements relacionado con el parámetro. Es decir dependiento del elemento puede obtener las dimensiones por las cuales es analizable un indicador y viceversa. Aplica el mismo concepto para el paradigma de atributos, obteniendo los atributos relacionados del atributo parámetro.

Sintaxis:
void GetRelatedBusinessElementCollection (in: GXBISession session, in: Character businessElementName, out: ArrayOfGXBIBusinessElement businessElementCollection, out: GXBIStatus status )

Parámetros:

EvalBusinessElement
Evalúa el Business Element de nombre businessElementName aplicando los filtros especificados en la colleccion de objetos filtro filterCollection.

Sintaxis:
void EvalBusinessElement (in: GXBISession session, in: Character businessElementName, in: ArrayOfGXBIFilter filterCollection, out :Character result, out: GXBIStatus status )

Parámetros:

GetUserBusinessElementCollection
Obtiene la colección de Business Elements a los que tiene permiso el usuario cuyo nombre es userName.

Sintaxis:
void GetUserBusinessElementCollection (in: GXBISession session, in: Character userName, in: Character businessElementType, out: ArrayOfGXBIBusinessElement businessElementCollection, GXBIStatus status )

Parámetros:

SetBusinessElement
Actualiza un Business Element. Es posible modificar la Descripción y si se encuentra disponible para el usuario final.

Sintaxis:
void SetBusinessElement (in: GXBISession session, in: GXBIBusinessElement businessElement, out: GXBIStatus status )

Parámetros:

GetValuesRestrictionCollection
Obtiene la colección de restricciones (sin sus valores en el caso de que la restricción sea parcial) de un Business Element.

Sintaxis:
void GetValuesRestrictionCollection (in: GXBISession session, in: Character userName, in: Character attributeOrGroupName, out: ArrayOfGXBIValuesRestriction valuesRestrictionCollection, out: GXBIStatus status )

Parámetros:

GetValuesRestriction
Obtiene una restricción con su colección de valores para el Business Element parámetro (con sus valores en el caso de que la restricción sea parcial).

Sintaxis:
void GetValuesRestriction (in: GXBISession session, in: Character userName, in: Character businessElementRestrictedName, in: Character restrictedByBusinessElementName, out: GXBIValuesRestriction valuesRestrictionCollection, out: GXBIStatus status)

Parámetros:

CreateExtensibleEntity
Crea una Entidad Extensible.

Sintaxis:
void CreateExtensibleEntity (in: GXBISession session, in: Character extensibleEntityName, in: Character extensibleEntityDescription, in: Character extensibleEntityKey, out: GXBIStatus status )

Parámetros:

CreateUserDefinedAttribute
Crea un atributo definido por el usuario.

Sintaxis:
void CreateUserDefinedAttribute ( in: GXBISession session, in: Character extensibleEntityName, in: GXBIUda userDefinedAttribute, out: GXBIStatus status )

Parámetros:

Por mas información a cerca de Atributos definidos por el usuario, cliquear aquí.

Test

ConnectionTest
Chequea que las interfaces de los web services funcionen correctamente. Se recomienda su utilización en caso de troubleshooting.

Sintaxis:
void ConnectionTest ( in: Numeric executeSeccondLayerService, out: Character text )

Parámetros: