CAA Web Services Home

 

Configuration Expression

Overview of Configuration Expression used in ENOVIA LCA V5 CAA Web services
Technical Article

Abstract

This article introduces the Configuration Expression and its usage in ENOVIA LCA V5 CAA Web service.
 

 

Configuration Expression: CONFGURATION

Configuration Expression, denoted by CONFIGURATION tag,  is an XML expression to specify effectivities  used by createConfigHandler and createModification Web services[1]. Configuration Expression is composed of a Configuration Handler Expression, and a Modification Expression. Effectivities used to create config handlers is specified by Configuration Handler Expression, and effectivities used to create modifications is specified by Modification Expression.

[Top]

Configuration Handler Expression: ENOVIA_CONFIGHANDLER

Configuration Handler Expression, denoted by ENOVIA_CONFIGHANDLER tag,  describes the structure and values to be passed in createCofigHandler[1] Web service for creation of Configuration Handlers. Details of this structure are explained below:

[Top]

Configuration Handler Expression Tags

Detailed elements of a Configuration Handler Expression:

 

<CONFIGURATION COMMAND= " " > Required tag. COMMAND value is ignored.
 <ENOVIA_CONFIGHANDLER NAME =""> Required tag. A unique name of the Configuration Handler has to be given.
 
      <HANDLER_DOMAIN DOMAIN = ""  > Domains value is required and can be customized.
The valid string values with the base install of ENOVIA LCA:
  • VALIDE
  • Engineering Effectivity
  • Manufacturing Effectivity
  • Maintenance Effectivity
  • Proposed Domain
       <HANDLER_EFFECTIVITY> Required tag
         <EFF_TYPE> Required tag. Only one instance is allowed. When multiple elements of EFF_TYPE are specified, logical OR is applied between the EFF_TYPE elements.
               <RANGE_RANGE  START=" " END=" "/> START is Integer (positive).
END is Integer (positive, use -1 for ∞).
START value must be less than the END value.
               <RANGE_MILESTONE START=" " END=" "/> START is Integer (positive).
END is Milestone uuid string.
START value must be less than the integer value contained in the END Milestone object.
             <MILESTONE_RANGE START=" " END=" "/> START is Milestone uuid String.
END is Integer (positive, use -1 for ∞).
START value contained in the Milestone must be less than the END value.
              <DATE_DATE START=" " END=" "/> START is date. Format mm/dd/yyyy.
END is date. Format mm/dd/yyyy.
START date must be less than the END date.
                <DATE_MILESTONE START=" " END=" "/> START is date. Format mm/dd/yyyy.
END is Milestone uuid string.
START date must be less than the date value contained in END Milestone.
                <MILESTONE_DATE START=" " END=" "/> START is Milestone uuid string.
END is date. Format mm/dd/yyyy.
START date in Milestone must be less than the END date
             <MILESTONE_MILESTONE START=" " END=" "/> START is Milestone uuid string.
END is Milestone uuid string.
START date in Milestone must be less than the END date in Milestone
                <SPECIFICATION VALUE=" "/> Valid uuid string of a Enovia Specification object.
          </EFF_TYPE> Closing Tag.
      </HANDLER_EFFECTIVITY> Closing Tag.
    </HANDLER_DOMAIN> Closing Tag.
  </ENOVIA_CONFIGHANDLER> Closing Tag.
</CONFIGURATION> Closing Tag.

Note: For integer value ∞ use -1

 

Modification Expression: ENOVIA_MODIFICATION

Modification Expression, denoted by ENOVIA_MODIFICATION tag,  describes the structure and values to be passed in createModification[1] Web service for creation of Modifications in ENOVIA LCA. Details of this structure is explained below.

[Top]

Modification Expression Tags

Detailed the elements of a Modification Expression:

 

<CONFIGURATION COMMAND= " " > Required tag. COMMAND value is ignored.
 <ENOVIA_MODIFICATION NAME =""> Required tag. Value is optional. ENOVIA LCA will generate one if NAME value is empty.
 
      <MOD_DOMAIN > Required tag
      <EFF_DOMAIN NAME=""> Domain is required and can be customized.
The valid string value with the base install of ENOVIA LCA:
  • VALIDE
  • Engineering Effectivity
  • Manufacturing Effectivity
  • Maintenance Effectivity
  • Proposed Domain
       <MOD_EFFECTIVITY> Required tag
         <EFF_TYPE> Required tag. Only one instance is allowed. When multiple elements of EFF_TYPE are specified, logical OR is applied between the EFF_TYPE elements.
               <RANGE_RANGE  START=" " END=" "/> START is Integer (positive).
END is Integer (positive, use -1 for ∞).
START value must be less than the END value.
               <RANGE_MILESTONE START=" " END=" "/> START is Integer (positive).
END is Milestone uuid string.
START value must be less than the integer value contained in the END Milestone object.
             <MILESTONE_RANGE START=" " END=" "/> START is Milestone uuid String.
END is Integer (positive, use -1 for ∞).
START value contained in the Milestone must be less than the END value.
              <DATE_DATE START=" " END=" "/> START is date. Format mm/dd/yyyy.
END is date. Format mm/dd/yyyy.
START date must be less than the END date.
                <DATE_MILESTONE START=" " END=" "/> START is date. Format mm/dd/yyyy.
END is Milestone uuid string.
START date must be less than the date value contained in END Milestone.
                <MILESTONE_DATE START=" " END=" "/> START is Milestone uuid string.
END is date. Format mm/dd/yyyy.
START date in Milestone must be less than the END date
             <MILESTONE_MILESTONE START=" " END=" "/> START is Milestone uuid string.
END is Milestone uuid string.
START date in Milestone must be less than the END date in Milestone
                <SPECIFICATION VALUE=" "/> Valid uuid string of a Enovia Specification object.
          </EFF_TYPE> Closing Tag.
          <EFF_AND_TYPE> Optional tag. Used for creating AND operation with Specification. Multiple allowed.
                  <RANGE_RANGE START="" END=""/>
                  <RANGE_MILESTONE START=" " END=" "/>
                  <MILESTONE_RANGE START=" " END=" "/>
                  <DATE_DATE START=" " END=" "/>
                  <DATE_MILESTONE START=" " END=" "/>
                  <MILESTONE_DATE START=" " END=" "/>
                  <MILESTONE_MILESTONE START=" " END=" "/>
                  <SPECIFICATION VALUE=" "/>		 One and only one element, from those listed here, is permitted.


                   <EFF_AND> Required tag indicating an AND operation
                          <SPECIFICATION VALUE=" "/> Valid uuid string of a Enovia Specification object. Multiple allowed.
                    </EFF_AND> Closing Tag.
            </EFF_AND_TYPE> Closing Tag.
      </MOD_EFFECTIVITY> Closing Tag.
    </EFF_DOMAIN> Closing Tag.
    </MOD_DOMAIN> Closing Tag.
  </ENOVIA_MODIFICATION> Closing Tag.
</CONFIGURATION> Closing Tag.

Note: For integer value ∞ use -1

[Top]

EXAMPLES

     Create Configuration Handler - Simple Case.

        This Configuration expression will create a Enovia Configuration Handler named "simpleConfigHandler" with 'Engineering Effectivity' whose RANGE_RANGE values are 1-100 OR 1 - ∞ (infinity).

<?xml version="1.0" encoding="UTF-8"?>
 <CONFIGURATION COMMAND="Create/Empty" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <ENOVIA_CONFIGHANDLER NAME="simpleConfiHandler" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
           <HANDLER_DOMAIN DOMAIN="Engineering Effectivity">
                <HANDLER_EFFECTIVITY>
                     <EFF_TYPE>
                          <RANGE_RANGE START="1" END="100"/>
                          <RANGE_RANGE  START="1" END="-1"/>
                    </EFF_TYPE>
            </HANDLER_EFFECTIVITY>
        </HANDLER_DOMAIN>
      </ENOVIA_CONFIGHANDLER>
</CONFIGURATION>

[Top]

 

     Create Configuration Handler - Complex Case.     

        This Configuration expression will create a Enovia Configuration Handler named "complexConfigHandler" with 'Engineering Effectivity' whose RANGE_RANGE values are 1-100 OR 1 - ∞ (infinity). It also contains DATE_DATE, MILESTONE_MILESTONE, OR SPECIFICATION effectivity types.

<?xml version="1.0" encoding="UTF-8"?>
<CONFIGURATION COMMAND="" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <ENOVIA_CONFIGHANDLER NAME="complexConfigHandler" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
           <HANDLER_DOMAIN DOMAIN="Engineering Effectivity">
                <HANDLER_EFFECTIVITY>
                     <EFF_TYPE>
                          <RANGE_RANGE START="1" END="100"/>
                          <RANGE_RANGE  START="1" END="-1"/>
                         <DATE_DATE START="06/08/2006" END="06/07/2007"/>
                         <MILESTONE_MILESTONE                        START="1083A53D9B000057CF42A9D39B000E72680000000007454E4F564C52345C00
000005446F63496430000104454E4F56085644656661756C741F003C44424D533E3C7264623E3C454E4F434F4D4D4F4E3E454E4F434F4D4D4F4E
2000000080A2B3BD00000509384D10620005108D454E4F44525F444F4344495220202020"
END="1083A89D9B000057CF42A9D39B000E72680000000007454E4F564C52345C00000005446F63496430000104454E4F56085644656661756C7
41F003C44424D533E3C7264623E3C454E4F434F4D4D4F4E3E454E4F434F4D4D4F4E2000000080A2B3BD00000509384D10620005108D454E4F44
525F444F4344495220202020"/>
                         <SPECIFICATION VALUE="1083B89D9B990057CF42A9D39B000E72680000000007454E4F564C52345C00000005446F63496430000
104454E4F56085644656661756C741F003C44424D533E3C7264623E3C454E4F434F4D4D4F4E3E454E4F434F4D4D4F4E2000000080A2B3BD000005
09384D10620005108D454E4F44525F444F4344495220202020"/>
                    </EFF_TYPE>
            </HANDLER_EFFECTIVITY>
        </HANDLER_DOMAIN>
      </ENOVIA_CONFIGHANDLER>
</CONFIGURATION>

 

[Top]

     Create Modification - Simple Case.

        This Modification Expression creates a Enovia Modification named "simpleModification" with 'Engineering Effectivity' whose RANGE_RANGE values are 1-100 OR 1 - ∞ (infinity).

<?xml version="1.0" encoding="UTF-8"?>
<CONFIGURATION COMMAND="" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <ENOVIA_MODIFICATION NAME="simpleModfiication" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
          <MOD_DOMAIN>
            <EFF_DOMAIN NAME="Engineering Effectivity">
               <MOD_EFFECTIVITY>
                         <EFF_TYPE>
                              <RANGE_RANGE START="1" END="100"/>

                             <RANGE_RANGE START="1" END="-1"/>
                          </EFF_TYPE>
              </MOD_EFFECTIVITY>
          </EFF_DOMAIN>
       </MOD_DOMAIN>
     </ENOVIA_MODIFICATION>
</CONFIGURATION>

[Top]

 

     Create Modification - with AND Specification.     

        This Modification Expression creates a Enovia Modification named "MyModification" with 'Engineering Effectivity' by DATE_DATE OR MILESTONE_MILESTONE. The AND Specification is contained in EFF_AND_TYPE tag. Within which a SPECIFICATION AND RANGE_RANGE effectivities are defined.

<?xml version="1.0" encoding="UTF-8"?>
<CONFIGURATION COMMAND="" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <ENOVIA_MODIFICATION NAME="MyModfiication" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
          <MOD_DOMAIN>
            <EFF_DOMAIN NAME="Engineering Effectivity">
               <MOD_EFFECTIVITY>
                         <EFF_TYPE>
                        <DATE_DATE START="06/08/2006" END="06/07/2007"/>
                         <MILESTONE_MILESTONE                        START="1083A53D9B000057CF42A9D39B000E72680000000007454E4F564C52345C00000005446F6349643000010445
4E4F56085644656661756C741F003C44424D533E3C7264623E3C454E4F434F4D4D4F4E3E454E4F434F4D4D4F4E2000000080A2B3BD00000509384D10620005108D454E4F44525
F444F4344495220202020"
END="1083A89D9B000057CF42A9D39B000E72680000000007454E4F564C52345C00000005446F63496430000104454E4F56085644656661756C741F003C44424D533E3C7264623
E3C454E4F434F4D4D4F4E3E454E4F434F4D4D4F4E2000000080A2B3BD00000509384D10620005108D454E4F44525F444F4344495220202020"/>
                        </EFF_TYPE>
                   <EFF_AND_TYPE>
                      <EFF_AND>

<RANGE_RANGE START="1" END="100"/>

                      </EFF_AND>
                           <SPECIFICATION VALUE="1083B89D9B990057CF42A9D39B000E72680000000007454E4F564C52345C00000005446F63496430000104454E4F56085644656661
756C741F003C44424D533E3C7264623E3C454E4F434F4D4D4F4E3E454E4F434F4D4D4F4E2000000080A2B3BD00000509384D10620005108D454E4F44525F444F4344495220
202020"/>
"/>                   </EFF_AND_TYPE>

              </MOD_EFFECTIVITY>
          </EFF_DOMAIN>
       </MOD_DOMAIN>
     </ENOVIA_MODIFICATION>
</CONFIGURATION>

 

 

[Top]

In Short

Configuration Expression is used as an input for createConfigHanlder and createModification web service methods[1] to create Enovia Configuration Handlers and Modifications.

[Top]

References

[1] Consuming ENOVWSProdStructConfigCpp CAA Web Service
[Top]

History

Version: 1 [Feb 2006] Document created
[Top]

Copyright © 2006, Dassault Systèmes. All rights reserved.