Introduction to the Scan Sync Module

Jul 22, 2024

Introduction to the Scan Sync Module

Presenter Introduction

  • Speaker: Ser from Link Digital
  • Role: Web Developer
  • Company focus: Open data management using S Data Management System

Challenges addressed

  • Clients require not just data storage/management but also:
    • Related content like news pages, articles, blog posts
    • Visual data representations (maps, charts)

Solution using Drupal

  • CMS used: Drupal Content Management System (CMS)
  • Module: Scan Sync Module

Features of Scan Sync Module

  • Scan Client Service: Allows retrieving data from the Scan site via REST API.
  • Drupal Endpoint: Provides the menu structure required for the site.
  • Availability: Downloadable via Composer.
  • Configuration page: Accessible after installation and enabling the module.

Configuration Fields

  • Scan URL: URL of the Scan application.
  • Service API token: Obtainable from Scan settings page.
  • API Header Name: Default header format provided.
  • HTTP Authentication: Credential provision for development instances.

Status and Usage

  • Connection Status: Shows 'connected' once fields are appropriately filled.
  • Service Utilization: Services can be used in custom modules/themes.

Available Services

  • Scan Client Service: Enables direct interaction with Scan API using action names and parameters (refer to Scan API documentation).
  • Scan Data Import Service: Facilitates data retrieval/manipulation using pre-defined methods for common API requests like get package list, get group list, get tag list.

Additional Features

  • Endpoint for Exporting Menu Structure:
    • Found under configuration > web services > rest
    • Enable and configure with method 'GET' and format 'JSON'
    • Authorization: Token-based (part of configuration)
    • URL provides schema of the menu structure using machine name

Future Improvements

  • Upcoming features include storing data inside Drupal entities.

Closing

  • Appreciation for participation
  • Speaker: Ser from Link Digital