You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by ac...@apache.org on 2016/05/24 07:42:11 UTC
[1/2] camel git commit: Added camel-servicenow docs to Gitbook
Repository: camel
Updated Branches:
refs/heads/master 93f5952e4 -> 5b5cf32bb
Added camel-servicenow docs to Gitbook
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/0a9eb291
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/0a9eb291
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/0a9eb291
Branch: refs/heads/master
Commit: 0a9eb291517ed1252fb50680ac67b1ebcb99b98b
Parents: 93f5952
Author: Andrea Cosentino <an...@gmail.com>
Authored: Tue May 24 09:37:29 2016 +0200
Committer: Andrea Cosentino <an...@gmail.com>
Committed: Tue May 24 09:38:20 2016 +0200
----------------------------------------------------------------------
.../src/main/docs/servicenow.adoc | 154 +++++++++++++++++++
docs/user-manual/en/SUMMARY.md | 1 +
2 files changed, 155 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/0a9eb291/components/camel-servicenow/src/main/docs/servicenow.adoc
----------------------------------------------------------------------
diff --git a/components/camel-servicenow/src/main/docs/servicenow.adoc b/components/camel-servicenow/src/main/docs/servicenow.adoc
new file mode 100644
index 0000000..25d4839
--- /dev/null
+++ b/components/camel-servicenow/src/main/docs/servicenow.adoc
@@ -0,0 +1,154 @@
+[[ServiceNow-ServiceNowComponent]]
+ServiceNow Component
+~~~~~~~~~~~~~~~~~~~~
+
+*Available as of Camel 2.18*
+
+The ServiceNow component provides access to all of ServiceNow
+https://developer.servicenow.com/app.do#!/rest_api_doc?v=fuji[REST
+API].�
+
+Maven users will need to add the following dependency to their pom.xml
+for this component:
+
+[source,java]
+-------------------------------------------------
+ <dependency>
+ <groupId>org.apache.camel</groupId>
+ <artifactId>camel-servicenow</artifactId>
+ <version>${camel-version}</version>
+ </dependency>
+-------------------------------------------------
+
+[[ServiceNow-URIformat]]
+URI format
+^^^^^^^^^^
+
+[source,java]
+---------------------------------------
+ servicenow://instanceName?[options]
+---------------------------------------
+
+[[ServiceNow-Options]]
+Options
+^^^^^^^
+
+
+// component options: START
+The ServiceNow component has no options.
+// component options: END
+
+
+
+// endpoint options: START
+The ServiceNow component supports 17 endpoint options which are listed below:
+
+{% raw %}
+[width="100%",cols="2s,1,1m,1m,5",options="header"]
+|=======================================================================
+| Name | Group | Default | Java Type | Description
+| instanceName | producer | | String | *Required* The ServiceNow instance name
+| displayValue | producer | false | String | Return the display value (true) actual value (false) or both (all) for reference fields (default: false)
+| excludeReferenceLink | producer | | Boolean | True to exclude Table API links for reference fields (default: false)
+| inputDisplayValue | producer | | Boolean | True to set raw value of input fields (default: false)
+| models | producer | | String | Defines the default model to use for a table
+| password | producer | | String | *Required* ServiceNow account password MUST be provided
+| resource | producer | | String | The default resource can be overridden by header CamelServiceNowResource
+| suppressAutoSysField | producer | | Boolean | True to suppress auto generation of system fields (default: false)
+| table | producer | | String | The default table can be overridden by header CamelServiceNowTable
+| userName | producer | | String | *Required* ServiceNow user account name MUST be provided
+| apiUrl | advanced | | String | The ServiceNow REST API url
+| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange
+| mapper | advanced | | ObjectMapper | Sets Jackson's ObjectMapper to use for request/reply
+| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| oauthClientId | security | | String | OAuth2 ClientID
+| oauthClientSecret | security | | String | OAuth2 ClientSecret
+| oauthTokenUrl | security | | String | OAuth token Url
+|=======================================================================
+{% endraw %}
+// endpoint options: END
+
+
+[[ServiceNow-Headers]]
+Headers
+^^^^^^^
+
+[width="100%",cols="10%,10%,80%",options="header",]
+|=======================================================================
+|Name |Type |Description
+
+|CamelServiceNowResource |String |The resource to access TABLE, AGGREGATE, IMPORT
+
+|CamelServiceNowTable |String |The table to access
+
+|CamelServiceNowAction |String |The action to perform RETRIEVE, CREATE, MODIFY, DELETE, UPDATE
+
+|CamelServiceNowModel |Class |The data model
+
+|CamelServiceNowSysId |String |ServiceNow sysy_id
+
+|CamelServiceNowQuery |String |An encoded query
+
+|CamelServiceNowDisplayValue |String |Return the display value (true), actual value (false), or both (all) for
+reference fields (default: false)
+
+|CamelServiceNowInputDisplayValue |Boolean |True to set raw value of input fields
+
+|CamelServiceNowExcludeReferenceLink |Boolean |True to exclude Table API links for reference fields
+
+|CamelServiceNowFields |String |Comma-separated field names to return in the response
+
+|CamelServiceNowMinFields |String |A comma-separated list of fields for which to calculate the minimum
+value
+
+|CamelServiceNowMaxFields |String |A comma-separated list of fields for which to calculate the maximum
+value
+
+|CamelServiceNowSumFields |String |A comma-separated list of fields for which to calculate the sum of the
+values
+
+|CamelServiceNowLimit |Integer |Limit to be applied on pagination
+
+|CamelServiceNowView |String |UI view to determine fields returned in the response.
+
+|CamelServiceNowSuppressAutoSysField |Boolean |True to suppress auto generation of system fields
+
+|CamelServiceNowAvgFields |String |A comma-separated list of fields for which to calculate the average
+value
+
+|CamelServiceNowCount |Boolean |A boolean flag. You can set this parameter to�*true*�for the number of
+records returned by the query
+
+|CamelServiceGroupBy |String |The fields to group the returned data by
+
+|CamelServiceOrderBy |String |A list of values to order grouped results by
+
+|CamelServiceHaving |String |An additional query allowing you to filter the data based on an
+aggregate operation
+|=======================================================================
+
+[[ServiceNow-Usageexamples]]
+Usage examples:
+^^^^^^^^^^^^^^^
+
+�
+{% raw %}
+[source,java]
+-------------------------------------------------------------------------------------------------------------------
+context.addRoutes(new RouteBuilder() {
+ public void configure() {
+ from("direct:servicenow")
+ .to("servicenow:{{env:SERVICENOW_INSTANCE}}"
+ + "?userName={{env:SERVICENOW_USERNAME}}"
+ + "&password={{env:SERVICENOW_PASSWORD}}"
+ + "&oauthClientId={{env:SERVICENOW_OAUTH2_CLIENT_ID}}"
+ + "&oauthClientSecret={{env:SERVICENOW_OAUTH2_CLIENT_SECRET}}"
+ + "&model.incident=org.apache.camel.component.servicenow.model.Incident")
+ .to("mock:servicenow");
+ }
+});�Map<String, Object> headers = new HashMap<>();headers.put(ServiceNowConstants.RESOURCE, "table");
+headers.put(ServiceNowConstants.ACTION, ServiceNowConstants.ACTION_RETRIEVE);
+headers.put(ServiceNowConstants.SYSPARM_LIMIT, "10");
+headers.put(ServiceNowConstants.TABLE, "incident");template.sendBodyAndHeaders("direct:servicenow", null, headers);
+-------------------------------------------------------------------------------------------------------------------
+{% endraw %}
http://git-wip-us.apache.org/repos/asf/camel/blob/0a9eb291/docs/user-manual/en/SUMMARY.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md
index 253cb46..3c6d166 100644
--- a/docs/user-manual/en/SUMMARY.md
+++ b/docs/user-manual/en/SUMMARY.md
@@ -232,6 +232,7 @@
* [Schematron](schematron.adoc)
* [SCR](camel-and-scr.adoc)
* [Script](script.adoc)
+ * [Servicenow](servicenow.adoc)
* [SJMS](sjms.adoc)
* [SJMS Batch](sjms-batch.adoc)
* [Telegram](telegram.adoc)
[2/2] camel git commit: Removed camel-hystrix from docs
Posted by ac...@apache.org.
Removed camel-hystrix from docs
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/5b5cf32b
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/5b5cf32b
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/5b5cf32b
Branch: refs/heads/master
Commit: 5b5cf32bb0b85993c6b176e2fe807136af12e37d
Parents: 0a9eb29
Author: Andrea Cosentino <an...@gmail.com>
Authored: Tue May 24 09:38:36 2016 +0200
Committer: Andrea Cosentino <an...@gmail.com>
Committed: Tue May 24 09:38:51 2016 +0200
----------------------------------------------------------------------
docs/user-manual/en/SUMMARY.md | 1 -
1 file changed, 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/5b5cf32b/docs/user-manual/en/SUMMARY.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md
index 3c6d166..998a0a2 100644
--- a/docs/user-manual/en/SUMMARY.md
+++ b/docs/user-manual/en/SUMMARY.md
@@ -153,7 +153,6 @@
* [HL7](hl7.adoc)
* [Http](http.adoc)
* [Http4](http4.adoc)
- * [Hystrix](hystrix.adoc)
* [Ibatis](ibatis.adoc)
* [Infinispan](infinispan.adoc)
* [IRC](irc.adoc)