$ cd <path-to-zenform-rb.git>
$ bundle exec zenform apply --config-path <CONFIG_PATH>zenform-rb is a configuration management tool for Zendesk, which creates below Zendesk contents from configuration files which you made.
- Ruby (the specified version in
.ruby-version)
$ git clone [email protected]:xflagstudio/zenform-rb.git
$ cd zenform-rb
$ ./bin/setupYou can see commands list by executing bundle exec zenform help.
This part explains simply how to use each command.
See bundle exec zenform help [COMMAND] for further details.
apply creates Zendesk contents according to configuration files.
$ cd <path-to-zenform-rb.git>
$ bundle exec zenform apply --config-path <CONFIG_PATH><CONFIG_PATH> is a path of the directory including configuration files.
default: <path-to-zenform-rb.git>/zendesk_config.
Put configuration files in any directory <CONFIG_PATH> as below.
<CONFIG_PATH>/
├ auth_info.json
├ ticket_fields.csv
├ ticket_forms.csv
└ triggers.csv
auth_info.json includes authentication information.
ticket_fields.csv, ticket_forms.csv and triggers.csv include settings of each contents.
Though there are many params in configuration files, there are 4 types of parameters.
| Type | Example |
|---|---|
| string | user_id, os, os_version, ... |
| integer | ..., -2, -1, 0, 1, 2, 3, ... |
| bool | TRUE, true or FALSE , false |
| string[] (string array with JSON format) |
["user_id","os","os_version"], ["app_version"], ... |
| string[][] (2-dimensional string array with JSON format) |
[["requester_id","title of comment","body of comment"], ["solved"]], ... |
See wiki pages for further details.
- auth_info.json (wiki / sample)
- ticket_fields.csv (wiki / sample)
- ticket_forms.csv (wiki / sample)
- triggers.csv (wiki / sample)
Configuration files other than auth_info.json has slug param,
which is an identifier for each contents in Zenform.
Even though you can assign just numbers to slug, we recommend you to assign a meaningful name representing the configuration.
We would be grateful if you make a pull requests or report an issue 😊
XFLAG Studio CRE Team