Getting started

Quick Start

To serve OCA ecosystem on your machine, run the following commands in your command line:

curl https://raw.githubusercontent.com/THCLab/oca-ecosystem/main/docker-compose.yml > docker-compose.yml
docker-compose up

This command will serve OCA Browseropen in new window on port 8000 by default.

with default layouts

for f in examples/swiss_passport/entries/*; do;
  curl -X POST "http://localhost:9293/api/v1/files" -H "accept: */*" -H "Content-Type: multipart/form-data" -F "file=@$f";
done;

Hosting entries in Data Vault allows to reuse complex entries in many OCAs. You can link Entry Code Overlay or Entries Overlay with entries in Data Vault by it's SAI instead of keeping all entries data inside Overlays.

  • Go to Preview and select OCA Bundle file
  • As a result OCA Form and Credential are rendered with default layouts

custom layouts

for f in examples/swiss_passport/assets/*; do;
  curl -X POST "http://localhost:9293/api/v1/files" -H "accept: */*" -H "Content-Type: multipart/form-data" -F "file=@$f";
done;

Assets may be images, fonts etc. used in custom layout.

  • In Develop -> XLS to OCA Converter select XLS file as before
  • In Select Credential Layout file and Select Form Layout file fields select downloaded layouts files
  • Click Convert button and download generated file (OCA Bundle)
  • Download entries filesopen in new window and upload them to data-vault with listed command:
for f in examples/swiss_passport/entries/*; do;
  curl -X POST "http://localhost:9293/api/v1/files" -H "accept: */*" -H "Content-Type: multipart/form-data" -F "file=@$f";
done;
  • Go to Preview and select OCA Bundle file
  • As a result OCA Form and Credential are rendered with custom defined layouts

Learn more about defining custom layouts

OCA References

TODO

Tutorial

Defining OCA in xls file

Last Updated:
Contributors: blelump