From 669915c559fb9bcd4a8f8d5239f0b9b6ab33436b Mon Sep 17 00:00:00 2001
From: Dinh Danh Le <dinh.danh.le@ericsson.com>
Date: Sun, 5 Aug 2018 09:54:13 +0100
Subject: Adding Apex docs for Plugins module

Change-Id: Icf68473b472a5896972de5b07b275682a77a1c9f
Signed-off-by: Dinh Danh Le <dinh.danh.le@ericsson.com>
Issue-ID: POLICY-867
---
 .../src/site-docs/adoc/fragments/ct-file-io.adoc   | 53 ++++++++++++++++++++++
 1 file changed, 53 insertions(+)
 create mode 100644 plugins/plugins-event/plugins-event-carrier/src/site-docs/adoc/fragments/ct-file-io.adoc

(limited to 'plugins/plugins-event/plugins-event-carrier/src/site-docs/adoc/fragments/ct-file-io.adoc')

diff --git a/plugins/plugins-event/plugins-event-carrier/src/site-docs/adoc/fragments/ct-file-io.adoc b/plugins/plugins-event/plugins-event-carrier/src/site-docs/adoc/fragments/ct-file-io.adoc
new file mode 100644
index 000000000..bdde9e982
--- /dev/null
+++ b/plugins/plugins-event/plugins-event-carrier/src/site-docs/adoc/fragments/ct-file-io.adoc
@@ -0,0 +1,53 @@
+//
+// ============LICENSE_START=======================================================
+//  Copyright (C) 2016-2018 Ericsson. All rights reserved.
+// ================================================================================
+// This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE
+// Full license text at https://creativecommons.org/licenses/by/4.0/legalcode
+// 
+// SPDX-License-Identifier: CC-BY-4.0
+// ============LICENSE_END=========================================================
+//
+// @author Sven van der Meer (sven.van.der.meer@ericsson.com)
+//
+
+== File IO
+
+File IO does not require a specific plugin, it is supported be default.
+
+=== File Input
+
+APEX will take events from a file.
+The same file should not be used as an output.
+The configuration is as follows:
+
+[source%nowrap,json]
+----
+"carrierTechnologyParameters" : {
+  "carrierTechnology" : "FILE", // <1>
+  "parameters" : {
+    "fileName" : "examples/events/SampleDomain/EventsIn.xmlfile" // <2>
+  }
+}
+----
+<1> set file input
+<2> the name of the file to read events from
+
+
+=== File Output
+
+APEX will write events to a file.
+The same file should not be used as an input.
+The configuration is as follows:
+
+[source%nowrap,json]
+----
+"carrierTechnologyParameters" : {
+  "carrierTechnology" : "FILE", // <1>
+  "parameters" : {
+    "fileName"  : "examples/events/SampleDomain/EventsOut.xmlfile" // <2>
+  }
+}
+----
+<1> set file output
+<2> the name of the file to write events to
-- 
cgit 1.2.3-korg