You can store your UI Configuration file either locally or on a remote web server. If you store the file locally, supply the filename to any app that is using the UI configuration. For details, see the section Direct the App SDK to a Locally Stored UI Configuration File in the Android, iOS or Web Developer Guide.
Using a remote server
If you store your UI configuration files on a remote server, you must store the files in a specific directory structure under specific file names. Choose the name of your root configuration directory on the remote server. Make a subdirectory for each platform that you want to configure, and make a default directory for configurations that are common to all platforms.
If your chosen root configuration directory is uicfg_dir, then the required subdirectory names must be:
uicfg_dir/default/
uicfg_dir/and/
uicfg_dir/ios/
uicfg_dir/web/
The root configuration directory must contain a file called toc.json that lists all the files. Inside the subdirectories, you can optionally place configuration files used for localizing strings in your application. You can choose your own names for the root configuration directory and for the media files, so they have yellow highlights in the example below. If included, the other subdirectories and filenames must have specific names to indicate their use.
uicfg_dir
│
├─── toc.json
│
├─── default
│ ├─── ui_cfg.json
│ ├─── ui_cfg_en.json
│ ├─── ui_cfg_en-us.json
│ ├─── ui_cfg_ja.json
│ └─── ui_cfg_fr-ca.json
│
├─── and
│ ├─── ui_cfg.json
│ ├─── ui_cfg_en.json
│ ├─── ui_cfg_en-us.json
│ ├─── media.zip
│ ├─── media_en.zip
│ └─── media_en-us.zip
│
├─── ios
│ ├─── ui_cfg.json
│ ├─── ui_cfg_en.json
│ ├─── ui_cfg_en-us.json
│ ├─── media.zip
│ ├─── media_en.zip
│ └─── media_en-us.zip
│
└─── web
├─── ui_cfg.json
├─── ui_cfg_en.json
├─── ui_cfg_en-us.json
├─── media
│ ├─── add_reg_icon.png
│ ├─── remove_reg_icon.png
│ └─── rename_reg_icon.png
├─── media_en
│ ├─── add_reg_icon.png
│ ├─── remove_reg_icon.png
│ └─── rename_reg_icon.png
└─── media_en-us
├─── add_reg_icon.png
├─── remove_reg_icon.png└─── rename_reg_icon.png
In this case, uicfg_dir/toc.json contains:
[
"default/ui_cfg.json",
"default/ui_cfg_en.json",
"default/ui_cfg_en-us.json",
"default/ui_cfg_ja.json",
"default/ui_cfg_fr-ca.json",
"and/ui_cfg.json",
"and/ui_cfg_en.json",
"and/ui_cfg_en-us.json",
"and/media.zip",
"and/media_en.zip",
"and/media_en-us.zip",
"ios/ui_cfg.json",
"ios/ui_cfg_en.json",
"ios/ui_cfg_en-us.json",
"ios/media.zip",
"ios/media_en.zip",
"ios/media_en-us.zip",
"web/ui_cfg.json",
"web/ui_cfg_en.json",
"web/ui_cfg_en-us.json",
"web/media",
"web/media_en",
"web/media_en-us"
]The media.zip file contains the images. In the web directory, media files are expanded instead of being in a zip file, and they are stored in their own media directory, for example: uicfg_dir/web/media/add_reg_icon.png. Media files are never located in the default directory.
Once your files and directories are in place on the remote server, supply the root of the configuration directory to any app that is using the UI configuration. See the section Direct the App SDK to a Remotely Stored UI Configuration File in the Android, iOS or Web Replacing the UI Guides.