Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Index 

Índice
outlinetrue
exclude.*ndice
stylenone

 

 


Speaking of datasets

...

..

...

.

...

Datasets are components that allow you to standardize standardizing access to information from locations external to the platform, such as applications and databases. High-performance datasets have a data storage cache obtained externally, which aims to reduce the number of accesses to external data services, that is, it creates a copy of the data structure within the platform for consultationquery, enhancing the performance of the datasets developed on the platform. Therefore, the data are is queried on the platform itself, preventing access to data in the external provider system in every request.

In order to update the data of the copy created on the platform, it is necessary to define the synchronization frequency on the Task Scheduler.

 

Basic Path

 

01. From the main menu, click on Control panel.

02. In the General tab, click on Datasets.

03. View all datasets that have been exported to the platform.

Expandir
titleLearn more

This feature does not allow the creation of datasets, they must be developed in Studio and later exported to the platform.

You can search for a specific dataset through the Search field located in the upper right corner of the window.

 

Alternative Paths

 

Make dataset offline in mobile

 

01. Click the Edit icon on the Offline mobile column.

02. Define the requested information in the displayed window.

This feature allows creating datasets and defining which ones will be offline on mobile devices, which ones should be synchronized with the external data provider, and the synchronization frequency, disable those that are no longer used, among other options.

Active datasets are highlighted with a stronger font color to stand out among datasets that are no longer being used.

Informações
titleStay tuned for more info!

Refer to the technical documentation to learn more about dataset development.


Displaying datasets

...

01. In the main menu, click Control Panel, then check Development container and click Datasets.

02. View all datasets shown in the list.

Painel

It is possible to search for a specific dataset through the Search field located on the upper right corner of the window, or use the Filter button to select datasets that will be returned.


Filtering datasets

...

01. Click the Filter button located on the upper right corner of the window.

02. Select the datasets to be shown on screen. Filter by status (active, inactive and/or under editing) and type (internal, simple and/or advanced).

Painel

The selected types of datasets will be listed.


New simple dataset

...

01. Click New Dataset, and click Simple.

02. In the Code field, enter a code for the dataset.

Painel

To avoid inconsistencies, the dataset code and description must not contain special characters (except for “_” and “-”).

03. In the Description field, enter a description for the dataset.

04. In the Service field, select a service for the dataset.

Painel

If you do not have any registered services, simply go to the Services menu in the General tab of the Control Panel to create a new one.

05. When you select the SOAP, REST, or JDBC services, the fill-in options will appear differently from one to the other. Fill in the fields according to the selected service.

Painel
Deck of Cards
historyfalse
idservicos
Card
ids
labelSOAP

When selecting the SOAP service type, complete the following fields:

Operation
Selecting the magnifying glass icon will allow you to select one of the available operations. The operations will be listed by Name and PortType (ColleagueService).

To set up
In the settings of the selected operation, Properties, SOAP Headers and Return Processing can be configured.

Painel

Properties

  • Basic Authentication - Select whether or not to authenticate. You can define a user name and password.
  • SSL - enable when soap service requires use of ssl.
  • Disable Chunking - disable sending the entire soap envelope.
  • List SOAP messages - enable to show the sending and receiving messages in the log.


Dataset keys


Allows setting the keys to be used during offline synchronization, in order to avoid duplicate records from each synchronization.

SOAP Headers

Allows you to add a header.

Treatment Return

  • Extract Result: Allows you to select this option to extract a report in xml format and include a tag.

Parameters:
Fill in the parameters as required:

Assignment
-Null or Variable (When Null is selected, the Value field is automatically dispensed).

Value
-WKCompany or WKUser (Will be displayed when the assignment field is selected as Variable).

Card
idr
labelREST

When selecting the REST service type, complete the following fields:

Operation
Selecting the magnifying glass icon will allow you to select one of the available operations. The operations will be listed by Name, Method (GET), and API.

To set up
In the settings of the selected operation, the Properties, Headers and Return.

Painel

Properties

  • SSL - enable when soap service requires use of ssl.
  • List messages - enable to show the sending and receiving messages in the log.
  • Response time - enable to display the time the request waits for the response.

Dataset keys

Allows setting the keys to be used during offline synchronization, in order to avoid duplicate records from each synchronization.

Headers
Allows you to add a header.

Treatment Return

  • Extract Result: Allows you to select this option to extract a report in JSON format and include a path

Click Save to complete the configuration.

Parameters:
Fill in the parameters as required:

Assignment
-Null or Variable (When Null is selected, the Value field is automatically dispensed).

Value
-WKCompany or WKUser (Will be displayed when the assignment field is selected as Variable).

Card
idj
labelJDBC

When selecting the JDBC service type, complete the following fields:

Table
Selecting the magnifying glass icon will allow you to select one of the available tables. The operations will be listed by Name and Type (Table, VIew or Synonym).

To set up
In the selected table settings, you can configure some properties such as:


  • Limit Result - Enable to limit the number of records returned.
  • Key field for the table - Allows to select a key field for the table, being: limit or offset.

Click Save to complete the creation.

Fields
Fill in the fields as requested:


Filters - Allows you to add filters to the fields.

Painel

To create filters, you need to configure some information. Are they:

Operation
Lets you select one of the available operations: AND, OR or NOT.

Initial value
Set an initial value. Ex: 1

Final value
Define an end value. Ex: 3

Use Like
Search for content, not exact, but that contains part of the value informed. Just select Yes or No.

  • Return - Allow or not to return a value. Just press Yes or No.
  • Sort - allows you to sort the fields in ascending or descending order.

06. Click Save.


New advanced dataset

...

01. Click New Dataset, and click Advanced.

02. In the Code field, enter a code for the dataset.

Painel

To avoid inconsistencies, the dataset code and description must not contain special characters (except for “_” and “-”).

03. In the Description field, enter a description for the dataset.

Painel

This adds a new advanced dataset record and opens the screen to edit the dataset source code. The source code will be saved as draft before the authenticated user clicks Save. Changes to the source code are only applied to the dataset after the user completes all changes and clicks the Post button. Refer to the technical documentation available here to learn more about building advanced datasets.


Enable offline dataset on mobile

...

01. Click the edit icon in the Offline mobile column, represented by the pencil symbol.

02. Define the required information in the pop-up window

Painel

The default setting is No (Off).

Required information:

Use cache on mobile devices?

When enabled, the data in the dataset is stored in cache when used on

Expandir
titleLearn more

The requested information is:

Use cache in mobile devices?
When enabled, this option specifies that the data in the dataset is to be stored in cache when it is used in mobile devices. In this case, the button is presented with the call ON, stating ON (yes) is displayed, indicating that the feature is active. When activated set to disable the feature, the button is presented with the call OFF, stating OFF  (no) is displayed, indicating that the feature is disabled.

Mobile cache expiration time

Time in which the stored data is considered valid and remain remains in the cache of mobile devices before being updated.

Not use cache when the mobile device is online?

When enabled, it states that the data in cache will is not be accessed queried when the mobile device is online, that is, they will be it is required from the external system.

03. Click on Save.

 

Enable dataset data synchronization

 

01. Click the Edit icon on the Sync dataset column.

02. Enable dataset data synchronization in "Synchronize with server?".

Expandir
titleLearn more

It is only possible to enable data synchronization for datasets developed on the platform. When enabling synchronization, it will be carried out according to the schedule created in Task Scheduler. Information on how to define the synchronization frequency can be obtained in the alternate path Edit scheduling.

When this feature is enabled, the button is marked as ON. When activated to disable the feature, it is presented with the call OFF, stating that the feature is disabled.

03. Click Close to return to the main window.

 

View Syncing Information

 

01. Click the information icon on the Last synchronization column.

02. View the information of the last data synchronization of the dataset.

03. Click Close to return to the main window.

 

Enable scheduling of dataset data synchronization

 

01. Click on the context menu located on the bottom right side of the line that corresponds to the dataset for which the synchronization schedule will be edited.

02. Click on Edit scheduling.

03. In the Schedule settings window, change the desired information.

Expandir
titleLearn more

Additional information on the fields can be found in Task Scheduler.

04. Click Confirm.

 

Query dataset

 

01. Click on the context menu located on the bottom-right side of the line corresponding to the dataset that will be queried.

02. Click on Query dataset.

03. View the dataset source code.

04. Click Close.

 

Delete the dataset data

 

01. Click on the context menu located on the bottom-right side of the line corresponding to the dataset from which data will be deleted.

02. Click on Delete data.

03. In the message displayed, click on Yes.

Expandir
titleLearn more

When activating this option, all data contained in the dataset is deleted.

 

Synchronize data in the dataset

 

01. Click on the context menu located on the bottom-right side of the line corresponding to the dataset from which data will be synchronized.

02. Click on Synchronize now.

Expandir
titleLearn more

When pressing this option, the data from the dataset written on the platform are synchronized with the corresponding data from the external system. 

 

Nota
titleAttencion

New data created on mobile devices when using the offline mode is only available for query on other forms after the mobile application is synchronized with the Fluig server. For more information about this process, go to the step Configuring dataset synchronization on this page.

Painel

For Internal datasets, this option is not editable. They are only viewed as default, Internal.


Import dataset

...

01. Click Import.

02. Select the server to which the dataset will be imported.

Painel

The server must be properly registered as detailed in the Servers item. The dataset will only be successfully imported if the selected server has a update 1.6.5 (Liquid) or higher.

If there is already a dataset with the same code imported from another server, the platform will show a warning message, and the user must confirm in order to create a new version with the deployment of the imported dataset.

03. Click Import.


Export dataset

...

01. Select the datasets to be exported.

02. Click Export.

03. Select the server to which the dataset will be exported.

Painel

The server must be properly registered as detailed in the Servers item. The dataset will only be successfully imported if the selected server has a update 1.6.5 (Liquid) or higher.

04. Click Export.


Configure access permission in the dataset

...

The Control Panel Permissions feature allows you to define users, roles, or groups that will have access to Internal datasets. For more details, go to Permission features in APIs, datasets and webservices.


Dataset synchronization

...

Synchronization features are available in a specific screen, which can be accessed by clicking the link in the Synchronization column. Refer to the Dataset synchronization page to learn more about this feature.


More dataset actions

...

Datasets contain several specific actions, which may be checked by clicking the Horizontal bars icon in the More actions column. Refer to the More dataset actions page to learn more about these features. 



Informações
titlePlease note!

This documentation is valid from the Liquid (1.6.5.10 ) update. If you use a previous update, it may contain information different from what you see on your platform.

 

...