dabl-meta.yaml

## Copyright (c) 2021, Digital Asset (Switzerland) GmbH and/or its affiliates.
## SPDX-License-Identifier: Apache-2.0

catalog:
    name: dabl-integration-core
    group_id: com.digitalasset
    version: 0.9.81 # NOTE EXPERIMENTAL TAG UNTIL python-direct-hub-if SUPPORT IN HUB
    short_description: The Core Pack
    description: Timer and Loopback Integrations
    author: Digital Asset (Switzerland) GmbH
    license: Apache-2.0
    tags: [ integration, experimental ]
    icon_file: integration-icon.svg
    source_url: https://github.com/digital-asset/daml-dit-integration-core
integration_types:
    - id: loopback
      name: Loopback
      description: >
          Allows for commands to be sent to the ledger in response
          to contract create events.
      entrypoint: core_int.integration_loopback:integration_loopback_main
      env_class: core_int.integration_loopback:IntegrationLoopbackEnv
      fields:
          - id: templateFilter
            name: Event Template Filter
            description: >
                Contract template ID for created event filter.
            field_type: contract_template
          - id: targetContractMode
            name: Target Contract Mode
            description: >
                Mode used to select the target contract
                for the choice exercise. The choice can be exercised
                either on the newly created contract that triggered
                the integration or on a new contract instance
                created via the 'create and execute' ledger command
            field_type: enum:["Create And Execute", "Trigger Contract"]
          - id: targetTemplate
            name: Target Template
            description: >
                Name of the contract containing the choice
                to be triggered in response to the contract event. (Not
                used in 'Trigger Contract' mode.)
            field_type: contract_template
          - id: templateChoice
            name: Target Choice Name
            description: Name of the choice to be exercised on the target contract.
            field_type: >
                contract_choice:{"templateNameField": "targetTemplate"}
    - id: timer
      name: Timer
      description: >
          Schedules a timer that exercices a choice on all active contracts
          of a given contract template at a periodic interval.
      entrypoint: core_int.integration_timer:integration_timer_main
      env_class: core_int.integration_timer:IntegrationTimerEnv
      fields:
          - id: targetTemplate
            name: Target Template
            description: >
                Name of the contract template containing the choice to be
                triggered in response to the timer expiring.
            field_type: contract_template
          - id: templateChoice
            name: Target Choice Name
            description: Name of the choice to be exercised on the target contracts.
            field_type: >
                contract_choice:{"templateNameField": "targetTemplate"}
          - id: interval
            name: Wait Interval
            description: The wait interval in seconds.
            field_type: integer
    - id: ledger_event_log
      name: Ledger Event Log
      description: >
          Writes a log message for all ledger events.
      entrypoint: core_int.integration_ledger_event_log:integration_ledger_event_log_main
      env_class: core_int.integration_ledger_event_log:IntegrationLedgerEventLogEnv
      fields:
          - id: historyBound
            name: Transaction History Bound
            description: >
                Bound on the length of the history maintained by the integration
                for the purpose of the log fetch endpoint. -1 can be used to remove
                the bound entirely. Negative values below -1 are reserved.
            field_type: integer
            default_value: "1024"
    - id: table
      name: Table
      description: >
          Maintains an internal set of all contracts corresponding to a given
          contract template, and allows that set to be queried in tabular
          form via a web endpoint.
      entrypoint: core_int.integration_table:integration_table_main
      env_class: core_int.integration_table:IntegrationTableEnv
      fields:
          - id: targetTemplate
            name: Target Template
            description: >
                Name of the contract template containing source data for the
                tabular data to be served by the integration.
            field_type: contract_template
          - id: csvDialect
            name: CSV Dialect
            description: >
                Dialect of CSV to generate. These correspond to dialects of CSV
                supported by Python 3's CSV library.
            field_type: enum:["Excel", "Excel w/Tabs", "Unix"]
            default_value: "Excel"