Re: [sca-assembly] ISSUE 49: Add an optional description attribute topromoted properties, references and services

[Dieter Koenig1 <dieterkoenig@de.ibm.com>]

I was going to make a similar proposal for **SCA elements in general**.

We get corresponding customer requests for SCA components as well as for
BPEL processes (which support a documentation element like the one below)
and BPEL4People-style user interactions (new OASIS TC, the submitted spec
has all the elements below).

I propose a base type that supports displayName, description, and
documentation - each one 0..unbounded with an xml:lang attribute.

   <xsd:complexType name="SCABaseType" abstract="true">
      <xsd:sequence>
         <xsd:element name="displayName" type="sca:tDisplayName" minOccurs
="0" maxOccurs="unbounded"/>
         <xsd:element name="description" type="sca:tDescription" minOccurs
="0" maxOccurs="unbounded"/>
         <xsd:element name="documentation" type="sca:tDocumentation"
minOccurs="0" maxOccurs="unbounded"/>
      </xsd:sequence>
   </xsd:complexType>

   <!-- natural language strings -->
   <xsd:complexType name="tDisplayName">
      <xsd:simpleContent>
         <xsd:extension base="sca:tText64">
            <xsd:attribute ref="xml:lang"/>
         </xsd:extension>
      </xsd:simpleContent>
   </xsd:complexType>
   <xsd:complexType name="tDescription">
      <xsd:simpleContent>
         <xsd:extension base="sca:tText254">
            <xsd:attribute ref="xml:lang"/>
         </xsd:extension>
      </xsd:simpleContent>
   </xsd:complexType>
   <xsd:complexType name="tDocumentation">
      <xsd:simpleContent>
         <xsd:extension base="sca:tText4096">
            <xsd:attribute ref="xml:lang"/>
         </xsd:extension>
      </xsd:simpleContent>
   </xsd:complexType>

   <!-- length-restricted strings -->
   <xsd:simpleType name="tText64">
      <xsd:restriction base="xsd:string">
         <xsd:maxLength value="64"/>
         <xsd:whiteSpace value="preserve"/>
      </xsd:restriction>
   </xsd:simpleType>
   <xsd:simpleType name="tText254">
      <xsd:restriction base="xsd:string">
         <xsd:maxLength value="254"/>
         <xsd:whiteSpace value="preserve"/>
      </xsd:restriction>
   </xsd:simpleType>
   <xsd:simpleType name="tText4096">
      <xsd:restriction base="xsd:string">
         <xsd:maxLength value="4096"/>
         <xsd:whiteSpace value="preserve"/>
      </xsd:restriction>
   </xsd:simpleType>

Kind Regards
DK
                                                                                                                   
 Dieter König                          Mail: dieterkoenig@de.ibm.com         IBM Deutschland Entwicklung GmbH      
                                                                                                                   
 Senior Technical Staff Member         Tel (office): (+49) 7031-16-3426      Vorsitzender des Aufsichtsrats:       
                                                                             Martin Jetter                         
                                                                                                                   
 Architect, Business Process           Fax (office): (+49) 7031-16-4890      Geschäftsführung: Herbert Kircher     
 Choreographer                                                                                                     
                                                                                                                   
 Member, Technical Expert Council      Tel (home office): (+49) 7032-201464  Sitz der Gesellschaft: Böblingen      
                                                                                                                   
                                       Schönaicher Strasse 220, 71032        Registergericht: Amtsgericht          
                                       Böblingen, Germany                    Stuttgart, HRB 243294                 
                                                                                                                   
                                                                                                                   
                                                                                                                   




                                                                                                                       
  From:       Anish Karmarkar <Anish.Karmarkar@oracle.com>                                                             
                                                                                                                       
  To:         Scott Vorthmann <scottv@tibco.com>                                                                       
                                                                                                                       
  Cc:         Mark Combellack <mcombellack@avaya.com>, sca-assembly@lists.oasis-open.org                               
                                                                                                                       
  Date:       26.02.2008 08:20                                                                                         
                                                                                                                       
  Subject:    Re: [sca-assembly] ISSUE 49: Add an optional description attribute to promoted properties, references    
              and services                                                                                             
                                                                                                                       





I think such description is potentially useful for all the SCA elements.
Proposal:
Create a base type for all the SCA types. Such a base type may look like
this:

<complexType name="SCABaseType" abstract="true">
   <sequence>
     <element name="documentation" minOccurs="0" />
   </sequence>
</complexType>

-Anish
--

Scott Vorthmann wrote:
>
> http://www.osoa.org/jira/browse/ASSEMBLY-49
>
> On Feb 13, 2008, at 3:08 AM, Mark Combellack wrote:
>
>> RAISER:           Mark Combellack
>>
>> TARGET:          SCA Assembly Specification
>>
>> DESCRIPTION:
>>
>> It is currently envisioned that an Application Assembler can take a
>> Composite written by another person and use it in their own
>> applications. Often these “3rdparty” Composites will have promoted
>> Properties and References that will need to be set by the Application
>> Assembler. From the SCDL, the Application Assembler has only the name
>> of the promoted Properties and References to document what they do.
>>
>> What is missing is the ability for the Composite Developer to add a
>> short description to promoted Properties and References that would
>> inform the Application Assembler what they are for.
>>
>> It may also be desirable to add a description to promoted Services as
>> well.
>>
>> PROPOSAL:
>>
>> Add an optional “description” attribute to Property, Reference and
>> Service that would allow the Composite Developer to write a brief
>> description of them.
>>
>
>
> ---------------------------------------------------------------------
> To unsubscribe from this mail list, you must leave the OASIS TC that
> generates this mail.  You may a link to this group and all your TCs in
> OASIS
> at:
> https://www.oasis-open.org/apps/org/workgroup/portal/my_workgroups.php

---------------------------------------------------------------------
To unsubscribe from this mail list, you must leave the OASIS TC that
generates this mail.  You may a link to this group and all your TCs in
OASIS
at:
https://www.oasis-open.org/apps/org/workgroup/portal/my_workgroups.php