Skip to content

Commit

Permalink
Edit format
Browse files Browse the repository at this point in the history
  • Loading branch information
chelseacheung committed Jan 26, 2017
1 parent 2a3c735 commit 2e36935
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 19 deletions.
22 changes: 10 additions & 12 deletions docs/source/as2_partnership.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ AS2 From
| | |
| | This field is **mandatory** and it is **RECOMMENDED** that the length of this value be less than 255 characters. |
| | |
| | See :ref:`note <note>` below. |
| | See note below. |
+-----------------+------------------------------------------------------------------------------------------------------------------+

AS2 To
Expand All @@ -71,17 +71,15 @@ AS2 To
| | |
| | This field is **mandatory** and it is **RECOMMENDED** that the length of this value be less than 255 characters. |
| | |
| | See :ref:`note <note>` below. |
| | See note below. |
+-----------------+------------------------------------------------------------------------------------------------------------------+

.. _note:
.. note::
`AS2 From`_ and `AS2 To`_ form a pair that identify the **send** and **recieve** partnerships (i.e. they form a composite key that identifies the parties involved in the data exchange).

| **NOTE**:
| `AS2 From`_ and `AS2 To`_ form a pair that identify the **send** and **recieve** partnerships (i.e. they form a composite key that identifies the parties involved in the data exchange).
The values of [``AS2 From``, ``AS2 To``] are reversed in the **receive** partnership with respect to the **send** partnership. For example:
The values of [``AS2 From``, ``AS2 To``] are reversed in the **receive** partnership with respect to the **send** partnership. For example:

**Send**: [``CompanyA``, ``CompanyB``] --> **Receive**: [``CompanyB``, ``CompanyA``].
**Send**: [``CompanyA``, ``CompanyB``] --> **Receive**: [``CompanyB``, ``CompanyA``].

Disabled
^^^^^^^^
Expand Down Expand Up @@ -195,14 +193,14 @@ Asynchronous Receipt
| **Options** | [ ``true`` = asynchronous reply ], [ ``false`` = synchronous reply ] |
+------------------+-----------------------------------------------------------------------------------------------------------------+

Synchronous reply
~~~~~~~~~~~~~~~~~~~~~~
**Synchronous reply**

AS2 message receipts are encapsulated in the HTTP response.

.. image:: /_static/images/first_step/as2-send-sync.png

Asynchronous reply
~~~~~~~~~~~~~~~~~~
**Asynchronous reply**

AS2 message receipts will be delivered through another HTTP connection from recipient to sender.

.. image:: /_static/images/first_step/as2-send-async.png
Expand Down
8 changes: 4 additions & 4 deletions docs/source/ebms_partnership.rst
Original file line number Diff line number Diff line change
Expand Up @@ -117,15 +117,15 @@ Sync Reply Mode
| **Options** | [ ``mshSignalsOnly`` = synchronous reply ], [ ``none`` = asynchronous reply ] |
+-----------------+------------------------------------------------------------------------------------------------------------------+

Synchronous reply
~~~~~~~~~~~~~~~~~
**Synchronous reply**

ebMS message acknowledgement is included in the HTTP/SOAP response.

.. image:: /_static/images/first_step/ebms-send-sync.png


Asynchronous reply
~~~~~~~~~~~~~~~~~~
**Asynchronous reply**

ebMS message acknowledgement will be delivered through another HTTP/SOAP connection from the recipient to the sender.

.. image:: /_static/images/first_step/ebms-send-async.png
Expand Down
3 changes: 2 additions & 1 deletion docs/source/first_step.rst
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,8 @@ For an AS2 partnership, the **AS2 From** and **AS2 To** fields in a partnership
* In a sending partnership, these values are taken as the values in the headers of outgoing messages.
* In a receiving partnership, these values are taken as filtering criteria. If Hermes 2 receives an AS2 message whose **AS2 From** and **AS2 To** values do not have a matching partnership, the incoming message is rejected/ignored and no application can retrieve the message on the receiving side.

**NOTE**: The values of **AS2 From** and **AS2 To** in the incoming AS2 message are interchanged before finding the matching partnership (i.e. the filtering criteria [AS2 From, AS2 To] = [Incoming AS2 To, Incoming AS2 From] in the AS2 message).
.. note::
The values of **AS2 From** and **AS2 To** in the incoming AS2 message are interchanged before finding the matching partnership (i.e. the filtering criteria **[AS2 From, AS2 To] = [Incoming AS2 To, Incoming AS2 From]** in the AS2 message).

Although the values of **AS2 From** and **AS2 To** have no constraints, it is highly recommended that they be company specific, such as Data Universal Numbering System (DUNS) numbers, or simply identification strings agreed upon between trading partners.

Expand Down
3 changes: 2 additions & 1 deletion docs/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,8 @@ Prerequisite
#. Edit :file:`/etc/systemd/system/tomcat.service`. Change :envvar:`Environment=JAVA_HOME=/usr/lib/jvm/java-1.8.0-openjdk-amd64/jre` to :envvar:`Environment=JAVA_HOME=/usr/lib/jvm/java-8-oracle/jre`
#. Restart Tomcat

**Note:** To access the admin page, you will need to have a Tomcat user with an admin role. One way to do this is to define the user in :file:`tomcat-users.xml`. Please refer to the Realm Configuration section in the Tomcat documentation for more details.
.. note::
To access the admin page, you will need to have a Tomcat user with an admin role. One way to do this is to define the user in :file:`tomcat-users.xml`. Please refer to the Realm Configuration section in the Tomcat documentation for more details.

Sample of :file:`tomcat-user.xml`:

Expand Down
3 changes: 2 additions & 1 deletion docs/source/java_client.rst
Original file line number Diff line number Diff line change
Expand Up @@ -578,7 +578,8 @@ We need to create a SOAP message with 3 parameters and send it to Hermes 2 as th
#. Attach a payload if necessary. The example here uses a purchase order XML as the payload of the AS2 message, so the associated content type is ``application/xml``.
**NOTE:** Only ONE payload is allowed in a SOAP request for the AS2 sender web service.
.. note::
Only **ONE** payload is allowed in a SOAP request for the AS2 sender web service.
.. code-block:: java
Expand Down

0 comments on commit 2e36935

Please sign in to comment.