Skip to content

Commit

Permalink
Merge pull request syndesisio#4818 from TovaCohen/FUSEDOC-2921-tutori…
Browse files Browse the repository at this point in the history
…alUpdates

user doc: Update tutorials for combo of step and connection cards.
  • Loading branch information
TovaCohen authored Mar 10, 2019
2 parents bfc97de + acfc4d2 commit 4a0fabb
Show file tree
Hide file tree
Showing 23 changed files with 61 additions and 58 deletions.
2 changes: 1 addition & 1 deletion doc/shared/p_register-with-sf.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ https://help.salesforce.com/articleView?id=connected_app_create.htm[Create a Con
.. In the *Callback URL* field, paste your
{prodname} URL, which you copied at the beginning of this procedure.
For example:
`\https://app-proj9128.7b63.{prodnameinurl}.openshiftapps.com/api/v1/credentials/callback`.
`\https://app-proj912876.7b63.{prodnameinurl}.openshiftapps.com/api/v1/credentials/callback`.
.. For *OAuth Scopes*, add:
** *Access and manage your data (api)*
** *Allow access to your unique identifier (openid)*
Expand Down
12 changes: 6 additions & 6 deletions doc/shared/p_register-with-twitter.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ image:images/CopyCallback.png[Copy Callback URL] to
copy the callback URL for your installation of {prodname} to the clipboard.
You will need this URL later in this procedure.
.. To the right of the *Twitter* entry,
click *Register* to display the *Consumer Key* and *Consumer Secret* fields.
click *Register* to display the *Consumer API Key* and *ConsumerAPI Secret Key* fields.
. In another browser tab, go to your
https://developer.twitter.com/apps[Twitter developer account], sign in if you
need to, and do the following:
Expand All @@ -50,8 +50,8 @@ of this procedure and remove `api/v1/credentials/callback` from the end
of the URL.
.. Select *Enable Sign in with Twitter*.
.. In the *Callback URLs* field, paste the URL again. It should be
something like this:
`\https://app-proj9128.7b63.{prodnameinurl}.openshiftapps.com/api/v1/credentials/callback`.
something like this:
`\https://app-proj912876.7b63.{prodnameinurl}.openshiftapps.com/api/v1/credentials/callback`.
.. A 100-character description of how you plan to use this app is required.
For convenience, you can copy and paste:
`This is a demo application so that I can evaluate how to integrate Twitter
Expand All @@ -60,12 +60,12 @@ with my enterprise applications.`
.. Click *Create* again to confirm that you reviewed the developer terms.
.. At the top of the page for the app you just created, click
the *Keys and tokens* tab.
.. Copy the API key.
.. Copy the consumer API key.

. Return to your {prodname} *Settings* page and paste the Twitter
consumer API key into the {prodname} Twitter *Consumer Key* field.
consumer API key into the {prodname} Twitter *Consumer API Key* field.
. Return to the Twitter *Keys and tokens* tab and copy the consumer API secret key.
. Return to your {prodname} *Settings* page and paste the Twitter
consumer API secret key into the {prodname} Twitter
*Consumer Secret* field.
*Consumer API Secret Key* field.
. Click *Save* and then click *Ok*.
14 changes: 5 additions & 9 deletions doc/tutorials/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
include::topics/shared/attributes.adoc[]

:prodname: Syndesis
:prodversion: 7.2
:prodversion: 7.3
:imagesdir: topics
:prodnameinurl: fuse-ignite
:productpkg: red_hat_fuse
:version: 7.2
:version: 7.3
:parent-context: tutorials
:location: upstream

Expand All @@ -18,22 +18,18 @@ application or service, operate on that data if you need to, and then send the
data to a completely different application or service. You can do all this
without writing code.

Explore {prodname} by creating these
sample integrations:
Explore {prodname} by creating sample integrations.
A <<comparison-of-sample-integrations_{context},comparison table>>
can help you decide which of these integrations to create first:

* <<twitter-to-salesforce_{context}>>
* <<salesforce-to-db_{context}>>
* <<amq-to-rest-api_{context}>>

See this <<comparison-of-sample-integrations_{context},comparison table>>
to decide which integration to create first.

See also: link:{LinkFuseOnlineIntegrationGuide}[{NameOfFuseOnlineIntegrationGuide}]

include::topics/r_comparison-of-sample-integrations.adoc[leveloffset=+1]

// include::topics/shared/log_in.adoc[leveloffset=+1]

include::topics/as_t2sf-intro.adoc[leveloffset=+1]

include::topics/as_sf2db-intro.adoc[leveloffset=+1]
Expand Down
4 changes: 2 additions & 2 deletions doc/tutorials/topics/as_amq2api-intro.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

:parent-context: {context}
[id='amq-to-rest-api_{context}']
= Implementing an AMQ to REST API sample integration
= Implementing the AMQ to REST API sample integration

:context: amq2api
This sample integration connects to a Red Hat AMQ broker to obtain item
Expand All @@ -29,7 +29,7 @@ ifeval::["{location}" == "downstream"]

* You must be logged in to {prodname}.
If you are not already logged in, see
link:{LinkFuseOnlineTutorials}#logging-in-and-out_tutorials[What to expect the first time you use {prodname}.]
link:{LinkFuseOnlineTutorials}#logging-in-and-out_tutorials[What to expect the first time that you use {prodname}.]
endif::[]
To implement the AMQ to REST API sample integration, the main steps are:
Expand Down
3 changes: 2 additions & 1 deletion doc/tutorials/topics/as_sf2db-create-integration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@

:context: sf2db-create
To create and deploy an integration that uses the Salesforce
connection and the database connection, the main steps are:
connection that you created and the database connection that is
provided with {prodname}, the main steps are:

* xref:sf2db-choose-start-connection_{context}[]
* xref:sf2db-choose-finish-connection_{context}[]
Expand Down
2 changes: 1 addition & 1 deletion doc/tutorials/topics/as_sf2db-intro.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Salesforce to database sample integration.
ifeval::["{location}" == "downstream"]
* You must be logged in to your {prodname} environment.
If you are not already logged in, see
link:{LinkFuseOnlineTutorials}#logging-in-and-out_tutorials[What to expect the first time you use {prodname}.]
link:{LinkFuseOnlineTutorials}#logging-in-and-out_tutorials[What to expect the first time that you use {prodname}.]
endif::[]

To implement, deploy, and test this sample integration, the main steps are:
Expand Down
4 changes: 2 additions & 2 deletions doc/tutorials/topics/as_t2sf-intro.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
This sample integration watches Twitter for tweets that mention
a particular Twitter user. When the integration finds such tweets,
it filters
them so that only those tweets that contain the text you specify cause
them so that only those tweets that contain the text that you specify cause
the integration to continue.

For tweets that contain the specified text, the integration passes
Expand All @@ -31,7 +31,7 @@ It takes less than two minutes to obtain a Salesforce account.
ifeval::["{location}" == "downstream"]
* You must be logged in to your {prodname} environment.
If you are not already logged in, see
link:{LinkFuseOnlineTutorials}#logging-in-and-out_tutorials[What to expect the first time you use {prodname}.]
link:{LinkFuseOnlineTutorials}#logging-in-and-out_tutorials[What to expect the first time that you use {prodname}.]
endif::[]

To implement, deploy, and test this sample integration, the main steps are:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,5 @@ and identifies any items that were damaged when they were received.

.Procedure

. In {prodname}, in the center, click *Add a Step*.
. In {prodname}, in the visualization panel on the left, click the plus sign.
. On the *Choose a Step* page, click *Damage Reporter*.
6 changes: 3 additions & 3 deletions doc/tutorials/topics/p_amq2api-add-mapping-step.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ database that the REST API accesses.
* You added the Damage Reporter step to the integration.

.Procedure
. In {prodname}, in the left panel, hover over the plus sign between the damage reporter
step and the finish connection to display a pop-up in which
you click *Add a step*.
. In {prodname}, in the visualization panel on the left panel,
click the plus sign that is between the Damage Reporter
step and the finish connection.
. On the *Choose a Step* page, click *Data Mapper*. In the data mapper,
the *Source* panel on the left displays the fields in the
output from the damage reporter step. The
Expand Down
2 changes: 1 addition & 1 deletion doc/tutorials/topics/p_amq2api-confirm-works.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ integration that you created and deployed.
. In a new browser window, go to the To Do app display by
inserting `*todo-*` in front of the URL
for your {prodname} environment. For example:
`\https://todo-app-proj7614.6a63.fuse-ignite.openshiftapps.com/`.
`\https://todo-app-proj761432.6a63.fuse-ignite.openshiftapps.com/`.
. In the To Do app display, click *Show JMS Form* to display an
input box that contains an XML message.
. Click *Send JMS Message* to send that message
Expand Down
2 changes: 1 addition & 1 deletion doc/tutorials/topics/p_amq2api-create-custom-step.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ extension.
ID, name, description, and type, and lists *Damage Reporter* as the custom step
that the extension defines.
. Click *Import Extension*. {prodname} makes the custom step available and displays
the extension details page.
the list of extensions that have been imported.

.Additional resources
For information about coding an extension and creating its `.jar` file, see:
Expand Down
6 changes: 4 additions & 2 deletions doc/tutorials/topics/p_amq2api-name-and-publish.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,16 @@ deploy it.
the connection to the Todo App API.

.Procedure
. In {prodname}, in the upper right, click *Publish* to give it a name.
. In {prodname}, in the upper right, click *Publish*.
. In the *Integration Name* field, enter a name for the
integration. For example, `*AMQ to REST API Sample Integration*`.
. Optionally, in the *Description* field, enter information that might be
helpful to know about this integration.
. In the upper right corner, click *Publish*.
+
{prodname} displays the integration summary page with a progress
{prodname} starts to deploy the integration and then displays the
list of integrations in this environment. In the entry for your AMQ to
REST API integration, you can see a progress
indicator that shows the publishing stages.
{prodname} is generating the runtime for the integration and
will start it when the runtime is ready. This takes a few minutes.
Expand Down
2 changes: 1 addition & 1 deletion doc/tutorials/topics/p_amq2api-upload-todo-app-icon.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ to upload it.

. Display the To Do app icon:

.. In a new browser tab, paste the URL for your OpenAPI (Swagger) document.
.. In a new browser tab, paste the URL for your OpenAPI document.
.. At the end of the URL, replace `swagger.json` with `images/todo_icon.png`
and click *Enter* to display the icon. For example:
`\https://todo-app-proj217402.6a63.fuse-ignite.openshiftapps.com/images/todo_icon.png`.
Expand Down
6 changes: 2 additions & 4 deletions doc/tutorials/topics/p_sf2db-add-mapping-step.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,8 @@ fields in the sample database.
* The integration's finish connection is to the PostgresDB sample database.

.Procedure
. In {prodname}, in the left panel, hover over the plus sign immediately after the
start connection to display a pop-up in which you click *Add a Step*.

. Click *Data Mapper* and wait a few moments. When the data fields
. In {prodname}, in the visualization panel on the left, click the plus sign.
. On the *Choose a Step* page, click *Data Mapper* and wait a few moments. When the data fields
appear, the *Sources* panel on the left displays the Salesforce fields
and the *Target* panel on the right displays the database fields.

Expand Down
8 changes: 4 additions & 4 deletions doc/tutorials/topics/p_sf2db-choose-finish.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
= Choosing the finish connection

In {prodname}, to continue creating the Salesforce to database sample
integration, after you add the start connection, you add the finish connection
to the integration.
integration, after you add the start connection, you add the finish connection
to the integration.

.Prerequisites
* You added the Salesforce connection to the integration as the start connection.
Expand All @@ -19,7 +19,7 @@ This integration finishes by using the credentials
defined in this database connection to connect to the
provided sample database.

. On the *Choose an Action* page, click *Invoke SQL stored procedure*,
. On the *Choose an Action* page, click *Invoke stored procedure*,
which passes data to a stored procedure.

. In the *Procedure Name* field, click and select *add_lead*, which is the
Expand All @@ -28,4 +28,4 @@ The selected procedure determines the requirements for additional
steps in the integration, for example, which Salesforce data fields
need to be mapped to which database fields.

. Click *Done* to add the finish connection to the integration.
. Click *Next* to add the finish connection to the integration.
2 changes: 1 addition & 1 deletion doc/tutorials/topics/p_sf2db-choose-start.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Salesforce connection. If you specified the example name,
you would click *SF Connect 1*.
. On the *Choose an Action* page, click *On create*.
. In the *Object name* field, select *Lead*.
. Click *Done* to add the start connection to the integration.
. Click *Next* to add the start connection to the integration.

.Next step
When the integration is running, after connecting to Salesforce,
Expand Down
3 changes: 1 addition & 2 deletions doc/tutorials/topics/p_sf2db-confirm-works.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ in the fields that you mapped: *Company*, *Email*, *FirstName*,
*LastName*, *LeadSource*, *Status*, *Phone*, and *Rating*.
. In a new browser window, insert `*todo-*` in front of the URL
for your {prodname} environment. For example:
`\https://todo-app-proj7614.6a63.fuse-ignite.openshiftapps.com/`.
`\https://todo-app-proj761432.6a63.fuse-ignite.openshiftapps.com/`.
+
Your {prodname} environment provides the To Do app, which has a
REST API for accessing a database that contains tasks. In the AMQ to REST
Expand All @@ -37,7 +37,6 @@ OpenAPI (Swagger) document for the To Do app to create an API client connector.
. In the *To Do App* display, you should see a notification that a new
lead was created in the database.


. Optionally, view the integration log to troubleshoot an
unexpected result or to learn more about integration execution:

Expand Down
4 changes: 3 additions & 1 deletion doc/tutorials/topics/p_sf2db-name-and-publish.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,9 @@ integration. For example, `*Salesforce to Database Sample Integration*`.
. In the upper right corner, click *Publish*.

+
{prodname} displays the integration summary page with a progress
{prodname} starts to deploy the integration and then displays the list of
integrations in this environment. The entry for your Salesforce to
database integration displays a progress
indicator that shows the publishing stages.
{prodname} is generating the runtime for the integration and
will start it when the runtime is ready. This takes a few minutes.
Expand Down
6 changes: 4 additions & 2 deletions doc/tutorials/topics/p_t2sf-add-filter-step.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ continues only if that content is present.

.Procedure

. In the main panel, click *Add a step*.
. In the visualization panel on the left, click the plus sign, which
displays the steps that you can add to the integration.
. Click *Basic Filter*.

. In the first field (*The data you want to evaluate*), start to enter
Expand All @@ -25,7 +26,8 @@ filter for is in the Twitter `text` field, which contains the text of the tweet.

. Accept *contains* as the condition to be met for the integration to
continue.
. In the last field, enter `*#RedHatIsGreat*` or some other text you choose.
. In the last field, enter `*#RedHatIsGreat*` or some other text
that you choose for the value to check for.
A tweet that mentions you must contain the text you enter here for
the integration to continue operating on this data.
. Click *Done* to complete the basic filter step.
13 changes: 6 additions & 7 deletions doc/tutorials/topics/p_t2sf-add-mapping-step.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,9 @@ Salesforce contact fields.

.Procedure

. In {prodname}, in the left panel, hover over the plus sign between the filter
step and the finish connection to display a pop-up in which
you click *Add a Step*.
. Click *Data Mapper* and wait a few moments. When the data fields
. In {prodname}, in the visualization panel on the left, click the plus sign that is between the filter
step and the finish connection.
. On the *Choose a Step* page, click *Data Mapper* and wait a few moments. When the data fields
appear, the *Sources* panel on the left displays the Twitter fields
and the *Target* panel on the right displays the Salesforce fields.
. Map the Twitter `name` field to the Salesforce
Expand All @@ -30,8 +29,8 @@ to display the search field and enter `*name*`.
.. In the *Target* panel, scroll down and click *FirstName*. The
data mapper displays a line from the source *name* field to the
target *FirstName* field.
.. In the *Target* panel, scroll down, hover over *LastName*, and press
*CTRL-Mouse1* (*CMD-Mouse1* on MacOS) to select *LastName*.
.. In the *Target* panel, scroll down, hover over *LastName*, press
*CTRL-Mouse1* (*CMD-Mouse1* on MacOS) and select *LastName*.
The data mapper displays another line from the Twitter
*name* field, but this time it goes to the Salesforce *LastName* field.
The blue lines indicate the current focus.
Expand All @@ -49,7 +48,7 @@ mapping. Then click the trash can icon in the top right of the data mapper.

. Map the Twitter `screenName` field to the Salesforce
`Title` field:
.. In the *Sources* panel, scroll down to click
.. In the *Sources* panel, click
the *screenName* field.
.. On the right, at the top of the *Target* panel,
click the magnifying
Expand Down
2 changes: 1 addition & 1 deletion doc/tutorials/topics/p_t2sf-choose-finish.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,5 @@ defined in this connection to connect to Salesforce.
. On the *New record* page, click in the *Object name* field
and select *Contact* as the
Salesforce record to create.
. Click *Done* to add the finish
. Click *Next* to add the finish
connection to the integration.
5 changes: 2 additions & 3 deletions doc/tutorials/topics/p_t2sf-confirm-working.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
= Confirming that the Twitter to Salesforce integration works

To confirm that the Twitter to Salesforce sample integration is working,
tweet some messages and check for results in Salesforce.
create some tweets and check for results in Salesforce.

.Prerequisites

Expand All @@ -23,7 +23,7 @@ tweet does not contain the text you specified in the basic filter
step:
.. In Twitter, send a tweet that:
* Mentions your Twitter handle
* Does not contain the text you specified in the basic filter step
* Does not contain the text that you specified in the basic filter step
+
For example: `*@Aslan #likesRedHat.*`
.. Wait for the polling interval to elapse, which can be 30 - 60 seconds.
Expand All @@ -48,7 +48,6 @@ The new contact record should have the name that is associated with the
Twitter account that you used to tweet. The text of your tweet should be in the
*Description* field, and your Twitter screen name should be in the *Title* field.


. Optionally, view the integration log to troubleshoot an
unexpected result or to learn more about integration execution:

Expand Down
9 changes: 7 additions & 2 deletions doc/tutorials/topics/p_t2sf-name-and-publish.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,19 @@ can deploy it and see how it works.
* You just added a data mapping step to the integration.

.Procedure
. In {prodname}, at the top of the left panel, in the *Integration Name* field,
. In the upper right corner, click *Publish*.
. In the *Integration Name* field,
enter a name of your choice that distinguishes this integration
from any other integrations. For
example: `*Twitter to Salesforce Sample Integration*`.
. In the *Description* field, optionally enter some information
about the integration.
. In the upper right corner, click *Publish*.

+
{prodname} displays the integration summary page with a progress
{prodname} starts to deploy the integration and then displays the list
of integrations in this environment. In the entry for your Twitter to
Salesforce integration, you can see a progress
indicator that shows the publishing stages.
{prodname} is generating the runtime for the integration and
will start it when the runtime is ready. This takes a few minutes.
Expand Down

0 comments on commit 4a0fabb

Please sign in to comment.