Input
Key name: Input
Element type: Dictionnary
Status: Optional
Let you configure the properties of the input variables files, where all the values entered by the user will be found. You can read Input components to ask information to the user.
As this group is optional, it can be omitted. In this case, the file path will be /Users/[username]/Octory/Octory_inputs.json
and the file format will be JSON.
Keys
Name | Type | Possible values | Required |
---|---|---|---|
FileFormat | String | PLIST , JSON | Required |
FilePath | String | - |
Detail
FileFormat Required
Type: String
Possible values: PLIST
, JSON
Explanation: Lets you specify the file format you want to use to save the input variables
FilePath
Type: Boolean
Explanation: Let you specify the path of the file where Octory will write in. Prefer absolute paths, and avoid special characters like ~
. For the tilde, you should use the ${USER_NAME}
placeholder which Octory will populate.
Octory will overwrite the file if it exists or create it. You need to specify the full path to the file, for example: /tmp/user_input.json
or /Users/Shared/enrollment_inputs.plist
. The extension of the file has to match the FileFormat
key.
You may need to give the right to the end-user to write in some directories if necessary, for Octory to be able to save the file in those directories.
Example
Tell Octory to save the user's inputs at /Users/Shared/Octory_inputs.json
in a JSON format.
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<!-- ... -->
<key>Input</key>
<dict>
<key>FileFormat</key>
<string>JSON</string>
<key>FilePath</key>
<string>/Users/Shared/Octory_inputs.json</string>
</dict>
<!-- ... -->
</dict>
</plist>