crm-bij1migratie/README.md

bij1migratie

Helps migrate BIJ1's data sources (as CSV) to CiviCRM, including:

• Airtable
• Mollie
  • Customers
  • Payments
  • Chargebacks

The extension is licensed under AGPL-3.0.

Requirements

• PHP v7.2+
• CiviCRM (tested: 5.48.0)
• CiviCRM CLI
• CiviCRM extensions:
  • action-provider
  • de.systopia.identitytracker
  • de.systopia.xcm
  • form-processor
  • org.project60.banking
  • bij1algemeen

Testing

• PHPUnit
• PHPStan

Development

• CiviCRM Extension CLI

Documentation

• Python

Installation (Web UI)

Learn more about installing CiviCRM extensions in the CiviCRM Sysadmin Guide.

Installation (CLI, Zip)

Sysadmins and developers may download the .zip file for this extension and install it with the command-line tool cv.

cd <extension-dir>
cv dl bij1migratie@https://github.com/FIXME/bij1migratie/archive/master.zip

Installation (CLI, Git)

Sysadmins and developers may clone the Git repo for this extension and install it with the command-line tool cv.

git clone https://github.com/FIXME/bij1migratie.git
cv en bij1migratie

Getting Started

• Zorg dat de volgende Civi instellingen ingesteld zijn:
  • bij1_basisbedrag
• In CiviCRM, onder tab Beheer, ga naar Automation en dan Form processors. Gebruik daar de import knop om de .json files uit map form-processors te importeren.
• Onder tab Beheer, ga naar Migratie Bij1 -> CiviCRM, e.g. http://localhost/wp-admin/admin.php?page=CiviCRM&q=civicrm%2Fbij1migratie%2Fform%2Fcsvselect.
• Vul het formulier in en start de import (sample data), in volgorde:
  • Mollie klanten
  • Airtable
  • Betalingen
  • ChargeBacks

Overview

• data/**/*.csv: anonymized source data samples
• Mapping/*Mapping.php: match names used in form processors to column positions in source CSVs.
• CRM/Bij1migratie/CsvFile.php#sanitize*(): column selection, transformations
• CRM/Bij1migratie/Migratie.php#migreer*(): checks, import by API, row-level error logging
• form-processors/bij1_*_migratie.json: how to process imported fields

Testing

Static analysis

phpstan analyse .

Unit tests

• place this repository in a CiviCRM installation
• run:

phpunit tests

Reloading extension code to container

Given an environment variable $CIVICRM_BIJ1_PATH pointing to your local checkout of civicrm-bij1:

export FLDR=/var/lib/docker/volumes/civicrm-bij1_civi-data/_data/wp-content/uploads/civicrm/ext/crm-bij1migratie/
mkdir -p $FLDR
sudo cp -r ./* $FLDR
docker compose -f $CIVICRM_BIJ1_PATH/docker-compose.yml exec civi bash -c "cv ext:enable bij1migratie"

Build (this) documentation

Run:

pip install mkdocs
mkdocs serve

Known Issues

(* FIXME *)