Skip to content

sesam-community/omega365

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

37 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Omega 365 client service

A microservice for connecting to Omega 365.

SesamCommunity CI&CD

Environment variables:

base_url - base url to the Omega 365 instance.

username - Omega 365 username.

password - Omega 365.

resources - a list of the configured Omega 365 API endpoints, the following properties are declarable for each endpoint:

LOG_LEVEL - Defaults to "INFO".

  • fields: a list of the properties exposed by the endpoint. Required property.
  • resource_name: name of the Omega 365 resource. Required property.
  • id_property_name: name of the property containing the unique id of an entity. Required property.
  • since_property_name: name of the property containing the value for the since marker if the resource supports since functionality for continuation support. Optional property.

Example system config:

{
  "_id": "omega365-system",
  "type": "system:microservice",
  "docker": {
    "environment": {
      "base_url": "$ENV(omega365-url)",
      "LOG_LEVEL": "DEBUG",
      "page_number": "1",
      "page_size": "1000",
      "password": "$SECRET(omega365_password)",
      "protocol": "json",
      "resources": [{
        "fields": [{
          "name": "PrimKey"
        }, {
          "name": "Created"
        }, {
          "name": "Name"
        }],
        "id_property_name": "PrimKey",
        "resource_name": "omega365-integration-resourcename",
        "since_property_name": "Updated"
      }],
      "username": "$ENV(omega365-username)"
    },
    "image": "sesamcommunity/omega365:1.0",
    "port": 5002
  }
}

Example pipe config when used as a source:

{
  "_id": "omega365-pipe",
  "type": "pipe",
  "source": {
    "type": "json",
    "system": "omega365-system",
    "completeness": false,
    "is_since_comparable": true,
    "supports_since": true,
    "url": "omega365-integration-resourcename"
  }
}

Example pipe config when used as a sink:

{
  "_id": "omega365-endpoint",
  "type": "pipe",
  "source": {
    "type": "dataset",
    "dataset": "omega365-dataset"
  },
  "sink": {
    "type": "json",
    "system": "omega365-system",
    "url": "omega365-integration-resourcename"
  }
}