complexType WorkListViewEdit
diagram brm_all_diagrams/brm_all_p375.png
namespace http://api.brm.n2.tibco.com
type extension of WorkListViewCommon
properties
base WorkListViewCommon
children entityID resourcesRequired orderFilterCriteria authors users customData
used by
elements createWorkListView editWorkListView
complexType WorkListView
attributes
Name  Type  Use  Default  Fixed  Annotation
name  derived by: xs:string  required      
documentation
The user defined name of the view.
description  derived by: xs:string        
documentation
Optional description that can be given to the work list view.
owner  derived by: xs:string        
documentation
The resourceID of the owner of this view.   If omitted the ID of the resource calling the createWorkListView API will  be used.   This resource can always edit or use this view.
public  xs:boolean        
documentation
Is this view publlic, i.e. can it be used by any AMX-BPM user.   If TRUE then it will be visible to ALL users, not just those in the "users" set.
getAllocatedItems  xs:boolean        
documentation
Optional default behaviour is false. If true then this is a request for allocated Work Items. If false then the request is for offered Work Items.
annotation
documentation
Definition of a work list view used for editing (i.e. create and delete operations).
source <xs:complexType name="WorkListViewEdit">
 
<xs:annotation>
   
<xs:documentation>Definition of a work list view used for editing (i.e. create and delete operations).</xs:documentation>
 
</xs:annotation>
 
<xs:complexContent>
   
<xs:extension base="WorkListViewCommon">
     
<xs:sequence minOccurs="0">
       
<xs:element name="authors" type="orgdto:XmlModelEntityId" minOccurs="0" maxOccurs="unbounded">
         
<xs:annotation>
           
<xs:documentation>Array of XmlModelEntityId objects for entities (GROUPS, POSITIONS, ORGUNITS and RESOURCES) who are allowed to edit the view.</xs:documentation>
         
</xs:annotation>
       
</xs:element>
       
<xs:element name="users" type="orgdto:XmlModelEntityId" minOccurs="0" maxOccurs="unbounded">
         
<xs:annotation>
           
<xs:documentation>Array of XmlModelEntityId objects for resources who are allowed to use the view.</xs:documentation>
         
</xs:annotation>
       
</xs:element>
       
<xs:element name="customData" type="xs:string" minOccurs="0">
         
<xs:annotation>
           
<xs:documentation>A string attribute the caller can use to provide and custom data they wish to store with the work list view.  BRM will not look at or use this attribute value but will just store it with the work view definition.   If storing XML data the value should be wrapped in a CDATA section.</xs:documentation>
         
</xs:annotation>
       
</xs:element>
     
</xs:sequence>
   
</xs:extension>
 
</xs:complexContent>
</xs:complexType>

element WorkListViewEdit/authors
diagram brm_all_diagrams/brm_all_p376.png
type XmlModelEntityId
properties
minOcc 0
maxOcc unbounded
content complex
children dynamic-id-attr qualifierSet
attributes
Name  Type  Use  Default  Fixed  Annotation
model-version  xs:int  optional  -1    
documentation
Major version number of the organization model in which an organization model entity resides.

If not specified, the default value will be the latest version of the organization model.

(Version numbers must be compatible with, and conform to, the OSGi version number schema. For Directory Engine, only the major part of the version number is significant.)
entity-type  OrganisationalEntityType  required      
documentation
Enumerated value defining the type of the organization model entity.
guid  xs:string  required      
documentation
Globally unique ID of the organization model entity.

(Although this value is unique across all entities, if the entity exists within more than one major version, it will share the same GUID.)
qualifier  xs:string  optional      
documentation
Only applicable in certain circumstances, and only to organization model entities whose entity-type is PRIVILEGE or CAPABILITY. These entities can have an association with other entities - for example, a resource may hold many capabilities, or a position may have many privileges.

These associations can have a qualifying value, according to their nature, to differentiate them. For example, the PRIVILEGE to sign off a purchase order may be qualified with the maximum amount that can be signed off.
annotation
documentation
Array of XmlModelEntityId objects for entities (GROUPS, POSITIONS, ORGUNITS and RESOURCES) who are allowed to edit the view.
source <xs:element name="authors" type="orgdto:XmlModelEntityId" minOccurs="0" maxOccurs="unbounded">
 
<xs:annotation>
   
<xs:documentation>Array of XmlModelEntityId objects for entities (GROUPS, POSITIONS, ORGUNITS and RESOURCES) who are allowed to edit the view.</xs:documentation>
 
</xs:annotation>
</xs:element>

element WorkListViewEdit/users
diagram brm_all_diagrams/brm_all_p377.png
type XmlModelEntityId
properties
minOcc 0
maxOcc unbounded
content complex
children dynamic-id-attr qualifierSet
attributes
Name  Type  Use  Default  Fixed  Annotation
model-version  xs:int  optional  -1    
documentation
Major version number of the organization model in which an organization model entity resides.

If not specified, the default value will be the latest version of the organization model.

(Version numbers must be compatible with, and conform to, the OSGi version number schema. For Directory Engine, only the major part of the version number is significant.)
entity-type  OrganisationalEntityType  required      
documentation
Enumerated value defining the type of the organization model entity.
guid  xs:string  required      
documentation
Globally unique ID of the organization model entity.

(Although this value is unique across all entities, if the entity exists within more than one major version, it will share the same GUID.)
qualifier  xs:string  optional      
documentation
Only applicable in certain circumstances, and only to organization model entities whose entity-type is PRIVILEGE or CAPABILITY. These entities can have an association with other entities - for example, a resource may hold many capabilities, or a position may have many privileges.

These associations can have a qualifying value, according to their nature, to differentiate them. For example, the PRIVILEGE to sign off a purchase order may be qualified with the maximum amount that can be signed off.
annotation
documentation
Array of XmlModelEntityId objects for resources who are allowed to use the view.
source <xs:element name="users" type="orgdto:XmlModelEntityId" minOccurs="0" maxOccurs="unbounded">
 
<xs:annotation>
   
<xs:documentation>Array of XmlModelEntityId objects for resources who are allowed to use the view.</xs:documentation>
 
</xs:annotation>
</xs:element>

element WorkListViewEdit/customData
diagram brm_all_diagrams/brm_all_p378.png
type xs:string
properties
minOcc 0
maxOcc 1
content simple
annotation
documentation
A string attribute the caller can use to provide and custom data they wish to store with the work list view.  BRM will not look at or use this attribute value but will just store it with the work view definition.   If storing XML data the value should be wrapped in a CDATA section.
source <xs:element name="customData" type="xs:string" minOccurs="0">
 
<xs:annotation>
   
<xs:documentation>A string attribute the caller can use to provide and custom data they wish to store with the work list view.  BRM will not look at or use this attribute value but will just store it with the work view definition.   If storing XML data the value should be wrapped in a CDATA section.</xs:documentation>
 
</xs:annotation>
</xs:element>


XML Schema documentation generated by XMLSpy Schema Editor http://www.altova.com/xmlspy