Package com.ptc.windchill.esi.load

Class LoadESI

java.lang.Object
com.ptc.windchill.esi.load.LoadESI
public class LoadESI extends Object
This class is used by wt.load.StandardLoadService to create objects for classes in the com.ptc.windchill.esi. package.



Supported API: true

See Also:
  • StandardLoadService

  • Method Details

    • beginCreateESITarget

      public static boolean beginCreateESITarget(Hashtable<String,String> nv, Hashtable<String,String> cmdLineArgs, Vector<?> returnObjects)
      Processes the "csvBeginESITarget" directive in the XML load file.

      Creates a distribution target object, applies the default attribute values associated with the specified type definition, and caches it in the loader's memory.

      When using wt.load.LoadFromFile to load distribution target, use the following XML format:

      XML Format

      <csvBeginESITarget handler="com.ptc.windchill.esi.load.LoadESI.beginCreateESITarget" >
        <csvtypedef> typedef </csvtypedef>
        <csvnumber> target number </csvnumber>
        <csvname> target name </csvname>
        <csvdescription> target description </csvdescription>
        <csvtaskURI> target task URI </csvtaskURI>
        <csvdefaultForContext> default for context </csvdefaultForContext>
        <csvstatus> status </csvstatus>
        <csvresponseMetaInfoPath> responseMetaInfoPath </csvresponseMetaInfoPath>
      </csvBeginESITarget >
       
      <csvIBAValue handler="wt.iba.value.service.LoadValue.createIBAValue" >
        ...
      </csvIBAValue >
       
      <csvIBAValue handler="wt.iba.value.service.LoadValue.createIBAValue" >
        ...
      </csvIBAValue >
       
      <csvIBAValue handler="wt.iba.value.service.LoadValue.createIBAValue" >
        ...
      </csvIBAValue >
       
      <csvIBAValue handler="wt.iba.value.service.LoadValue.createIBAValue" >
        ...
      </csvIBAValue >
       
      <csvEndESITarget handler="com.ptc.windchill.esi.load.LoadESI.endCreateESITarget" />

      Tag Definitions

         
      typedef This contains the identifier string of a com.ptc.core.meta.common.TypeIdentifier.

      i.e. com.ptc.windchill.esi.tgt.ESITarget|com.ptc.windchill.esi.tgt. ESISAPTarget

      This would create a specific type of distribution target or any customized soft type for distribution target. This currently supports the following distribution target types:

      • com.ptc.windchill.esi.tgt.ESITarget|com.ptc.windchill.esi.tgt.ESISAPTarget
      • com.ptc.windchill.esi.tgt.ESITarget|com.ptc.windchill.esi.tgt.ESIOATarget
      • com.ptc.windchill.esi.tgt.ESITarget|com.ptc.windchill.esi.tgt.ESIFileTarget
      • com.ptc.windchill.esi.tgt.ESITarget|com.ptc.windchill.esi.tgt.ESIFTPTarget
      • com.ptc.windchill.esi.tgt.ESITarget|com.ptc.windchill.esi.tgt.ESIEmailTarget

      This currently does not handle custom modeled types. If there is a need for one of these, then a custom loader needs to be created.

         
      target number The number of the distribution target. A value is required for this attribute.
         
      target name The name of the distribution target. A value is required for this attribute.
         
      target description The description of the distribution target. A value is required for this attribute.
         
      target task URI The url of the Info*Engine task to be used by ESI. A value is required for this attribute if distribution target is custom soft type of root distribution target.

      Value for this is populated based on the different type of distribution target from preferences. This value is optional for OOTB SAP, OA, File, FTP ,E-Mail etc. distribution targets.

         
      default for context Indicates if this distribution target is default target for the context (i.e. Container) in which this object is created. Value set to true indicates default for context otherwise distribution target is not default.
      This value is optional and defaults to false.
         
      status Indicates if this distribution target is active or inactive. This value is optional and defaults to ACTIVE.
         
      target responseMetaInfoPath The path to ESI Response Meta Information file to be used by ESI for generating the response. A value is required for this attribute and defaults to file which resides under $WT_HOME\codebase\com\ptc\windchill\esi
      IBAValue Please refer to the wt.iba.value.service.LoadValue.createIBAValue for more details about the TAG. Also refer to the DTD for XML directive in the load file.
         

      Distribution Targets of Specific Types

         
      SAP Distribution Target The "typedef" tag value set to com.ptc.windchill.esi.tgt.ESITarget|com.ptc.windchill.esi.tgt.ESISAPTarget would create a SAP type of distribution target or any customized soft extention of SAP type of distribution target. SAP distribution target requires values of following soft attributes.
      • SystemID
      • Client
      • Plant

      Plant value is optional for SAP type of distribution target.

         
      Oracle Applications (OA) Distribution Target The "typedef" tag value set to com.ptc.windchill.esi.tgt.ESITarget|com.ptc.windchill.esi.tgt.ESIOATarget would create a OA type of distribution target or any customized soft extention of OA type of distribution target. OA distribution target requires values of following soft attributes. This would create a specific type of distribution target or any customized soft type for distribution target. This currently supports the following distribution target types:

      • DSN
      • Organization
         
      File Distribution Target The "typedef" tag value set to com.ptc.windchill.esi.tgt.ESITarget|com.ptc.windchill.esi.tgt.ESIFileTarget would create a File type of distribution target or any customized soft extention of File type of distribution target. File distribution target requires values of following soft attributes.
      • Path
         
      FTP Distribution Target The "typedef" tag value set to com.ptc.windchill.esi.tgt.ESITarget|com.ptc.windchill.esi.tgt.ESIFTPTarget would create a FTP type of distribution target or any customized soft extention of FTP type of distribution target. FTP distribution target requires values of following soft attributes.
      • FTP_UserID
      • FTP_Password
      • FTP_Host
      • FTP_Host
      • FTP_Port
      • FTP_Path

      • FTP_Port: This value is optional and defaults to 21
      • FTP_Path: This value is optional for FTP type of distribution target.
         
      E-mail Distribution Target The "typedef" tag value set to com.ptc.windchill.esi.tgt.ESITarget|com.ptc.windchill.esi.tgt.ESIEmailTarget would create a E-mail type of distribution target or any customized soft extention of E-mail type of distribution target. E-mail distribution target requires values of following soft attributes.
      • To
      • Cc
      • Bcc
      • ReplyTo
      • EmailHost
      • From

      Except "To" attribute values for all other attribute are optional for E-mail type of distribution target.

         

      Response Setting on Distribution Target

      Response settings attributes are set to default values. Please refer the guides for more details on settings. If needed the values can be modified by refering to the attribute and values. Modification can be specified in csvIBAValue tag while creating distribution target.



      Supported API: true

      Extendable: false

      Parameters:
      nv - The nv parameter is a hash table of the attribute names from the map file as the keys and the corresponding strings from one line of the data file as the value. This holds the Name/Value pairs of distribution target attributes.
      cmdLineArgs - command line argument that can contain supplemental load data. The cmdLineArgs parameter is a hash table of the extra attributes from the command line (parameters not defined in the interface). This allows substitution of values from the command line into the data file at runtime.
      returnObjects - Vector of the object(s) created by this method. Used by wt.load.StandardLoadService for accurate user feedback messages.
      Returns:
      true success
      false failure
      See Also:

    • beginCreateUpdateESITarget

      public static boolean beginCreateUpdateESITarget(Hashtable<String,String> nv, Hashtable<String,String> cmdLineArgs, Vector<?> returnObjects)
      Processes the "csvBeginESITarget" directive in the XML load file.

      Creates or Updates the distribution target object, in case of creation applies the default attribute values and in other case applies the updated attribute values associated with the specified type definition, and caches it in the loader's memory.

      When using wt.load.LoadFromFile to load distribution target, use the following XML format:

      XML Format

      <csvBeginESITarget handler="com.ptc.windchill.esi.load.LoadESI.beginCreateUpdateESITarget" >
        <csvtypedef> typedef </csvtypedef>
        <csvnumber> target number </csvnumber>
        <csvname> target name </csvname>
        <csvdescription> target description </csvdescription>
        <csvtaskURI> target task URI </csvtaskURI>
        <csvdefaultForContext> default for context </csvdefaultForContext>
        <csvstatus> status </csvstatus>
        <csvresponseMetaInfoPath> responseMetaInfoPath </csvresponseMetaInfoPath>
        <csv> responseMetaInfoPath </csvresponseMetaInfoPath>
      </csvBeginESITarget >
       
      <csvIBAValue handler="wt.iba.value.service.LoadValue.createOrUpdateIBAValue" >
        ...
      </csvIBAValue >
       
      <csvIBAValue handler="wt.iba.value.service.LoadValue.createOrUpdateIBAValue" >
        ...
      </csvIBAValue >
       
      <csvIBAValue handler="wt.iba.value.service.LoadValue.createOrUpdateIBAValue" >
        ...
      </csvIBAValue >
       
      <csvIBAValue handler="wt.iba.value.service.LoadValue.createOrUpdateIBAValue" >
        ...
      </csvIBAValue >
       
      <csvEndESITarget handler="com.ptc.windchill.esi.load.LoadESI.endCreateUpdateESITarget" />

      Tag Definitions

         
      typedef This contains the identifier string of a com.ptc.core.meta.common.TypeIdentifier.

      i.e. com.ptc.windchill.esi.tgt.ESITarget|com.ptc.windchill.esi.tgt. ESISAPTarget

      This would create a specific type of distribution target or any customized soft type for distribution target. This currently supports the following distribution target types:

      • com.ptc.windchill.esi.tgt.ESITarget|com.ptc.windchill.esi.tgt.ESISAPTarget
      • com.ptc.windchill.esi.tgt.ESITarget|com.ptc.windchill.esi.tgt.ESIOATarget
      • com.ptc.windchill.esi.tgt.ESITarget|com.ptc.windchill.esi.tgt.ESIFileTarget
      • com.ptc.windchill.esi.tgt.ESITarget|com.ptc.windchill.esi.tgt.ESIFTPTarget
      • com.ptc.windchill.esi.tgt.ESITarget|com.ptc.windchill.esi.tgt.ESIEmailTarget

      This currently does not handle custom modeled types. If there is a need for one of these, then a custom loader needs to be created.

         
      target number The number of the distribution target. A value is required for this attribute.
         
      target name The name of the distribution target. A value is required for this attribute.
         
      target description The description of the distribution target. A value is required for this attribute.
         
      target task URI The url of the Info*Engine task to be used by ESI. A value is required for this attribute if distribution target is custom soft type of root distribution target.

      Value for this is populated based on the different type of distribution target from preferences. This value is optional for OOTB SAP, OA, File, FTP ,E-Mail etc. distribution targets.

         
      default for context Indicates if this distribution target is default target for the context (i.e. Container) in which this object is created. Value set to true indicates default for context otherwise distribution target is not default.
      This value is optional and defaults to false.
         
      status Indicates if this distribution target is active or inactive. This value is optional and defaults to ACTIVE.
         
      target responseMetaInfoPath The path to ESI Response Meta Information file to be used by ESI for generating the response. A value is required for this attribute and defaults to file which resides under $WT_HOME\codebase\com\ptc\windchill\esi
      IBAValue Please refer to the wt.iba.value.service.LoadValue.createIBAValue for more details about the TAG. Also refer to the DTD for XML directive in the load file.
         

      Distribution Targets of Specific Types

         
      SAP Distribution Target The "typedef" tag value set to com.ptc.windchill.esi.tgt.ESITarget|com.ptc.windchill.esi.tgt.ESISAPTarget would create a SAP type of distribution target or any customized soft extention of SAP type of distribution target. SAP distribution target requires values of following soft attributes.
      • SystemID
      • Client
      • Plant

      Plant value is optional for SAP type of distribution target.

         
      Oracle Applications (OA) Distribution Target The "typedef" tag value set to com.ptc.windchill.esi.tgt.ESITarget|com.ptc.windchill.esi.tgt.ESIOATarget would create a OA type of distribution target or any customized soft extention of OA type of distribution target. OA distribution target requires values of following soft attributes. This would create a specific type of distribution target or any customized soft type for distribution target. This currently supports the following distribution target types:

      • DSN
      • Organization
         
      File Distribution Target The "typedef" tag value set to com.ptc.windchill.esi.tgt.ESITarget|com.ptc.windchill.esi.tgt.ESIFileTarget would create a File type of distribution target or any customized soft extention of File type of distribution target. File distribution target requires values of following soft attributes.
      • Path
         
      FTP Distribution Target The "typedef" tag value set to com.ptc.windchill.esi.tgt.ESITarget|com.ptc.windchill.esi.tgt.ESIFTPTarget would create a FTP type of distribution target or any customized soft extention of FTP type of distribution target. FTP distribution target requires values of following soft attributes.
      • FTP_UserID
      • FTP_Password
      • FTP_Host
      • FTP_Host
      • FTP_Port
      • FTP_Path

      • FTP_Port: This value is optional and defaults to 21
      • FTP_Path: This value is optional for FTP type of distribution target.
         
      E-mail Distribution Target The "typedef" tag value set to com.ptc.windchill.esi.tgt.ESITarget|com.ptc.windchill.esi.tgt.ESIEmailTarget would create a E-mail type of distribution target or any customized soft extention of E-mail type of distribution target. E-mail distribution target requires values of following soft attributes.
      • To
      • Cc
      • Bcc
      • ReplyTo
      • EmailHost
      • From

      Except "To" attribute values for all other attribute are optional for E-mail type of distribution target.

         

      Response Setting on Distribution Target

      Response settings attributes are set to default values. Please refer the guides for more details on settings. If needed the values can be modified by refering to the attribute and values. Modification can be specified in csvIBAValue tag while creating distribution target.



      Supported API: true

      Extendable: false

      Parameters:
      nv - The nv parameter is a hash table of the attribute names from the map file as the keys and the corresponding strings from one line of the data file as the value. This holds the Name/Value pairs of distribution target attributes.
      cmdLineArgs - command line argument that can contain supplemental load data. The cmdLineArgs parameter is a hash table of the extra attributes from the command line (parameters not defined in the interface). This allows substitution of values from the command line into the data file at runtime.
      returnObjects - Vector of the object(s) created by this method. Used by wt.load.StandardLoadService for accurate user feedback messages.
      Returns:
      true success
      false failure
      See Also:

    • endCreateUpdateESITarget

      public static boolean endCreateUpdateESITarget(Hashtable<String,String> nv, Hashtable<String,String> cmdLineArgs, Vector<ESITarget> returnObjects) throws WTException
      Processes the "csvEndESITarget" directive in the csv load file. Causes the cached distribution target to associate soft attribues from preceding IBAValue load file lines with the distribution target, applies the default attribute values associated with the specified type definition, persists the distribution target and clears the caches in the loader's memory.

      XML Format

      <csvEndESITarget handler="com.ptc.windchill.esi.load.LoadESI.endCreateUpdateESITarget" />

      Supported API: true

      Extendable: false

      Parameters:
      nv - The nv parameter is a hash table of the attribute names from the map file as the keys and the corresponding strings from one line of the data file as the value. This holds the Name/Value pairs of distribution target attributes.
      cmdLineArgs - command line argument that can contain supplemental load data. The cmdLineArgs parameter is a hash table of the extra attributes from the command line (parameters not defined in the interface). This allows substitution of values from the command line into the data file at runtime.
      returnObjects - Vector of the object(s) created by this method. Used by wt.load.StandardLoadService for accurate user feedback messages.
      Throws:
      WTException
      See Also:

    • endCreateESITarget

      public static boolean endCreateESITarget(Hashtable<String,String> nv, Hashtable<String,String> cmdLineArgs, Vector<ESITarget> returnObjects)
      Processes the "csvEndESITarget" directive in the csv load file. Causes the cached distribution target to associate soft attribues from preceding IBAValue load file lines with the distribution target, applies the default attribute values associated with the specified type definition, persists the distribution target and clears the caches in the loader's memory.

      XML Format

      <csvEndESITarget handler="com.ptc.windchill.esi.load.LoadESI.endCreateESITarget" />

      Supported API: true

      Extendable: false

      Parameters:
      nv - The nv parameter is a hash table of the attribute names from the map file as the keys and the corresponding strings from one line of the data file as the value. This holds the Name/Value pairs of distribution target attributes.
      cmdLineArgs - command line argument that can contain supplemental load data. The cmdLineArgs parameter is a hash table of the extra attributes from the command line (parameters not defined in the interface). This allows substitution of values from the command line into the data file at runtime.
      returnObjects - Vector of the object(s) created by this method. Used by wt.load.StandardLoadService for accurate user feedback messages.
      Returns:
      true success
      false failure
      See Also:

    • endUpdateESITarget

      public static boolean endUpdateESITarget(Hashtable<String,String> nv, Hashtable<String,String> cmdLineArgs, Vector<ESITarget> returnObjects)
      Processes the "csvEndESITarget" directive in the csv load file. Causes the cached distribution target to associate soft attribues from preceding IBAValue load file lines with the distribution target, update attribute values associated with the specified type definition, persists the distribution target and clears the caches in the loader's memory.

      XML Format

      <csvEndESITarget handler="com.ptc.windchill.esi.load.LoadESI.endUpdateESITarget" />

      Supported API: true

      Extendable: false

      Parameters:
      nv - The nv parameter is a hash table of the attribute names from the map file as the keys and the corresponding strings from one line of the data file as the value. This holds the Name/Value pairs of distribution target attributes.
      cmdLineArgs - command line argument that can contain supplemental load data. The cmdLineArgs parameter is a hash table of the extra attributes from the command line (parameters not defined in the interface). This allows substitution of values from the command line into the data file at runtime.
      returnObjects - Vector of the object(s) created by this method. Used by wt.load.StandardLoadService for accurate user feedback messages.
      Returns:
      true success
      false failure
      See Also:

    • createESITargetAssignmentLink

      public static boolean createESITargetAssignmentLink(Hashtable<String,String> nv, Hashtable<String,String> cmdLineArgs, Vector<String> returnObjects)
      Processes the "csvESITargetAssignmentLink" directive in the XML load file.

      Creates a distribution target link object. Creates the association between relesable and distribution target object.
      When using wt.load.LoadFromFile to load distribution target link, use the following XML format:

      XML Format

      <csvESITargetAssignmentLink handler= "com.ptc.windchill.esi.load.LoadESI.createESITargetAssignmentLink" >
        <csvreleasableObjectNumber> releasable object number </csvreleasableObjectNumber>
        <csvreleasableObjectType> releasable object type </csvreleasableObjectType>
        <csvversion> version </csvversion>
        <csviteration> iteration </csviteration>
        <csvnumber> target number </csvnumber>
      </csvESITargetAssignmentLink >
       

      Tag Definitions

         
      releasable object number The number of the releasable object to which distribution target needs to be associated. A value is required for this attribute.
         
      releasable object Type An object type of the releasable object to which distribution target needs to be associated. A value is required for this attribute.
         
      version The revision of the relesable object to which distribution target needs to be associated.

      This value is optional required only if releasable object is revision controlled.
         
      iteration The revision of the relesable object to which distribution target needs to be associated.
      This value is optional required only if releasable object is iterated.
         
      target number The number that identifies distribution target. A value is required for this attribute.
         


      Supported API: true

      Extendable: false

      Parameters:
      nv - The nv parameter is a hash table of the attribute names from the map file as the keys and the corresponding strings from one line of the data file as the value. This holds the Name/Value pairs of distribution target link attributes.
      cmdLineArgs - command line argument that can contain supplemental load data. The cmdLineArgs parameter is a hash table of the extra attributes from the command line (parameters not defined in the interface). This allows substitution of values from the command line into the data file at runtime.
      returnObjects - Vector of the object(s) created by this method. Used by wt.load.StandardLoadService for accurate user feedback messages.
      Returns:
      true if ESITargetAssignmentLink created and persisted ok, false otherwise.
      See Also:

    • beginCreateESITargetAssignmentLink

      public static boolean beginCreateESITargetAssignmentLink(Hashtable<String,String> nv, Hashtable<String,String> cmdLineArgs, Vector<?> returnObjects)
      Processes the "csvBeginESITargetAssignmentLink" directive in the XML load file.

      Creates a distribution target link object,Creates the association between relesable and distribution target object, applies the default attribute values associated with the specified type definition, and caches it in the loader's memory.

      Use beginCreateReleaseActivities(Hashtable, Hashtable, Vector) when loading multiple release activities for better performance.

      When using wt.load.LoadFromFile to load distribution target link, use the following XML format:

      XML Format

      <csvBeginESITargetAssignmentLink handler= "com.ptc.windchill.esi.load.LoadESI.beginCreateESITargetAssignmentLink" >
        <csvtypedef> typedef </csvtypedef>
        <csvreleasableObjectNumber> releasable object number </csvreleasableObjectNumber>
        <csvreleasableObjectType> releasable object type </csvreleasableObjectType>
        <csvversion> version </csvversion>
        <csviteration> iteration </csviteration>
        <csvnumber> target number </csvnumber>
      </csvBeginESITargetAssignmentLink >
       
      <csvIBAValue handler="wt.iba.value.service.LoadValue.createIBAValue" >
        ...
      </csvIBAValue >
       
      <csvIBAValue handler="wt.iba.value.service.LoadValue.createIBAValue" >
        ...
      </csvIBAValue >
       
      <csvIBAValue handler="wt.iba.value.service.LoadValue.createIBAValue" >
        ...
      </csvIBAValue >
       
      <csvIBAValue handler="wt.iba.value.service.LoadValue.createIBAValue" >
        ...
      </csvIBAValue >
       
      <csvEndESITargetAssignmentLink handler="com.ptc.windchill.esi.load.endCreateESITargetAssignmentLink" />

      Tag Definitions

         
      typedef This contains the identifier string of a com.ptc.core.meta.common.TypeIdentifier.

      i.e. com.ptc.windchill.esi.tgt.ESITargetAssignmentLink|com.mycompany. MyTargetAssignmentLink

      This would create a specific type of distribution target link or any customized soft type for distribution target link. This currently supports the following distribution target link types:

      • com.ptc.windchill.esi.tgt.ESITargetAssignmentLink

      This currently does not handle custom modeled types. If there is a need for one of these, then a custom loader needs to be created.

      This value is optional and defaults to com.ptc.windchill.esi.tgt.ESITargetAssignmentLink.
         
      releasable object number The number of the releasable object to which distribution target needs to be associated. A value is required for this attribute.
         
      releasable object Type An object type of the releasable object to which distribution target needs to be associated. A value is required for this attribute.
         
      version The revision of the relesable object to which distribution target needs to be associated.

      This value is optional required only if releasable object is revision controlled.
         
      iteration The revision of the relesable object to which distribution target needs to be associated.
      This value is optional required only if releasable object is iterated.
         
      target number The number that identifies distribution target. A value is required for this attribute.
         


      Supported API: true

      Extendable: false

      Parameters:
      nv - The nv parameter is a hash table of the attribute names from the map file as the keys and the corresponding strings from one line of the data file as the value. This holds the Name/Value pairs of distribution target link attributes.
      cmdLineArgs - command line argument that can contain supplemental load data. The cmdLineArgs parameter is a hash table of the extra attributes from the command line (parameters not defined in the interface). This allows substitution of values from the command line into the data file at runtime.
      returnObjects - Vector of the object(s) created by this method. Used by wt.load.StandardLoadService for accurate user feedback messages.
      Returns:
      true success
      false failure
      See Also:

    • endCreateESITargetAssignmentLink

      public static boolean endCreateESITargetAssignmentLink(Hashtable<String,String> nv, Hashtable<String,String> cmdLineArgs, Vector<String> returnObjects)
      Processes the "csvEndESITargetAssignmentLink" directive in the csv load file. Causes the cached distribution target link to associate soft attribues from preceding IBAValue load file lines with the distribution target link, applies the default attribute values associated with the specified type definition, persists the distribution target link and clears the caches in the loader's memory.

      XML Format

      <csvEndESITargetAssignmentLink handler= "com.ptc.windchill.esi.load.LoadESI.endCreateESITargetAssignmentLink" />

      Supported API: true

      Extendable: false

      Parameters:
      nv - The nv parameter is a hash table of the attribute names from the map file as the keys and the corresponding strings from one line of the data file as the value. This holds the Name/Value pairs of distribution target link attributes.
      cmdLineArgs - command line argument that can contain supplemental load data. The cmdLineArgs parameter is a hash table of the extra attributes from the command line (parameters not defined in the interface). This allows substitution of values from the command line into the data file at runtime.
      returnObjects - Vector of the object(s) created by this method. Used by wt.load.StandardLoadService for accurate user feedback messages.
      Returns:
      true success
      false failure
      See Also:

    • beginCreateReleaseActivities

      public static boolean beginCreateReleaseActivities(Hashtable<String,String> nv, Hashtable<String,String> cmdLineArgs, Vector<Persistable> returnObjects)
      Processes the "beginReleaseActivities" directive in the XML load file.

      Creates a multiple release activity objects, applies the default attribute values associated with the specified type definition, and caches it in the loader's memory.

      Use this when loading multiple release activities.

      When using wt.load.LoadFromFile to load release activity, use the following XML format:

      XML Format

      <csvBeginReleaseActivities handler="com.ptc.windchill.esi.load.LoadESI.beginCreateReleaseActivities" />
      <csvCreateReleaseActivity handler="com.ptc.windchill.esi.load.LoadESI.createReleaseActivity" >
        <csvreleaseClass> releaseClass </csvreleaseClass>
        <csvobjectClass> releasable object type </csvobjectClass>
        <csvnumber> releasable object number </csvnumber>
        <csvobjectVersion> releasable object version </csvobjectVersion>
        <csvobjectIteration> releasable object iteration </csvobjectIteration>
        <csvobjectView> releasable object view </csvobjectView>
        <csvtargetNumber> distribution target number </csvtargetNumber>
        <csvpublishDate> publication date </csvpublishDate>
        <csvpublishAction> publication action </csvpublishAction>
        <csvcontainerPath> container path </csvcontainerPath>
        <csvpublishMessage> message </csvpublishMessage>
        <csveffContext> effContext </csveffContext>
        <csvchangeNumber> changeNumber </csvchangeNumber>
      </csvCreateReleaseActivity >
      <csvCreateReleaseActivityForLink handler="com.ptc.windchill.esi.load.LoadESI.createReleaseActivityForLink" >
        <csvreleaseClass> releaseClass </csvreleaseClass>
        <csvlinkClass> releasable link type </csvlinkClass>
        <csvroleAObjectClass> object type of roleA of link </csvroleAObjectClass>
        <csvroleAObjectNumber> object number of roleA of releasable link </csvroleAObjectNumber>
        <csvroleAObjectVersion> version of roleA object of releasable link </csvroleAObjectVersion>
        <csvroleAObjectIteration> iteration of roleA object of releasable link </csvroleAObjectIteration>
        <csvroleAObjectView> view of roleA object of releasable link </csvroleAObjectView>
        <csvroleBObjectClass> object type of roleB of link </csvroleBObjectClass>
        <csvroleBObjectNumber> object number of roleB of releasable link </csvroleBObjectNumber>
        <csvroleBObjectVersion> version of roleB object of releasable link </csvroleBObjectVersion>
        <csvroleBObjectIteration> iteration of roleB object of releasable link </csvroleBObjectIteration>
        <csvroleBObjectView> view of roleB object of releasable link </csvroleBObjectView>
        <csvtargetNumber> distribution target number </csvtargetNumber>
        <csvpublishDate> publication date </csvpublishDate>
        <csvpublishAction> publication action </csvpublishAction>
        <csvcontainerPath> container path </csvcontainerPath>
        <csvpublishMessage> message </csvpublishMessage>
        <csveffContext> effContext </csveffContext>
      </csvCreateReleaseActivityForLink >
      <csvEndReleaseActivities handler="com.ptc.windchill.esi.load.LoadESI.endCreateReleaseActivities" />

      Tag Definitions

      *
         
      releaseClass The esi release class of releasable object. A value is required for this attribute.
      This contains the string such as 'com.ptc.windchill.esi.Part' or 'com.ptc.windchill.esi.mpml.ProcessPlan', etc.
         
      releasable object type The class type of releasable object. A value is required for this attribute.
      This contains the string such as 'wt.part.WTPart' or 'com.ptc.windchill.mpml.processplan.MPMProcessPlan', etc.
         
      releasable object number The number of the releasable object. A value is required for this attribute.
         
      releasable object version The version of the releasable object. A value is optional for this attribute.
         
      releasable object iteration The iteration of the releasable object. A value is optional for this attribute.
         
      releasable object view The view of the releasable object. A value is optional for this attribute.
         
      releasable link type The class type of releasable link. A value is required for this attribute.
      This contains the string such as 'com.ptc.windchill.mpml.processplan.MPMPartToProcessPlanLink', etc.
         
      object number of roleA of releasable link The object number of the roleA of releasable link object. A value is required for this attribute.
         
      object number of roleA of releasable link The object number of the roleA of releasable link object. A value is required for this attribute.
         
      version of roleA object of releasable link The version of the roleA of releasable link object. A value is optional for this attribute.
         
      iteration of roleA object of releasable link The iteration of the roleA of releasable link object. A value is optional for this attribute.
         
      view of roleA object of releasable link The view of the roleA of releasable link object. A value is optional for this attribute.
         
      object number of roleB of releasable link The object number of the roleB of releasable link object. A value is required for this attribute.
         
      object number of roleB of releasable link The object number of the roleB of releasable link object. A value is required for this attribute.
         
      version of roleB object of releasable link The version of the roleB of releasable link object. A value is optional for this attribute.
         
      iteration of roleB object of releasable link The iteration of the roleB of releasable link object. A value is optional for this attribute.
         
      view of roleB object of releasable link The view of the roleB of releasable link object. A value is optional for this attribute.
         
      distribution target number The number of the distribution target. A value is required for this attribute.
         
      publication date The date of the publication. A value is optional for this attribute.
         
      publication action The action of the publication. A value is required for this attribute.
      This contains one the string from 'create', 'change' or 'delete'.
         
      container path The container path of the releasable object. A value is optional for this attribute.
         
      message The publish message for release activity. A value is optional for this attribute.
         
      effContext The effContext for release activity. A value is optional for this attribute.
         
      changeNumber The changeNumber for release activity. A value is optional for this attribute.
         



      Supported API: true

      Extendable: false

      Parameters:
      nv - The nv parameter is a hash table of the attribute names from the map file as the keys and the corresponding strings from one line of the data file as the value. This holds the Name/Value pairs of release activity attributes.
      cmdLineArgs - command line argument that can contain supplemental load data. The cmdLineArgs parameter is a hash table of the extra attributes from the command line (parameters not defined in the interface). This allows substitution of values from the command line into the data file at runtime.
      returnObjects - Vector of the object(s) created by this method. Used by wt.load.StandardLoadService for accurate user feedback messages.
      Returns:
      true success
      false failure
      See Also:

    • endCreateReleaseActivities

      public static boolean endCreateReleaseActivities(Hashtable<String,String> nv, Hashtable<String,String> cmdLineArgs, Vector<Persistable> returnObjects)
      Processes the "csvEndReleaseActivities" directive in the csv load file. Causes the cached release activity to persists in the windchill database and clears the caches in the loader's memory.

      XML Format

      <csvEndReleaseActivities handler="com.ptc.windchill.esi.load.LoadESI.endCreateReleaseActivities" />

      Supported API: true

      Extendable: false

      Parameters:
      nv - The nv parameter is a hash table of the attribute names from the map file as the keys and the corresponding strings from one line of the data file as the value. This holds the Name/Value pairs of release activity attributes.
      cmdLineArgs - command line argument that can contain supplemental load data. The cmdLineArgs parameter is a hash table of the extra attributes from the command line (parameters not defined in the interface). This allows substitution of values from the command line into the data file at runtime.
      returnObjects - Vector of the object(s) created by this method. Used by wt.load.StandardLoadService for accurate user feedback messages.
      Returns:
      true success
      false failure
      See Also:

    • endCreateReleaseActivity

      public static boolean endCreateReleaseActivity(Hashtable<String,String> nv, Hashtable<String,String> cmdLineArgs, Vector<Persistable> returnObjects)
      Processes the "csvEndReleaseActivity" directive in the csv load file. Causes the cached release activity to persists in the windchill database and clears the caches in the loader's memory.

      XML Format

      <csvEndReleaseActivity handler="com.ptc.windchill.esi.load.LoadESI.endCreateReleaseActivity" />

      Supported API: true

      Extendable: false

      Parameters:
      nv - The nv parameter is a hash table of the attribute names from the map file as the keys and the corresponding strings from one line of the data file as the value. This holds the Name/Value pairs of release activity attributes.
      cmdLineArgs - command line argument that can contain supplemental load data. The cmdLineArgs parameter is a hash table of the extra attributes from the command line (parameters not defined in the interface). This allows substitution of values from the command line into the data file at runtime.
      returnObjects - Vector of the object(s) created by this method. Used by wt.load.StandardLoadService for accurate user feedback messages.
      Returns:
      true success
      false failure
      See Also:

    • createReleaseActivity

      public static boolean createReleaseActivity(Hashtable<String,String> nv, Hashtable<String,String> cmdLineArgs, Vector<Persistable> returnObjects)
      Processes the "createReleaseActivity" directive in the XML load file.

      Creates a release activity object, applies the default attribute values associated with the specified type definition, and persists it in the database.

      When using wt.load.LoadFromFile to load release activity, use the following XML format:

      XML Format

      <csvCreateReleaseActivity handler="com.ptc.windchill.esi.load.LoadESI.createReleaseActivity" >
        <csvreleaseClass> releaseClass </csvreleaseClass>
        <csvobjectClass> releasable object type </csvobjectClass>
        <csvnumber> releasable object number </csvnumber>
        <csvobjectVersion> releasable object version </csvobjectVersion>
        <csvobjectIteration> releasable object iteration </csvobjectIteration>
        <csvobjectView> releasable object view </csvobjectView>
        <csvtargetNumber> distribution target number </csvtargetNumber>
        <csvpublishDate> publication date </csvpublishDate>
        <csvpublishAction> publication action </csvpublishAction>
        <csvcontainerPath> container path </csvcontainerPath>
        <csvpublishMessage> message </csvpublishMessage>
        <csveffContext> effContext </csveffContext>
        <csvchangeNumber> changeNumber </csvchangeNumber>
      </csvCreateReleaseActivity >

      Tag Definitions

         
      releaseClass The esi release class of releasable object. A value is required for this attribute.
      This contains the string such as 'com.ptc.windchill.esi.Part' or 'com.ptc.windchill.esi.mpml.ProcessPlan', etc.
         
      releasable object type The class type of releasable object. A value is required for this attribute.
      This contains the string such as 'wt.part.WTPart' or 'com.ptc.windchill.mpml.processplan.MPMProcessPlan', etc.
         
      releasable object number The number of the releasable object. A value is required for this attribute.
         
      releasable object version The version of the releasable object. A value is optional for this attribute.
         
      releasable object iteration The iteration of the releasable object. A value is optional for this attribute.
         
      releasable object view The view of the releasable object. A value is optional for this attribute.
         
      distribution target number The number of the distribution target. A value is required for this attribute.
         
      publication date The date of the publication. A value is optional for this attribute.
         
      publication action The action of the publication. A value is required for this attribute.
      This contains the string such as 'create', 'change' and 'delete'.
         
      container path The container path of the releasable object. A value is optional for this attribute.
         
      message The publish message for release activity. A value is optional for this attribute.
         
      effContext The effContext for release activity. A value is optional for this attribute.
         
      changeNumber The changeNumber for release activity. A value is optional for this attribute.
         



      Supported API: true

      Extendable: false

      Parameters:
      nv - The nv parameter is a hash table of the attribute names from the map file as the keys and the corresponding strings from one line of the data file as the value. This holds the Name/Value pairs of release activity attributes.
      cmdLineArgs - command line argument that can contain supplemental load data. The cmdLineArgs parameter is a hash table of the extra attributes from the command line (parameters not defined in the interface). This allows substitution of values from the command line into the data file at runtime.
      returnObjects - Vector of the object(s) created by this method. Used by wt.load.StandardLoadService for accurate user feedback messages.
      Returns:
      true success
      false failure
      See Also:

    • createReleaseActivityForLink

      public static boolean createReleaseActivityForLink(Hashtable<String,String> nv, Hashtable<String,String> cmdLineArgs, Vector<Persistable> returnObjects)
      Processes the "createReleaseActivityForLink" directive in the XML load file.

      Creates a release activity object for links, applies the default attribute values associated with the specified type definition, and persists it in the database.

      Use beginCreateReleaseActivities(Hashtable, Hashtable, Vector) when loading multiple release activities for better performance.

      When using wt.load.LoadFromFile to load release activity for links, use the following XML format:

      XML Format

      <csvCreateReleaseActivityForLink handler="com.ptc.windchill.esi.load.LoadESI.createReleaseActivityForLink" >
        <csvreleaseClass> releaseClass </csvreleaseClass>
        <csvlinkClass> releasable link type </csvlinkClass>
        <csvroleAObjectClass> object type of roleA of link </csvroleAObjectClass>
        <csvroleAObjectNumber> object number of roleA of releasable link </csvroleAObjectNumber>
        <csvroleAObjectVersion> version of roleA object of releasable link </csvroleAObjectVersion>
        <csvroleAObjectIteration> iteration of roleA object of releasable link </csvroleAObjectIteration>
        <csvroleAObjectView> view of roleA object of releasable link </csvroleAObjectView>
        <csvroleBObjectClass> object type of roleB of link </csvroleBObjectClass>
        <csvroleBObjectNumber> object number of roleB of releasable link </csvroleBObjectNumber>
        <csvroleBObjectVersion> version of roleB object of releasable link </csvroleBObjectVersion>
        <csvroleBObjectIteration> iteration of roleB object of releasable link </csvroleBObjectIteration>
        <csvroleBObjectView> view of roleB object of releasable link </csvroleBObjectView>
        <csvtargetNumber> distribution target number </csvtargetNumber>
        <csvpublishDate> publication date </csvpublishDate>
        <csvpublishAction> publication action </csvpublishAction>
        <csvcontainerPath> container path </csvcontainerPath>
        <csvpublishMessage> message </csvpublishMessage>
        <csveffContext> effContext </csveffContext>
      </csvCreateReleaseActivityForLink >

      Tag Definitions

         
      releaseClass The esi release class of releasable object. A value is required for this attribute.
      This contains the string such as 'com.ptc.windchill.esi.mpml.PartToProcessPlanLink', etc.
         
      releasable link type The class type of releasable link. A value is required for this attribute.
      This contains the string such as 'com.ptc.windchill.mpml.processplan.MPMPartToProcessPlanLink', etc.
         
      object number of roleA of releasable link The object number of the roleA of releasable link object. A value is required for this attribute.
         
      object number of roleA of releasable link The object number of the roleA of releasable link object. A value is required for this attribute.
         
      version of roleA object of releasable link The version of the roleA of releasable link object. A value is optional for this attribute.
         
      iteration of roleA object of releasable link The iteration of the roleA of releasable link object. A value is optional for this attribute.
         
      view of roleA object of releasable link The view of the roleA of releasable link object. A value is optional for this attribute.
         
      object number of roleB of releasable link The object number of the roleB of releasable link object. A value is required for this attribute.
         
      object number of roleB of releasable link The object number of the roleB of releasable link object. A value is required for this attribute.
         
      version of roleB object of releasable link The version of the roleB of releasable link object. A value is optional for this attribute.
         
      iteration of roleB object of releasable link The iteration of the roleB of releasable link object. A value is optional for this attribute.
         
      view of roleB object of releasable link The view of the roleB of releasable link object. A value is optional for this attribute.
         
      distribution target number The number of the distribution target. A value is required for this attribute.
         
      publication date The date of the publication. A value is optional for this attribute.
         
      publication action The action of the publication. A value is required for this attribute.
      This contains the string such as 'create', 'change' and 'delete'.
         
      container path The container path of the releasable object. A value is optional for this attribute.
         
      message The publish message for release activity. A value is optional for this attribute.
         
      effContext The effContext for release activity. A value is optional for this attribute.
         



      Supported API: true

      Extendable: false

      Parameters:
      nv - The nv parameter is a hash table of the attribute names from the map file as the keys and the corresponding strings from one line of the data file as the value. This holds the Name/Value pairs of release activity attributes.
      cmdLineArgs - command line argument that can contain supplemental load data. The cmdLineArgs parameter is a hash table of the extra attributes from the command line (parameters not defined in the interface). This allows substitution of values from the command line into the data file at runtime.
      returnObjects - Vector of the object(s) created by this method. Used by wt.load.StandardLoadService for accurate user feedback messages.
      Returns:
      true success
      false failure
      See Also: