Objective

The Quick Query Widget to be provided by Fluig will show the user data of indicators to be defined by the business areas for each of the ERPs. This widget will obtain information settings and business data through REST services to be implemented by each of the segments. For the Datasul  line, the REST service will be provided by the Datasul Framework, which in turn will search the settings and data of each of the indicators of a particular BO (Business Object Progress). These BOs must be implemented by the business areas responsible for the indicators.

The Quick Query Widget will be similar to the form in Figure 1 below.

You can access a prototype of the Quick Query widget screen through the link http://cassino:8180/integration/static/quicksearch/index.html?indicator=XXXX where XXXX must be the code of the registered indicator.

Figure 1

Indicator register

The indicators must be registered in GOLD under the option “ENG20065 – Quick Query Indicator Register” as shown in Figure 2.  

Figure 2

Once the indicator register routine is accessed, GOLD will open the initial screen, as shown in Figure 3.

.

Figure 3

Figure 3 shows the following actions:

• Add: Enables the fields for the registration of a new indicator.
• Modify: Allows the editing of a previously selected indicator.
• Copy Version: Creates a replica of an  indicator of Innovation(79) to Supportability(69).
• Delete: Removes the indicator.
• Search: Performs the search for indicators.
• First, Previous, Next, Last: Navigates between indicator records.
• List: Opens a list screen with all indicators.
• Export: Exports indicators in a fluig_indic.d file.

When choosing the option Add, GOLD will enable the fields for addition as shown in Figure 4.

Figure 4

As shown in Figure 4, the following fields are available for addition:

• • Sub Product: Indicates for which sub-product the indicator will be issued
  • Package: Indicates in which package the indicator will be released
  • Indicator: Sequential field which will identify the indicator. (Generated automatically)
  • BO Name: The name of the BO (ex: fluig/qs/user.p) that will be responsible for providing the settings information and the records for the indicator at hand must be entered. Further in this document we will see the details for implementation of this BO.
  • Description of indicator: Description of indicator that will be used to display it in the Fluig Quick Query widget.

  • Records per Page: Number of records that will be displayed in the Fluig Quick Query widget. The widget will perform the automatic page break according to the number of records to be displayed.

  • Has cache: indicates whether the browse will cache the data.

  • Time of data in memory: time, in seconds, that the browser will keep the cache.

  • Custom BO: If a customization is required, the custom BO name must be entered in this field. This BO must implement the same procedures as a default BO, as described below.
  • Autocomplete: checkbox indicating if autocomplete is enabled for this indicator.
    
    

For product 69, the current package is 60 – 12.1.1, which will already be recommended. The screen does not allow registration in a higher package.

If the user registers in a package below the official one, the screen will display a message informing that a higher package is available, and that this record must also be registered in the official package.

In the export option, the analyst must select for which subproduct and package the indicators should be exported, as shown in Figure 5.

After exporting, a fluig_indic.d file will be created, and a version of it copied to the TSF of the univdata folder ($/FOUNDATION/Fontes_Doc/Sustentacao/V11/V11/progress/src/univdata)

NOTE: The analyst is entirely responsible for this commit in the univdata folder 

Figure 5

Importing indicators

After the indicators are exported (fluig_indic.d), they must also be imported within Datasul. This procedure may be performed through the menu  (Foundation --> Basic (NPS) --> Tasks --> Importing Quick Queries).

When accessing this menu item, Datasul will open an import quick query screen, as shown in Figure 6.

Figure 6

In this screen, simply enter the location of the fluig_indic.d file and import it.

REST Service and BOs of Indicators

The Quick Query Widget will use a REST service available at Datasul to obtain the data required for the indicator. In turn, this REST service will obtain the information and data of each indicator through the indicator register and of a BO linked to the indicator.

To assist in the process of developing the BO, the include i_fluig_indicator.i was created, and will contain all default temp-tables to be used in the procedures. In order to use this include, simply import it in the beginning of the BO by inserting the following line:

Each BO of an indicator must implement the procedures described below:

Procedure Name: pi-obtem-campos-entidade-pai

Description: returns the list of columns of the parent entity to populate the upper left combobox of the widget (Figure 1).

Parameters:

• user: user identifier for ERP (CHARACTER - INPUT type)
• company: company identifier for ERP (CHARACTER - INPUT type)
• ttParentFields: temp-table with the code/label list. Should contain only the items that the user is allowed to query (TEMP-TABLE – OUTPUT type)

       TEMP-TABLE fields:

• ccode: CHARACTER - field code
• clabel: CHARACTER - field label

Procedure Name: pi-obtem-colunas

Description: returns a Column Model list of the columns to be displayed in the quick query widget grid. This information will be used by the service to assemble the colModel, comprising the response JSON.

Parameters:

• user: user identifier for ERP (CHARACTER - INPUT type)
• company: company identifier for ERP (CHARACTER - INPUT type)
• ttColumnModel: temp-table with the settings data for the Grid columns. Should contain only the columns that the user is allowed to query (TEMP-TABLE – OUTPUT type)

       TEMP-TABLE fields:

• • cname: CHARACTER - column name
  • cindex: CHARACTER - column index
  • clabel: CHARACTER - column name
  • lsortable: LOGICAL - indicates whether the user can sort by column
  • iwidth: INTEGER - column width, in pixels
  • calign: CHARACTER - column alignment (left, center or rigth)
  • csorttype: CHARACTER - sorting type (asc or dec)
  • cformatter: CHARACTER - formatter type, e.g.: date
  • cdatefmt: CHARACTER - date field format, e.g.: "d-M-Y"
  • lshowOnGrid:LOGICAL - indicates whether this field should be displayed in grid (default option = true)
  • cdefault-value: CHARACTER - default value for field.

When opening a related action in a Progress program, include a column named rowid in the procedure return. 

Example of procedure:

Procedure Name: pi-obtem-lista-selecao

Description: returns a list of items to comprise the selectionValues in the response JSON, which will be used to populate the upper right combobox of the widget (Figure 1).

Parameters:

• user: user identifier for ERP (CHARACTER - INPUT type)
• company: company identifier for ERP (CHARACTER - INPUT type)
• ttSelectionValues: temp-table with the list of filters (selection values). Should contain only the items that the user is allowed to query (TEMP-TABLE – OUTPUT type)

       TEMP-TABLE fields:

• • ccode: CHARACTER - field code
  • clabel: CHARACTER - field label

Example of procedure:

Procedure Name: pi-obtem-acoes-relacionadas

Description: returns a list of items to comprise relatedActions item in the response JSON, which will be used to populate the Related Actions combo (Figure 1).

Parameters:

• user: user identifier for ERP (CHARACTER - INPUT type)
• company: company identifier for ERP (CHARACTER - INPUT type)
• ttRelatedActions: temp-table with the list of related indicators. Should contain only the items that the user is allowed to query (TEMP-TABLE – OUTPUT type)

       TEMP-TABLE fields:

• clabel: CHARACTER - field label
• ctype: CHARACTER - type of form to be opened. Possible values (md, flex or progress)
• cmodule: CHARACTER - module to be opened
• cprogram: CHARACTER - program to be opened
• cviewtype: CHARACTER - type of screen format to be opened. Used for ctype=md or ctype=flex. Possible values (portlet,view and window)
• crowid: CHARACTER - should be used to inform the field that will represent the rowid to related entities. 

With this information, the URLs will be assembled according to the formats below:

Progress:

http://10.80.5.40:8080/abl-external-call/execute?module=sec&program=sec000aa.w&user=framework

Metadata:

http://10.80.5.40:8080/josso/signon/externalUserAuthentication.do?josso_cmd=external-login&type=md&fromFluig=true&program=fnd.CRUDUsuarMestre&viewtype=view&userid=framework&password=ZnJhbWV3b3Jr=

Flex:

http://server:port/josso/signon/externalUserAuthentication.do?josso_cmd=external-login&type=frwk&module=fnd&fromFluig=true&program=datasul-calculatorportlet-flex&viewtype=portlet&userid=super&password=c3N6a0AxMjM=

Details of how to assemble the URLs, query the document:

Invoking Applications and Forms on Datasul through Fluig

DEFINE VARIABLE  mdProgram AS CHARACTER.

DEFINE VARIABLE ttPreSelRecord AS TEMP-TABLE.

mdProgram = GET-MD-PROGRAM().

/* Checks if the selected record sent by Fluig (if any)

   corresponds to the current form */

IF mdProgram = “crm1150.FFIndicadorX” THEN DO:

    ttPreSelRecord = GET-PRE-SEL-RECORD().

    /* Based on that, we have the record sent by Fluig available at

       temp-table ttPreSelRecord, where the field names correspond to the

       names defined in the colModel of the start service. The rest of the script 
       should then prepare the presentation of the record.*/

    ...

    ...

END.


					

IF r-ind-tabela <> ? THEN DO:

      RUN pi-reposiciona-query IN h_q01fn069 (INPUT r-ind-tabela).

      ASSIGN r-ind-tabela = ?.

END.

{utp/indicador-tabela.i}

IF r-ind-tabela <> ? THEN DO:

    FIND FIRST plano_cta_ctbl NO-LOCK

        WHERE ROWID(plano_cta_ctbl) = r-ind-tabela NO-ERROR.

    IF AVAIL plano_cta_ctbl THEN DO:

        ASSIGN v_rec_plano_cta_ctbl = RECID(plano_cta_ctbl).

    END.

    ASSIGN r-ind-tabela = ?.

END.