Filewriter-call - Revision history

Anonymous: /* {{VULCON}} / {{GVCONSOLE}} Configuration */

2012-11-16T12:04:10Z

‎{{VULCON}} / {{GVCONSOLE}} Configuration

Anonymous at 12:03, 16 November 2012

2012-11-16T12:03:50Z

Anonymous: /* How To */

2012-02-08T11:47:02Z

‎How To

Anonymous: /* How To */

2012-02-08T11:43:53Z

‎How To

Anonymous: /* {{VULCON}} / {{GVCONSOLE}} Configuration */

2012-02-08T11:02:17Z

‎{{VULCON}} / {{GVCONSOLE}} Configuration

Anonymous: /* {{VULCON}} / {{GVCONSOLE}} Configuration */

2012-02-08T11:00:35Z

‎{{VULCON}} / {{GVCONSOLE}} Configuration

Anonymous: /* {{VULCON}} / {{GVCONSOLE}} Configuration */

2012-02-08T10:59:59Z

‎{{VULCON}} / {{GVCONSOLE}} Configuration

Anonymous: Created page with "==Definition== Use this plug-in if you want to write the contain of a Buffer object into a file present or not in the local file system. The target file will be overwritten if it..."

2012-01-31T16:58:37Z

Created page with "==Definition== Use this plug-in if you want to write the contain of a Buffer object into a file present or not in the local file system. The target file will be overwritten if it..."

New page

==Definition==
Use this plug-in if you want to write the contain of a Buffer object into a file present or not in the local file system. The target file will be overwritten if it is already present.

{{GVESB}} provides two different tools, {{L_GVCONSOLE}} and {{L_VULCON}}, to configure this plug-ins in [[GVServices]].

=={{VULCON}} / {{GVCONSOLE}} Configuration==

This plug-in writes into a local filesystem file.

Complete file path is the concatenation of ''targetPath'' attribute, with the ''fileName'' attribute.
Both of them can contain [[placeholders]], that are expanded at plugin call time.

Attributes ''targetPath'' and ''fileName'' are subject to these constraints:
* attribute ''targetPath'' is overridden by ''GVFW_DIRECTORY'' property, if present in current GVBuffer. If property is
not defined in GVBuffer, the ''targetPath'' attribute in the configuration is used. In both cases, the value of this attribute can be a placeholder, resolved at plugin call time, and the result of the expansion, must result in an absolute pathname, otherwise an exception is thrown. <br/> An exception is also thrown if neither the property nor the attribute in configuration are set.
* attribute ''fileName'' is overridden by ''GVFW_FILE_NAME'' property, if present in current GVBuffer. If property is not defined in GVBuffer, the ''fileName'' attribute in the configuration is used. In both cases, the value of this attribute can be a placeholder, resolved at plugin call time, and the result of the expansion, combined with the previous attribute, must result in an existent resource in the local filesystem, otherwise an exception is thrown. <br/> An exception is also thrown
if neither the property nor the attribute in configuration are set.

The ''filewriter-call'' element is used by: [[Channel]] and [[routed-call]]. It has the following attributes:

* ''type'': call.
* ''class'': it.greenvulcano.gvesb.virtual.file.reader.FileWriter.
* ''name'': Operation name. Used in the [[Flow]] section to associate workflow nodes to VCL operations.
* ''targetPath'': This value can be static or dynamic, containing [[placeholders]] that could be replaced at plugin call time. This is a default value, and is used if the property ''GVFW_DIRECTORY'' is not defined in the current GVBuffer.
* ''fileName'': This value can be static or dynamic, containing [[placeholders]] that could be replaced at plugin call time. This is a default value, and is used if the property ''GVFW_FILE_NAME'' is not defined in the current GVBuffer.

and does not have subelements.

==How To==

Suppose you want to create a file present in the <nowiki>${{gv.app.home}}</nowiki>/TEST/TESTFS/TestXML/output folder. Right-clicking on Channel, insert after, FileWriter-call, a new element FileWriter-call will be created. Clicking above, on the Properties view you can set its attributes. [[File:VULCONFilewriter_call.jpg|thumb|Filewriter_call attributes]]

''Class'' and ''type'' are passed by default. Name, in this example, takes the value ''writeFile'', and ''file-name'' is passed as a parameter through the property ''FILE_NAME'' (see [[placeholders]]).

The respective part of the GVCore.xml file becomes:

<syntaxhighlight lang="XML">
<System id-system="GVESB" system-activation="on">
<Channel id-channel="TEST_CHANNEL_FILE">
----
<filereader-call class="it.greenvulcano.gvesb.virtual.file.reader.FileWriter"
fileName="ognl{{property['FILE_NAME']}}"
name="writeFile"
srcPath="${{gv.app.home}}/TEST/TESTFS/TestXML/output"
type="call"/>
</Channel>
</System>
</syntaxhighlight>

associated to the Service ''ValidateRemoteSingleXMLFile''.

<syntaxhighlight lang="XML">
<Service group-name="DEFAULT_GRP" id-service="ValidateRemoteSingleXMLFile" service-activation="on" statistics="off">
<Operation name="Request" operation-activation="on" out-check-type="none" type="operation">
<Participant id-channel="TEST_CHANNEL_FILE" id-system="GVESB"/>
<Flow first-node="fillProperties" point-x="9" point-y="31">
<ChangeGVBufferNode class="it.greenvulcano.gvesb.core.flow.ChangeGVBufferNode"
id="fillProperties" input="node" next-node-id="read_validate_file"
op-type="change GVBuffer" output="input" point-x="-15" point-y="160" type="flow-node">
<ChangeGVBuffer clear-data="false">
<OGNLScript>
property['FILE_NAME']=@it.greenvulcano.configuration.XMLConfig@get(object,'@name')
</OGNLScript>
</ChangeGVBuffer>
</ChangeGVBufferNode>
...
<GVOperationNode class="it.greenvulcano.gvesb.core.flow.GVOperationNode"
id="write_file" id-system="GVESB" input="input"
next-node-id="move_file" op-type="call"
operation-name="writeFile" output="input"
point-x="628" point-y="263" type="flow-node"/>
<GVEndNode class="it.greenvulcano.gvesb.core.flow.GVEndNode"
end-business-process="yes" id="end" op-type="end"
output="input" point-x="747" point-y="21" type="flow-node"/>
</Flow>
</Operation>
</Service>
</syntaxhighlight>

The first operation node, ''ChangeGVBufferNode: fillProperties'' is used for setting the property ''FILE_NAME'' containing the name of the file to be written. After other elements, it is added the ''GVOperationNode: write_file'' who calls the operation ''filewriter_call: writeFile''.

@@ Line 32: / Line 32: @@
 | append || optional || If true, the data are appended at the end of an existing file
 |-
-| appendEOL || optional || If true, then the attribute defines the EOL chars to append at the end of the input data.
+| appendEOL || optional || If true, then the attribute defines the EOL chars to append at the end of the input data. Default to nothing.
 |}

@@ Line 29: / Line 29: @@
 |-
 | fileName || required ||  This value can be static or dynamic, containing [[placeholders]] that could be replaced at plugin call time. This is a default value, and is used if the property ''GVFW_FILE_NAME'' is not defined in the current [[GVBuffer]].
 |}

@@ Line 79: / Line 79: @@
 * The first operation node, ''GVOperationNode: TestBirt'' defines the information needed for generating a BIRT report which be saved in '''report''' [[GVBuffer]] output.
-* The second Operation Node '''GVOperationNode : write''' receives '''report''' GVBUFFER as input and calls the operation '''filewriter-call : WriteReportFile''' which save its contain as an Excel file named '''Report.xsl''' into path <nowiki>${{gv.app.home}}</nowiki>/log (see [[placeholders]]).
+* The second Operation Node '''GVOperationNode : write''' receives '''report''' GVBUFFER as input and calls the operation '''filewriter-call : WriteReportFile''' which save its contain as an Excel file named '''Report.xls''' into path <nowiki>${{gv.app.home}}</nowiki>/log (see [[placeholders]]).
 * The third node, ''GVEndNode : end'', finishes the [[flow]].

@@ Line 13: / Line 13: @@
 Attributes ''targetPath'' and ''fileName'' are subject to these constraints:
-* attribute ''targetPath'' is overridden by ''GVFW_DIRECTORY'' property, if present in current [[GVBuffer]]. If property is
+* attribute ''targetPath'' is overridden by ''GVFW_DIRECTORY'' property, if present in current [[GVBuffer]]. If property is not defined in [[GVBuffer]], the ''targetPath'' attribute in the configuration is used. In both cases, the value of this attribute can be a placeholder, resolved at plugin call time, and the result of the expansion, must result in an absolute pathname, otherwise an exception is thrown. <br/> An exception is also thrown if neither the property nor the attribute in configuration are set.
-not defined in [[GVBuffer]], the ''targetPath'' attribute in the configuration is used. In both cases, the value of this attribute can be a placeholder, resolved at plugin call time, and the result of the expansion, must result in an absolute pathname, otherwise an exception is thrown. <br/> An exception is also thrown if neither the property nor the attribute in configuration are set.
+* attribute ''fileName'' is overridden by ''GVFW_FILE_NAME'' property, if present in current [[GVBuffer]]. If property is not defined in [[GVBuffer]], the ''fileName'' attribute in the configuration is used. In both cases, the value of this attribute can be a placeholder, resolved at plugin call time, and the result of the expansion, combined with the previous attribute, must result in an existent resource in the local filesystem otherwise an exception is thrown. <br/> An exception is also thrown if neither the property nor the attribute in configuration are set.
 The ''filewriter-call'' element is used by: [[Channel]] and [[routed-call]]. It has the following attributes:
@@ Line 31: / Line 30: @@
 | fileName || required ||  This value can be static or dynamic, containing [[placeholders]] that could be replaced at plugin call time. This is a default value, and is used if the property ''GVFW_FILE_NAME'' is not defined in the current [[GVBuffer]].
 |}
 and does not have sub-elements.

@@ Line 15: / Line 15: @@
 * attribute ''targetPath'' is overridden by ''GVFW_DIRECTORY'' property, if present in current [[GVBuffer]]. If property is
 not defined in [[GVBuffer]], the ''targetPath'' attribute in the configuration is used. In both cases, the value of this attribute can be a placeholder, resolved at plugin call time, and the result of the expansion, must result in an absolute pathname, otherwise an exception is thrown. <br/> An exception is also thrown if neither the property nor the attribute in configuration are set.
-* attribute ''fileName'' is overridden by ''GVFW_FILE_NAME'' property, if present in current [[GVBuffer]]. If property is not defined in [[GVBuffer]], the ''fileName'' attribute in the configuration is used. In both cases, the value of this attribute can be a placeholder, resolved at plugin call time, and the result of the expansion, combined with the previous attribute, must result in an existent resource in the local filesystem, otherwise an exception is thrown. <br/> An exception is also thrown
+* attribute ''fileName'' is overridden by ''GVFW_FILE_NAME'' property, if present in current [[GVBuffer]]. If property is not defined in [[GVBuffer]], the ''fileName'' attribute in the configuration is used. In both cases, the value of this attribute can be a placeholder, resolved at plugin call time, and the result of the expansion, combined with the previous attribute, must result in an existent resource in the local filesystem, otherwise an exception is thrown. <br/> An exception is also thrown if neither the property nor the attribute in configuration are set.
 The ''filewriter-call'' element is used by: [[Channel]] and [[routed-call]]. It has the following attributes:

@@ Line 35: / Line 35: @@
 ==How To==
-Suppose you want to create a file present in the <nowiki>${{gv.app.home}}</nowiki>/TEST/TESTFS/TestXML/output folder. Right-clicking on Channel, insert after, FileWriter-call, a new element FileWriter-call will be created. Clicking above, on the Properties view you can set its attributes. [[File:VULCONFilewriter_call.jpg|thumb|Filewriter_call attributes]]
+Suppose you want to create an Excel report file in the <nowiki>${{gv.app.home}}</nowiki>/log folder. Right-clicking on [[Channel]], insert after, FileWriter-call, a new element FileWriter-call will be created. Clicking above, on the Properties view, you can set its attributes like this: [[File:VULCONFilewriter_call.jpg|thumb|Filewriter_call attributes]]
 The respective part of the GVCore.xml file becomes:
@@ Line 44: / Line 45: @@
 <syntaxhighlight lang="XML">
 <System id-system="GVESB" system-activation="on">
-     <Channel id-channel="TEST_CHANNEL_FILE">
+     <Channel id-channel="TEST_CHANNEL">
          ----
-         <filereader-call class="it.greenvulcano.gvesb.virtual.file.reader.FileWriter"
+         <filewriter-call class="it.greenvulcano.gvesb.virtual.file.writer.FileWriter"
-            fileName="ognl{{property[&apos;FILE_NAME&apos;]}}"
+             fileName="Report.xls"
-            name="writeFile"
+             name="WriteReportFile"
-            srcPath="${{gv.app.home}}/TEST/TESTFS/TestXML/output"
+             targetPath="${{gv.app.home}}/log" type="call"/>
      </Channel>
 </System>
 </syntaxhighlight>
-associated to the Service ''ValidateRemoteSingleXMLFile''.
+associated to the Service ''TestBirt''.
 <syntaxhighlight lang="XML">
-<Service group-name="DEFAULT_GRP" id-service="ValidateRemoteSingleXMLFile" service-activation="on" statistics="off">
+<Service group-name="DEFAULT_GRP" id-service="TestBirt" service-activation="on" statistics="off">
-   <Operation name="Request" operation-activation="on" out-check-type="none" type="operation">
+    <Operation name="RequestReply" operation-activation="on" out-check-type="sys-svc-id" type="operation">
-      <Participant id-channel="TEST_CHANNEL_FILE" id-system="GVESB"/>
+         <Participant id-channel="TEST_CHANNEL" id-system="GVESB"/>
-      <Flow first-node="fillProperties" point-x="9" point-y="31">
+         <Flow first-node="generate" point-x="20" point-y="150">
-           <ChangeGVBufferNode class="it.greenvulcano.gvesb.core.flow.ChangeGVBufferNode"
+              <GVOperationNode class="it.greenvulcano.gvesb.core.flow.GVOperationNode"
-                  id="fillProperties" input="node" next-node-id="read_validate_file"
+                    dump-in-out="false" id="generate" id-system="GVESB" input="input"
-                  op-type="change GVBuffer" output="input" point-x="-15" point-y="160" type="flow-node">
+                    next-node-id="write" op-type="call" operation-name="TestBirt" output="report"
-                <ChangeGVBuffer clear-data="false">
+                    point-x="172" point-y="143" type="flow-node"/>
-                     <OGNLScript>
+              <GVOperationNode class="it.greenvulcano.gvesb.core.flow.GVOperationNode"
-                          property[&apos;FILE_NAME&apos;]=@it.greenvulcano.configuration.XMLConfig@get(object,&apos;@name&apos;)
+                    dump-in-out="false" id="write" id-system="GVESB" input="report" next-node-id="end" op-type="call"
-                     </OGNLScript>
+                    operation-name="WriteReportFile" output="output" point-x="363" point-y="143" type="flow-node"/>
-                </ChangeGVBuffer>
+              <GVEndNode class="it.greenvulcano.gvesb.core.flow.GVEndNode" end-business-process="yes" id="end" op-type="end"
-           </ChangeGVBufferNode>
+                    output="output" point-x="563" point-y="154" type="flow-node">
-                  ...
+                   <ChangeGVBuffer clear-data="true"/>
-           <GVOperationNode class="it.greenvulcano.gvesb.core.flow.GVOperationNode"
+             </GVEndNode>
-                   id="write_file" id-system="GVESB" input="input"
+         </Flow>
     </Operation>
 </Service>
 </syntaxhighlight>
-The first operation node, ''ChangeGVBufferNode: fillProperties'' is used for setting the property ''FILE_NAME'' containing the name of the file to be written. After other elements, it is added the ''GVOperationNode: write_file'' who calls the operation ''filewriter_call: writeFile''.
+* The first operation node, ''GVOperationNode: TestBirt'' defines the information needed for generating a BIRT report which be saved in '''report''' [[GVBuffer]] output.