Format Clause for the Add Policy Command

This clause defines the formats permitted under the policy for checked in files. Depending on the policy and the object created, certain files are appropriate or inappropriate. The Format clause restricts the types of files that can be associated with a business object.

The Format clause is required if you want to check in files under the policy:

format FORMAT_NAME{,FORMAT_NAME}

Or

format all
  • FORMAT_NAME is the name of a previously defined format. If the format was not previously defined, an error message results.

For example, you could have a policy that governs photos. This policy would need formats for processing files that contain photographic images. In this case, there might be two file formats allowed: GIF and JPG. These formats specify the software commands required to view, edit, and print files of type Photo. You might write this policy definition as:

add policy Photo
   description "Photo Process"
   type Photo   format GIF,JPG
   defaultformat GIF
   store Photo
   sequence "1,2,3,..."
   state base
     public all
     owner all;

Like the Type clause, the Format clause has a variation that uses the keyword 'all.' When this clause is used, all existing and future formats defined within the 3DEXPERIENCE Platform are allowed under this policy-the policy governs objects of all formats. The 'all' keyword is more like an option that can be turned on for the policy rather than a list of formats. If a list of formats is already defined for the policy and the 'all' keyword is used, the system will clear the list and turn the 'format all' option on for the policy.

Use caution with the Format All clause. Are there any formats that you do not want to permit under this policy? If there are, you will need to either list all of the desired formats or edit the policy after assigning all formats.