Advanced Arguments
  • 24 Jun 2021
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Advanced Arguments

  • Dark
    Light
  • PDF

Article summary

There are a number of advanced arguments available which you can use to customize the behavior of the Tag.bio server.

csv

datatype: filepath

csv=my_data.csv

The CSV file to load. Otherwise, you need to specify a data_dir path and config file arguments.

data_dir

datatype: filepath

data_dir=./data

A path to the directory containing the data files specified within config.json.

delimiter

datatype: string

delimiter="\t"

The delimiter used in the file to separate row values (optional)

config

datatype: filepath

config=config.json

A JSON file, usually housed in ./config/, containing the CSV configuration.

main

datatype: filepath

main=main.json

A JSON file, usually at the root of the project, containing the protocols, protocol specifications, and test scripts.

port

datatype: integer

port=8001

Used to set the server to a specified port. Defaults to 8000.

log

datatype: string

log=log.txt

A file to log server output. Limits console verbosity.

entities

datatype: integer

entities=1000

For restricting the maximum number of entities to load from source data.

random

datatype: integer

random=80

Used with entities to specify a selection rate for random entities.

seed

datatype: integer

seed=1234

Used with random to specify a seed for reproducable randomizations.

process_count

datatype: integer

process_count=10

A designation for the number of processor threads to use. Defaults to 1.

output_config

datatype: filepath

output_config=auto_config.json

A JSON file to be written as a new CSV configuration after parsing. See Build a Config File for details on using the "parsers": "all" feature to automate config creation.

https_password_file

datatype: filepath

https_passwords_file=top_secret.txt

A properties file containing https passwords.

https_key_store

datatype: filepath

https_key_store=top_secret.jks

A properties file containing https keystore information.

api_key_count

datatype: integer

api_key_count=1

The number of api_keys to generate.

api_key_file

datatype: filepath

api_key_file=api_keys.txt

The file where the api_keys will be written.

whitelist

datatype: filepath

whitelist=whitelisted.txt

A TXT file containing a new-line delimited list of IP addresses to be whitelisted.


Was this article helpful?

What's Next