El nexo entre tecnología y negocios
 
[ AFC00498 ] Utilización de consultas del usuario en los monitores de negocio
Summary
Business monitor design is modified, so that instead of using Apia's database views, uses user's queries.

It is applied to
  • Apia 2.4.0.17


Behavior

When designing a customized business monitor, in “Business monitor” within Design module, instead of associating a database view, it will be possible to associate a user query.

Queries that can be associated must be:

  • Business monitor – Related elements
  • Business monitor – Element properties
  • Business monitor – Dependencies properties
  • Business monitor – Element instances

Queries can be designed with any source (database or business class) and only the following conditions shall be fulfilled:

  • Business monitor – Related elements: query entered must have the following columns (this columns are required when designing user queries in order to select the corresponding type):
    • ele_type (varchar): indicates the type of element to which it is related. Possible values are:
      • E: entity.
      • EI: entity instance.
      • P: process.
      • PI: process instance.
      • T: task.
      • O: group.
      • U: user.
      • ele_id (int or double): indicates element’s internal Ip of Apia.
      • ele_name (varchar): indicates the name of the element.
      • ele_image (varchar): indicates image path that should be shown. If null, the image by default of the element is shown.  
      • dep_label (varchar): name of dependency that should be shown.
      • dep_direction (varchar): indicates dependency. Possible values are:
        • in: input to main element.
        • out: output to main element.
        • na: none of the above. Value used by default if no value is specified or if the value specified is wrong.
      • ele_father_id (int or double): indicates internal Id of Apia, of the element that defines the element.  The value of this column is only required when entity/process instances are being shown and it is used to verify if the element can be shown. If ele_type is EI or PI is compulsory, otherwise, null must be returned. If this value exists, it will be used to control if the element exists, otherwise, ele_id value will be used.
      • env_id (int) *: identifier of the environment in which the user is located.
      • ele_id_from (de tipo int) *: identifier of mail element.
  • Business monitor – Element properties: the query that is entered must have the following columns (this columns are requested when designing user queries in order to select the corresponding type):
    • prp_name (varchar): property name.
    • prp_value (varchar): property value.
    • env_id (int) *: identifier of environment in which the user is located.
    • ele_id_from (int) *: identifier of main element.
  • Business monitor – Dependencies properties: query entered must have the following columns (these columns are required when designing user queries, in order to select the corresponding type):
    • prp_name (varchar): property name.
    • prp_value (varchar): property value.
    • env_id (int) *: identifier of environment in which the user is located.
    • ele_id_from (int) *: identifier of main element.
    • ele_type_to (varchar) *: type of element to which dependency aims.
    • ele_id_to (varchar) *: id of the element to which the main element is being associated.  
  • Business monitor – Element instances: query entered must have the following columns (these columns are required when designing user queries, in order to select the corresponding type):
    • inst_id (int): Apia’s internal code of the instance.
    • inst_ident (varchar): instance identifier.
    • inst_name (varchar): value that represents the instance.
    • env_id (int) *: identifier of the environment in which the user is located.
    • ele_id_from (int) *: main element identifier.

This setting is possible for:

  • Entities.
  • Entity instances (it is not possible to set the list of instances of the element).
  • Processes.
  • Process instances (it is not possible to set the list of instances of the element).

Elements that are marked with * must be used as filters, therefore, if a query with Business class source is set, these parameters must be input.



Related from
[ ANF00205 ] Business monitor
[ ANF00206 ] Customized business monitor design
Suggested items
[ AFC01774 ] Visualization of grids' data paged in monitoring
[ AHT00161 ] Example of access to the monitor of documents by API
[ ANF00139 ] ApiaMonitor
[ AFC00507 ] Export business monitors
[ ABR00049 ] Error when having access to the processes' monitor with Postgres base
[ ARN00205 ] Apia Monitor Release 2.4
[ AFC00525 ] Attributes label in Entities monitor
[ AFC00590 ] Entities monitoring customization
[ ANF00182 ] Acceso al monitor de documentos por API
[ AFC00561 ] Access to processes from Entities monitor