Define the ADIF import scheme

Definition of the ADIF import scheme is done in Alfabet Expand.

  1. Go to the ADIF tab.
  2. Right-click the root node and select Create Import Scheme.
  3. Set at least the following attributes of the new ADIF import scheme:
    • Name: Define a unique name for the ADIF import scheme.
    • Assistant: Select GenericAPIIntegration_Assistant.
    • Category: If you would like to execute the ADIF import via the Job Scheduler functionality, you must select the correct category for the user case JobScheduler . For an overview of the configuration required to execute an ADIF scheme via the Job Scheduler functionality, see Activating the Job Schedule Functionality in the reference manual Configuring Alfabet with Alfabet Expand.

    For a description of the other, optional parameters of the ADIF import scheme, see Configuring Data Import with ADIF in the reference manual Alfabet Data Integration Framework.

    The definition of ADIF and the activation of the job scheduler functionality is identical for Alfabet 11 and Alfabet 10 releases and not yet included in the documentation for Alfabet 11. The links above open the documents from the Alfabet 10 documentation.

  4. Right-click the ADIF import scheme in the explorer and select Create ADIF Scheme Details Using the Generic API Integration Assistant.
  5. In the assistant, define the basic attributes:
    • Name: Define the name of the ADIF import entry that will be created within the ADIF import scheme by the assistant. This ADIF import entry will trigger the generation of the temporary table the imported data will be stored in during the import process.
    • Generic API Integration Database Connection: Select the Generic API integration database connection which you defined in the configuration step: Define a database connection object.
  6. Click the New > Add Resource Filter button in the toolbar in the attribute field. A new editor opens.
  7. Define the following attributes in the given order:
    • Operations attribute, select a GET endpoint from the third-party RESTful endpoints configured for the Generic API integration database connection.
    • Primary Report: Select the report providing the parameter values to be sent to the third-party's RESTful service endpoint for the import call. The report was created in the configuration step: Define a configured report to set import call parameters.
    • Request Mappings: The table lists all parameters and JSON body fields of the selected endpoint. In the Report Column column, select the column of the dataset in the configured report providing the data for the parameter or JSON body field. You need to map at least the mandatory parameters and JSON body fields.

      For the example given in the section Define a configured report to set import call parameters the parameter mapping would be:

      GenericAPI_ADIFImportParamMappingExample 

  8. Click OK to close the mapping definition.
  9. Click OK to close the assistant.
  10. In the ADIF explorer, right-click the ADIF import scheme and select the Reread from Database option to view the changes made in the ADIF scheme by the assistant.
  11. Configure the ADIF scheme to change the object data in the Alfabet database according to demand. For more information, see Configuring Data Import with ADIF in the reference manual Alfabet Data Integration Framework.

    For JSON array import from a third-party RESTful service, payload of type array nested inside objects is written in a single column of the temporary table during ADIF import. The entire array content is then available in this column and respective object data can be consumed as JSON data at the time of ADIF execution and processing.