<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
  <channel>
    <title>Stroom – file</title>
    <link>/tags/file/</link>
    <description>Recent content in file on Stroom</description>
    <generator>Hugo -- gohugo.io</generator>
    <lastBuildDate>Tue, 27 Jul 2021 00:00:00 +0000</lastBuildDate>
    
	  <atom:link href="/tags/file/index.xml" rel="self" type="application/rss+xml" />
    
    
      
        
      
    
    
    <item>
      <title>Docs: File Output</title>
      <link>/docs/user-guide/pipelines/file-output/</link>
      <pubDate>Tue, 27 Jul 2021 00:00:00 +0000</pubDate>
      
      <guid>/docs/user-guide/pipelines/file-output/</guid>
      <description>
        
        
        &lt;p&gt;When outputting files with Stroom, the output file names and paths can include various substitution variables to form the file and path names.&lt;/p&gt;
&lt;h2 id=&#34;context-variables&#34;&gt;Context Variables&lt;/h2&gt;
&lt;p&gt;The following replacement variables are specific to the current processing context.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;${feed}&lt;/code&gt; - The name of the feed that the stream being processed belongs to&lt;/li&gt;
&lt;li&gt;&lt;code&gt;${pipeline}&lt;/code&gt; - The name of the pipeline that is producing output&lt;/li&gt;
&lt;li&gt;&lt;code&gt;${sourceId}&lt;/code&gt; - The id of the input data being processed&lt;/li&gt;
&lt;li&gt;&lt;code&gt;${partNo}&lt;/code&gt; - The part number of the input data being processed where data is in aggregated batches&lt;/li&gt;
&lt;li&gt;&lt;code&gt;${searchId}&lt;/code&gt; - The id of the batch search being performed. This is only available during a batch search&lt;/li&gt;
&lt;li&gt;&lt;code&gt;${node}&lt;/code&gt; - The name of the node producing the output&lt;/li&gt;
&lt;/ul&gt;
&lt;h2 id=&#34;time-variables&#34;&gt;Time Variables&lt;/h2&gt;
&lt;p&gt;The following replacement variables can be used to include aspects of the current time in UTC.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;${year}&lt;/code&gt; - Year in 4 digit form, e.g. 2000&lt;/li&gt;
&lt;li&gt;&lt;code&gt;${month}&lt;/code&gt; - Month of the year padded to 2 digits&lt;/li&gt;
&lt;li&gt;&lt;code&gt;${day}&lt;/code&gt; - Day of the month padded to 2 digits&lt;/li&gt;
&lt;li&gt;&lt;code&gt;${hour}&lt;/code&gt; - Hour padded to 2 digits using 24 hour clock, e.g. 22&lt;/li&gt;
&lt;li&gt;&lt;code&gt;${minute}&lt;/code&gt; - Minute padded to 2 digits&lt;/li&gt;
&lt;li&gt;&lt;code&gt;${second}&lt;/code&gt; - Second padded to 2 digits&lt;/li&gt;
&lt;li&gt;&lt;code&gt;${millis}&lt;/code&gt; - Milliseconds padded to 3 digits&lt;/li&gt;
&lt;li&gt;&lt;code&gt;${ms}&lt;/code&gt; - Milliseconds since the epoch&lt;/li&gt;
&lt;/ul&gt;
&lt;h2 id=&#34;system-environment-variables&#34;&gt;System (Environment) Variables&lt;/h2&gt;
&lt;p&gt;System variables (environment variables) can also be used, e.g. &lt;code&gt;${TMP}&lt;/code&gt;.&lt;/p&gt;
&lt;h2 id=&#34;file-name-references&#34;&gt;File Name References&lt;/h2&gt;
&lt;p&gt;rolledFileName in RollingFileAppender can use references to the fileName to incorporate parts of the non rolled file name.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;${fileName}&lt;/code&gt; - The complete file name&lt;/li&gt;
&lt;li&gt;&lt;code&gt;${fileStem}&lt;/code&gt; - Part of the file name before the file extension, i.e. everything before the last &amp;lsquo;.&amp;rsquo;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;${fileExtension}&lt;/code&gt; - The extension part of the file name, i.e. everything after the last &amp;lsquo;.&amp;rsquo;&lt;/li&gt;
&lt;/ul&gt;
&lt;h2 id=&#34;other-variables&#34;&gt;Other Variables&lt;/h2&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;${uuid}&lt;/code&gt; - A randomly generated UUID to guarantee unique file names&lt;/li&gt;
&lt;/ul&gt;

      </description>
    </item>
    
  </channel>
</rss>
