Excel

Parameters

Required parameters are in red and Optional parameters are in blue.

---

• filepath, the file location to write the Excel file to

---

• filepath_suffix, an optional suffix to add to the Excel file, based on CURRENT DATETIME.
  default: None ( use the strftime.org cheatsheet as a guide )

---

• date_time_format, the string representation of date times
  default: %Y-%m-%dT%H:%M:%S.%f ( use the strftime.org cheatsheet as a guide )

---

• save_strategy, how to save new data into an existing directory
  default: OVERWRITE ( allowed: APPEND, OVERWRITE )

---

Serverless Requirements

If you're running CS Tools    serverless, you'll want to ensure you install these    python requirements.

Don't know what this means? It's probably safe to ignore it.

How do I use the Syncer in commands?

CS Tools accepts syncer definitions in either declarative or configuration file form.

_{Find the copy button to the right of the code block.}

  Declarative   Configuration File

Simply write the parameters out alongside the command.

cs_tools tools searchable metadata --syncer "excel://filepath=searchable.xlsx" --config dogfood

^{* when declaring multiple parameters inline, you should wrap the enter value in quotes.}

1. Create a file with the .toml extension.

   syncer-overwrite.toml

   [configuration]
   filepath = "searchable.xlsx"
   filepath_suffix = "--generated-on-%Y-%m-%d"
   date_time_format = "%Y-%m-%dT%H:%M:%S%z"
   save_strategy = "OVERWRITE"
   

   ^{* this is a complete example, not all parameters are required.}

2. Write the filename in your command in place of the parameters.

   cs_tools tools searchable metadata --syncer excel://syncer-overwrite.toml --config dogfood