This is an automated email from the ASF dual-hosted git repository.
mbrohl pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/ofbiz-framework.git
commit 63d1df79b8fb529c65d44c7ccac56632f2442287
Author: holivier <holiv...@apache.org>
AuthorDate: Wed Feb 12 17:51:56 2020 +0100
Documented: Payment-gateway Docbook files migration to asciidoc format
(OFBIZ-10294)
All the help files associated to it are called via include in the main
document.
Merge (and call included) all helps about payment-gatway-config and
payment-gateway-transaction in this file
---
.../HELP_ACCOUNTING_AuthorizeTransaction.xml | 102 ---------------------
.../HELP_ACCOUNTING_CaptureTransaction.xml | 55 -----------
.../HELP_ACCOUNTING_EditPaymentGatewayConfig.xml | 42 ---------
...ELP_ACCOUNTING_EditPaymentGatewayConfigType.xml | 23 -----
.../HELP_ACCOUNTING_FindGatewayResponses.xml | 44 ---------
.../HELP_ACCOUNTING_FindPaymentGatewayConfig.xml | 23 -----
...LP_ACCOUNTING_FindPaymentGatewayConfigTypes.xml | 25 -----
.../helpdata/HELP_ACCOUNTING_ManualTransaction.xml | 74 ---------------
.../HELP_ACCOUNTING_ViewGatewayResponse.xml | 26 ------
.../helpdata/HELP_ACCOUNTING_payment_gateway.xml | 35 -------
.../HELP_ACCOUNTING_payment_gateway_config.xml | 44 ---------
.../_include/HELP_AuthorizeTransaction.adoc | 67 ++++++++++++++
.../asciidoc/_include/HELP_CaptureTransaction.adoc | 39 ++++++++
.../_include/HELP_EditPaymentGatewayConfig.adoc | 30 ++++++
.../_include/HELP_FindGatewayResponses.adoc | 31 +++++++
.../asciidoc/_include/HELP_ManualTransaction.adoc | 43 +++++++++
.../_include/HELP_ViewGatewayResponse.adoc | 26 ++++++
.../asciidoc/_include/acc-payment-gateway.adoc | 60 ++++++++++++
.../accounting/src/docs/asciidoc/accounting.adoc | 2 +
19 files changed, 298 insertions(+), 493 deletions(-)
diff --git
a/applications/accounting/data/helpdata/HELP_ACCOUNTING_AuthorizeTransaction.xml
b/applications/accounting/data/helpdata/HELP_ACCOUNTING_AuthorizeTransaction.xml
deleted file mode 100644
index ca0f3d2..0000000
---
a/applications/accounting/data/helpdata/HELP_ACCOUNTING_AuthorizeTransaction.xml
+++ /dev/null
@@ -1,102 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to you under the Apache License, Version
-2.0 (the "License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-http://www.apache.org/licenses/LICENSE-2.0 Unless required by
-applicable law or agreed to in writing, software distributed under the
-License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-CONDITIONS OF ANY KIND, either express or implied. See the License for
-the specific language governing permissions and limitations under the
-License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; version="5.0"
- xmlns:xl="http://www.w3.org/1999/xlink";
xmlns:xi="http://www.w3.org/2001/XInclude";
- xsi:schemaLocation="http://docbook.org/ns/docbook
../../../content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook";>
- <title>The Authorize Transaction help screen</title>
- <para>An authorization is a temporary transaction that shows a commitment
to take money from an
- account.</para>
- <para>The 'Authorize' process is the first step in allowing a sales
transaction payment to be
- accepted. In OFBiz a service would be defined to carry out the
authorisation process each
- time for example, a credit card is used. It will perform specific
validation tests before
- the payment can be classes as 'authorised'. </para>
- <para>When a payment is authorised it means that it has been validated and
that the credit card
- or bank account has been checked to ensure that it has sufficient
funds available to cover
- the proposed transaction. A number or code may be issued as evidence
of the
- authorisation.</para>
- <para>NOTE: In the 'Payment' settings for a store as part of the Product
Payment setup the user
- can specify various services that will process a payment transactions
through to completion.
- This includes the following:</para>
- <para>
- <itemizedlist>
- <listitem>
- <para>Payment Authorisation</para>
- </listitem>
- <listitem>
- <para>Payment Capture</para>
- </listitem>
- <listitem>
- <para>Payment Credit</para>
- </listitem>
- <listitem>
- <para>Payment Authentication Verification</para>
- </listitem>
- <listitem>
- <para>Payment Re-Authorisation</para>
- </listitem>
- <listitem>
- <para>Payment Refund</para>
- </listitem>
- <listitem>
- <para>Payment Release Authorisation </para>
- </listitem>
- </itemizedlist>
- </para>
- <para>This is used to provide verification and approval for the first step
of the sales
- transaction payment process.</para>
- <para>An 'Authorize' button is also displayed on Sales Order detail screen
if a Credit Card
- payment was specified for a sales order. This is probably a more
natural place for a payment
- transaction to be authorised.</para>
- <para>NOTE: Using OFBiz demo data if DemoCustomer uses their credit card
for payment then an
- transaction is created that is automatically authorised and can be
viewed using the Gateway
- Responses. </para>
- <section>
- <title>How do I create and authorise a transaction?</title>
- <para>
- <orderedlist>
- <listitem>
- <para>Enter the 'Order Id' of the sales order for which
payment is being
- made</para>
- </listitem>
- <listitem>
- <para>Enter the 'Order Payment Preference Id' (NOTE: This
is automatically
- generated at sales order creation and may be difficult
to find out...I found
- it by initially doing an order and then paying by
DemoCustomer's credit card
- and checking Gateway Responses for what was displayed
in that field for the
- order)</para>
- </listitem>
- <listitem>
- <para>Select the 'Payment Method Type' (NOTE TO CHECK:
What happens if you use
- other selections not just credit card?)</para>
- </listitem>
- <listitem>
- <para>Enter the 'Amount'</para>
- </listitem>
- <listitem>
- <para>Press the 'Authorize' button</para>
- </listitem>
- <listitem>
- <para>A new transaction should be displayed with the
status of authorised</para>
- </listitem>
- </orderedlist>
- </para>
- <para>NOTE: The demo data payment settings for the Payment
authorisation Service is set to
- always approve so no transactions will display here because of
this. Need to test and
- maybe try removing the 'always approve' to see if the transaction
will be created as
- 'unauthorised ' </para>
- </section>
-</section>
diff --git
a/applications/accounting/data/helpdata/HELP_ACCOUNTING_CaptureTransaction.xml
b/applications/accounting/data/helpdata/HELP_ACCOUNTING_CaptureTransaction.xml
deleted file mode 100644
index bf78587..0000000
---
a/applications/accounting/data/helpdata/HELP_ACCOUNTING_CaptureTransaction.xml
+++ /dev/null
@@ -1,55 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to you under the Apache License, Version
-2.0 (the "License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-http://www.apache.org/licenses/LICENSE-2.0 Unless required by
-applicable law or agreed to in writing, software distributed under the
-License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-CONDITIONS OF ANY KIND, either express or implied. See the License for
-the specific language governing permissions and limitations under the
-License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; version="5.0"
- xmlns:xl="http://www.w3.org/1999/xlink";
xmlns:xi="http://www.w3.org/2001/XInclude";
- xsi:schemaLocation="http://docbook.org/ns/docbook
../../../content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook";>
- <title>The Capture Transaction help screen. </title>
- <para>This screen is used to input or 'capture' a payment against a Sales
Order. Unlike the
- authorise, this function will actually deduct the amount from eg a
credit card and apply the
- payment to a specific order.</para>
- <para>It is likely that the before the payment is 'captured' in this
screen, it would have been
- through an authorisation first.</para>
- <para>NOTE TO CHECK: Investigate how this links in with the Payment
Gateway Configurations
- screens</para>
- <section>
- <title>How do I capture a transaction?</title>
- <para>
- <orderedlist>
- <listitem>
- <para>Enter the Order Id for the payment (eg Sales Order
Id)</para>
- </listitem>
- <listitem>
- <para>Enter Order Payment Preference Id (Unsure of what
this is...a type of
- unique identifier perhaps?)</para>
- </listitem>
- <listitem>
- <para>Select the 'Payment Method Type'</para>
- </listitem>
- <listitem>
- <para>Select the 'Payment Type'</para>
- </listitem>
- <listitem>
- <para>Enter the 'Amount'</para>
- </listitem>
- <listitem>
- <para>Press the 'Capture' button</para>
- </listitem>
- </orderedlist>
- </para>
- <para>A transaction will be created and can be viewed via the 'Gateway
Responses' tab</para>
- </section>
-</section>
diff --git
a/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditPaymentGatewayConfig.xml
b/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditPaymentGatewayConfig.xml
deleted file mode 100644
index eeed70a..0000000
---
a/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditPaymentGatewayConfig.xml
+++ /dev/null
@@ -1,42 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to you under the Apache License, Version
-2.0 (the "License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-http://www.apache.org/licenses/LICENSE-2.0 Unless required by
-applicable law or agreed to in writing, software distributed under the
-License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-CONDITIONS OF ANY KIND, either express or implied. See the License for
-the specific language governing permissions and limitations under the
-License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; version="5.0"
- xmlns:xl="http://www.w3.org/1999/xlink";
xmlns:xi="http://www.w3.org/2001/XInclude";
- xsi:schemaLocation="http://docbook.org/ns/docbook
../../../content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook";>
- <title>The Edit Payment Gateway Config help screen</title>
- <para>This screen allows the user to update the payment gateway
configuration.</para>
- <para>A range of parameters need to be set before the payment gateway will
work This includes
- details of the username and password required for the validation of
the external account
- that will be using the gateway.</para>
- <section>
- <title>How do I update a Payment Gateway Configuration?</title>
- <para>
- <orderedlist>
- <listitem>
- <para>Select the gateway Find Payment Gateway Config
screen</para>
- </listitem>
- <listitem>
- <para>Enter the details required for the configuration
type selected (NOTE: This
- will be different for each individual configuration
selected)</para>
- </listitem>
- <listitem>
- <para>Press the 'Update' button</para>
- </listitem>
- </orderedlist>
- </para>
- </section>
-</section>
diff --git
a/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditPaymentGatewayConfigType.xml
b/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditPaymentGatewayConfigType.xml
deleted file mode 100644
index 0856374..0000000
---
a/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditPaymentGatewayConfigType.xml
+++ /dev/null
@@ -1,23 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to you under the Apache License, Version
-2.0 (the "License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-http://www.apache.org/licenses/LICENSE-2.0 Unless required by
-applicable law or agreed to in writing, software distributed under the
-License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-CONDITIONS OF ANY KIND, either express or implied. See the License for
-the specific language governing permissions and limitations under the
-License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
- version="5.0" xmlns:xl="http://www.w3.org/1999/xlink";
xmlns:xi="http://www.w3.org/2001/XInclude";
- xsi:schemaLocation="http://docbook.org/ns/docbook
../../../content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook";>
- <title>The Edit Payment Gateway Config Type help screen</title>
- <para>This screen allows the update of an existing payment gateway
configuration type.</para>
- <para>NOTE: New Payment Gateway Configuration Types cannot be created via
this screen.</para>
-</section>
diff --git
a/applications/accounting/data/helpdata/HELP_ACCOUNTING_FindGatewayResponses.xml
b/applications/accounting/data/helpdata/HELP_ACCOUNTING_FindGatewayResponses.xml
deleted file mode 100644
index 867b87a..0000000
---
a/applications/accounting/data/helpdata/HELP_ACCOUNTING_FindGatewayResponses.xml
+++ /dev/null
@@ -1,44 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to you under the Apache License, Version
-2.0 (the "License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-http://www.apache.org/licenses/LICENSE-2.0 Unless required by
-applicable law or agreed to in writing, software distributed under the
-License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-CONDITIONS OF ANY KIND, either express or implied. See the License for
-the specific language governing permissions and limitations under the
-License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; version="5.0"
- xmlns:xl="http://www.w3.org/1999/xlink";
xmlns:xi="http://www.w3.org/2001/XInclude";
- xsi:schemaLocation="http://docbook.org/ns/docbook
../../../content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook";>
- <title>The Find Gateway Responses help screen</title>
- <para>This is the default screen for the 'Transactions' sub menu. Press
the 'Lookup' button to
- display details of all transactions that have been authorised,
captured or manually
- entered.</para>
- <section>
- <title>How do I view all Gateway response transactions?</title>
- <para>
- <orderedlist>
- <listitem>
- <para>Press the 'Lookup' button</para>
- </listitem>
- </orderedlist>
- </para>
- <para>A list of all transactions that have been authorised, captured
or manually entered
- will be displayed.</para>
- </section>
- <section>
- <title>Transaction results (external link)</title>
- <para>
- <link
xl:href="http://www.authorize.net/support/merchant/Transaction_Response/Transaction_Response.htm";>
- List of all the transaction results
- </link>
- </para>
- </section>
-</section>
diff --git
a/applications/accounting/data/helpdata/HELP_ACCOUNTING_FindPaymentGatewayConfig.xml
b/applications/accounting/data/helpdata/HELP_ACCOUNTING_FindPaymentGatewayConfig.xml
deleted file mode 100644
index eccc31e..0000000
---
a/applications/accounting/data/helpdata/HELP_ACCOUNTING_FindPaymentGatewayConfig.xml
+++ /dev/null
@@ -1,23 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to you under the Apache License, Version
-2.0 (the "License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-http://www.apache.org/licenses/LICENSE-2.0 Unless required by
-applicable law or agreed to in writing, software distributed under the
-License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-CONDITIONS OF ANY KIND, either express or implied. See the License for
-the specific language governing permissions and limitations under the
-License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
- version="5.0" xmlns:xl="http://www.w3.org/1999/xlink";
xmlns:xi="http://www.w3.org/2001/XInclude";
- xsi:schemaLocation="http://docbook.org/ns/docbook
../../../content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook";>
- <title>The Find Payment Gateway Config help screen</title>
- <para>The default screen allows the user to search for any payment gateway
configurations that are setup.</para>
- <para>Press the 'Lookup' button to see a list of existing
configurations.</para>
-</section>
diff --git
a/applications/accounting/data/helpdata/HELP_ACCOUNTING_FindPaymentGatewayConfigTypes.xml
b/applications/accounting/data/helpdata/HELP_ACCOUNTING_FindPaymentGatewayConfigTypes.xml
deleted file mode 100644
index fdf74aa..0000000
---
a/applications/accounting/data/helpdata/HELP_ACCOUNTING_FindPaymentGatewayConfigTypes.xml
+++ /dev/null
@@ -1,25 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to you under the Apache License, Version
-2.0 (the "License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-http://www.apache.org/licenses/LICENSE-2.0 Unless required by
-applicable law or agreed to in writing, software distributed under the
-License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-CONDITIONS OF ANY KIND, either express or implied. See the License for
-the specific language governing permissions and limitations under the
-License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
- version="5.0" xmlns:xl="http://www.w3.org/1999/xlink";
xmlns:xi="http://www.w3.org/2001/XInclude";
- xsi:schemaLocation="http://docbook.org/ns/docbook
../../../content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook";>
- <title>The Find Payment Gateway Config Types help screen</title>
- <para>This screen lists some of the most common payment gateway
- configuration types that have been created as part of the seed or demo
- data.</para>
- <para>Press the 'Lookup' button to see a list of existing payment
gateway configuration types.</para>
-</section>
diff --git
a/applications/accounting/data/helpdata/HELP_ACCOUNTING_ManualTransaction.xml
b/applications/accounting/data/helpdata/HELP_ACCOUNTING_ManualTransaction.xml
deleted file mode 100644
index bbb1a50..0000000
---
a/applications/accounting/data/helpdata/HELP_ACCOUNTING_ManualTransaction.xml
+++ /dev/null
@@ -1,74 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to you under the Apache License, Version
-2.0 (the "License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-http://www.apache.org/licenses/LICENSE-2.0 Unless required by
-applicable law or agreed to in writing, software distributed under the
-License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-CONDITIONS OF ANY KIND, either express or implied. See the License for
-the specific language governing permissions and limitations under the
-License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; version="5.0"
- xmlns:xl="http://www.w3.org/1999/xlink";
xmlns:xi="http://www.w3.org/2001/XInclude";
- xsi:schemaLocation="http://docbook.org/ns/docbook
../../../content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook";>
- <title>The Manual Transaction help screen</title>
- <para>The Manual Electronic Transaction screen allows the user to manually
input and process
- payment related transactions.</para>
- <para>Options available include the following:</para>
- <para>
- <itemizedlist>
- <listitem>
- <para>Authorising payment transactions</para>
- </listitem>
- <listitem>
- <para>Refunding payments</para>
- </listitem>
- <listitem>
- <para>Payment Re-Authorisation</para>
- </listitem>
- <listitem>
- <para>Payment Capture</para>
- </listitem>
- </itemizedlist>
- </para>
- <section>
- <title>How do I create a manual electronic transaction?</title>
- <para>
- <orderedlist>
- <listitem>
- <para>Select the 'Payment Method Type' (eg Credit
Card)</para>
- </listitem>
- <listitem>
- <para>Select the 'Product Store'</para>
- </listitem>
- <listitem>
- <para>Select the 'Transaction Type' (NOTE: This is the
type of transaction that
- needs to be created, eg authorisation, capture,refund
etc)</para>
- </listitem>
- </orderedlist>
- </para>
- <para>Additional fields will be displayed </para>
- <para>
- <orderedlist>
- <listitem>
- <para>Enter the required details (eg name, credit card,
billing address, amount
- etc)</para>
- </listitem>
- <listitem>
- <para>Press the 'Submit' button</para>
- </listitem>
- </orderedlist>
- </para>
- <para>A transsaction will be created that can be viewed via the
Gateway Transactions
- screen</para>
- <para>NOTE TO CHECK: Possible bug as could not get this to work using
'Payment Authorisation
- Service' and error message appeared regarding a missing parameter
missing for Order
- Preference Id but the Order Preference Id was not displayed on the
screen</para>
- </section>
-</section>
diff --git
a/applications/accounting/data/helpdata/HELP_ACCOUNTING_ViewGatewayResponse.xml
b/applications/accounting/data/helpdata/HELP_ACCOUNTING_ViewGatewayResponse.xml
deleted file mode 100644
index 585d6b8..0000000
---
a/applications/accounting/data/helpdata/HELP_ACCOUNTING_ViewGatewayResponse.xml
+++ /dev/null
@@ -1,26 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to you under the Apache License, Version
-2.0 (the "License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-http://www.apache.org/licenses/LICENSE-2.0 Unless required by
-applicable law or agreed to in writing, software distributed under the
-License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-CONDITIONS OF ANY KIND, either express or implied. See the License for
-the specific language governing permissions and limitations under the
-License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
- version="5.0" xmlns:xl="http://www.w3.org/1999/xlink";
xmlns:xi="http://www.w3.org/2001/XInclude";
- xsi:schemaLocation="http://docbook.org/ns/docbook
../../../content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook";>
- <title>The View Gateway Response help screen</title>
- <para>This screen shows details of an individual gateway transaction.
- It displays specific information regarding the order and the payment.
- The lower part of the screen shows the gateway response details
- indicating the time and codes used to process the transaction through
- the gateway.</para>
-</section>
diff --git
a/applications/accounting/data/helpdata/HELP_ACCOUNTING_payment_gateway.xml
b/applications/accounting/data/helpdata/HELP_ACCOUNTING_payment_gateway.xml
deleted file mode 100644
index 00a1474..0000000
--- a/applications/accounting/data/helpdata/HELP_ACCOUNTING_payment_gateway.xml
+++ /dev/null
@@ -1,35 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
- <!--
- Licensed to the Apache Software Foundation (ASF) under one or
- more contributor license agreements. See the NOTICE file
- distributed with this work for additional information regarding
- copyright ownership. The ASF licenses this file to you under the
- Apache License, Version 2.0 (the "License"); you may not use
- this file except in compliance with the License. You may obtain
- a copy of the License at
- http://www.apache.org/licenses/LICENSE-2.0 Unless required by
- applicable law or agreed to in writing, software distributed
- under the License is distributed on an "AS IS" BASIS, WITHOUT
- WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions
- and limitations under the License.
- -->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
- version="5.0" xmlns:xl="http://www.w3.org/1999/xlink";
xmlns:xi="http://www.w3.org/2001/XInclude";
- xsi:schemaLocation="http://docbook.org/ns/docbook
../../../content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook";>
- <title>Payment Gateway Transactions.</title>
- <para>The Payment Gateway is made up of a configurable interface
- that
- processes payments.</para>
- <para>Payment transactions can be authorised, captured and processed
- or
- refunded via the selected mechanism. (eg Paypal, Authorise.net, etc)
- </para>
- <xi:include href="HELP_ACCOUNTING_FindGatewayResponses.xml" />
- <xi:include href="HELP_ACCOUNTING_AuthorizeTransaction.xml" />
- <xi:include href="HELP_ACCOUNTING_CaptureTransaction.xml" />
- <xi:include href="HELP_ACCOUNTING_ViewGatewayResponse.xml" />
- <xi:include href="HELP_ACCOUNTING_ManualTransaction.xml" />
-
-</section>
diff --git
a/applications/accounting/data/helpdata/HELP_ACCOUNTING_payment_gateway_config.xml
b/applications/accounting/data/helpdata/HELP_ACCOUNTING_payment_gateway_config.xml
deleted file mode 100644
index 6de03a5..0000000
---
a/applications/accounting/data/helpdata/HELP_ACCOUNTING_payment_gateway_config.xml
+++ /dev/null
@@ -1,44 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to you under the Apache License, Version
-2.0 (the "License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-http://www.apache.org/licenses/LICENSE-2.0 Unless required by
-applicable law or agreed to in writing, software distributed under the
-License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-CONDITIONS OF ANY KIND, either express or implied. See the License for
-the specific language governing permissions and limitations under the
-License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; version="5.0"
- xmlns:xl="http://www.w3.org/1999/xlink";
xmlns:xi="http://www.w3.org/2001/XInclude";
- xsi:schemaLocation="http://docbook.org/ns/docbook
../../../content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook";>
- <title>Payment Gateway Config.</title>
- <para>Payment Gateway Configuration is used to setup the parameters
required for the system to
- accept payments via different or external applications</para>
- <para>Examples of these include:</para>
- <para>
- <itemizedlist>
- <listitem>
- <para>Paypal</para>
- </listitem>
- <listitem>
- <para>PayFlow</para>
- </listitem>
- <listitem>
- <para>Authorise.net</para>
- </listitem>
- <listitem>
- <para>Clear Commerce</para>
- </listitem>
- </itemizedlist>
- </para>
- <xi:include href="HELP_ACCOUNTING_FindPaymentGatewayConfig.xml"/>
- <xi:include href="HELP_ACCOUNTING_EditPaymentGatewayConfig.xml"/>
- <xi:include href="HELP_ACCOUNTING_FindPaymentGatewayConfigTypes.xml"/>
- <xi:include href="HELP_ACCOUNTING_EditPaymentGatewayConfigType.xml"/>
-</section>
diff --git
a/applications/accounting/src/docs/asciidoc/_include/HELP_AuthorizeTransaction.adoc
b/applications/accounting/src/docs/asciidoc/_include/HELP_AuthorizeTransaction.adoc
new file mode 100644
index 0000000..d90064d
--- /dev/null
+++
b/applications/accounting/src/docs/asciidoc/_include/HELP_AuthorizeTransaction.adoc
@@ -0,0 +1,67 @@
+////
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+////
+= Help for The Authorize Transaction
+An authorization is a temporary transaction that shows a commitment to take
money from an account.
+
+The 'Authorize' process is the first step in allowing a sales transaction
payment to be accepted. +
+In OFBiz a service would be defined to carry out the authorisation process
each time for example, a credit card is used.
+It will perform specific validation tests before the payment can be classes as
'authorised'.
+
+When a payment is authorised it means that it has been validated and that the
credit card or bank account has been checked
+to ensure that it has sufficient funds available to cover the proposed
transaction. +
+A number or code may be issued as evidence of the authorisation.
+
+NOTE: In the 'Payment' settings for a store as part of the Product Payment
setup the user can specify various services that
+ will process a payment transactions through to completion.
+
+This includes the following:
+
+* Payment Authorisation
+* Payment Capture
+* Payment Credit
+* Payment Authentication Verification
+* Payment Re-Authorisation
+* Payment Refund
+* Payment Release Authorisation
+
+This is used to provide verification and approval for the first step of the
sales transaction payment process.
+
+An 'Authorize' button is also displayed on Sales Order detail screen if a
Credit Card payment was specified for a sales order.
+This is probably a more natural place for a payment transaction to be
authorised.
+
+NOTE: Using OFBiz demo data if DemoCustomer uses their credit card for payment
then an transaction is created that is
+ automatically authorised and can be viewed using the Gateway Responses.
+
+== How do I create and authorise a transaction?
+. Enter the 'Order Id' of the sales order for which payment is being made
+. Enter the 'Order Payment Preference Id' +
+ (NOTE: This is automatically generated at sales order creation and may be
difficult to find out... +
+ I found it by initially doing an order and then paying by DemoCustomer's
credit card and checking Gateway Responses for what
+ was displayed in that field for the order)
+. Select the 'Payment Method Type' +
+ (NOTE TO CHECK: What happens if you use other selections not just credit
card?)
+. Enter the 'Amount'
+. Press the 'Authorize' button
+. A new transaction should be displayed with the status of authorised
+
+NOTE: The demo data payment settings for the Payment authorisation Service is
set to always approve so no transactions
+ will display here because of this. +
+ TO CHECK: Need to test and maybe try removing the 'always approve' to
see if the transaction will be created
+ as 'unauthorised'
+
\ No newline at end of file
diff --git
a/applications/accounting/src/docs/asciidoc/_include/HELP_CaptureTransaction.adoc
b/applications/accounting/src/docs/asciidoc/_include/HELP_CaptureTransaction.adoc
new file mode 100644
index 0000000..cc735ed
--- /dev/null
+++
b/applications/accounting/src/docs/asciidoc/_include/HELP_CaptureTransaction.adoc
@@ -0,0 +1,39 @@
+////
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+////
+
+= Help for Capture Transaction
+This screen is used to input or 'capture' a payment against a Sales Order.
+
+Unlike the authorise, this function will actually deduct the amount from eg a
credit card and apply the payment
+to a specific order.
+
+It is likely that the before the payment is 'captured' in this screen, it
would have been through an authorisation first.
+
+NOTE: TO CHECK: Investigate how this links in with the Payment Gateway
Configurations screens
+
+== How do I capture a transaction?
+. Enter the Order Id for the payment (eg Sales Order Id)
+. Enter Order Payment Preference Id +
+ (TO CHECK Unsure of what this is...a type of unique identifier perhaps?)
+. Select the 'Payment Method Type'
+. Select the 'Payment Type'
+. Enter the 'Amount'
+. Press the 'Capture' button
+
+A transaction will be created and can be viewed via the 'Gateway Responses'
screen.
\ No newline at end of file
diff --git
a/applications/accounting/src/docs/asciidoc/_include/HELP_EditPaymentGatewayConfig.adoc
b/applications/accounting/src/docs/asciidoc/_include/HELP_EditPaymentGatewayConfig.adoc
new file mode 100644
index 0000000..0aa85bc
--- /dev/null
+++
b/applications/accounting/src/docs/asciidoc/_include/HELP_EditPaymentGatewayConfig.adoc
@@ -0,0 +1,30 @@
+////
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+////
+
+= Help for Edit Payment Gateway Config
+This screen allows the user to update the payment gateway configuration.
+
+A range of parameters need to be set before the payment gateway will work This
includes details of the username and password
+required for the validation of the external account that will be using the
gateway.
+
+== How do I update a Payment Gateway Configuration?
+. Select the gateway Find Payment Gateway Config screen
+. Enter the details required for the configuration type selected +
+ (NOTE: This will be different for each individual configuration selected)
+. Press the 'Update' button
diff --git
a/applications/accounting/src/docs/asciidoc/_include/HELP_FindGatewayResponses.adoc
b/applications/accounting/src/docs/asciidoc/_include/HELP_FindGatewayResponses.adoc
new file mode 100644
index 0000000..71f8e20
--- /dev/null
+++
b/applications/accounting/src/docs/asciidoc/_include/HELP_FindGatewayResponses.adoc
@@ -0,0 +1,31 @@
+////
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+////
+
+= Help for Find Gateway Responses
+This is the default screen for the 'Transactions' sub menu. +
+Press the 'Lookup' button to display details of all transactions that have
been authorised, captured or manually entered.
+
+== How do I view all Gateway response transactions?
+. Press the 'Lookup' button
+
+A list of all transactions that have been authorised, captured or manually
entered will be displayed.
+
+== Transaction results (external link)
+http://www.authorize.net/support/merchant/Transaction_Response/Transaction_Response.htm
+
+can give the List of all the transaction results
diff --git
a/applications/accounting/src/docs/asciidoc/_include/HELP_ManualTransaction.adoc
b/applications/accounting/src/docs/asciidoc/_include/HELP_ManualTransaction.adoc
new file mode 100644
index 0000000..a97f878
--- /dev/null
+++
b/applications/accounting/src/docs/asciidoc/_include/HELP_ManualTransaction.adoc
@@ -0,0 +1,43 @@
+////
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+////
+= Help for Manual Transaction
+
+The Manual Electronic Transaction screen allows the user to manually input and
process payment related transactions.
+
+Options available include the following:
+
+* Authorising payment transactions
+* Refunding payments
+* Payment Re-Authorisation
+* Payment Capture
+
+
+== How do I create a manual electronic transaction?
+. Select the 'Payment Method Type' (eg Credit Card)
+. Select the 'Product Store'
+. Select the 'Transaction Type' +
+ (NOTE: This is the type of transaction that needs to be created, eg
authorisation, capture,refund etc) +
+ Additional fields will be displayed
+. Enter the required details (eg name, credit card, billing address, amount
etc)
+. Press the 'Submit' button
+
+A transsaction will be created that can be viewed via the Gateway Transactions
screen
+
+NOTE: TO CHECK: Possible bug as could not get this to work using 'Payment
Authorisation Service' and error message appeared
+ regarding a missing parameter missing for Order Preference Id but the
Order Preference Id was not displayed on the screen
diff --git
a/applications/accounting/src/docs/asciidoc/_include/HELP_ViewGatewayResponse.adoc
b/applications/accounting/src/docs/asciidoc/_include/HELP_ViewGatewayResponse.adoc
new file mode 100644
index 0000000..7a3ce66
--- /dev/null
+++
b/applications/accounting/src/docs/asciidoc/_include/HELP_ViewGatewayResponse.adoc
@@ -0,0 +1,26 @@
+////
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+////
+= Help for View Gateway Response
+
+This screen shows details of an individual gateway transaction.
+
+It displays specific information regarding the order and the payment.
+
+The lower part of the screen shows the gateway response details indicating the
time and codes used to process the transaction
+through the gateway.
\ No newline at end of file
diff --git
a/applications/accounting/src/docs/asciidoc/_include/acc-payment-gateway.adoc
b/applications/accounting/src/docs/asciidoc/_include/acc-payment-gateway.adoc
new file mode 100644
index 0000000..178d0a7
--- /dev/null
+++
b/applications/accounting/src/docs/asciidoc/_include/acc-payment-gateway.adoc
@@ -0,0 +1,60 @@
+////
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+////
+= Payment Gateway
+
+The Payment Gateway is made up of a configurable interface that processes
payments.
+
+Before using using them, it's needed to config them. +
+*Payment Gateway Configuration* is used to setup the parameters required for
the system to accept payments via different or
+ external applications
+
+Examples of these include:
+
+* Paypal
+* PayFlow
+* Authorise.net
+* Clear Commerce
+
+When config is done, *Payment transactions* can be authorised, captured and
processed or refunded via the selected mechanism,
+(eg Paypal, Authorise.net, etc) more details are explained in
<<_payment_transaction_management_in_user_interface>>
+
+== Payment Gateway Config management in User Interface
+include::HELP_EditPaymentGatewayConfig.adoc[leveloffset=+2]
+
+=== Help for Find Payment Gateway Config Types
+This screen lists some of the most common payment gateway configuration types
that have been created as part of
+ the seed or demo data.
+
+Press the 'Lookup' button to see a list of existing payment gateway
configuration types.
+
+=== Help for Edit Payment Gateway Config Type
+This screen allows the update of an existing payment gateway configuration
type.
+
+NOTE: New Payment Gateway Configuration Types cannot be created via this
screen.
+
+== Payment Transaction management in User Interface
+include::HELP_FindGatewayResponses.adoc[leveloffset=+2]
+
+include::HELP_AuthorizeTransaction.adoc[leveloffset=+2]
+
+include::HELP_CaptureTransaction.adoc[leveloffset=+2]
+
+include::HELP_ViewGatewayResponse.adoc[leveloffset=+2]
+
+include::HELP_ManualTransaction.adoc[leveloffset=+2]
diff --git a/applications/accounting/src/docs/asciidoc/accounting.adoc
b/applications/accounting/src/docs/asciidoc/accounting.adoc
index 433df93..b70966a 100644
--- a/applications/accounting/src/docs/asciidoc/accounting.adoc
+++ b/applications/accounting/src/docs/asciidoc/accounting.adoc
@@ -32,6 +32,8 @@ include::_include/acc-invoices.adoc[leveloffset=+1]
include::_include/acc-payments.adoc[leveloffset=+1]
+include::_include/acc-payments-gateway.adoc[leveloffset=+1]
+
include::_include/acc-agreements.adoc[leveloffset=+1]
include::_include/acc-financial-accounts.adoc[leveloffset=+1]
