You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ofbiz.apache.org by ha...@apache.org on 2009/12/23 05:18:37 UTC
svn commit: r893401 - in /ofbiz/trunk/applications/accounting:
data/helpdata/ documents/
Author: hansbak
Date: Wed Dec 23 04:18:37 2009
New Revision: 893401
URL: http://svn.apache.org/viewvc?rev=893401&view=rev
Log:
Accounting aggreements help screens a contribution of Sharan
OFBIZ-3372
Modified:
ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreement.xml
ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreementGeographicalApplic.xml
ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreementItem.xml
ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreementItemParty.xml
ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreementItemProduct.xml
ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreementItemSupplierProduct.xml
ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreementItemTerm.xml
ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreementRoles.xml
ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreementTerms.xml
ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreementWorkEffortApplics.xml
ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_FindAgreement.xml
ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_ListAgreementGeographicalApplic.xml
ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_ListAgreementItemParties.xml
ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_ListAgreementItemProducts.xml
ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_ListAgreementItemSupplierProducts.xml
ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_ListAgreementItemTerms.xml
ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_ListAgreementItems.xml
ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_ListAgreementPromoAppls.xml
ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_agreements.xml
ofbiz/trunk/applications/accounting/documents/Accounting.xml
Modified: ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreement.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreement.xml?rev=893401&r1=893400&r2=893401&view=diff
==============================================================================
--- ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreement.xml (original)
+++ ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreement.xml Wed Dec 23 04:18:37 2009
@@ -18,5 +18,32 @@
xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
xmlns="http://docbook.org/ns/docbook">
<title>The Edit Agreement help screen</title>
- <para></para>
+ <para>The 'Agreement' sub menu is used to enter the basic details required for setting up a new
+ agreement or editing an existing one.</para>
+ <para>It can be used to create or update the following details for an Agreement:</para>
+ <itemizedlist>
+ <listitem><para>The parties the agreement is between and their roles</para></listitem>
+ <listitem><para>The agreement type (eg Sales, Purchase, Commission, Employment etc)</para></listitem>
+ <listitem><para>Specific products </para></listitem>
+ <listitem><para>Start and End Date</para></listitem>
+ <listitem><para>Description</para></listitem>
+ </itemizedlist>
+ <section>
+ <title>How do I edit an agreement?</title>
+ <orderedlist>
+ <listitem><para>Find the agreement that needs to be amended</para></listitem>
+ <listitem><para>Click on Agreement Id</para></listitem>
+ <listitem><para>The 'Edit Agreement' screen will be displayed</para></listitem>
+ <listitem><para>Amend the details required and press the 'Submit' button (NOTE: Additional agreement details can be updated via the other tabs eg Agreement Terms, Agreement Roles, Agreement Items and Agreement Work Effort Appls)</para></listitem>
+ </orderedlist>
+ </section>
+ <section>
+ <title>How do I copy an existing agreement?</title>
+ <orderedlist>
+ <listitem><para>Find the agreement that needs to be copied</para></listitem>
+ <listitem><para>Click on the Agreement Id</para></listitem>
+ <listitem><para>The 'Edit Agreement' screen will be displayed</para></listitem>
+ <listitem><para>At the bottom of the screen press the 'Copy' in the 'Copy Agreement' window (NOTE: The default tick boxes will copy the agreement terms, products and party. If not required then click on the boxes to stop them being copied)</para></listitem>
+ </orderedlist>
+ </section>
</section>
\ No newline at end of file
Modified: ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreementGeographicalApplic.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreementGeographicalApplic.xml?rev=893401&r1=893400&r2=893401&view=diff
==============================================================================
--- ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreementGeographicalApplic.xml (original)
+++ ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreementGeographicalApplic.xml Wed Dec 23 04:18:37 2009
@@ -18,5 +18,6 @@
xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
xmlns="http://docbook.org/ns/docbook">
<title>The Edit Agreement Geo help screen</title>
- <para></para>
+ <para>This screen is used to create a geographical location for an agreement item.</para>
+ <para>NOTE: A new entry can be created or removed but not updated.</para>
</section>
\ No newline at end of file
Modified: ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreementItem.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreementItem.xml?rev=893401&r1=893400&r2=893401&view=diff
==============================================================================
--- ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreementItem.xml (original)
+++ ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreementItem.xml Wed Dec 23 04:18:37 2009
@@ -18,5 +18,33 @@
xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
xmlns="http://docbook.org/ns/docbook">
<title>The Edit Agreement Item help screen</title>
- <para></para>
+ <para>This screen allows specific items to be added to agreement. Currently these are limited to the following:</para>
+ <itemizedlist>
+ <listitem><para>Pricing</para></listitem>
+ <listitem><para>Commission Rate</para></listitem>
+ <listitem><para>Sub-Agreement</para></listitem>
+ <listitem><para>Exhibit</para></listitem>
+ <listitem><para>Section</para></listitem>
+ </itemizedlist>
+ <section>
+ <title>How do I create an agreement item?</title>
+ <orderedlist>
+ <listitem><para>Press the 'Create Agreement Item' button</para></listitem>
+ <listitem><para>The 'Edit Agreement Item' screen is displayed</para></listitem>
+ <listitem><para>Select the 'Agreement Item Type Id' from the drop down box</para></listitem>
+ <listitem><para>Use the drop down box to select the 'Currency' for the Agreement Item</para></listitem>
+ <listitem><para>Enter any 'Agreement Text' if required</para></listitem>
+ <listitem><para>Enter path for 'Agreement Image' if required</para></listitem>
+ <listitem><para>Press the 'Submit' button</para></listitem>
+ <listitem><para>A new sub menu will be displayed containing 'Promotions','Terms','Products','Party' and 'Geo' for additional details that can be setup for the agreement item</para></listitem>
+ </orderedlist>
+ </section>
+ <section>
+ <title>How do I edit an agreement item?</title>
+ <orderedlist>
+ <listitem><para>Select the agreement item to be updated by clicking on the Agreement Item Id</para></listitem>
+ <listitem><para>The 'Edit Agreement Item' screen is displayed</para></listitem>
+ <listitem><para>Update the fields required (NOTE: Additional details can be updated by selecting the Promotions, Terms, Product, Party or Geo sub menus)</para></listitem>
+ </orderedlist>
+ </section>
</section>
\ No newline at end of file
Modified: ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreementItemParty.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreementItemParty.xml?rev=893401&r1=893400&r2=893401&view=diff
==============================================================================
--- ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreementItemParty.xml (original)
+++ ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreementItemParty.xml Wed Dec 23 04:18:37 2009
@@ -18,5 +18,9 @@
xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
xmlns="http://docbook.org/ns/docbook">
<title>The Edit Agreement Item Party help screen</title>
- <para></para>
+ <para>This screen is used to add or update a party linked to an agreement item. This could be useful for storing specific contact names associated with an agreement item.</para>
+ <section>
+ <title>How do I update a party for an agreement item?</title>
+ <para>Parties for an agreement item cannot be updated. They can only be added or removed.</para>
+ </section>
</section>
\ No newline at end of file
Modified: ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreementItemProduct.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreementItemProduct.xml?rev=893401&r1=893400&r2=893401&view=diff
==============================================================================
--- ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreementItemProduct.xml (original)
+++ ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreementItemProduct.xml Wed Dec 23 04:18:37 2009
@@ -18,5 +18,5 @@
xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
xmlns="http://docbook.org/ns/docbook">
<title>The Edit Agreement Item Product help screen</title>
- <para></para>
+ <para>This screen is used to create or update a product entry for an agreement item.</para>
</section>
\ No newline at end of file
Modified: ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreementItemSupplierProduct.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreementItemSupplierProduct.xml?rev=893401&r1=893400&r2=893401&view=diff
==============================================================================
--- ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreementItemSupplierProduct.xml (original)
+++ ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreementItemSupplierProduct.xml Wed Dec 23 04:18:37 2009
@@ -18,5 +18,5 @@
xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
xmlns="http://docbook.org/ns/docbook">
<title>The Edit Agreement Item Supplier Product help screen</title>
- <para></para>
+ <para>This screen is used to create or update a product entry for a supplier agreement item. Any updates made in this screen can also be viewed in Catalog Manager for the product under the product 'Suppliers' and 'Agreements' tabs.</para>
</section>
\ No newline at end of file
Modified: ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreementItemTerm.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreementItemTerm.xml?rev=893401&r1=893400&r2=893401&view=diff
==============================================================================
--- ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreementItemTerm.xml (original)
+++ ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreementItemTerm.xml Wed Dec 23 04:18:37 2009
@@ -18,5 +18,5 @@
xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
xmlns="http://docbook.org/ns/docbook">
<title>The Edit Agreement Item Term help screen</title>
- <para></para>
+ <para>This screen is used to create or update the terms for an agreement item.</para>
</section>
\ No newline at end of file
Modified: ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreementRoles.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreementRoles.xml?rev=893401&r1=893400&r2=893401&view=diff
==============================================================================
--- ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreementRoles.xml (original)
+++ ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreementRoles.xml Wed Dec 23 04:18:37 2009
@@ -18,5 +18,24 @@
xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
xmlns="http://docbook.org/ns/docbook">
<title>The Edit Agreements Roles help screen</title>
- <para></para>
+ <para>This screen is used to assign a party roles for an agreement.</para>
+ <section>
+ <title>How do I add a party role to an agreement?</title>
+ <orderedlist>
+ <listitem><para>Use the lookup to select the 'Party Id'</para></listitem>
+ <listitem><para>Use the drop down box to select the 'Party Role Id'</para></listitem>
+ <listitem><para>Press the 'Add' button (NOTE: If the party does not have this role associated with them then an error will be displayed)</para></listitem>
+ <listitem><para>The new entry will be displayed in the lower part of the screen</para></listitem>
+ </orderedlist>
+ </section>
+ <section>
+ <title>How do I update a party role for an agreement?</title>
+ <para>Party roles can only be added and deleted. They cannot be updated.</para>
+ </section>
+ <section>
+ <title>How do I delete a party role from an agreement?</title>
+ <orderedlist>
+ <listitem><para>Press the 'Remove' button for the entry that needs to be deleted.</para></listitem>
+ </orderedlist>
+ </section>
</section>
\ No newline at end of file
Modified: ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreementTerms.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreementTerms.xml?rev=893401&r1=893400&r2=893401&view=diff
==============================================================================
--- ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreementTerms.xml (original)
+++ ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreementTerms.xml Wed Dec 23 04:18:37 2009
@@ -12,11 +12,95 @@
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 Agreement Terms help screen</title>
- <para></para>
+ 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 Agreement Terms help screen</title>
+ <para>Agreement Terms are the rules that make up the agreement.
+ Agreements may have a one or more terms.</para>
+ <para>Examples of agreement terms from a sales and purchase viewpoint
+ include the following:</para>
+ <itemizedlist>
+ <listitem>
+ <para>Payment due within a certain timeframe (eg 30 days)</para>
+ </listitem>
+ <listitem>
+ <para>Discounts for early payment</para>
+ </listitem>
+ <listitem>
+ <para>Specifying Late fee penalties</para>
+ </listitem>
+ <listitem>
+ <para>Purchasing agreements</para>
+ </listitem>
+ <listitem>
+ <para>Specifying commission rates</para>
+ </listitem>
+ <listitem>
+ <para>Exclusive Relationship</para>
+ </listitem>
+ </itemizedlist>
+ <para>NOTE: Agreements can also be specified for Employment, Legal, Non
+ Compete etc.</para>
+ <para>Agreement terms are configured by linking them to the Invoice
+ Item Type.</para>
+ <para>IMPORTANT NOTE: The drop down box for 'Invoice Item Type'
+ contains what appears to be duplicates for items such as 'Invoice
+ Fee', 'Invoice Discount', 'Invoice Finished Good Item' etc. These are
+ NOT duplicates one of these entries refers to the Sales Invoice and
+ the other refers to the Purchase Invoice. As the descriptions are
+ exactly the same it is impossible to know which refers to which so
+ needs to be done using trial and error!</para>
+ <section>
+ <title>How do I add a payment term for 30 days?</title>
+ <orderedlist>
+ <listitem>
+ <para>Select 'Payment Net Days' from the 'Term Type Id' drop down
+ box</para>
+ </listitem>
+ <listitem>
+ <para>Enter '30' in the 'Term Days' field</para>
+ </listitem>
+ <listitem>
+ <para>Press the 'Submit' button</para>
+ </listitem>
+ </orderedlist>
+ </section>
+ <section>
+ <title>How do I add a discount term of 2% if paid within 10 days?
+ </title>
+ <orderedlist>
+ <listitem>
+ <para>Select 'Payment Discounted if paid with Specified Days' from
+ the 'Term Type Id' drop down box</para>
+ </listitem>
+ <listitem>
+ <para>Enter '2' in the 'Term Value' field</para>
+ </listitem>
+ <listitem>
+ <para>Enter '10' in the 'Term Days' field</para>
+ </listitem>
+ <listitem>
+ <para>Press the 'Submit' button</para>
+ </listitem>
+ </orderedlist>
+ </section>
+ <section>
+ <title>How do I specify pricing in a specific currency only for this
+ customer or supplier?</title>
+ <para>This is done using the 'Agreement Items' sub menu</para>
+ </section>
+ <section>
+ <title>How do I delete a payment term?</title>
+ <orderedlist>
+ <listitem>
+ <para>Locate the payment term required</para>
+ </listitem>
+ <listitem>
+ <para>Press the 'Remove'on the entry that needs to be removed</para>
+ </listitem>
+ </orderedlist>
+ </section>
</section>
\ No newline at end of file
Modified: ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreementWorkEffortApplics.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreementWorkEffortApplics.xml?rev=893401&r1=893400&r2=893401&view=diff
==============================================================================
--- ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreementWorkEffortApplics.xml (original)
+++ ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_EditAgreementWorkEffortApplics.xml Wed Dec 23 04:18:37 2009
@@ -18,5 +18,24 @@
xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
xmlns="http://docbook.org/ns/docbook">
<title>The Agreement Work Effort Applications help screen</title>
- <para></para>
+ <para>This screen is used to link a work effort to the whole agreement or an individual agreement item.</para>
+ <section>
+ <title>How do I add a work effort to an agreement?</title>
+ <orderedlist>
+ <listitem><para>Use the drop down box to select the 'Agreement Item Seq Id'</para></listitem>
+ <listitem><para>Use the lookup to select the 'Workeffort Id'</para></listitem>
+ <listitem><para>Press the 'Add' button</para></listitem>
+ <listitem><para>The new entry is displayed in the lower part of the screen</para></listitem>
+ </orderedlist>
+ </section>
+ <section>
+ <title>How do I update a work effort for an agreement?</title>
+ <para>Work efforts can only be added or deleted. They cannot be updated</para>
+ </section>
+ <section>
+ <title>How do I delete a work effort from an agreement?</title>
+ <orderedlist>
+ <listitem><para>Press the 'Delete' button for the entry that needs to be deleted</para></listitem>
+ </orderedlist>
+ </section>
</section>
\ No newline at end of file
Modified: ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_FindAgreement.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_FindAgreement.xml?rev=893401&r1=893400&r2=893401&view=diff
==============================================================================
--- ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_FindAgreement.xml (original)
+++ ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_FindAgreement.xml Wed Dec 23 04:18:37 2009
@@ -18,5 +18,31 @@
xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
xmlns="http://docbook.org/ns/docbook">
<title>The Find Agreements help screen</title>
- <para></para>
+ <para> The default screen is for the Agreements tab is 'Find Agreements'. It is used to locate existing agreements that have been created. The user has the option to</para>
+ <itemizedlist><listitem><para>use the 'Find' button to locate an existing agreement or </para></listitem>
+ <listitem><para>create a new one by clicking on the 'Create Agreement' button.</para></listitem>
+ </itemizedlist>
+ <section>
+ <title>How do I locate an existing agreement?</title>
+ <orderedlist>
+ <listitem><para>Enter search option details if known</para></listitem>
+ <listitem><para>Press the 'Find' button</para></listitem>
+ <listitem><para>A list of existing agreements will be displayed</para></listitem>
+ </orderedlist>
+ </section>
+ <section>
+ <title>How do I create a new agreement?</title>
+ <orderedlist>
+ <listitem><para>Press the 'Create Agreement' button</para></listitem>
+ <listitem><para>The 'Edit Agreement' screen is displayed</para></listitem>
+ <listitem><para>Enter the details required and press the 'Submit' button</para></listitem>
+ </orderedlist>
+ </section>
+ <section>
+ <title>How do I cancel an agreement?</title>
+ <orderedlist>
+ <listitem><para>Locate the agreement required</para></listitem>
+ <listitem><para>Press the 'Cancel' button on the agreement entry that needs to be cancelled</para></listitem>
+ </orderedlist>
+ </section>
</section>
\ No newline at end of file
Modified: ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_ListAgreementGeographicalApplic.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_ListAgreementGeographicalApplic.xml?rev=893401&r1=893400&r2=893401&view=diff
==============================================================================
--- ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_ListAgreementGeographicalApplic.xml (original)
+++ ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_ListAgreementGeographicalApplic.xml Wed Dec 23 04:18:37 2009
@@ -18,5 +18,20 @@
xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
xmlns="http://docbook.org/ns/docbook">
<title>The List Agreement Geo help screen</title>
- <para></para>
+ <para>This screen is used to display a list of the geographical locations that are valid for the agreement item.</para>
+ <section>
+ <title>How do I create a new geographical location for an agreement item?</title>
+ <orderedlist>
+ <listitem><para>Press the 'New' button</para></listitem>
+ <listitem><para>The 'Edit Agreement Geographical Application' screen is displayed</para></listitem>
+ <listitem><para>Use the drop down box to select the 'Geo Id'</para></listitem>
+ <listitem><para>Press the 'Submit' button</para></listitem>
+ </orderedlist>
+ </section>
+ <section>
+ <title>How do I delete a geographical location for an agreement item?</title>
+ <orderedlist>
+ <listitem><para>Press the 'Delete' button for the entry that needs to be deleted</para></listitem>
+ </orderedlist>
+ </section>
</section>
\ No newline at end of file
Modified: ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_ListAgreementItemParties.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_ListAgreementItemParties.xml?rev=893401&r1=893400&r2=893401&view=diff
==============================================================================
--- ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_ListAgreementItemParties.xml (original)
+++ ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_ListAgreementItemParties.xml Wed Dec 23 04:18:37 2009
@@ -18,5 +18,20 @@
xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
xmlns="http://docbook.org/ns/docbook">
<title>The Agreement Items Parties help screen</title>
- <para></para>
+ <para>This screen is used to display any parties that have been linked to this agreement item.</para>
+ <section>
+ <title>How do I create a party for an agreement item?</title>
+ <orderedlist>
+ <listitem><para>Press the 'New' button</para></listitem>
+ <listitem><para>The 'Edit Agreement Item Party' screen is displayed</para></listitem>
+ <listitem><para>Manually enter or use the lookup to select the 'Party Id'</para></listitem>
+ <listitem><para>Press the 'Submit' button</para></listitem>
+ </orderedlist>
+ </section>
+ <section>
+ <title>How do I remove a party for an agreement item?</title>
+ <orderedlist>
+ <listitem><para>Press the 'Delete' button for the entry that needs to be deleted.</para></listitem>
+ </orderedlist>
+ </section>
</section>
\ No newline at end of file
Modified: ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_ListAgreementItemProducts.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_ListAgreementItemProducts.xml?rev=893401&r1=893400&r2=893401&view=diff
==============================================================================
--- ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_ListAgreementItemProducts.xml (original)
+++ ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_ListAgreementItemProducts.xml Wed Dec 23 04:18:37 2009
@@ -18,5 +18,30 @@
xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
xmlns="http://docbook.org/ns/docbook">
<title>The Agreement Item Products help screen</title>
- <para></para>
-</section>
\ No newline at end of file
+ <para>This screen is used to link a specific product or products to an agreement. This can be useful for restricting a discount or product pricing to a particular product (or range of products) for a specific customer.</para>
+ <section>
+ <title>How do I add a product to an agreement item?</title>
+ <orderedlist>
+ <listitem><para>Press the 'New Product' button</para></listitem>
+ <listitem><para>The 'Edit Agreement Item Product' screen is displayed</para></listitem>
+ <listitem><para>Manually enter or use the lookup to select the 'Product Id'</para></listitem>
+ <listitem><para>Enter the 'Price' to be associated to the product for this agreement item</para></listitem>
+ <listitem><para>Press the 'Submit' button</para></listitem>
+ </orderedlist>
+ </section>
+ <section>
+ <title>How do I update a product linked to an agreement item?</title>
+ <orderedlist>
+ <listitem><para>Select the product required by clicking on the 'Product Id'</para></listitem>
+ <listitem><para>The 'Edit Agreement Item Product' screen is displayed</para></listitem>
+ <listitem><para>Update the 'Price' for the product (NOTE: Only product price is available for update)</para></listitem>
+ <listitem><para>Press the 'Submit' button</para></listitem>
+ </orderedlist>
+ </section>
+ <section>
+ <title>How do I delete a product from an agreement item?</title>
+ <orderedlist>
+ <listitem><para>Press the 'Remove' button on the entry that needs to be deleted</para></listitem>
+ </orderedlist>
+ </section>
+ </section>
\ No newline at end of file
Modified: ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_ListAgreementItemSupplierProducts.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_ListAgreementItemSupplierProducts.xml?rev=893401&r1=893400&r2=893401&view=diff
==============================================================================
--- ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_ListAgreementItemSupplierProducts.xml (original)
+++ ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_ListAgreementItemSupplierProducts.xml Wed Dec 23 04:18:37 2009
@@ -18,5 +18,36 @@
xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
xmlns="http://docbook.org/ns/docbook">
<title>The List Agreement Item Supplier Products help screen</title>
- <para></para>
+ <para>This screen is used to link a specific product (or range of products) to an agreement. This can be useful for restricting a discount or product pricing to a product (or range of products) for a particular supplier.</para>
+ <para>NOTE: Products created here will be linked to the product and can be view using Catalog Manager. Entries can be viewed under the Product 'Suppliers' and 'Agreements' tabs.</para>
+ <section>
+ <title>How do I add a product to an agreement item?</title>
+ <orderedlist>
+ <listitem><para>Press the 'New Product' button</para></listitem>
+ <listitem><para>The 'Edit Agreement Item Product' screen is displayed</para></listitem>
+ <listitem><para>Manually enter or use the lookup to select the 'Product Id'</para></listitem>
+ <listitem><para>Enter the 'Available From Date'</para></listitem>
+ <listitem><para>Leave the 'Thru Date' blank</para></listitem>
+ <listitem><para>Using the drop down box select the 'Supplier Order Pref Id'</para></listitem>
+ <listitem><para>Enter the 'Last Price'</para></listitem>
+ <listitem><para>Enter 'Supplier Product Id'</para></listitem>
+ <listitem><para>Enter any other details as required or leave blank</para></listitem>
+ <listitem><para>Press the 'Submit' button</para></listitem>
+ </orderedlist>
+ </section>
+ <section>
+ <title>How do I update a product linked to an agreement item?</title>
+ <orderedlist>
+ <listitem><para>Select the product required by clicking on the 'Product Id'</para></listitem>
+ <listitem><para>The 'Edit Agreement Item Product' screen is displayed</para></listitem>
+ <listitem><para>Update the details as required</para></listitem>
+ <listitem><para>Press the 'Submit' button</para></listitem>
+ </orderedlist>
+ </section>
+ <section>
+ <title>How do I delete a product from an agreement item?</title>
+ <orderedlist>
+ <listitem><para>Press the 'Remove' button on the entry that needs to be deleted</para></listitem>
+ </orderedlist>
+ </section>
</section>
\ No newline at end of file
Modified: ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_ListAgreementItemTerms.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_ListAgreementItemTerms.xml?rev=893401&r1=893400&r2=893401&view=diff
==============================================================================
--- ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_ListAgreementItemTerms.xml (original)
+++ ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_ListAgreementItemTerms.xml Wed Dec 23 04:18:37 2009
@@ -18,5 +18,29 @@
xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
xmlns="http://docbook.org/ns/docbook">
<title>The Agreements Item Terms help screen</title>
- <para></para>
+ <para>This screen is used to enter or maintain terms that are specific to an agreement item. The terms available are the same as those found under the 'Agreement Terms' tab and any related terms will be displayed both here and under the 'Agreement Items' tab .</para>
+ <section>
+ <title>How do I create a term for an agreement item?</title>
+ <orderedlist>
+ <listitem><para>Press the 'Create Term' button</para></listitem>
+ <listitem><para>The 'Edit Agreement Item Term' screen is displayed</para></listitem>
+ <listitem><para>Enter the term details required</para></listitem>
+ <listitem><para>Press the 'Submit' button</para></listitem>
+ </orderedlist>
+ </section>
+ <section>
+ <title>How do I update a term for an agreement item?</title>
+ <orderedlist>
+ <listitem><para>Select the term for the agreement item by clicking on the term id</para></listitem>
+ <listitem><para>The 'Edit Agreement Item Term' screen is displayed</para></listitem>
+ <listitem><para>Update the details required</para></listitem>
+ <listitem><para>Press the 'Submit' button</para></listitem>
+ </orderedlist>
+ </section>
+ <section>
+ <title>How do I delete a term for an agreement item?</title>
+ <orderedlist>
+ <listitem><para>Press the 'Remove' button on the term entry that needs to be deleted.</para></listitem>
+ </orderedlist>
+ </section>
</section>
\ No newline at end of file
Modified: ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_ListAgreementItems.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_ListAgreementItems.xml?rev=893401&r1=893400&r2=893401&view=diff
==============================================================================
--- ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_ListAgreementItems.xml (original)
+++ ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_ListAgreementItems.xml Wed Dec 23 04:18:37 2009
@@ -18,5 +18,5 @@
xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
xmlns="http://docbook.org/ns/docbook">
<title>The List Agreement Items help screen</title>
- <para></para>
+ <para>This screen is used to display a list of items that have been created for an agreement.</para>
</section>
\ No newline at end of file
Modified: ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_ListAgreementPromoAppls.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_ListAgreementPromoAppls.xml?rev=893401&r1=893400&r2=893401&view=diff
==============================================================================
--- ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_ListAgreementPromoAppls.xml (original)
+++ ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_ListAgreementPromoAppls.xml Wed Dec 23 04:18:37 2009
@@ -18,5 +18,32 @@
xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
xmlns="http://docbook.org/ns/docbook">
<title>The Agreements Item Promotions help screen</title>
- <para></para>
+ <para>This screen is used to enter or maintain any promotions that are associated with the Agreement Item. This can be useful if you want to limit where a particular promotion is applied. Promotions are setup in Catalog Manager and can be selected here.</para>
+ <section>
+ <title>How do I add a promotion to an agreement item?</title>
+ <orderedlist>
+ <listitem><para>Press the 'Add New Promotion' button</para></listitem>
+ <listitem><para>The 'Edit Agreement Promo Applications' screen is displayed</para></listitem>
+ <listitem><para>Select the 'Product Promo Id' from the drop down box</para></listitem>
+ <listitem><para>Enter the 'From Date'</para></listitem>
+ <listitem><para>Enter the 'Thru Date' if required (NOTE:This can be left blank)</para></listitem>
+ <listitem><para>Enter the 'Sequence Num' if required</para></listitem>
+ <listitem><para>Press the 'Submit' button</para></listitem>
+ </orderedlist>
+ </section>
+ <section>
+ <title>How do I edit an existing promotion for an agreement item?</title>
+ <orderedlist>
+ <listitem><para>Select the agreement item promotion by clicking on on the promotion id</para></listitem>
+ <listitem><para>The 'Edit Agreement Promo Applications' screen is displayed</para></listitem>
+ <listitem><para>Update the details required</para></listitem>
+ <listitem><para>Press the 'Submit' button</para></listitem>
+ </orderedlist>
+ </section>
+ <section>
+ <title>How do I delete a promotion from an agreement item?</title>
+ <orderedlist>
+ <listitem><para>Press the 'Remove' button on the entry that needs to be deleted.</para></listitem>
+ </orderedlist>
+ </section>
</section>
\ No newline at end of file
Modified: ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_agreements.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_agreements.xml?rev=893401&r1=893400&r2=893401&view=diff
==============================================================================
--- ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_agreements.xml (original)
+++ ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_agreements.xml Wed Dec 23 04:18:37 2009
@@ -30,11 +30,10 @@
</itemizedlist>
<xi:include href="HELP_ACCOUNTING_FindAgreement.xml"/>
<xi:include href="HELP_ACCOUNTING_EditAgreement.xml"/>
- <xi:include href="HELP_ACCOUNTING_ListAgreementTerms.xml"/>
<xi:include href="HELP_ACCOUNTING_EditAgreementTerms.xml"/>
<xi:include href="HELP_ACCOUNTING_EditAgreementItem.xml"/>
<xi:include href="HELP_ACCOUNTING_ListAgreementPromoAppls.xml"/>
- <xi:include href="HELP_ACCOUNTING_ListAgreementItemTerm.xml"/>
+ <xi:include href="HELP_ACCOUNTING_ListAgreementItemTerms.xml"/>
<xi:include href="HELP_ACCOUNTING_EditAgreementItemTerm.xml"/>
<xi:include href="HELP_ACCOUNTING_ListAgreementItemProducts.xml"/>
<xi:include href="HELP_ACCOUNTING_EditAgreementItemProduct.xml"/>
Modified: ofbiz/trunk/applications/accounting/documents/Accounting.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/accounting/documents/Accounting.xml?rev=893401&r1=893400&r2=893401&view=diff
==============================================================================
--- ofbiz/trunk/applications/accounting/documents/Accounting.xml (original)
+++ ofbiz/trunk/applications/accounting/documents/Accounting.xml Wed Dec 23 04:18:37 2009
@@ -32,5 +32,6 @@
<xi:include href="../data/helpdata/HELP_ACCOUNTING_billing_accounts.xml" />
<xi:include href="../data/helpdata/HELP_ACCOUNTING_financial_accounts.xml" />
<xi:include href="../data/helpdata/HELP_ACCOUNTING_tax_authorities.xml" />
+ <xi:include href="../data/helpdata/HELP_ACCOUNTING_agreements.xml" />
<xi:include href="../data/helpdata/HELP_ACCOUNTING_Features.xml" />
</chapter>