Documentation Index

Fetch the complete documentation index at: https://platform.docs.zenoo.com/llms.txt

Use this file to discover all available pages before exploring further.

​

Component model

• huddle component contains the main workflow, business logic and project-specific configuration.
• huddle.routes component contains project-specific route definitions.
• document-check component provides ID document and liveness check functionality via a set of workflows and functions, the configuration includes the country and API credentials.
• otp component provides a workflow to verify an SMS OTP code using a customer mobile, the configuration includes a number of retries, country code, OTP provider, etc.

​

Hub Component

• name a unique name of a component,
• version a component version, if omitted SHA-256 hash is generated,
• definition a set of DSL closure definitions using Component DSL,
• dependencies a set of resolved references to other components and connectors used in the definition.
• configuration a JSON-like configuration data, see more
• configuration schema a JSON schema for configuration data, see more

​

Component repository

• validates component definition based on Component DSL,
• checks the availability of component dependencies,
• validates each DSL closure based on Hub DSL,
• resolves component dependencies versions,
• generates the component version if omitted, using SHA-256 hash of the component,
• registers the component.

​

Component DSL

• target
• exposed
• workflow
• function
• route
• mapper
• transport

​

DSL reference

dependencies {
    component 'workflows'
}

target {
    workflow('test@workflows')
}

target {
    workflow('test')
}

workflow('test') {
    defintion
}

​

Target

target {
    workflow('reference')
}

​

Exposed

exposed('reference') {
    function('existing@component')
}

exposed('inline') {
    sharable {
        function('existing.')
    }
}

exposed('store') {
    function('create-record@crm')
        .onDecision('ACCEPTED') {
            payload ->
                response {
                    status HttpStatus.ACCEPTED
                    header HttpHeaders.LOCATION, payload.url
                    body payload
                }
        }
    error()
}

​

Workflow

workflow('name') {
    definition
}

​

Function

function('name') {
    definition
}

​

Route

route('name') {
    uri '/uri'
    export data
    validate { payload specification }
    checkpoint()
    terminal()
}

• uri identifies a route for a Hub Client and is mandatory
• export is used to pass data to a Hub Client, like lists and key-value maps
• validate specifies data constrains for route result submitted by a Hub Client
• checkpoint() marks the route as a checkpoint, disables going back
• terminal() marks the route as terminal and checkpoint

​

Mapper

    mapper("name") {
        input ->
            expression
    }

    mapper("client-fullname") {
        input -> [ fullname: "$input.client.firstname $input.client.lastname" ]
   }

​

Transport

• base URL
• authentication
  • basic
  • bearer
• more to come:)

​

Basic authentication

• username the username used for authentication
• password the password associated with the username

transport('id-provider') {
    auth {
        basic {
            username 'username'
            password 'password'
        }
    }
}

​

Bearer authentication

• url the token endpoint URL where the authentication request is sent
• type the grant type used for authentication (e.g. password, client_credentials), the default is password
• scope the level of access requested, as a space-separated list of permissions
• username the username of the resource owner (used in password grant type).
• password the password of the resource owner (used in password grant type).
• clientCredentials the client credentials (client_id:client_secret) for the application, encoded in Base64

transport('id-provider') {
    auth {
        bearer {
            url "$baseUrl/token"
            username 'username'
            password 'password'
            scope 'transactions/get'
        }
    }
}

​

Dependencies

dependencies {
    connector 'sms@otp:1.2.0'
    component 'zenoo.playground'
    component 'zenoo.otp:2.4', [countryCode: '+420', tries: 3]
}

​

Component configuration

• set using a component config service
• set when declaring a component dependency in the dependencies section

​

Component config service

• Spring environment, looks up a component configuration under hub.components.config using the component name
• Cloud provider configuration storage (e.g., AWS Secrets Manager, in-memory storage, etc.)

hub:
  components:
    config:
      stage:
          playground.test:
            service: dummy

dependencies {
    component 'zenoo.playground', config('stage.zenoo.playground')
}

dependencies {
    component 'zenoo-otp:2.4', config('zenoo-otp@sandbox.config')
}

​

Component dependency config

dependencies {
    component 'zenoo.playground'
    component 'zenoo.otp:2.4', [countryCode: code]
}

workflow('play') {
    loop(tries) {
        workflow('do-something')
    }
}

​

Attributes

tries << tries ?: 3

dependencies {
    component 'zenoo.playground'
    component 'zenoo.otp:2.4', [countryCode: '+420', tries: tries]
}

workflow('play') {
    loop(tries) {
        workflow('do-something')
    }
}

require {
    api {
        url
        username
        password
    }
}

exchange('exchange') {
    http {
        url api.url
        basicAuth api.username, api.password
    }
}

​

Component api key

hub:
  components:
    security:
      "playground.test": "secret-key"