Page History

...

• Parameter
  summary Security configuration name security type json

  
  

  • Parameter
    summary Indicates the encryption key used in all encryption/decryption process name encryptionKey

  • Parameter
    summary Path to the file holding the encryption key. Recommended over encryptionKey name encryptionKeyFile

    Note
    We recommend the use of encryptionKeyFile over the encriptionKey directly in the configuration file. Never use both a the same time

  • (server only) 

    Parameter
    summary User profiles definitions, an array of json objects, each one representing a user name users type json

     (server only)
     

    • Parameter
      summary user account name username

       (server only) 

    • Parameter
      summary User password name password

       (server only) 

    • Parameter
      summary User roles name roles type string array

       (not in use yet) (server only)
   

• Parameter
  summary SSL configuration name ssl type json

   (server only)
   

  • Parameter
    summary Enables and disables the use of the SSL default false name enable type boolean

     (server only) 

  • Parameter
    summary key store holding the certificate name keyStore

     (server only) 

  • Parameter
    summary Password of the key store name keyStorePassword

     (server only)

Export & Import (Server Only)

Manages the export functionality

...

• Parameter
  summary Configuration for the export functionality name exportSettings type json

  • (server only) 

    Parameter
    summary Maximum size in megabytes for each zip generated by the export name maxSize type integer

    (server only) 

  • Parameter
    summary Quantity of entries per file name batchSize type integer

...

• Parameter
  summary Locations for external libraries, the locations can be either folder paths or paths directly to the jars files name libraryJars type string array

• (server only) 

  Parameter
  summary Indicates the class name of the external REST handler to use. If the class is in a non-standard package path, the whole path needs to be specified name restHandlers type string array

   (server only) 

• Parameter
  summary Indicates the class name of the external Model to use. If the class is in a non-standard package path, the whole path needs to be specified name models type string array

   (server only)

Server Proxys Configuration

...

(

...

Server Only)

...

• Parameter
  summary Configuration for the GTP3 proxy name gpt3

  (server only) 

  • Parameter
    summary Secret key for the OpenAI API name key

...

• Parameter
  summary Provider configurations name providers type json

  
      Each provider has it own configuration, which will not be review in this section
  

  • Parameter
    summary Provider name name name

  • Parameter
    summary Type of provider, the type is the name segment of the class name (e.g. TheName is the type for TheNameProvider class) name type

• Parameter
  summary Tag manager configuration name tagManager type json

  • Parameter
    summary Name of the resource to use for the tags. The value should be form by "<provider_name>:<source_name>" default saga-provider:saga_tags name resource

• Parameter
  summary Pipeline manager configuration name pipelineManager type json

  • Parameter
    summary Name of the resource to use for the pipelines. The value should be form by "<provider_name>:<source_name>" default saga-provider:saga_pipelines name resource

  (server only) 

• Parameter
  summary Connections for the server user interface (one at the moment ¯\_(ツ)_/¯ ). Use to manage the patterns, tags, and pretty much every single stored element in elasticsearch name solutions type json

   (server only)

  • Parameter
    summary Elasticsearch configuration name elasticSearch type json

    
    

    • Parameter
      summary Protocol to use for the connection default http name schema

    • Parameter
      summary Hostname of the Elasticsearch server default localhost name hostname

    • Parameter
      summary Elasticsearch port default 9200 name port type integer

    • Parameter
      summary List of hostnames and ports to connect to name hostnamesAndPorts type string array

    • Parameter
      summary This will be the prefix for all the indexes created for this Saga solution default saga name indexName

    • Parameter
      summary Elasticsearch username name user

    • Parameter
      summary Path to the file holding the password name password

    • Parameter
      summary Timeout in seconds for all the connections use by the user interface default 30 name timeout type integer

    • Parameter
      summary Time in seconds to wait before a retry of a failed connection default 5 name delay

    • Parameter
      summary Number of times to retry a failed connection default 3 name retries type integer

    • Parameter
      summary Sets the maximum of elements to fetch with each request. The default is -1 indicating no limit is set default -1 name maxResults type integer

...

Code Block
language js theme RDark
{ "config": { "apiPort": 8080, "ipAddress": "0.0.0.0", "security": { "enable": false, "encryptionKey": "SDFW$%GW$S%S#", "encryptionKeyFile": "./bin/saga.ek", "users": [{ "username": "admin", "password": "password", "roles": "admin" }] }, "libraryJars": [ "./lib" ], "tagManager": { "resource": "saga-provider:saga_tags" }, "pipelineManager": { "resource": "saga-provider:saga_pipelines" }, "datasetFolder": "./datasets", "ssl": { "enable": false, "keyStore": "./bin/saga.jks", "keyStorePassword": "encrypted:NxepNROIgJ27pYpmKEw30llscPA8zCUpbQW676E7H8Nwo9DMABKQsIYF3fcSxQGG" }, "exportSettings" : { "maxSize" : 40, "batchSize" : 5000 }, "restHandlers": [], "models": [], "uiHandlers": [], "gpt3": { "key": "encrypted:7E7nI0+ofh//r1bFvTQCnY7DQlG6Kh4aA1TQlh44/NoxR0DDzHaeZdBXqYAguEXc" }, "providers": [ { "name": "filesystem-provider", "type": "FileSystem", "baseDir": "./config" }, { "name": "saga-provider", "type": "Elastic", "scheme": "http", "hostname": "localhost", "port": 9200, "timestamp": "updatedAt", "exclude": [ "updatedAt", "createdAt" ] } ], "solutions": [ { "display": "Saga", "elasticSearch": { "scheme": "http", "hostname": "localhost", "port": 9200, "hostnamesAndPorts": ["server1:9210", "server2:9220"], "indexName": "saga", "timeout": 30, "delay": 5, "retries": 3 } } ] } }

...