Basic Pipelet

Version 14 by Sebastian Sybrecht
on Aug 20, 2009 11:37.

<< Changes from 13 to 14
compared with
Current by Thomas Menzel
on Feb 12, 2010 17:41.

 
Key
These lines were removed. This word was removed.
These lines were added. This word was added.

View page history


There are 3 changes. View first change.

 {composition-setup}{composition-setup}
 {deck:id=myDeck}
 {card:label=General Information}
  
 h2. Overview
  
 || Name | Basic Pipelet ||
 || Vendor | eccenca ||
 || Authors | ||
 || Homepage | ||
 || Issue Management | [http://support.eccenca.com/jira/browse/]... ||
 || Continuous Integration | n/a ||
 || Categories | Pipelet ||
 || Most Recent Version (see older versions) | Version 1.0 ||
 || Availability (see older versions) | eccenca / SMILA... ||
 || State | Stable ||
 || Support | [!ALLDOC:_Images^SupportedFeature.png!|DEVNET:eccenca Supported Feature|eccenca supported feature] ||
 || License | [Freeware eccenca Component License] ||
 || Price | Free ||
 || Release Docs | [http://wiki.eccenca.com/]... ||
 || Java API Docs | n/a ||
 || Download Source | ||
 || Download JAR | ||
 \\
 \\
  
 h2. Description/Features
  
 {card}
 {card:label=Instructions/Configuration}
 h2. TextFingerpritnPipelet
  
 Example of using {{TextFingerpritnPipelet}} is covered in [ECCCE:How to use TextFingerprint pipelet]
  
 h2. StringUtilsPipelet
  
 StringUtilsPipelet is a multi-action conversion pipelet which means that
  
 * it's configured like any other [conversion pipelets|Conversion pipelets configuration]
 * it also has a mandatory {{ConversionAction}} configuration property
  
 The available {{ConversionAction}} options are:
  
 * {{TruncateAtString}} \- truncates a string at a point of first occurence of a substring configured
 * {{SubString}} \- extracts a substing from a string given using configured start and and indexes
 * {{ToLowerCase}} \- converts the string to a lower case
  
 h3. Additional conversion configuration parameters
  
 h5. TruncateAtString
  
 || Name || Type || Value || Constraint || Description ||
 | SearchString | String | \- | \- | The substring to truncate the source string at |
  
 h5. SubString
  
 || Name || Type || Value || Constraint || Description ||
 | StartIndex | Integer | Character index | \- | The substring start character index |
 | EndIndex | Integer | Character index | \- | The substring end character index |
  
 h5. ToLowerCase
  
 _None_
  
 h3. Examples
  
 h5. TruncateAtString usage example
  
 This invocation configuration will overwrite the "Hello World and Java" string to "Hello World " in "Content" attachment:
  
 {code:xml}<extensionActivity name="invokeStringUtilsPipelet">
  <proc:invokePipelet>
  <proc:pipelet class="com.eccenca.smila.pipelets.basic.StringUtilsPipelet" />
   <proc:pipelet class="com.eccenca.pipelets.basic.StringUtilsPipelet" />
  <proc:variables input="request" />
  <proc:PipeletConfiguration>
  <proc:Property name="SourceType">
  <proc:Value>ATTACHMENT</proc:Value>
  </proc:Property>
  <proc:Property name="Source">
  <proc:Value>Text</proc:Value>
  </proc:Property>
  <proc:Property name="TargetType">
  <proc:Value>ATTACHMENT</proc:Value>
  </proc:Property>
  <proc:Property name="TargetStoragePolicy">
  <proc:Value>OVERWRITE</proc:Value>
  </proc:Property>
  <proc:Property name="ConversionAction">
  <proc:Value>TruncateAtString</proc:Value>
  </proc:Property>
  <proc:Property name="SearchString">
  <proc:Value>and</proc:Value>
  </proc:Property>
  </proc:PipeletConfiguration>
  </proc:invokePipelet>
 </extensionActivity>
 {code}
 h5. SubString usage example
  
 This invocation configuration will overwrite the "Hello World" string with "Hello" in "Content" attachment:
  
 {code:xml}<extensionActivity name="invokeStringUtilsPipelet">
  <proc:invokePipelet>
<proc:pipelet class="com.eccenca.smila.pipelets.basic.StringUtilsPipelet" />
   <proc:pipelet class="com.eccenca.pipelets.basic.StringUtilsPipelet" />
  <proc:variables input="request" />
  <proc:PipeletConfiguration>
  <proc:Property name="SourceType">
  <proc:Value>ATTACHMENT</proc:Value>
  </proc:Property>
  <proc:Property name="Source">
  <proc:Value>Text</proc:Value>
  </proc:Property>
  <proc:Property name="TargetType">
  <proc:Value>ATTACHMENT</proc:Value>
  </proc:Property>
  <proc:Property name="TargetStoragePolicy">
  <proc:Value>OVERWRITE</proc:Value>
  </proc:Property>
  <proc:Property name="ConversionAction">
  <proc:Value>SubString</proc:Value>
  </proc:Property>
  <proc:Property name="StartIndex" type="java.lang.Integer">
  <proc:Value>0</proc:Value>
  </proc:Property>
  <proc:Property name="EndIndex" type="java.lang.Integer">
  <proc:Value>5</proc:Value>
  </proc:Property>
  </proc:PipeletConfiguration>
  </proc:invokePipelet>
 </extensionActivity>
 {code}
 h5. ToLowerCase usage example
  
 This invocation configuration will overwrite the "Hello World" string with "hello world" in "Content" attachment:
  
 {code:xml}<extensionActivity name="invokeStringUtilsPipelet">
  <proc:invokePipelet>
  <proc:pipelet class="com.eccenca.smila.pipelets.basic.StringUtilsPipelet" />
   <proc:pipelet class="com.eccenca.pipelets.basic.StringUtilsPipelet" />
  <proc:variables input="request" />
  <proc:PipeletConfiguration>
  <proc:Property name="SourceType">
  <proc:Value>ATTACHMENT</proc:Value>
  </proc:Property>
  <proc:Property name="Source">
  <proc:Value>Text</proc:Value>
  </proc:Property>
  <proc:Property name="TargetType">
  <proc:Value>ATTACHMENT</proc:Value>
  </proc:Property>
  <proc:Property name="TargetStoragePolicy">
  <proc:Value>OVERWRITE</proc:Value>
  </proc:Property>
  <proc:Property name="ConversionAction">
  <proc:Value>ToLowerCase</proc:Value>
  </proc:Property>
  </proc:PipeletConfiguration>
  </proc:invokePipelet>
 </extensionActivity>
 {code}
 {card}
 {card:label=Known Issues}Link to support.eccenca.com
 {card}
 {card:label=FAQs}Frequently Asked Questions about this extension.
 {card}
 {deck}