Apple iPod and iPod Touch Cell Phone User Manual


 
50 Appendix B Configuration Profile Format
Payload Content
The PayloadContent array is an array of dictionaries, where each dictionary describes an
individual payload of the profile. Each functional profile has at least one or more entries
in this array. Each dictionary in this array has a few common properties, regardless of
the payload type. Others are specialized and unique to each payload type.
PayloadDisplayName String, mandatory. This value determines a very short string to
be displayed to the user describing the profile, such as “VPN
Settings”. It does not have to be unique.
PayloadDescription String, optional. This value determines what descriptive, free-
form text will be shown to the user on the Detail screen for the
entire profile. This string should clearly identify the profile so the
user can decide whether to install it.
PayloadContent Array, optional. This value is the actual content of the profile. If it
is omitted, the whole profile has no functional meaning.
Key Value
Key Value
PayloadVersion Number, mandatory. The version of the individual payload.
Each profile can consist of payloads with different version numbers.
For instance, the VPN version number can be incremented at a
point in the future while the Mail version number would not.
PayloadUUID String, mandatory. This is usually a synthetically generated unique
identifier string. The exact content of this string is irrelevant;
however, it must be globally unique.
PayloadType String, mandatory. This key/value pair determines the type of the
individual payload within the profile,.
PayloadOrganization String, optional. This value describes the issuing organization of the
profile, as it will be shown to the user. It can be, but doesn’t have to
be, the same as the root level PayloadOrganization.
PayloadIdentifier String, mandatory. This value is by convention a dot-delimited
string uniquely describing the payload. It is usually the root
PayloadIdentifier with an appended subidentifier, describing the
particular payload.
PayloadDisplayName String, mandatory. This value is a very short string displayed to the
user which describes the profile, such as “VPN Settings”. It does not
have to be unique.
PayloadDescription String, optional. This value determines what descriptive, free-form
text is displayed on the Detail screen for this particular payload.