Share via

2.2.3.2.2 DatascreenTemplate Element

  • Article

The <DatascreenTemplate> element defines the properties of a file screen template object, as specified in the following schema.

 <xs:element name="DatascreenTemplate" minOccurs="0"
             maxOccurs="unbounded">
   <xs:complexType>
     <xs:sequence>
       <xs:element name="AllowedGroups">
         <xs:complexType>
           <xs:sequence>
             <xs:element name="FileGroup" minOccurs="0"
                                          maxOccurs="unbounded">
               <xs:complexType>
                 <xs:attribute name="FileGroupId" type="guidType"
                                                  use="required"/>
               </xs:complexType>
             </xs:element>
           </xs:sequence>
         </xs:complexType>
       </xs:element>
       <xs:element name="BlockedGroups">
         <xs:complexType>
           <xs:sequence>
             <xs:element name="FileGroup" minOccurs="0"
                                          maxOccurs="unbounded">
               <xs:complexType>
                 <xs:attribute name="FileGroupId" type="guidType"
                                                 use="required"/>
               </xs:complexType>
             </xs:element>
           </xs:sequence>
         </xs:complexType>
       </xs:element>
       <xs:element name="FileGroupActions">
         <xs:complexType>
           <xs:sequence>
             <xs:element ref="Action" minOccurs="0" maxOccurs="4"/>
           </xs:sequence>
         </xs:complexType>
       </xs:element>
     </xs:sequence>
     <xs:attribute name="Name" type="xs:string" use="required"/>
     <xs:attribute name="Id" type="guidType" use="required"/>
     <xs:attribute name="Flags" type="xs:integer" use="required"/>
     <xs:attribute name="Description" type="xs:string"
                   use="required"/>
   </xs:complexType>
 </xs:element>

AllowedGroups: This element MUST be present, it MUST occur only once in the file screen template, it MUST be empty, and it MUST NOT contain child elements.

BlockedGroups: This element MUST be present and MUST occur only once in the file screen template. It is the containing element for individual file groups that are blocked.

FileGroup: If present, this element MUST contain the attribute FileGroupId.

FileGroupId: This attribute MUST be present. It contains the ID of the file group that is allowed, which is one of the values returned by the IFsrmFileScreenBase::BlockedFileGroups (get) (section 3.2.4.2.26.1) method.

FileGroupActions: This element MUST be present and MUST occur only once in the file screen template. It is the containing element for the individual actions of the file screen template.

Action: If present, this element MUST contain all of the information listed under the <Action> element (section 2.2.3.2.1). There MUST be no more than one action for each FsrmActionType (section 2.2.1.2.9) enumeration value.

Name: This attribute MUST be present. It contains the name of the template, which is the same value as returned by the IFsrmFileScreenTemplate::Name (get) (section 3.2.4.2.30.2) method.

Id: This attribute MUST be present. It contains the ID of the template, which is the same value returned by the IFsrmObject::Id (get) (section 3.2.4.2.10.1) method.

Flags: This attribute MUST be present. It contains the file screen flags of the template, which is the same value returned by the IFsrmFileScreenBase::FileScreenFlags (get) (section 3.2.4.2.26.3) method.

Description: This attribute MUST be present. It contains the description of the file group, which is one of the values returned by the IFsrmObject::Description (get) (section 3.2.4.2.10.2) method.