Opentaps Wiki - User contributions [en]

Main Page

2019-05-14T16:42:22Z

Sichen:

opentaps Open Source ERP + CRM is an open source Enterprise Resource Planning (ERP) and Customer Relationship Management (CRM) system. The system is designed to bring together all aspects of a company, from customers to inventory to accounting, from online stores to the shop floor to the warehouse, so that everyone in the company works together as part of one coordinated process.

For information about opentaps 1.4 and 1.5, see the following sections:

*[[Opentaps_Installation_Manual|opentaps Installation Manual]] describes how to set up and install opentaps.

*[[Opentaps_Users_Manual|The opentaps Users Manual]] describes how opentaps works and how you can use opentaps to perform business tasks. It contains high-level overviews of the processes in opentaps and many "tips and tricks" for how to make it work the way you want.

*[[Opentaps_Reference_Manual|The opentaps Reference Manual]] provides detailed information about how different screens in opentaps work: what the fields mean, what data is displayed, what happens if you click that button. It is meant to be a reference for opentaps users and can be accessed directly from opentaps.

*[[Opentaps_Testing_Manual|The opentaps Testing Manual]] contains tests which could be run on a demo instance to validate the behavior of opentaps.

*[[Opentaps_Technical_Reference|opentaps Technical Reference]] provides technical references and documentation for developers who are looking to customize or extend opentaps.

*You can also find information about modules for opentaps, including
** [[opentaps Magento Integration]]: Integrates opentaps with the [http://www.magentocommerce.com Magento ecommerce system].
** [[opentaps Funambol Integration]] Using [http://www.funambol.com Funambol], opentaps can connect with mobile phones, Microsoft Outlook, and Google apps.
** [[opentaps Concur Integration]]: Integrates opentaps with the [http://www.concur.com/ Concur travel and expense management system].
** [[opentaps Distributor Application]]: A B2B online store for opentaps
** [[opentaps osCommerce Integration]]: Integrates the [http://www.oscommerce.com/ osCommerce] shopping cart with open taps
** [http://shop.opentaps.org/index.php/featured/vat-module-by-integratingweb.html opentaps VAT Module]: Support for Value Added Taxes (VAT)
** [http://shop.opentaps.org/index.php/featured/enhanced-financials-module.html Enhanced Financials Module]: Additional reports and screens for ledger analysis, bank reconciliation, check register, and bill payments.
** [http://shop.opentaps.org/index.php/featured/getresponse-email-marketing-integration-module.html GetResponse Email Marketing Integration Module]: Integrate opentaps with [http://www.getresponse.com/index/sichen GetResponse] for email marketing to your leads and customers.
** [http://shop.opentaps.org/index.php/featured/opentaps-ofbiz-endicia-integration-module.html Endicia Integration Module]: Integrate opentaps with Endicia to print US Postal Service labels for your shipments. Requires [https://account.dymoendicia.com/?referredBy=lopn signing up with Endicia Label Server].
** [[opentaps Analytics Data Loader]]: Loading data from ofbiz or opentaps to opentaps Analytics.

*Documentation for opentaps 1.0.x is available at [http://www.opentaps.org/docs_1_0/ www.opentaps.org/docs_1_0]

*Finally, some documentation is now available in [http://www.opentaps.org/esdocs/ Spanish] and [http://www.opentaps.org/cndocs Chinese], thanks to our community contributors.

All above documents following our standard [[Documentation Notation]]. If you are new to mediawiki, you might want to take a look at our [[Mediawiki cheat sheet]] to see how to use it.

New:
* [[Opentaps Analytics]]

Opentaps Technical Reference

2017-10-03T20:47:36Z

Sichen: /* Recommended Reading */

==Technical Reference==

''These documents are for developers who plan on customizing or extending opentaps''

===General Information===

* [[opentaps Release Process]]
* [[BPM Integration|SOA and BPM]]
* [[Importing Data with Dataimport]]
* [[opentaps Coding Standards]]
* [[opentaps User Interface Guidelines]]
* [[Managing Customizations with Upgrades]]
* [[How to Use Git: a Tutorial]]
* [[How To Use Monitoring Agents]]

===Developer Documentation===

* [[Technical Highlights of opentaps 1.4]]
* [http://www.opensourcestrategies.com/ofbiz/tutorials.php ofbiz framework tutorials]
* [[Domain Driven Architecture]]
* [[Using the Query Tool]]
* [[Base Entity Classes]]
* [[POJO Service Engine]]
* [[Java Wrapper for OFBiz Services]]
* [[Java Classes for Constants]]
* [[Managing Your Configuration Files]]
* [[Unit Testing]]
* [[Selenium UI Testing]]
* [[Working with the Domain Driven Architecture]]
* [[opentaps Hibernate Integration]]
* [[opentaps Search Feature]]
* [[How to use the opentaps Form Macros]]
* [[opentaps Ajax Pagination Framework]]
* [[Screen Widget Actions in Java]]
* [[Writing an ofbiz Container]]
* [[Checkstyle development tool]]
* [[Aspect Oriented Programming in opentaps]]
* [[Optimizations in Javascripts and CSS files]]
* [[How to Use Java BigDecimal: A Tutorial]]

==== opentaps and Google Web Toolkit ====
* [[Introduction to Google Web Toolkit (GWT)]]
* [[opentaps Google Web Toolkit]]
* [[Debugging GWT with Firebug]]
* [[Creating a Widget with Google Web Toolkit and opentaps]]

===Tips and Tricks===
* [[Creating and Applying Patches]]
* [[Extending opentaps]]
* [[Working with SSL]]
* [[Avoiding Database Deadlocks]]
* [[Database Tips]]
* Source Code Repository Management:
** [[SVN Tips]]
** [[How to use SVK]]
* [[Trac Tips]]
* [[CSS Display Bugs in IE]]
* [[Performance Analysis and Troubleshooting]]
* [[Running Tsung against opentaps server]]
* [[Solving the error unable to rename old file FOO to temporary file on Windows]]

===API and Technical Design Reference===
* [http://www.opentaps.org/javadocs opentaps JavaDocs]
* [[LiveCatalog XML-RPC API]]
* [[Amazon Integration]]
* [[Manufacturing Model]]
* [[Configuring the POS Store]]
* [[Configuring Authorize.NET]]
* [[Implementing CVV Security Code Checking]]

==opentaps Architecture==
* [[Examples of Modularity]]

==Recommended Reading==

<pre>
Show me your flowcharts and conceal your tables, and I'll continue to be mystified.
Show me your tables, and I won't usually need your flowcharts; they'll be obvious.
</pre>
-- [https://www.amazon.com/gp/product/0201835959/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=0201835959&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a The Mythical Man Month by Fred Brooks]

Even after four decades, and long after the word "flowchart" has been replaced by "UML", data models still play a central role in software design. The following three books will give you three different perspectives on data modeling for enterprise applications and help you understand the heart of opentaps. You should read all three to get a balanced perspective:

* [https://www.amazon.com/gp/product/0471380237/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=0471380237&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a Data Model Resource Book, Volume 1.] -- This comprehensive volume and approaches it from a relational perspective for transactional systems.
* [https://www.amazon.com/gp/product/0321125215/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=0321125215&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a Domain Driven Design] -- This book approaches the design of transactional applications from an object-oriented perspective.
* [https://www.amazon.com/gp/product/0471200247/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=0471200247&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a The Data Warehouse Toolkit] -- This book gives a comprehensive treatment from the analytical perspective.

There are also a couple of books about OFBiz on Amazon:
* [https://www.amazon.com/gp/product/1847194001/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=1847194001&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a Apache OFBiz Development]
* [https://www.amazon.com/gp/product/1847199186/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=1847199186&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a Apache OFBiz Cookbook]

Other helpful references:
* [https://www.amazon.com/gp/product/0131487876/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=0131487876&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a Open Source Licensing] -- If you want to learn more about open source software licenses, read this book instead of all the mailing list graffiti.
* [https://www.amazon.com/gp/product/0321344758/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=0321344758&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a Don't Make Me Think], or I will hate your user interface.

Opentaps Technical Reference

2017-10-03T20:47:01Z

Sichen: /* Recommended Reading */

==Technical Reference==

''These documents are for developers who plan on customizing or extending opentaps''

===General Information===

* [[opentaps Release Process]]
* [[BPM Integration|SOA and BPM]]
* [[Importing Data with Dataimport]]
* [[opentaps Coding Standards]]
* [[opentaps User Interface Guidelines]]
* [[Managing Customizations with Upgrades]]
* [[How to Use Git: a Tutorial]]
* [[How To Use Monitoring Agents]]

===Developer Documentation===

* [[Technical Highlights of opentaps 1.4]]
* [http://www.opensourcestrategies.com/ofbiz/tutorials.php ofbiz framework tutorials]
* [[Domain Driven Architecture]]
* [[Using the Query Tool]]
* [[Base Entity Classes]]
* [[POJO Service Engine]]
* [[Java Wrapper for OFBiz Services]]
* [[Java Classes for Constants]]
* [[Managing Your Configuration Files]]
* [[Unit Testing]]
* [[Selenium UI Testing]]
* [[Working with the Domain Driven Architecture]]
* [[opentaps Hibernate Integration]]
* [[opentaps Search Feature]]
* [[How to use the opentaps Form Macros]]
* [[opentaps Ajax Pagination Framework]]
* [[Screen Widget Actions in Java]]
* [[Writing an ofbiz Container]]
* [[Checkstyle development tool]]
* [[Aspect Oriented Programming in opentaps]]
* [[Optimizations in Javascripts and CSS files]]
* [[How to Use Java BigDecimal: A Tutorial]]

==== opentaps and Google Web Toolkit ====
* [[Introduction to Google Web Toolkit (GWT)]]
* [[opentaps Google Web Toolkit]]
* [[Debugging GWT with Firebug]]
* [[Creating a Widget with Google Web Toolkit and opentaps]]

===Tips and Tricks===
* [[Creating and Applying Patches]]
* [[Extending opentaps]]
* [[Working with SSL]]
* [[Avoiding Database Deadlocks]]
* [[Database Tips]]
* Source Code Repository Management:
** [[SVN Tips]]
** [[How to use SVK]]
* [[Trac Tips]]
* [[CSS Display Bugs in IE]]
* [[Performance Analysis and Troubleshooting]]
* [[Running Tsung against opentaps server]]
* [[Solving the error unable to rename old file FOO to temporary file on Windows]]

===API and Technical Design Reference===
* [http://www.opentaps.org/javadocs opentaps JavaDocs]
* [[LiveCatalog XML-RPC API]]
* [[Amazon Integration]]
* [[Manufacturing Model]]
* [[Configuring the POS Store]]
* [[Configuring Authorize.NET]]
* [[Implementing CVV Security Code Checking]]

==opentaps Architecture==
* [[Examples of Modularity]]

==Recommended Reading==

<pre>
Show me your flowcharts and conceal your tables, and I'll continue to be mystified.
Show me your tables, and I won't usually need your flowcharts; they'll be obvious.
</pre>
-- [https://www.amazon.com/gp/product/0201835959/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=0201835959&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a The Mythical Man Month by Fred Brooks]

Even after four decades, and long after the word "flowchart" has been replaced by "UML", data models still play a central role in software design. The following three books will give you three different perspectives on data modeling for enterprise applications and help you understand the heart of opentaps. You should read all three to get a balanced perspective:

* [https://www.amazon.com/gp/product/0471380237/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=0471380237&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a Data Model Resource Book, Volume 1.] -- This comprehensive volume and approaches it from a relational perspective for transactional systems.
* [https://www.amazon.com/gp/product/0321125215/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=0321125215&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a Domain Driven Design] -- This book approaches the design of transactional applications from an object-oriented perspective.
* [https://www.amazon.com/gp/product/0471200247/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=0471200247&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a The Data Model Resource Book, Vol. 1] -- This book gives a comprehensive treatment from the analytical perspective.

There are also a couple of books about OFBiz on Amazon:
* [https://www.amazon.com/gp/product/1847194001/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=1847194001&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a Apache OFBiz Development]
* [https://www.amazon.com/gp/product/1847199186/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=1847199186&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a Apache OFBiz Cookbook]

Other helpful references:
* [https://www.amazon.com/gp/product/0131487876/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=0131487876&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a Open Source Licensing] -- If you want to learn more about open source software licenses, read this book instead of all the mailing list graffiti.
* [https://www.amazon.com/gp/product/0321344758/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=0321344758&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a Don't Make Me Think], or I will hate your user interface.

Opentaps Technical Reference

2017-10-03T20:46:37Z

Sichen: /* Recommended Reading */

==Technical Reference==

''These documents are for developers who plan on customizing or extending opentaps''

===General Information===

* [[opentaps Release Process]]
* [[BPM Integration|SOA and BPM]]
* [[Importing Data with Dataimport]]
* [[opentaps Coding Standards]]
* [[opentaps User Interface Guidelines]]
* [[Managing Customizations with Upgrades]]
* [[How to Use Git: a Tutorial]]
* [[How To Use Monitoring Agents]]

===Developer Documentation===

* [[Technical Highlights of opentaps 1.4]]
* [http://www.opensourcestrategies.com/ofbiz/tutorials.php ofbiz framework tutorials]
* [[Domain Driven Architecture]]
* [[Using the Query Tool]]
* [[Base Entity Classes]]
* [[POJO Service Engine]]
* [[Java Wrapper for OFBiz Services]]
* [[Java Classes for Constants]]
* [[Managing Your Configuration Files]]
* [[Unit Testing]]
* [[Selenium UI Testing]]
* [[Working with the Domain Driven Architecture]]
* [[opentaps Hibernate Integration]]
* [[opentaps Search Feature]]
* [[How to use the opentaps Form Macros]]
* [[opentaps Ajax Pagination Framework]]
* [[Screen Widget Actions in Java]]
* [[Writing an ofbiz Container]]
* [[Checkstyle development tool]]
* [[Aspect Oriented Programming in opentaps]]
* [[Optimizations in Javascripts and CSS files]]
* [[How to Use Java BigDecimal: A Tutorial]]

==== opentaps and Google Web Toolkit ====
* [[Introduction to Google Web Toolkit (GWT)]]
* [[opentaps Google Web Toolkit]]
* [[Debugging GWT with Firebug]]
* [[Creating a Widget with Google Web Toolkit and opentaps]]

===Tips and Tricks===
* [[Creating and Applying Patches]]
* [[Extending opentaps]]
* [[Working with SSL]]
* [[Avoiding Database Deadlocks]]
* [[Database Tips]]
* Source Code Repository Management:
** [[SVN Tips]]
** [[How to use SVK]]
* [[Trac Tips]]
* [[CSS Display Bugs in IE]]
* [[Performance Analysis and Troubleshooting]]
* [[Running Tsung against opentaps server]]
* [[Solving the error unable to rename old file FOO to temporary file on Windows]]

===API and Technical Design Reference===
* [http://www.opentaps.org/javadocs opentaps JavaDocs]
* [[LiveCatalog XML-RPC API]]
* [[Amazon Integration]]
* [[Manufacturing Model]]
* [[Configuring the POS Store]]
* [[Configuring Authorize.NET]]
* [[Implementing CVV Security Code Checking]]

==opentaps Architecture==
* [[Examples of Modularity]]

==Recommended Reading==

<pre>
Show me your flowcharts and conceal your tables, and I'll continue to be mystified.
Show me your tables, and I won't usually need your flowcharts; they'll be obvious.
</pre>
-- [https://www.amazon.com/gp/product/0201835959/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=0201835959&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a The Mythical Man Month by Fred Brooks]

Even after four decades, and long after the word "flowchart" has been replaced by "UML", data models still play a central role in software design. The following three books will give you three different perspectives on data modeling for enterprise applications and help you understand the heart of opentaps. You should read all three to get a balanced perspective:

* [https://www.amazon.com/gp/product/0471380237/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=0471380237&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a Data Model Resource Book, Volume 1.] -- This comprehensive volume and approaches it from a relational perspective for transactional systems.
* [https://www.amazon.com/gp/product/0321125215/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=0321125215&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a Domain Driven Design] -- This book approaches the design of transactional applications from an object-oriented perspective.
* [https://www.amazon.com/gp/product/0471200247/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=0471200247&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a The Data Model Resource Book, Vol. 1] -- This book gives a comprehensive treatment from the analytical perspective.

There are also a couple of books about OFBiz on Amazon:
* [https://www.amazon.com/gp/product/1847194001/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=1847194001&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a Apache OFBiz Development]
* [https://www.amazon.com/gp/product/1847199186/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=1847199186&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a Apache OFBiz Cookbook]

Other helpful references:
* [https://www.amazon.com/gp/product/0131487876/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=0131487876&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a Opentaps Source Licensing] -- If you want to learn more about open source software licenses, read this book instead of all the mailing list graffiti.
* [https://www.amazon.com/gp/product/0321344758/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=0321344758&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a Don't Make Me Think], or I will hate your user interface.

Opentaps Technical Reference

2017-10-03T20:45:49Z

Sichen: /* Recommended Reading */

==Technical Reference==

''These documents are for developers who plan on customizing or extending opentaps''

===General Information===

* [[opentaps Release Process]]
* [[BPM Integration|SOA and BPM]]
* [[Importing Data with Dataimport]]
* [[opentaps Coding Standards]]
* [[opentaps User Interface Guidelines]]
* [[Managing Customizations with Upgrades]]
* [[How to Use Git: a Tutorial]]
* [[How To Use Monitoring Agents]]

===Developer Documentation===

* [[Technical Highlights of opentaps 1.4]]
* [http://www.opensourcestrategies.com/ofbiz/tutorials.php ofbiz framework tutorials]
* [[Domain Driven Architecture]]
* [[Using the Query Tool]]
* [[Base Entity Classes]]
* [[POJO Service Engine]]
* [[Java Wrapper for OFBiz Services]]
* [[Java Classes for Constants]]
* [[Managing Your Configuration Files]]
* [[Unit Testing]]
* [[Selenium UI Testing]]
* [[Working with the Domain Driven Architecture]]
* [[opentaps Hibernate Integration]]
* [[opentaps Search Feature]]
* [[How to use the opentaps Form Macros]]
* [[opentaps Ajax Pagination Framework]]
* [[Screen Widget Actions in Java]]
* [[Writing an ofbiz Container]]
* [[Checkstyle development tool]]
* [[Aspect Oriented Programming in opentaps]]
* [[Optimizations in Javascripts and CSS files]]
* [[How to Use Java BigDecimal: A Tutorial]]

==== opentaps and Google Web Toolkit ====
* [[Introduction to Google Web Toolkit (GWT)]]
* [[opentaps Google Web Toolkit]]
* [[Debugging GWT with Firebug]]
* [[Creating a Widget with Google Web Toolkit and opentaps]]

===Tips and Tricks===
* [[Creating and Applying Patches]]
* [[Extending opentaps]]
* [[Working with SSL]]
* [[Avoiding Database Deadlocks]]
* [[Database Tips]]
* Source Code Repository Management:
** [[SVN Tips]]
** [[How to use SVK]]
* [[Trac Tips]]
* [[CSS Display Bugs in IE]]
* [[Performance Analysis and Troubleshooting]]
* [[Running Tsung against opentaps server]]
* [[Solving the error unable to rename old file FOO to temporary file on Windows]]

===API and Technical Design Reference===
* [http://www.opentaps.org/javadocs opentaps JavaDocs]
* [[LiveCatalog XML-RPC API]]
* [[Amazon Integration]]
* [[Manufacturing Model]]
* [[Configuring the POS Store]]
* [[Configuring Authorize.NET]]
* [[Implementing CVV Security Code Checking]]

==opentaps Architecture==
* [[Examples of Modularity]]

==Recommended Reading==

<pre>
Show me your flowcharts and conceal your tables, and I'll continue to be mystified.
Show me your tables, and I won't usually need your flowcharts; they'll be obvious.
</pre>
-- [https://www.amazon.com/gp/product/0201835959/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=0201835959&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a The Mythical Man Month by Fred Brooks]

Even after four decades, and long after the word "flowchart" has been replaced by "UML", data models still play a central role in software design. The following three books will give you three different perspectives on data modeling for enterprise applications and help you understand the heart of opentaps. You should read all three to get a balanced perspective:

<a target="_blank" href="">The Data Model Resource Book, Vol. 1: A Library of Universal Data Models for All Enterprises</a><img src="//ir-na.amazon-adsystem.com/e/ir?t=racioutyle-20&l=am2&o=1&a=0471380237" width="1" height="1" border="0" alt="" style="border:none !important; margin:0px !important;" />

* [https://www.amazon.com/gp/product/0471380237/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=0471380237&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a Data Model Resource Book, Volume 1.] -- This comprehensive volume and approaches it from a relational perspective for transactional systems.
* [https://www.amazon.com/gp/product/0471380237/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=0321125215&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a Domain Driven Design] -- This book approaches the design of transactional applications from an object-oriented perspective.
* [https://www.amazon.com/gp/product/0471380237/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=0471200247&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a The Data Model Resource Book, Vol. 1] -- This book gives a comprehensive treatment from the analytical perspective.

There are also a couple of books about OFBiz on Amazon:
* [https://www.amazon.com/gp/product/0471380237/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=1847194001&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a Apache OFBiz Development]
* [https://www.amazon.com/gp/product/0471380237/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=1847199186&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a Apache OFBiz Cookbook]

Other helpful references:
* [https://www.amazon.com/gp/product/0471380237/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=0131487876&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a Opentaps Source Licensing] -- If you want to learn more about open source software licenses, read this book instead of all the mailing list graffiti.
* [https://www.amazon.com/gp/product/0471380237/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=0321344758&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a Don't Make Me Think], or I will hate your user interface.

Opentaps Technical Reference

2017-10-03T20:44:45Z

Sichen: /* Recommended Reading */

==Technical Reference==

''These documents are for developers who plan on customizing or extending opentaps''

===General Information===

* [[opentaps Release Process]]
* [[BPM Integration|SOA and BPM]]
* [[Importing Data with Dataimport]]
* [[opentaps Coding Standards]]
* [[opentaps User Interface Guidelines]]
* [[Managing Customizations with Upgrades]]
* [[How to Use Git: a Tutorial]]
* [[How To Use Monitoring Agents]]

===Developer Documentation===

* [[Technical Highlights of opentaps 1.4]]
* [http://www.opensourcestrategies.com/ofbiz/tutorials.php ofbiz framework tutorials]
* [[Domain Driven Architecture]]
* [[Using the Query Tool]]
* [[Base Entity Classes]]
* [[POJO Service Engine]]
* [[Java Wrapper for OFBiz Services]]
* [[Java Classes for Constants]]
* [[Managing Your Configuration Files]]
* [[Unit Testing]]
* [[Selenium UI Testing]]
* [[Working with the Domain Driven Architecture]]
* [[opentaps Hibernate Integration]]
* [[opentaps Search Feature]]
* [[How to use the opentaps Form Macros]]
* [[opentaps Ajax Pagination Framework]]
* [[Screen Widget Actions in Java]]
* [[Writing an ofbiz Container]]
* [[Checkstyle development tool]]
* [[Aspect Oriented Programming in opentaps]]
* [[Optimizations in Javascripts and CSS files]]
* [[How to Use Java BigDecimal: A Tutorial]]

==== opentaps and Google Web Toolkit ====
* [[Introduction to Google Web Toolkit (GWT)]]
* [[opentaps Google Web Toolkit]]
* [[Debugging GWT with Firebug]]
* [[Creating a Widget with Google Web Toolkit and opentaps]]

===Tips and Tricks===
* [[Creating and Applying Patches]]
* [[Extending opentaps]]
* [[Working with SSL]]
* [[Avoiding Database Deadlocks]]
* [[Database Tips]]
* Source Code Repository Management:
** [[SVN Tips]]
** [[How to use SVK]]
* [[Trac Tips]]
* [[CSS Display Bugs in IE]]
* [[Performance Analysis and Troubleshooting]]
* [[Running Tsung against opentaps server]]
* [[Solving the error unable to rename old file FOO to temporary file on Windows]]

===API and Technical Design Reference===
* [http://www.opentaps.org/javadocs opentaps JavaDocs]
* [[LiveCatalog XML-RPC API]]
* [[Amazon Integration]]
* [[Manufacturing Model]]
* [[Configuring the POS Store]]
* [[Configuring Authorize.NET]]
* [[Implementing CVV Security Code Checking]]

==opentaps Architecture==
* [[Examples of Modularity]]

==Recommended Reading==

<pre>
Show me your flowcharts and conceal your tables, and I'll continue to be mystified.
Show me your tables, and I won't usually need your flowcharts; they'll be obvious.
</pre>
-- [https://www.amazon.com/gp/product/0471380237/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=0201835959&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a The Mythical Man Month by Fred Brooks]

Even after four decades, and long after the word "flowchart" has been replaced by "UML", data models still play a central role in software design. The following three books will give you three different perspectives on data modeling for enterprise applications and help you understand the heart of opentaps. You should read all three to get a balanced perspective:

<a target="_blank" href="">The Data Model Resource Book, Vol. 1: A Library of Universal Data Models for All Enterprises</a><img src="//ir-na.amazon-adsystem.com/e/ir?t=racioutyle-20&l=am2&o=1&a=0471380237" width="1" height="1" border="0" alt="" style="border:none !important; margin:0px !important;" />

* [https://www.amazon.com/gp/product/0471380237/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=0471380237&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a Data Model Resource Book, Volume 1.] -- This comprehensive volume and approaches it from a relational perspective for transactional systems.
* [https://www.amazon.com/gp/product/0471380237/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=0321125215&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a Domain Driven Design] -- This book approaches the design of transactional applications from an object-oriented perspective.
* [https://www.amazon.com/gp/product/0471380237/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=0471200247&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a The Data Model Resource Book, Vol. 1] -- This book gives a comprehensive treatment from the analytical perspective.

There are also a couple of books about OFBiz on Amazon:
* [https://www.amazon.com/gp/product/0471380237/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=1847194001&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a Apache OFBiz Development]
* [https://www.amazon.com/gp/product/0471380237/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=1847199186&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a Apache OFBiz Cookbook]

Other helpful references:
* [https://www.amazon.com/gp/product/0471380237/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=0131487876&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a Opentaps Source Licensing] -- If you want to learn more about open source software licenses, read this book instead of all the mailing list graffiti.
* [https://www.amazon.com/gp/product/0471380237/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=0321344758&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a Don't Make Me Think], or I will hate your user interface.

Opentaps Technical Reference

2017-10-03T20:44:21Z

Sichen: /* Recommended Reading */

==Technical Reference==

''These documents are for developers who plan on customizing or extending opentaps''

===General Information===

* [[opentaps Release Process]]
* [[BPM Integration|SOA and BPM]]
* [[Importing Data with Dataimport]]
* [[opentaps Coding Standards]]
* [[opentaps User Interface Guidelines]]
* [[Managing Customizations with Upgrades]]
* [[How to Use Git: a Tutorial]]
* [[How To Use Monitoring Agents]]

===Developer Documentation===

* [[Technical Highlights of opentaps 1.4]]
* [http://www.opensourcestrategies.com/ofbiz/tutorials.php ofbiz framework tutorials]
* [[Domain Driven Architecture]]
* [[Using the Query Tool]]
* [[Base Entity Classes]]
* [[POJO Service Engine]]
* [[Java Wrapper for OFBiz Services]]
* [[Java Classes for Constants]]
* [[Managing Your Configuration Files]]
* [[Unit Testing]]
* [[Selenium UI Testing]]
* [[Working with the Domain Driven Architecture]]
* [[opentaps Hibernate Integration]]
* [[opentaps Search Feature]]
* [[How to use the opentaps Form Macros]]
* [[opentaps Ajax Pagination Framework]]
* [[Screen Widget Actions in Java]]
* [[Writing an ofbiz Container]]
* [[Checkstyle development tool]]
* [[Aspect Oriented Programming in opentaps]]
* [[Optimizations in Javascripts and CSS files]]
* [[How to Use Java BigDecimal: A Tutorial]]

==== opentaps and Google Web Toolkit ====
* [[Introduction to Google Web Toolkit (GWT)]]
* [[opentaps Google Web Toolkit]]
* [[Debugging GWT with Firebug]]
* [[Creating a Widget with Google Web Toolkit and opentaps]]

===Tips and Tricks===
* [[Creating and Applying Patches]]
* [[Extending opentaps]]
* [[Working with SSL]]
* [[Avoiding Database Deadlocks]]
* [[Database Tips]]
* Source Code Repository Management:
** [[SVN Tips]]
** [[How to use SVK]]
* [[Trac Tips]]
* [[CSS Display Bugs in IE]]
* [[Performance Analysis and Troubleshooting]]
* [[Running Tsung against opentaps server]]
* [[Solving the error unable to rename old file FOO to temporary file on Windows]]

===API and Technical Design Reference===
* [http://www.opentaps.org/javadocs opentaps JavaDocs]
* [[LiveCatalog XML-RPC API]]
* [[Amazon Integration]]
* [[Manufacturing Model]]
* [[Configuring the POS Store]]
* [[Configuring Authorize.NET]]
* [[Implementing CVV Security Code Checking]]

==opentaps Architecture==
* [[Examples of Modularity]]

==Recommended Reading==

<pre>
Show me your flowcharts and conceal your tables, and I'll continue to be mystified.
Show me your tables, and I won't usually need your flowcharts; they'll be obvious.
</pre>
-- [http://www.amazon.com/exec/obidos/redirect?tag=opensourcestr-20&path=ASIN/0201835959 The Mythical Man Month by Fred Brooks]

Even after four decades, and long after the word "flowchart" has been replaced by "UML", data models still play a central role in software design. The following three books will give you three different perspectives on data modeling for enterprise applications and help you understand the heart of opentaps. You should read all three to get a balanced perspective:

<a target="_blank" href="">The Data Model Resource Book, Vol. 1: A Library of Universal Data Models for All Enterprises</a><img src="//ir-na.amazon-adsystem.com/e/ir?t=racioutyle-20&l=am2&o=1&a=0471380237" width="1" height="1" border="0" alt="" style="border:none !important; margin:0px !important;" />

* [https://www.amazon.com/gp/product/0471380237/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=0471380237&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a Data Model Resource Book, Volume 1.] -- This comprehensive volume and approaches it from a relational perspective for transactional systems.
* [https://www.amazon.com/gp/product/0471380237/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=0321125215&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a Domain Driven Design] -- This book approaches the design of transactional applications from an object-oriented perspective.
* [https://www.amazon.com/gp/product/0471380237/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=0471200247&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a The Data Model Resource Book, Vol. 1] -- This book gives a comprehensive treatment from the analytical perspective.

There are also a couple of books about OFBiz on Amazon:
* [https://www.amazon.com/gp/product/0471380237/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=1847194001&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a Apache OFBiz Development]
* [https://www.amazon.com/gp/product/0471380237/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=1847199186&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a Apache OFBiz Cookbook]

Other helpful references:
* [https://www.amazon.com/gp/product/0471380237/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=0131487876&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a Opentaps Source Licensing] -- If you want to learn more about open source software licenses, read this book instead of all the mailing list graffiti.
* [https://www.amazon.com/gp/product/0471380237/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=0321344758&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a Don't Make Me Think], or I will hate your user interface.

Opentaps Technical Reference

2017-10-03T20:43:54Z

Sichen: /* Recommended Reading */

==Technical Reference==

''These documents are for developers who plan on customizing or extending opentaps''

===General Information===

* [[opentaps Release Process]]
* [[BPM Integration|SOA and BPM]]
* [[Importing Data with Dataimport]]
* [[opentaps Coding Standards]]
* [[opentaps User Interface Guidelines]]
* [[Managing Customizations with Upgrades]]
* [[How to Use Git: a Tutorial]]
* [[How To Use Monitoring Agents]]

===Developer Documentation===

* [[Technical Highlights of opentaps 1.4]]
* [http://www.opensourcestrategies.com/ofbiz/tutorials.php ofbiz framework tutorials]
* [[Domain Driven Architecture]]
* [[Using the Query Tool]]
* [[Base Entity Classes]]
* [[POJO Service Engine]]
* [[Java Wrapper for OFBiz Services]]
* [[Java Classes for Constants]]
* [[Managing Your Configuration Files]]
* [[Unit Testing]]
* [[Selenium UI Testing]]
* [[Working with the Domain Driven Architecture]]
* [[opentaps Hibernate Integration]]
* [[opentaps Search Feature]]
* [[How to use the opentaps Form Macros]]
* [[opentaps Ajax Pagination Framework]]
* [[Screen Widget Actions in Java]]
* [[Writing an ofbiz Container]]
* [[Checkstyle development tool]]
* [[Aspect Oriented Programming in opentaps]]
* [[Optimizations in Javascripts and CSS files]]
* [[How to Use Java BigDecimal: A Tutorial]]

==== opentaps and Google Web Toolkit ====
* [[Introduction to Google Web Toolkit (GWT)]]
* [[opentaps Google Web Toolkit]]
* [[Debugging GWT with Firebug]]
* [[Creating a Widget with Google Web Toolkit and opentaps]]

===Tips and Tricks===
* [[Creating and Applying Patches]]
* [[Extending opentaps]]
* [[Working with SSL]]
* [[Avoiding Database Deadlocks]]
* [[Database Tips]]
* Source Code Repository Management:
** [[SVN Tips]]
** [[How to use SVK]]
* [[Trac Tips]]
* [[CSS Display Bugs in IE]]
* [[Performance Analysis and Troubleshooting]]
* [[Running Tsung against opentaps server]]
* [[Solving the error unable to rename old file FOO to temporary file on Windows]]

===API and Technical Design Reference===
* [http://www.opentaps.org/javadocs opentaps JavaDocs]
* [[LiveCatalog XML-RPC API]]
* [[Amazon Integration]]
* [[Manufacturing Model]]
* [[Configuring the POS Store]]
* [[Configuring Authorize.NET]]
* [[Implementing CVV Security Code Checking]]

==opentaps Architecture==
* [[Examples of Modularity]]

==Recommended Reading==

<pre>
Show me your flowcharts and conceal your tables, and I'll continue to be mystified.
Show me your tables, and I won't usually need your flowcharts; they'll be obvious.
</pre>
-- [http://www.amazon.com/exec/obidos/redirect?tag=opensourcestr-20&path=ASIN/0201835959 The Mythical Man Month by Fred Brooks]

Even after four decades, and long after the word "flowchart" has been replaced by "UML", data models still play a central role in software design. The following three books will give you three different perspectives on data modeling for enterprise applications and help you understand the heart of opentaps. You should read all three to get a balanced perspective:

<a target="_blank" href="">The Data Model Resource Book, Vol. 1: A Library of Universal Data Models for All Enterprises</a><img src="//ir-na.amazon-adsystem.com/e/ir?t=racioutyle-20&l=am2&o=1&a=0471380237" width="1" height="1" border="0" alt="" style="border:none !important; margin:0px !important;" />

* [https://www.amazon.com/gp/product/0471380237/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=0471380237&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a Data Model Resource Book, Volume 1.] -- This comprehensive volume and approaches it from a relational perspective for transactional systems.
* [https://www.amazon.com/gp/product/0471380237/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=0321125215&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a Domain Driven Design] -- This book approaches the design of transactional applications from an object-oriented perspective.
* [https://www.amazon.com/gp/product/0471380237/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=0471200247&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a] -- This book gives a comprehensive treatment from the analytical perspective.

There are also a couple of books about OFBiz on Amazon:
* [https://www.amazon.com/gp/product/0471380237/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=1847194001&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a Apache OFBiz Development]
* [https://www.amazon.com/gp/product/0471380237/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=1847199186&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a Apache OFBiz Cookbook]

Other helpful references:
* [https://www.amazon.com/gp/product/0471380237/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=0131487876&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a Opentaps Source Licensing] -- If you want to learn more about open source software licenses, read this book instead of all the mailing list graffiti.
* [https://www.amazon.com/gp/product/0471380237/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=0321344758&linkCode=as2&tag=racioutyle-20&linkId=531758359dc655cd4a9c6527a1abd66a Don't Make Me Think], or I will hate your user interface.

Opentaps Technical Reference

2017-02-03T18:16:36Z

Sichen:

==Technical Reference==

''These documents are for developers who plan on customizing or extending opentaps''

===General Information===

* [[opentaps Release Process]]
* [[BPM Integration|SOA and BPM]]
* [[Importing Data with Dataimport]]
* [[opentaps Coding Standards]]
* [[opentaps User Interface Guidelines]]
* [[Managing Customizations with Upgrades]]
* [[How to Use Git: a Tutorial]]
* [[How To Use Monitoring Agents]]

===Developer Documentation===

* [[Technical Highlights of opentaps 1.4]]
* [http://www.opensourcestrategies.com/ofbiz/tutorials.php ofbiz framework tutorials]
* [[Domain Driven Architecture]]
* [[Using the Query Tool]]
* [[Base Entity Classes]]
* [[POJO Service Engine]]
* [[Java Wrapper for OFBiz Services]]
* [[Java Classes for Constants]]
* [[Managing Your Configuration Files]]
* [[Unit Testing]]
* [[Selenium UI Testing]]
* [[Working with the Domain Driven Architecture]]
* [[opentaps Hibernate Integration]]
* [[opentaps Search Feature]]
* [[How to use the opentaps Form Macros]]
* [[opentaps Ajax Pagination Framework]]
* [[Screen Widget Actions in Java]]
* [[Writing an ofbiz Container]]
* [[Checkstyle development tool]]
* [[Aspect Oriented Programming in opentaps]]
* [[Optimizations in Javascripts and CSS files]]
* [[How to Use Java BigDecimal: A Tutorial]]

==== opentaps and Google Web Toolkit ====
* [[Introduction to Google Web Toolkit (GWT)]]
* [[opentaps Google Web Toolkit]]
* [[Debugging GWT with Firebug]]
* [[Creating a Widget with Google Web Toolkit and opentaps]]

===Tips and Tricks===
* [[Creating and Applying Patches]]
* [[Extending opentaps]]
* [[Working with SSL]]
* [[Avoiding Database Deadlocks]]
* [[Database Tips]]
* Source Code Repository Management:
** [[SVN Tips]]
** [[How to use SVK]]
* [[Trac Tips]]
* [[CSS Display Bugs in IE]]
* [[Performance Analysis and Troubleshooting]]
* [[Running Tsung against opentaps server]]
* [[Solving the error unable to rename old file FOO to temporary file on Windows]]

===API and Technical Design Reference===
* [http://www.opentaps.org/javadocs opentaps JavaDocs]
* [[LiveCatalog XML-RPC API]]
* [[Amazon Integration]]
* [[Manufacturing Model]]
* [[Configuring the POS Store]]
* [[Configuring Authorize.NET]]
* [[Implementing CVV Security Code Checking]]

==opentaps Architecture==
* [[Examples of Modularity]]

==Recommended Reading==

<pre>
Show me your flowcharts and conceal your tables, and I'll continue to be mystified.
Show me your tables, and I won't usually need your flowcharts; they'll be obvious.
</pre>
-- [http://www.amazon.com/exec/obidos/redirect?tag=opensourcestr-20&path=ASIN/0201835959 The Mythical Man Month by Fred Brooks]

Even after four decades, and long after the word "flowchart" has been replaced by "UML", data models still play a central role in software design. The following three books will give you three different perspectives on data modeling for enterprise applications and help you understand the heart of opentaps. You should read all three to get a balanced perspective:
* [http://www.amazon.com/exec/obidos/redirect?tag=opensources08-20&path=ASIN/0471380237 Data Model Resource Book, Volume 1.] -- This comprehensive volume and approaches it from a relational perspective for transactional systems.
* [http://www.amazon.com/exec/obidos/redirect?tag=opensources08-20&path=ASIN/0321125215 Domain Driven Design] -- This book approaches the design of transactional applications from an object-oriented perspective.
* [http://www.amazon.com/exec/obidos/redirect?tag=opensources08-20&path=ASIN/0471200247 Data Warehouse Toolkit] -- This book gives a comprehensive treatment from the analytical perspective.

There are also a couple of books about OFBiz on Amazon:
* [http://www.amazon.com/exec/obidos/redirect?tag=opensources08-20&path=ASIN/1847194001 Apache OFBiz Development]
* [http://www.amazon.com/exec/obidos/redirect?tag=opensources08-20&path=ASIN/1847199186 Apache OFBiz Cookbook]

Other helpful references:
* [http://www.amazon.com/exec/obidos/redirect?tag=opensources08-20&path=ASIN/0131487876 Opentaps Source Licensing] -- If you want to learn more about open source software licenses, read this book instead of all the mailing list graffiti.
* [http://www.amazon.com/exec/obidos/redirect?tag=opensources08-20&path=ASIN/0321344758 Don't Make Me Think], or I will hate your user interface.

How to Use Git: a Tutorial

2016-03-08T15:44:34Z

Sichen: /* Other Notes */

This document is a work in progress.

__TOC__

==General Concepts==

[http://git-scm.com/ Git] is a free open source distributed version control system designed to handle everything from small to very large projects with speed and efficiency...once you learn how to use it.

Git can be (more than) a little confusing at first when coming from a Subversion background. Let's first try to compare subversion and git:
* it is '''distributed''': every ''checkout'' is actually a clone of the master repository, this means that there is no higher authority or single point of failure. Effectively every developer has it own repository with its own branches and own commits.
* because of that, it can also be describe as '''disconnected''': one does not need to access the master repository in order to commit, branch, merge or review the history.
* this makes all operations that would normally use the Subversion server __usable__ (checking commit log, blame, branching and merging).
* it is '''storage efficient''': the Opentaps repository in Git including 1.0.0 / 1.4 / 1.0 and all the branches and tags takes around 900Mo, typically a SVN checkout of 1.4 alone would be more than 600M, multiply this be each branch and by each tag ...

Probably one of the most important point is '''branching'''. Because Subversion branches are difficult to merge and expensive to create (one need to do a whole ''checkout'' to get a branch) they are mostly used as dead branches.

In comparison, in Git branches are very easy to create and merge back. In the git way of thinking, they are "free," and because they are local they are actually used all the time. The reason why a complete Git repository of opentaps is only 900Mo instead of a few gigabyte is because they all share a lot of common content.

Git branches are typically used for:
* local only configuration
* unit of work (tickets)
* client and sub projects

=== Local Configuration Branch ===

One of the first thing that we all do is the configuration of the database in `entityengine.xml`, and in subversion we have to lock the file else it ends up accidentally modified.

In Git one could instead use a '''configuration''' branch.

This branch can be considered a floating branch, because we want to apply it on top of whatever branch we are currently working on.
<pre>
*-----[master]----[work]----[configuration]
</pre>

=== Unit of work Branch ===

Let's say you want to work on a feature. With git, You can create a branch for your feature, work on it, and then merge it back to the main branch. A typical workflow is, from
<pre>
*-----[master]
</pre>

Create a working branch:
<pre>
*-----[master][1234-some-ticket]
</pre>

Make some commits, so your 1234-some-ticket branch advances further:
<pre>
*-----[master]---[1234-some-ticket]
</pre>

Then push the branch on `origin` for review, and have the reviewer merge it:
<pre>
*-----o------[master]
|
\---[1234-some-ticket]

master> git merge 1234-some-ticket

*-----o-----------------------(1234 merged)[master]
| |
\---[1234-some-ticket]/
</pre>

If we do not want the reviewer to do any conflict resolution and want to do it ourselves, we can merge the master into our 1234-some-ticket branch first:
<pre>
*-----o------[master]
|
\---[1234-some-ticket]

1234-some-ticket> git merge master

*-----o------[master]
| |
\------------(master merged)[1234-some-ticket]
<</pre>

Note that all of this do not mean that the branch has be local until ready, it can be pushed little by little.

We can then push it back to the master. This only produce one merge commit in the `master` branch per ticket / feature.
This makes it easier for third parties to follow.

=== Client and Sub Projects ===

Typically clients implementing opentaps or developers creating a project based on it use their own subversion repository created from a checkout of opentpas. Luckily the architecture of opentaps allow them to only store a custom hot-deploy component, but sometimes this is still a bit limited and as we know they end up touching code outside of there own components. Finally they sometimes request features / bug fixes that we implement in both our and their repository.

Having the ability to clone our repository and branch it easily means that the changes they make are contained in their branch. It also makes it easier for them to receive updates from the main opentaps repository. Finally, by setting up their repository as a new remote (eg: `client-origin`), you can have many clients in the same local repository (saving some disk space in the process). All that is needed is an SSH access, which is much easier to setup than a SVN server.

<pre>
*--o--o-----------------------------[origin/master]
| | | |
| | | |
| \----------[client-origin1/client]-[merged]
| |
| |
\---------[client-origin2/client]-[merged]
</pre>

==Using Git==

Now let's actually try to use git.

===Getting the Code===

First, let's take a look at the basic process of getting the code from git and making some local changes. Getting the code is a lot like subversion, at least on the surface. You would use the <tt>git clone</tt> command to pull the code from the remote repository to your local computer:
<pre>
$ git clone git://gitorious.org/opentaps/opentaps.git git-opentaps
Initialized empty Git repository in /Users/sichen/Documents/workspace/git-opentaps/.git/
remote: Counting objects: 78173, done.
remote: Compressing objects: 100% (14699/14699), done.
remote: Total 78173 (delta 57124), reused 77443 (delta 56698)
Receiving objects: 100% (78173/78173), 219.74 MiB | 303 KiB/s, done.
Resolving deltas: 100% (57124/57124), done.
Checking out files: 100% (15107/15107), done.
</pre>

If you have an existing repository, you can also use it as a reference when you clone, like this:
<pre>
$ git clone git://gitorious.org/opentaps/opentaps.git new-opentaps-git --reference /path/to/previous-opentaps-git/
</pre>

Now, let's imagine that you modified a file, such as <tt>framework/entity/config/entityengine.xml</tt>, and changed it to use mysql instead of the embedded Derby database. You can use <tt>git status</tt> to get a list of the files that have been modified:
<pre>
$ git status
# On branch master
# Changed but not updated:
# (use "git add <file>..." to update what will be committed)
# (use "git checkout -- <file>..." to discard changes in working directory)
#
# modified: framework/entity/config/entityengine.xml
#
no changes added to commit (use "git add" and/or "git commit -a")
</pre>

<tt>git diff</tt> will show you the actual modifications, or differences:
<pre>
$ git diff
diff --git a/framework/entity/config/entityengine.xml b/framework/entity/config/entityengine.xml
index 652c6fc..d6d341e 100644
--- a/framework/entity/config/entityengine.xml
+++ b/framework/entity/config/entityengine.xml
@@ -51,7 +51,7 @@ access. For a detailed description see the core/docs/entityconfig.html file.
<connection-factory class="org.ofbiz.entity.connection.DBCPConnectionFactory"/>

<delegator name="default" entity-model-reader="main" entity-group-reader="main" entity-eca-reader="main" distributed-cache-clear-enabled="false">
- <group-map group-name="org.ofbiz" datasource-name="localderby"/>
+ <group-map group-name="org.ofbiz" datasource-name="localmysql"/>
<group-map group-name="org.ofbiz.olap" datasource-name="localderbyolap"/>
<group-map group-name="org.opentaps.analytics" datasource-name="analytics"/>
<group-map group-name="org.opentaps.testing" datasource-name="testing"/>
</pre>
etc. etc.

===Updating===

To bring your clone up to date with the remote main opentaps repository,

<pre>
$ git fetch
</pre>

This will get updates from all the branches on the remote repository and pull them to your local clone. If you have created local branches from your remote branches, then you would need to update your local branches from the remote branches that were updated (see below):

$ git rebase origin/1447 1447

If however your local branches have changes, git will complain:
cannot rebase: you have unstaged changes
M framework/entity/config/entityengine.xml

If that's the case, you will have to "stash" your changes for the moment:
<pre>
$ git stash
$ git rebase origin/1447 1447
</pre>

==== Cherry Picking your Update ====

If you don't want to update everything, you can cherry pick a particular commit like this:
<pre>
$ git fetch
$ git cherry-pick <the-commit-hash>
</pre>

===Committing Your Changes===

To commit your changes, you must first add the change files to the list of files to commit with <tt>git add</tt>:
$ git add opentaps/opentaps-common/src/common/org/opentaps/gwt/common/server/lookup/PartyLookupService.java

This will move the file into the "Changes to be committed" list of files when you do your <tt>git status</tt>.

Note that <tt>git add</tt> is recursive, so if you
$ git add opentaps/search/src/

It will add all files which are in subdirectories of <tt>opentaps/search/src/</tt>

Once you have added your files, <tt>git commit</tt> will allow you to save your changes, or "commit" them.
<pre>
$ git commit -a
[master 4516382] Change configuration to use mysql
</pre>

'''Here's the big difference:''' After you have committed your change, it is committed to your local clone, '''not''' to the master git repository of opentaps. This means that it is still available to you, and to anybody who makes a clone of your git repository, but not to anybody who is cloning the main opentaps repository.

After you commit, you can get a history of your changes with <tt>git log</tt>:
<pre>
$ git log framework/entity/config/entityengine.xml
commit 4516382fb3d17da5a2bdccd1942b01636ea08e4d
Author: si chen <sichen@si-chens-imac.gateway.2wire.net>
Date: Tue Apr 13 11:32:56 2010 -0700

Change configuration to use mysql

commit b5bf829383d261f7eb2e4c733568dbcce65868f7
Author: sparksun <sparksun@d3523486-f5fe-0310-a41a-a15a4e76f3c7>
Date: Thu Jan 7 13:51:57 2010 +0000

#1315 add useOldAliasMetadataBehavior parameter in mysql jdbc url for avoid hibernate cannot find column view entity

git-svn-id: svn://svn.opentaps.org/opentaps_all/versions/1.4/trunk@14503 d3523486-f5fe-0310-a41a-a15a4e76f3c7

commit 6678504157a4234d051292a336bc623d83107ff2
Author: jwickers <jwickers@d3523486-f5fe-0310-a41a-a15a4e76f3c7>
Date: Fri Nov 27 04:12:00 2009 +0000

Reset default entity config to use Derby

git-svn-id: svn://svn.opentaps.org/opentaps_all/versions/1.4/trunk@14071 d3523486-f5fe-0310-a41a-a15a4e76f3c7
</pre>

Note that unlike subversion, you can see a log of all the changes of the file even before your branch was created.

===Un-Committing Your Changes===

Uh oh, I didn't mean to commit that.

You can un-commit your changes with

$ git reset HEAD <file>

or un-commit all your changes
$ git reset HEAD

You can do this before pushing them up (see below.)

===Reverting a Changed File===

What if you want to revert your changes to a file and go back to the way it was on your local repository? In git, you would use <tt>checkout</tt>, like this:
git checkout <file>

Thanks to http://norbauer.com/notebooks/code/notes/git-revert-reset-a-single-file for this tip!

===Your Stash===

To see the changes you have stashed away,
$ git stash list

To see which files have been stashed away, use
$ git stash show

This shows a list of files in the stash. You can see the changes actually stashed with
$ git stash show -u

To get it back out of the stash and apply the stashed away changes to your current working branch,
$ git stash pop

(Note its' better to <tt>git stash pop</tt> than <tt>git stash apply</tt>, or your temporary changes will stay around and accumulate until it's confusing. If that happens, you need to get rid of them (see below) and start over again.)

Sometimes every time you <tt>git stash pop</tt>, you'll get a conflict. This may have happened because your stash actually contains unresolved conflicts. The only way to fix it is to get rid of that stash.
$ git stash drop
will get rid of the last stash. You can drop a few until the problem goes away.

To get rid of a particular stash, use
$ git stash drop <stash>

To drop a particular stash.

If you don't need any of your stash, you can clear it all with
$ git stash clear

WARNING: If you stash unmerged conflicts, every time you pop from your stash, git will complain about unmerged changes.

===Pushing Your Changes Up===

To send your changes back up to the main opentaps git repository, you would need to do a
$ git push git@gitorious.org:opentaps/opentaps.git

To push a branch other than the one you are currently on (see below), use
$ git push git@gitorious.org:opentaps/opentaps.git name-of-branch

To push a branch which is not linked to a remote branch,
$ git push origin local-branch:remote-branch

If you get this error message:
! [rejected] master -> master (non-fast-forward)
It means that your version is out of date, and you need to do a <tt>git fetch</tt> to bring your version of the day first before pushing up your changes.
Permission denied (publickey).
You need to upload your public key, usually </tt>~/.ssh/id_rsa.pub</tt>, to your profile on gitorious.

===Branching===

First let's take a look at what branches are available:
<pre>
$ git branch -a
* master
remotes/origin/HEAD -> origin/master
remotes/origin/master
</pre>

The current branch you're on is the one marked with a "*". The branches which start with "/remotes/" are from remote locations, such as gitorious, where you cloned opentaps. You can't really work with those.

To create your own branch,
<pre>
$ git branch dataimport
$ git branch -a
dataimport
* master
remotes/origin/HEAD -> origin/master
remotes/origin/master
</pre>

Now, to start working with your new branch, you need to switch to it. '''The <tt>git checkout</tt> command is actually for switching between branches, like <tt>svn switch</tt>''':
<pre>
$ git checkout dataimport
Switched to branch 'dataimport'
$ git branch -a
* dataimport
master
remotes/origin/HEAD -> origin/master
remotes/origin/master
</pre>

Here's something else that will seem strange at first about branches in git: If you make changes but do not commit them, and then switch to a different branch, git will give you a diff against the other branch. So, for example:
<pre>
$ git checkout dataimport
$ vi my-file
# make some changes
$ git diff
# will show the changes you just made against your current branch, or dataimport
$ git checkout master
$ git diff
# will show the same changes, but now against the master branch you just switched to
</pre>

You would need to commit the changes to one branch or another. Then, when you switch between the branches with <tt>git checkout</tt> or see a log of your committed changes with <tt>git log</tt>, you will see the difference if you are on one branch versus another.

===Deleting a Branch===

If you need to get rid of a branch,
$ git branch useless-branch
$ git branch -d useless-branch

===Copying Remote Branches===

If you have multiple remote branches, so that
<pre>
$ git branch -a
* pro-master
remotes/origin/1447
remotes/origin/1474
remotes/origin/1487
remotes/origin/HEAD -> origin/pro-master
remotes/origin/master
remotes/origin/pro-master
</pre>

You should make a local branch which copies a remote branch first before working with it:
$ git checkout -b 1447 origin/1447

This will copy the <tt>origin/1447</tt> branch to <tt>1447</tt>:
$ git branch -a
<pre>
* 1447
pro-master
remotes/origin/1447
remotes/origin/1474
remotes/origin/1487
remotes/origin/HEAD -> origin/pro-master
remotes/origin/master
remotes/origin/pro-master
</pre>

Otherwise, if you try to checkout to a remote branch directly, git will get confused:
$ git checkout origin/1447
$ git branch -a
* (no branch)
pro-master
remotes/origin/1447
...

===Resetting to a Remote Branch===

Sometimes the remote branch may actually "fall behind" your local branch, so that when you use <tt>git fetch</tt> and <tt>git rebase</tt>, git could still not correctly mirror it. This might happen if you went back on the remote branch, for example to remove some bad commits, and then moved forward again. For example, this e-mail from git tells you that:
<pre>
This update added new revisions after undoing existing revisions. That is
to say, the old revision is not a strict subset of the new revision. This
situation occurs when you --force push a change and generate a repository
containing something like this:

* -- * -- B -- O -- O -- O (e678fc2bb071e8d57d428a7c8cb25bc2cfbe28e5)
\
N -- N -- N (007ba5038c62421d458a02fb66889d271292a48f)
</pre>

At other times, you may just want to get rid of all your local commits and go back to wherever the remote branch is right now, but <tt>git rebase</tt> would just merge the changes from the remote branch to your local branch, and not get rid of your commits.

In either case, you can solve the problem with a <tt>git reset</tt>, for example:
$ git reset --hard origin/1447

Before doing this though, you could save your local branch in another branch first:
$ git branch clone-my-1447-branch
$ git reset --hard origin/1447

and then later, if you ever need it back, you can always use <tt>git rebase</tt>
$ git rebase 1447 clone-my-1447-branch

===Reversing Pushed Changes===

Sometimes you or somebody else might have pushed changes accidentally to the remove repository. To get rid of them, first get a log or history of the push commits:
$ git log

Then, use <tt>git reset</tt> to push back to a particular come it, identified by its SHA1 sequence from the log. For example:
$ git reset --hard 6bb3dc30bc0c8fc36421474cf9376d658ee643aa

Sometimes just the first few letters and numbers of the sequence, such as <tt>6bb3dc</tt> would do.

After you've done the reset, you need to push it back to the server. However, if you just pushed your branch, you will get an error message:
<pre>
$ git push git@gitorious.org:opentaps/opentaps.git master
To git@gitorious.org:opentaps/opentaps.git
! [rejected] master -> master (non-fast-forward)
error: failed to push some refs to 'git@gitorious.org:opentaps/opentaps.git'
To prevent you from losing history, non-fast-forward updates were rejected
Merge the remote changes before pushing again. See the 'Note about
fast-forwards' section of 'git push --help' for details.
</pre>

To really push it, you would need to add a <tt>+</tt> before your branch name:
<pre>
$ git push git@gitorious.org:opentaps/opentaps.git +master
Total 0 (delta 0), reused 0 (delta 0)
=> Syncing Gitorious... [OK]
To git@gitorious.org:opentaps/opentaps.git
+ 6398f5f...6bb3dc3 master -> master (forced update)
</pre>

===Fixing Commits Which Have Not Been Pushed===

If you have committed changes but have not pushed him yet, you have several ways of fixing them:
* git reset --hard origin/xxx : you will lose all the local commits and changes in your current branch
* git commit --ammend : you can use the ammend flag to "fix" the previous commit
* git reset XXX : without --hard it only resets the branch marker, but keeps the changes, so you can recommit the changes in a different way or fix them / etc ..
* git rebase -i XXX : opens an editor with the list of commits from XXX to your current branch state and you can remove one of those commits / reorder them / merge some together / etc ..

===Merging===

You can merge the changes from branch into another by switching to the target branch first, then doing a <tt>git merge</tt>. If you want to get the changes from a remote branch, you should <tt>git fetch</tt> and <tt>git rebase</tt> first. For example,
$ git fetch
$ git rebase origin/master master
$ git checkout dataimport
$ git merge master

This sequence gets all the updates from the remote git server, then updates the local copy of the master branch from the remote one. Next, I switched over to the dataimport branch. Finally, I merged the changes from the master branch to the dataimport branch.

Once you've done this, you may want to send the merged version of your local branch back to the remote repository. In that case, you must push again:
$ git push dataimport

Note that you do not need to commit first, because the merge happens on the local repository, so there are no uncommitted changes against the local repository.

You can always undo a rebase
$ git rebase --abort

===Merge Request===

Here's an example of something that would be a lot of work with subversion but almost trivial with git:

git pull git://gitorious.org/opentaps/opentaps.git refs/merge-requests/6
git push git://gitorious.org/opentaps/opentaps.git

I've just pulled a merge request from our gitorious repository, which are automatically merged into their branches in my local git repository, and then I pushed them back to gitorious.

====Clean Merge Requests====

Normally when working on a branch one would sometime have to merge the changes from the trunk into it in order to keep working on up-to-date code.
However when making a merge request this can result in a lot of those merges making the request harder to review.

When possible, instead of merging the trunk into the working branch one could rebase the working branch on top of the trunk.
For example if the trunk (from gitorious) is ''master'' and the working branch is ''my-feature''

git rebase master my-feature

===Experimenting with Git===

When you are first working with git, try this from any branch:
$ git branch tmp

This will copy it to a branch called <tt>tmp</tt>. You can then do whatever you want, such as
$ git reset XXX --hard

If later you decide that's not what you wanted, you can try to get it back with
$ git reset --hard tmp

Also, you can use
$ git reflog

to get a history.

===Extracting Diff from History===

To get historical changes from git, you can use <tt>git diff</tt> like this:
$ git diff 7cc3f0ce846952196dde68c62595f9 0069e2e46ad591bf4b7cf169d493b9

This will produce a diff file which you can then use the <tt>patch</tt> command to apply to other files.

Note that <tt>git diff</tt> parameters are in opposite sequence of <tt>svn diff</tt>:

$ svn diff <earlier>:<later>

is the same as
$ git diff <later> <earlier>

===Working with Additional Remote Repositories===

The other neat thing about git is that you can add additional remote repositories. For example, you may have cloned your own repository, but then you want to merge in changes from opentaps, or merge some of your changes back against opentaps. You can do this by adding the gitorious opentaps:
$ git remote add gitorious git://gitorious.org/opentaps/opentaps.git
$ git fetch -all
....
From git://gitorious.org/opentaps/opentaps
....
* [new branch] master -> gitorious/master

Now if you check your branches, you will see that there is a new <tt>remotes/gitorious/master</tt> branch:
$ git branch -a
....
remotes/gitorious/master

To merge in from gitorious opentaps:
$ git merge gitorious/master

(That's it!)

To merge back to opentaps, you need to create a patch file
$ git diff -p gitorious/master origin/master

or just the specified directories:
$ git diff -p gitorious/master origin/master -- opentaps
$ git diff -p gitorious/master origin/master -- opentaps/crmsfa opentaps/financials

and use the patch file for merging.

==Other Notes==

===File Formats===

With more frequent branching and merging, it's important that you keep file formats consistent and avoid Unix/Windows file differences. Make sure your editor is set to use Unix line terminations (use LF instead or CRLF). '''Before pushing to GIT, make sure your commit does not change the line terminations!''' Use $ git diff, and you will see the diff change all the file instead of just the relevant part.

If you are not sure about your editor you can also try to find the DOS2UNIX.EXE utility to set the proper formating.

===Untracked Files===

To get a list of files not tracked by git,
$ git status

You can remove files which are not tracked by git with
$ git clean -x -f -d

It will remove all the untracked files and directories from your current directory.

===What if Git Hangs?===

Sometimes git could get stuck while unpacking objects:
$ git fetch
remote: Counting objects: 137, done.
remote: Compressing objects: 100% (79/79), done.
Unpacking objects: 13% (12/88)

When I ctrl+c stop it and then check, there's a large list of dangling commits:
$ git fsck
Checking object directories: 100% (256/256), done.
Checking objects: 100% (210332/210332), done.
dangling commit d70058dada2c537a03d68d79f5c71a2325ae1c8f
dangling commit 5617c81334112457e6bd8d058b252172cc131562
dangling commit 942b10e3066e96b8b2311ae3882763a1e06c8179
dangling commit af3b78d82838f237048a7f1b22032d0e02cd4bbf
dangling commit 7454907e59d3e340b41ba5bb4d7449d033f1ec53
......

This fixed it:
$ git gc --aggressive

==References==
* http://git.or.cz/course/svn.html
* http://www-cs-students.stanford.edu/~blynn/gitmagic/ch01.html
* http://jonas.iki.fi/git_guides/HTML/git_guide/
* http://www.bitsun.com/documents/gittutorcn.htm
* http://wenku.baidu.com/view/a3490b22192e45361066f56a.html
* http://wiki.eclipse.org/EGit/User_Guide

How to Use Git: a Tutorial

2016-01-21T21:38:50Z

Sichen: /* Your Stash */

This document is a work in progress.

__TOC__

==General Concepts==

[http://git-scm.com/ Git] is a free open source distributed version control system designed to handle everything from small to very large projects with speed and efficiency...once you learn how to use it.

Git can be (more than) a little confusing at first when coming from a Subversion background. Let's first try to compare subversion and git:
* it is '''distributed''': every ''checkout'' is actually a clone of the master repository, this means that there is no higher authority or single point of failure. Effectively every developer has it own repository with its own branches and own commits.
* because of that, it can also be describe as '''disconnected''': one does not need to access the master repository in order to commit, branch, merge or review the history.
* this makes all operations that would normally use the Subversion server __usable__ (checking commit log, blame, branching and merging).
* it is '''storage efficient''': the Opentaps repository in Git including 1.0.0 / 1.4 / 1.0 and all the branches and tags takes around 900Mo, typically a SVN checkout of 1.4 alone would be more than 600M, multiply this be each branch and by each tag ...

Probably one of the most important point is '''branching'''. Because Subversion branches are difficult to merge and expensive to create (one need to do a whole ''checkout'' to get a branch) they are mostly used as dead branches.

In comparison, in Git branches are very easy to create and merge back. In the git way of thinking, they are "free," and because they are local they are actually used all the time. The reason why a complete Git repository of opentaps is only 900Mo instead of a few gigabyte is because they all share a lot of common content.

Git branches are typically used for:
* local only configuration
* unit of work (tickets)
* client and sub projects

=== Local Configuration Branch ===

One of the first thing that we all do is the configuration of the database in `entityengine.xml`, and in subversion we have to lock the file else it ends up accidentally modified.

In Git one could instead use a '''configuration''' branch.

This branch can be considered a floating branch, because we want to apply it on top of whatever branch we are currently working on.
<pre>
*-----[master]----[work]----[configuration]
</pre>

=== Unit of work Branch ===

Let's say you want to work on a feature. With git, You can create a branch for your feature, work on it, and then merge it back to the main branch. A typical workflow is, from
<pre>
*-----[master]
</pre>

Create a working branch:
<pre>
*-----[master][1234-some-ticket]
</pre>

Make some commits, so your 1234-some-ticket branch advances further:
<pre>
*-----[master]---[1234-some-ticket]
</pre>

Then push the branch on `origin` for review, and have the reviewer merge it:
<pre>
*-----o------[master]
|
\---[1234-some-ticket]

master> git merge 1234-some-ticket

*-----o-----------------------(1234 merged)[master]
| |
\---[1234-some-ticket]/
</pre>

If we do not want the reviewer to do any conflict resolution and want to do it ourselves, we can merge the master into our 1234-some-ticket branch first:
<pre>
*-----o------[master]
|
\---[1234-some-ticket]

1234-some-ticket> git merge master

*-----o------[master]
| |
\------------(master merged)[1234-some-ticket]
<</pre>

Note that all of this do not mean that the branch has be local until ready, it can be pushed little by little.

We can then push it back to the master. This only produce one merge commit in the `master` branch per ticket / feature.
This makes it easier for third parties to follow.

=== Client and Sub Projects ===

Typically clients implementing opentaps or developers creating a project based on it use their own subversion repository created from a checkout of opentpas. Luckily the architecture of opentaps allow them to only store a custom hot-deploy component, but sometimes this is still a bit limited and as we know they end up touching code outside of there own components. Finally they sometimes request features / bug fixes that we implement in both our and their repository.

Having the ability to clone our repository and branch it easily means that the changes they make are contained in their branch. It also makes it easier for them to receive updates from the main opentaps repository. Finally, by setting up their repository as a new remote (eg: `client-origin`), you can have many clients in the same local repository (saving some disk space in the process). All that is needed is an SSH access, which is much easier to setup than a SVN server.

<pre>
*--o--o-----------------------------[origin/master]
| | | |
| | | |
| \----------[client-origin1/client]-[merged]
| |
| |
\---------[client-origin2/client]-[merged]
</pre>

==Using Git==

Now let's actually try to use git.

===Getting the Code===

First, let's take a look at the basic process of getting the code from git and making some local changes. Getting the code is a lot like subversion, at least on the surface. You would use the <tt>git clone</tt> command to pull the code from the remote repository to your local computer:
<pre>
$ git clone git://gitorious.org/opentaps/opentaps.git git-opentaps
Initialized empty Git repository in /Users/sichen/Documents/workspace/git-opentaps/.git/
remote: Counting objects: 78173, done.
remote: Compressing objects: 100% (14699/14699), done.
remote: Total 78173 (delta 57124), reused 77443 (delta 56698)
Receiving objects: 100% (78173/78173), 219.74 MiB | 303 KiB/s, done.
Resolving deltas: 100% (57124/57124), done.
Checking out files: 100% (15107/15107), done.
</pre>

If you have an existing repository, you can also use it as a reference when you clone, like this:
<pre>
$ git clone git://gitorious.org/opentaps/opentaps.git new-opentaps-git --reference /path/to/previous-opentaps-git/
</pre>

Now, let's imagine that you modified a file, such as <tt>framework/entity/config/entityengine.xml</tt>, and changed it to use mysql instead of the embedded Derby database. You can use <tt>git status</tt> to get a list of the files that have been modified:
<pre>
$ git status
# On branch master
# Changed but not updated:
# (use "git add <file>..." to update what will be committed)
# (use "git checkout -- <file>..." to discard changes in working directory)
#
# modified: framework/entity/config/entityengine.xml
#
no changes added to commit (use "git add" and/or "git commit -a")
</pre>

<tt>git diff</tt> will show you the actual modifications, or differences:
<pre>
$ git diff
diff --git a/framework/entity/config/entityengine.xml b/framework/entity/config/entityengine.xml
index 652c6fc..d6d341e 100644
--- a/framework/entity/config/entityengine.xml
+++ b/framework/entity/config/entityengine.xml
@@ -51,7 +51,7 @@ access. For a detailed description see the core/docs/entityconfig.html file.
<connection-factory class="org.ofbiz.entity.connection.DBCPConnectionFactory"/>

<delegator name="default" entity-model-reader="main" entity-group-reader="main" entity-eca-reader="main" distributed-cache-clear-enabled="false">
- <group-map group-name="org.ofbiz" datasource-name="localderby"/>
+ <group-map group-name="org.ofbiz" datasource-name="localmysql"/>
<group-map group-name="org.ofbiz.olap" datasource-name="localderbyolap"/>
<group-map group-name="org.opentaps.analytics" datasource-name="analytics"/>
<group-map group-name="org.opentaps.testing" datasource-name="testing"/>
</pre>
etc. etc.

===Updating===

To bring your clone up to date with the remote main opentaps repository,

<pre>
$ git fetch
</pre>

This will get updates from all the branches on the remote repository and pull them to your local clone. If you have created local branches from your remote branches, then you would need to update your local branches from the remote branches that were updated (see below):

$ git rebase origin/1447 1447

If however your local branches have changes, git will complain:
cannot rebase: you have unstaged changes
M framework/entity/config/entityengine.xml

If that's the case, you will have to "stash" your changes for the moment:
<pre>
$ git stash
$ git rebase origin/1447 1447
</pre>

==== Cherry Picking your Update ====

If you don't want to update everything, you can cherry pick a particular commit like this:
<pre>
$ git fetch
$ git cherry-pick <the-commit-hash>
</pre>

===Committing Your Changes===

To commit your changes, you must first add the change files to the list of files to commit with <tt>git add</tt>:
$ git add opentaps/opentaps-common/src/common/org/opentaps/gwt/common/server/lookup/PartyLookupService.java

This will move the file into the "Changes to be committed" list of files when you do your <tt>git status</tt>.

Note that <tt>git add</tt> is recursive, so if you
$ git add opentaps/search/src/

It will add all files which are in subdirectories of <tt>opentaps/search/src/</tt>

Once you have added your files, <tt>git commit</tt> will allow you to save your changes, or "commit" them.
<pre>
$ git commit -a
[master 4516382] Change configuration to use mysql
</pre>

'''Here's the big difference:''' After you have committed your change, it is committed to your local clone, '''not''' to the master git repository of opentaps. This means that it is still available to you, and to anybody who makes a clone of your git repository, but not to anybody who is cloning the main opentaps repository.

After you commit, you can get a history of your changes with <tt>git log</tt>:
<pre>
$ git log framework/entity/config/entityengine.xml
commit 4516382fb3d17da5a2bdccd1942b01636ea08e4d
Author: si chen <sichen@si-chens-imac.gateway.2wire.net>
Date: Tue Apr 13 11:32:56 2010 -0700

Change configuration to use mysql

commit b5bf829383d261f7eb2e4c733568dbcce65868f7
Author: sparksun <sparksun@d3523486-f5fe-0310-a41a-a15a4e76f3c7>
Date: Thu Jan 7 13:51:57 2010 +0000

#1315 add useOldAliasMetadataBehavior parameter in mysql jdbc url for avoid hibernate cannot find column view entity

git-svn-id: svn://svn.opentaps.org/opentaps_all/versions/1.4/trunk@14503 d3523486-f5fe-0310-a41a-a15a4e76f3c7

commit 6678504157a4234d051292a336bc623d83107ff2
Author: jwickers <jwickers@d3523486-f5fe-0310-a41a-a15a4e76f3c7>
Date: Fri Nov 27 04:12:00 2009 +0000

Reset default entity config to use Derby

git-svn-id: svn://svn.opentaps.org/opentaps_all/versions/1.4/trunk@14071 d3523486-f5fe-0310-a41a-a15a4e76f3c7
</pre>

Note that unlike subversion, you can see a log of all the changes of the file even before your branch was created.

===Un-Committing Your Changes===

Uh oh, I didn't mean to commit that.

You can un-commit your changes with

$ git reset HEAD <file>

or un-commit all your changes
$ git reset HEAD

You can do this before pushing them up (see below.)

===Reverting a Changed File===

What if you want to revert your changes to a file and go back to the way it was on your local repository? In git, you would use <tt>checkout</tt>, like this:
git checkout <file>

Thanks to http://norbauer.com/notebooks/code/notes/git-revert-reset-a-single-file for this tip!

===Your Stash===

To see the changes you have stashed away,
$ git stash list

To see which files have been stashed away, use
$ git stash show

This shows a list of files in the stash. You can see the changes actually stashed with
$ git stash show -u

To get it back out of the stash and apply the stashed away changes to your current working branch,
$ git stash pop

(Note its' better to <tt>git stash pop</tt> than <tt>git stash apply</tt>, or your temporary changes will stay around and accumulate until it's confusing. If that happens, you need to get rid of them (see below) and start over again.)

Sometimes every time you <tt>git stash pop</tt>, you'll get a conflict. This may have happened because your stash actually contains unresolved conflicts. The only way to fix it is to get rid of that stash.
$ git stash drop
will get rid of the last stash. You can drop a few until the problem goes away.

To get rid of a particular stash, use
$ git stash drop <stash>

To drop a particular stash.

If you don't need any of your stash, you can clear it all with
$ git stash clear

WARNING: If you stash unmerged conflicts, every time you pop from your stash, git will complain about unmerged changes.

===Pushing Your Changes Up===

To send your changes back up to the main opentaps git repository, you would need to do a
$ git push git@gitorious.org:opentaps/opentaps.git

To push a branch other than the one you are currently on (see below), use
$ git push git@gitorious.org:opentaps/opentaps.git name-of-branch

To push a branch which is not linked to a remote branch,
$ git push origin local-branch:remote-branch

If you get this error message:
! [rejected] master -> master (non-fast-forward)
It means that your version is out of date, and you need to do a <tt>git fetch</tt> to bring your version of the day first before pushing up your changes.
Permission denied (publickey).
You need to upload your public key, usually </tt>~/.ssh/id_rsa.pub</tt>, to your profile on gitorious.

===Branching===

First let's take a look at what branches are available:
<pre>
$ git branch -a
* master
remotes/origin/HEAD -> origin/master
remotes/origin/master
</pre>

The current branch you're on is the one marked with a "*". The branches which start with "/remotes/" are from remote locations, such as gitorious, where you cloned opentaps. You can't really work with those.

To create your own branch,
<pre>
$ git branch dataimport
$ git branch -a
dataimport
* master
remotes/origin/HEAD -> origin/master
remotes/origin/master
</pre>

Now, to start working with your new branch, you need to switch to it. '''The <tt>git checkout</tt> command is actually for switching between branches, like <tt>svn switch</tt>''':
<pre>
$ git checkout dataimport
Switched to branch 'dataimport'
$ git branch -a
* dataimport
master
remotes/origin/HEAD -> origin/master
remotes/origin/master
</pre>

Here's something else that will seem strange at first about branches in git: If you make changes but do not commit them, and then switch to a different branch, git will give you a diff against the other branch. So, for example:
<pre>
$ git checkout dataimport
$ vi my-file
# make some changes
$ git diff
# will show the changes you just made against your current branch, or dataimport
$ git checkout master
$ git diff
# will show the same changes, but now against the master branch you just switched to
</pre>

You would need to commit the changes to one branch or another. Then, when you switch between the branches with <tt>git checkout</tt> or see a log of your committed changes with <tt>git log</tt>, you will see the difference if you are on one branch versus another.

===Deleting a Branch===

If you need to get rid of a branch,
$ git branch useless-branch
$ git branch -d useless-branch

===Copying Remote Branches===

If you have multiple remote branches, so that
<pre>
$ git branch -a
* pro-master
remotes/origin/1447
remotes/origin/1474
remotes/origin/1487
remotes/origin/HEAD -> origin/pro-master
remotes/origin/master
remotes/origin/pro-master
</pre>

You should make a local branch which copies a remote branch first before working with it:
$ git checkout -b 1447 origin/1447

This will copy the <tt>origin/1447</tt> branch to <tt>1447</tt>:
$ git branch -a
<pre>
* 1447
pro-master
remotes/origin/1447
remotes/origin/1474
remotes/origin/1487
remotes/origin/HEAD -> origin/pro-master
remotes/origin/master
remotes/origin/pro-master
</pre>

Otherwise, if you try to checkout to a remote branch directly, git will get confused:
$ git checkout origin/1447
$ git branch -a
* (no branch)
pro-master
remotes/origin/1447
...

===Resetting to a Remote Branch===

Sometimes the remote branch may actually "fall behind" your local branch, so that when you use <tt>git fetch</tt> and <tt>git rebase</tt>, git could still not correctly mirror it. This might happen if you went back on the remote branch, for example to remove some bad commits, and then moved forward again. For example, this e-mail from git tells you that:
<pre>
This update added new revisions after undoing existing revisions. That is
to say, the old revision is not a strict subset of the new revision. This
situation occurs when you --force push a change and generate a repository
containing something like this:

* -- * -- B -- O -- O -- O (e678fc2bb071e8d57d428a7c8cb25bc2cfbe28e5)
\
N -- N -- N (007ba5038c62421d458a02fb66889d271292a48f)
</pre>

At other times, you may just want to get rid of all your local commits and go back to wherever the remote branch is right now, but <tt>git rebase</tt> would just merge the changes from the remote branch to your local branch, and not get rid of your commits.

In either case, you can solve the problem with a <tt>git reset</tt>, for example:
$ git reset --hard origin/1447

Before doing this though, you could save your local branch in another branch first:
$ git branch clone-my-1447-branch
$ git reset --hard origin/1447

and then later, if you ever need it back, you can always use <tt>git rebase</tt>
$ git rebase 1447 clone-my-1447-branch

===Reversing Pushed Changes===

Sometimes you or somebody else might have pushed changes accidentally to the remove repository. To get rid of them, first get a log or history of the push commits:
$ git log

Then, use <tt>git reset</tt> to push back to a particular come it, identified by its SHA1 sequence from the log. For example:
$ git reset --hard 6bb3dc30bc0c8fc36421474cf9376d658ee643aa

Sometimes just the first few letters and numbers of the sequence, such as <tt>6bb3dc</tt> would do.

After you've done the reset, you need to push it back to the server. However, if you just pushed your branch, you will get an error message:
<pre>
$ git push git@gitorious.org:opentaps/opentaps.git master
To git@gitorious.org:opentaps/opentaps.git
! [rejected] master -> master (non-fast-forward)
error: failed to push some refs to 'git@gitorious.org:opentaps/opentaps.git'
To prevent you from losing history, non-fast-forward updates were rejected
Merge the remote changes before pushing again. See the 'Note about
fast-forwards' section of 'git push --help' for details.
</pre>

To really push it, you would need to add a <tt>+</tt> before your branch name:
<pre>
$ git push git@gitorious.org:opentaps/opentaps.git +master
Total 0 (delta 0), reused 0 (delta 0)
=> Syncing Gitorious... [OK]
To git@gitorious.org:opentaps/opentaps.git
+ 6398f5f...6bb3dc3 master -> master (forced update)
</pre>

===Fixing Commits Which Have Not Been Pushed===

If you have committed changes but have not pushed him yet, you have several ways of fixing them:
* git reset --hard origin/xxx : you will lose all the local commits and changes in your current branch
* git commit --ammend : you can use the ammend flag to "fix" the previous commit
* git reset XXX : without --hard it only resets the branch marker, but keeps the changes, so you can recommit the changes in a different way or fix them / etc ..
* git rebase -i XXX : opens an editor with the list of commits from XXX to your current branch state and you can remove one of those commits / reorder them / merge some together / etc ..

===Merging===

You can merge the changes from branch into another by switching to the target branch first, then doing a <tt>git merge</tt>. If you want to get the changes from a remote branch, you should <tt>git fetch</tt> and <tt>git rebase</tt> first. For example,
$ git fetch
$ git rebase origin/master master
$ git checkout dataimport
$ git merge master

This sequence gets all the updates from the remote git server, then updates the local copy of the master branch from the remote one. Next, I switched over to the dataimport branch. Finally, I merged the changes from the master branch to the dataimport branch.

Once you've done this, you may want to send the merged version of your local branch back to the remote repository. In that case, you must push again:
$ git push dataimport

Note that you do not need to commit first, because the merge happens on the local repository, so there are no uncommitted changes against the local repository.

You can always undo a rebase
$ git rebase --abort

===Merge Request===

Here's an example of something that would be a lot of work with subversion but almost trivial with git:

git pull git://gitorious.org/opentaps/opentaps.git refs/merge-requests/6
git push git://gitorious.org/opentaps/opentaps.git

I've just pulled a merge request from our gitorious repository, which are automatically merged into their branches in my local git repository, and then I pushed them back to gitorious.

====Clean Merge Requests====

Normally when working on a branch one would sometime have to merge the changes from the trunk into it in order to keep working on up-to-date code.
However when making a merge request this can result in a lot of those merges making the request harder to review.

When possible, instead of merging the trunk into the working branch one could rebase the working branch on top of the trunk.
For example if the trunk (from gitorious) is ''master'' and the working branch is ''my-feature''

git rebase master my-feature

===Experimenting with Git===

When you are first working with git, try this from any branch:
$ git branch tmp

This will copy it to a branch called <tt>tmp</tt>. You can then do whatever you want, such as
$ git reset XXX --hard

If later you decide that's not what you wanted, you can try to get it back with
$ git reset --hard tmp

Also, you can use
$ git reflog

to get a history.

===Extracting Diff from History===

To get historical changes from git, you can use <tt>git diff</tt> like this:
$ git diff 7cc3f0ce846952196dde68c62595f9 0069e2e46ad591bf4b7cf169d493b9

This will produce a diff file which you can then use the <tt>patch</tt> command to apply to other files.

Note that <tt>git diff</tt> parameters are in opposite sequence of <tt>svn diff</tt>:

$ svn diff <earlier>:<later>

is the same as
$ git diff <later> <earlier>

===Working with Additional Remote Repositories===

The other neat thing about git is that you can add additional remote repositories. For example, you may have cloned your own repository, but then you want to merge in changes from opentaps, or merge some of your changes back against opentaps. You can do this by adding the gitorious opentaps:
$ git remote add gitorious git://gitorious.org/opentaps/opentaps.git
$ git fetch -all
....
From git://gitorious.org/opentaps/opentaps
....
* [new branch] master -> gitorious/master

Now if you check your branches, you will see that there is a new <tt>remotes/gitorious/master</tt> branch:
$ git branch -a
....
remotes/gitorious/master

To merge in from gitorious opentaps:
$ git merge gitorious/master

(That's it!)

To merge back to opentaps, you need to create a patch file
$ git diff -p gitorious/master origin/master

or just the specified directories:
$ git diff -p gitorious/master origin/master -- opentaps
$ git diff -p gitorious/master origin/master -- opentaps/crmsfa opentaps/financials

and use the patch file for merging.

==Other Notes==

===File Formats===

With more frequent branching and merging, it's important that you keep file formats consistent and avoid Unix/Windows file differences. Make sure your editor is set to use Unix line terminations (use LF instead or CRLF). '''Before pushing to GIT, make sure your commit does not change the line terminations!''' Use $ git diff, and you will see the diff change all the file instead of just the relevant part.

If you are not sure about your editor you can also try to find the DOS2UNIX.EXE utility to set the proper formating.

===Untracked Files===

To get a list of files not tracked by git,
$ git status

You can remove files which are not tracked by git with
$ git clean -x -f -d

It will remove all the untracked files and directories from your current directory.

==References==
* http://git.or.cz/course/svn.html
* http://www-cs-students.stanford.edu/~blynn/gitmagic/ch01.html
* http://jonas.iki.fi/git_guides/HTML/git_guide/
* http://www.bitsun.com/documents/gittutorcn.htm
* http://wenku.baidu.com/view/a3490b22192e45361066f56a.html
* http://wiki.eclipse.org/EGit/User_Guide

How to Use Git: a Tutorial

2015-06-26T01:37:34Z

Sichen: /* Your Stash */

This document is a work in progress.

__TOC__

==General Concepts==

[http://git-scm.com/ Git] is a free open source distributed version control system designed to handle everything from small to very large projects with speed and efficiency...once you learn how to use it.

Git can be (more than) a little confusing at first when coming from a Subversion background. Let's first try to compare subversion and git:
* it is '''distributed''': every ''checkout'' is actually a clone of the master repository, this means that there is no higher authority or single point of failure. Effectively every developer has it own repository with its own branches and own commits.
* because of that, it can also be describe as '''disconnected''': one does not need to access the master repository in order to commit, branch, merge or review the history.
* this makes all operations that would normally use the Subversion server __usable__ (checking commit log, blame, branching and merging).
* it is '''storage efficient''': the Opentaps repository in Git including 1.0.0 / 1.4 / 1.0 and all the branches and tags takes around 900Mo, typically a SVN checkout of 1.4 alone would be more than 600M, multiply this be each branch and by each tag ...

Probably one of the most important point is '''branching'''. Because Subversion branches are difficult to merge and expensive to create (one need to do a whole ''checkout'' to get a branch) they are mostly used as dead branches.

In comparison, in Git branches are very easy to create and merge back. In the git way of thinking, they are "free," and because they are local they are actually used all the time. The reason why a complete Git repository of opentaps is only 900Mo instead of a few gigabyte is because they all share a lot of common content.

Git branches are typically used for:
* local only configuration
* unit of work (tickets)
* client and sub projects

=== Local Configuration Branch ===

One of the first thing that we all do is the configuration of the database in `entityengine.xml`, and in subversion we have to lock the file else it ends up accidentally modified.

In Git one could instead use a '''configuration''' branch.

This branch can be considered a floating branch, because we want to apply it on top of whatever branch we are currently working on.
<pre>
*-----[master]----[work]----[configuration]
</pre>

=== Unit of work Branch ===

Let's say you want to work on a feature. With git, You can create a branch for your feature, work on it, and then merge it back to the main branch. A typical workflow is, from
<pre>
*-----[master]
</pre>

Create a working branch:
<pre>
*-----[master][1234-some-ticket]
</pre>

Make some commits, so your 1234-some-ticket branch advances further:
<pre>
*-----[master]---[1234-some-ticket]
</pre>

Then push the branch on `origin` for review, and have the reviewer merge it:
<pre>
*-----o------[master]
|
\---[1234-some-ticket]

master> git merge 1234-some-ticket

*-----o-----------------------(1234 merged)[master]
| |
\---[1234-some-ticket]/
</pre>

If we do not want the reviewer to do any conflict resolution and want to do it ourselves, we can merge the master into our 1234-some-ticket branch first:
<pre>
*-----o------[master]
|
\---[1234-some-ticket]

1234-some-ticket> git merge master

*-----o------[master]
| |
\------------(master merged)[1234-some-ticket]
<</pre>

Note that all of this do not mean that the branch has be local until ready, it can be pushed little by little.

We can then push it back to the master. This only produce one merge commit in the `master` branch per ticket / feature.
This makes it easier for third parties to follow.

=== Client and Sub Projects ===

Typically clients implementing opentaps or developers creating a project based on it use their own subversion repository created from a checkout of opentpas. Luckily the architecture of opentaps allow them to only store a custom hot-deploy component, but sometimes this is still a bit limited and as we know they end up touching code outside of there own components. Finally they sometimes request features / bug fixes that we implement in both our and their repository.

Having the ability to clone our repository and branch it easily means that the changes they make are contained in their branch. It also makes it easier for them to receive updates from the main opentaps repository. Finally, by setting up their repository as a new remote (eg: `client-origin`), you can have many clients in the same local repository (saving some disk space in the process). All that is needed is an SSH access, which is much easier to setup than a SVN server.

<pre>
*--o--o-----------------------------[origin/master]
| | | |
| | | |
| \----------[client-origin1/client]-[merged]
| |
| |
\---------[client-origin2/client]-[merged]
</pre>

==Using Git==

Now let's actually try to use git.

===Getting the Code===

First, let's take a look at the basic process of getting the code from git and making some local changes. Getting the code is a lot like subversion, at least on the surface. You would use the <tt>git clone</tt> command to pull the code from the remote repository to your local computer:
<pre>
$ git clone git://gitorious.org/opentaps/opentaps.git git-opentaps
Initialized empty Git repository in /Users/sichen/Documents/workspace/git-opentaps/.git/
remote: Counting objects: 78173, done.
remote: Compressing objects: 100% (14699/14699), done.
remote: Total 78173 (delta 57124), reused 77443 (delta 56698)
Receiving objects: 100% (78173/78173), 219.74 MiB | 303 KiB/s, done.
Resolving deltas: 100% (57124/57124), done.
Checking out files: 100% (15107/15107), done.
</pre>

If you have an existing repository, you can also use it as a reference when you clone, like this:
<pre>
$ git clone git://gitorious.org/opentaps/opentaps.git new-opentaps-git --reference /path/to/previous-opentaps-git/
</pre>

Now, let's imagine that you modified a file, such as <tt>framework/entity/config/entityengine.xml</tt>, and changed it to use mysql instead of the embedded Derby database. You can use <tt>git status</tt> to get a list of the files that have been modified:
<pre>
$ git status
# On branch master
# Changed but not updated:
# (use "git add <file>..." to update what will be committed)
# (use "git checkout -- <file>..." to discard changes in working directory)
#
# modified: framework/entity/config/entityengine.xml
#
no changes added to commit (use "git add" and/or "git commit -a")
</pre>

<tt>git diff</tt> will show you the actual modifications, or differences:
<pre>
$ git diff
diff --git a/framework/entity/config/entityengine.xml b/framework/entity/config/entityengine.xml
index 652c6fc..d6d341e 100644
--- a/framework/entity/config/entityengine.xml
+++ b/framework/entity/config/entityengine.xml
@@ -51,7 +51,7 @@ access. For a detailed description see the core/docs/entityconfig.html file.
<connection-factory class="org.ofbiz.entity.connection.DBCPConnectionFactory"/>

<delegator name="default" entity-model-reader="main" entity-group-reader="main" entity-eca-reader="main" distributed-cache-clear-enabled="false">
- <group-map group-name="org.ofbiz" datasource-name="localderby"/>
+ <group-map group-name="org.ofbiz" datasource-name="localmysql"/>
<group-map group-name="org.ofbiz.olap" datasource-name="localderbyolap"/>
<group-map group-name="org.opentaps.analytics" datasource-name="analytics"/>
<group-map group-name="org.opentaps.testing" datasource-name="testing"/>
</pre>
etc. etc.

===Updating===

To bring your clone up to date with the remote main opentaps repository,

<pre>
$ git fetch
</pre>

This will get updates from all the branches on the remote repository and pull them to your local clone. If you have created local branches from your remote branches, then you would need to update your local branches from the remote branches that were updated (see below):

$ git rebase origin/1447 1447

If however your local branches have changes, git will complain:
cannot rebase: you have unstaged changes
M framework/entity/config/entityengine.xml

If that's the case, you will have to "stash" your changes for the moment:
<pre>
$ git stash
$ git rebase origin/1447 1447
</pre>

==== Cherry Picking your Update ====

If you don't want to update everything, you can cherry pick a particular commit like this:
<pre>
$ git fetch
$ git cherry-pick <the-commit-hash>
</pre>

===Committing Your Changes===

To commit your changes, you must first add the change files to the list of files to commit with <tt>git add</tt>:
$ git add opentaps/opentaps-common/src/common/org/opentaps/gwt/common/server/lookup/PartyLookupService.java

This will move the file into the "Changes to be committed" list of files when you do your <tt>git status</tt>.

Note that <tt>git add</tt> is recursive, so if you
$ git add opentaps/search/src/

It will add all files which are in subdirectories of <tt>opentaps/search/src/</tt>

Once you have added your files, <tt>git commit</tt> will allow you to save your changes, or "commit" them.
<pre>
$ git commit -a
[master 4516382] Change configuration to use mysql
</pre>

'''Here's the big difference:''' After you have committed your change, it is committed to your local clone, '''not''' to the master git repository of opentaps. This means that it is still available to you, and to anybody who makes a clone of your git repository, but not to anybody who is cloning the main opentaps repository.

After you commit, you can get a history of your changes with <tt>git log</tt>:
<pre>
$ git log framework/entity/config/entityengine.xml
commit 4516382fb3d17da5a2bdccd1942b01636ea08e4d
Author: si chen <sichen@si-chens-imac.gateway.2wire.net>
Date: Tue Apr 13 11:32:56 2010 -0700

Change configuration to use mysql

commit b5bf829383d261f7eb2e4c733568dbcce65868f7
Author: sparksun <sparksun@d3523486-f5fe-0310-a41a-a15a4e76f3c7>
Date: Thu Jan 7 13:51:57 2010 +0000

#1315 add useOldAliasMetadataBehavior parameter in mysql jdbc url for avoid hibernate cannot find column view entity

git-svn-id: svn://svn.opentaps.org/opentaps_all/versions/1.4/trunk@14503 d3523486-f5fe-0310-a41a-a15a4e76f3c7

commit 6678504157a4234d051292a336bc623d83107ff2
Author: jwickers <jwickers@d3523486-f5fe-0310-a41a-a15a4e76f3c7>
Date: Fri Nov 27 04:12:00 2009 +0000

Reset default entity config to use Derby

git-svn-id: svn://svn.opentaps.org/opentaps_all/versions/1.4/trunk@14071 d3523486-f5fe-0310-a41a-a15a4e76f3c7
</pre>

Note that unlike subversion, you can see a log of all the changes of the file even before your branch was created.

===Un-Committing Your Changes===

Uh oh, I didn't mean to commit that.

You can un-commit your changes with

$ git reset HEAD <file>

or un-commit all your changes
$ git reset HEAD

You can do this before pushing them up (see below.)

===Reverting a Changed File===

What if you want to revert your changes to a file and go back to the way it was on your local repository? In git, you would use <tt>checkout</tt>, like this:
git checkout <file>

Thanks to http://norbauer.com/notebooks/code/notes/git-revert-reset-a-single-file for this tip!

===Your Stash===

To see the changes you have stashed away,
$ git stash list

To see which files have been stashed away, use
$ git stash show

This shows a list of files in the stash. You can see the changes actually stashed with
$ git stash show -u

To get it back out of the stash and apply the stashed away changes to your current working branch,
$ git stash pop

(Note its' better to <tt>git stash pop</tt> than <tt>git stash apply</tt>, or your temporary changes will stay around and accumulate until it's confusing. If that happens, you need to get rid of them (see below) and start over again.)

To get rid of a particular stash, use
$ git stash drop <stash>

To drop a particular stash.

If you don't need any of your stash, you can clear it all with
$ git stash clear

WARNING: If you stash unmerged conflicts, every time you pop from your stash, git will complain about unmerged changes.

===Pushing Your Changes Up===

To send your changes back up to the main opentaps git repository, you would need to do a
$ git push git@gitorious.org:opentaps/opentaps.git

To push a branch other than the one you are currently on (see below), use
$ git push git@gitorious.org:opentaps/opentaps.git name-of-branch

To push a branch which is not linked to a remote branch,
$ git push origin local-branch:remote-branch

If you get this error message:
! [rejected] master -> master (non-fast-forward)
It means that your version is out of date, and you need to do a <tt>git fetch</tt> to bring your version of the day first before pushing up your changes.
Permission denied (publickey).
You need to upload your public key, usually </tt>~/.ssh/id_rsa.pub</tt>, to your profile on gitorious.

===Branching===

First let's take a look at what branches are available:
<pre>
$ git branch -a
* master
remotes/origin/HEAD -> origin/master
remotes/origin/master
</pre>

The current branch you're on is the one marked with a "*". The branches which start with "/remotes/" are from remote locations, such as gitorious, where you cloned opentaps. You can't really work with those.

To create your own branch,
<pre>
$ git branch dataimport
$ git branch -a
dataimport
* master
remotes/origin/HEAD -> origin/master
remotes/origin/master
</pre>

Now, to start working with your new branch, you need to switch to it. '''The <tt>git checkout</tt> command is actually for switching between branches, like <tt>svn switch</tt>''':
<pre>
$ git checkout dataimport
Switched to branch 'dataimport'
$ git branch -a
* dataimport
master
remotes/origin/HEAD -> origin/master
remotes/origin/master
</pre>

Here's something else that will seem strange at first about branches in git: If you make changes but do not commit them, and then switch to a different branch, git will give you a diff against the other branch. So, for example:
<pre>
$ git checkout dataimport
$ vi my-file
# make some changes
$ git diff
# will show the changes you just made against your current branch, or dataimport
$ git checkout master
$ git diff
# will show the same changes, but now against the master branch you just switched to
</pre>

You would need to commit the changes to one branch or another. Then, when you switch between the branches with <tt>git checkout</tt> or see a log of your committed changes with <tt>git log</tt>, you will see the difference if you are on one branch versus another.

===Deleting a Branch===

If you need to get rid of a branch,
$ git branch useless-branch
$ git branch -d useless-branch

===Copying Remote Branches===

If you have multiple remote branches, so that
<pre>
$ git branch -a
* pro-master
remotes/origin/1447
remotes/origin/1474
remotes/origin/1487
remotes/origin/HEAD -> origin/pro-master
remotes/origin/master
remotes/origin/pro-master
</pre>

You should make a local branch which copies a remote branch first before working with it:
$ git checkout -b 1447 origin/1447

This will copy the <tt>origin/1447</tt> branch to <tt>1447</tt>:
$ git branch -a
<pre>
* 1447
pro-master
remotes/origin/1447
remotes/origin/1474
remotes/origin/1487
remotes/origin/HEAD -> origin/pro-master
remotes/origin/master
remotes/origin/pro-master
</pre>

Otherwise, if you try to checkout to a remote branch directly, git will get confused:
$ git checkout origin/1447
$ git branch -a
* (no branch)
pro-master
remotes/origin/1447
...

===Resetting to a Remote Branch===

Sometimes the remote branch may actually "fall behind" your local branch, so that when you use <tt>git fetch</tt> and <tt>git rebase</tt>, git could still not correctly mirror it. This might happen if you went back on the remote branch, for example to remove some bad commits, and then moved forward again. For example, this e-mail from git tells you that:
<pre>
This update added new revisions after undoing existing revisions. That is
to say, the old revision is not a strict subset of the new revision. This
situation occurs when you --force push a change and generate a repository
containing something like this:

* -- * -- B -- O -- O -- O (e678fc2bb071e8d57d428a7c8cb25bc2cfbe28e5)
\
N -- N -- N (007ba5038c62421d458a02fb66889d271292a48f)
</pre>

At other times, you may just want to get rid of all your local commits and go back to wherever the remote branch is right now, but <tt>git rebase</tt> would just merge the changes from the remote branch to your local branch, and not get rid of your commits.

In either case, you can solve the problem with a <tt>git reset</tt>, for example:
$ git reset --hard origin/1447

Before doing this though, you could save your local branch in another branch first:
$ git branch clone-my-1447-branch
$ git reset --hard origin/1447

and then later, if you ever need it back, you can always use <tt>git rebase</tt>
$ git rebase 1447 clone-my-1447-branch

===Reversing Pushed Changes===

Sometimes you or somebody else might have pushed changes accidentally to the remove repository. To get rid of them, first get a log or history of the push commits:
$ git log

Then, use <tt>git reset</tt> to push back to a particular come it, identified by its SHA1 sequence from the log. For example:
$ git reset --hard 6bb3dc30bc0c8fc36421474cf9376d658ee643aa

Sometimes just the first few letters and numbers of the sequence, such as <tt>6bb3dc</tt> would do.

After you've done the reset, you need to push it back to the server. However, if you just pushed your branch, you will get an error message:
<pre>
$ git push git@gitorious.org:opentaps/opentaps.git master
To git@gitorious.org:opentaps/opentaps.git
! [rejected] master -> master (non-fast-forward)
error: failed to push some refs to 'git@gitorious.org:opentaps/opentaps.git'
To prevent you from losing history, non-fast-forward updates were rejected
Merge the remote changes before pushing again. See the 'Note about
fast-forwards' section of 'git push --help' for details.
</pre>

To really push it, you would need to add a <tt>+</tt> before your branch name:
<pre>
$ git push git@gitorious.org:opentaps/opentaps.git +master
Total 0 (delta 0), reused 0 (delta 0)
=> Syncing Gitorious... [OK]
To git@gitorious.org:opentaps/opentaps.git
+ 6398f5f...6bb3dc3 master -> master (forced update)
</pre>

===Fixing Commits Which Have Not Been Pushed===

If you have committed changes but have not pushed him yet, you have several ways of fixing them:
* git reset --hard origin/xxx : you will lose all the local commits and changes in your current branch
* git commit --ammend : you can use the ammend flag to "fix" the previous commit
* git reset XXX : without --hard it only resets the branch marker, but keeps the changes, so you can recommit the changes in a different way or fix them / etc ..
* git rebase -i XXX : opens an editor with the list of commits from XXX to your current branch state and you can remove one of those commits / reorder them / merge some together / etc ..

===Merging===

You can merge the changes from branch into another by switching to the target branch first, then doing a <tt>git merge</tt>. If you want to get the changes from a remote branch, you should <tt>git fetch</tt> and <tt>git rebase</tt> first. For example,
$ git fetch
$ git rebase origin/master master
$ git checkout dataimport
$ git merge master

This sequence gets all the updates from the remote git server, then updates the local copy of the master branch from the remote one. Next, I switched over to the dataimport branch. Finally, I merged the changes from the master branch to the dataimport branch.

Once you've done this, you may want to send the merged version of your local branch back to the remote repository. In that case, you must push again:
$ git push dataimport

Note that you do not need to commit first, because the merge happens on the local repository, so there are no uncommitted changes against the local repository.

You can always undo a rebase
$ git rebase --abort

===Merge Request===

Here's an example of something that would be a lot of work with subversion but almost trivial with git:

git pull git://gitorious.org/opentaps/opentaps.git refs/merge-requests/6
git push git://gitorious.org/opentaps/opentaps.git

I've just pulled a merge request from our gitorious repository, which are automatically merged into their branches in my local git repository, and then I pushed them back to gitorious.

====Clean Merge Requests====

Normally when working on a branch one would sometime have to merge the changes from the trunk into it in order to keep working on up-to-date code.
However when making a merge request this can result in a lot of those merges making the request harder to review.

When possible, instead of merging the trunk into the working branch one could rebase the working branch on top of the trunk.
For example if the trunk (from gitorious) is ''master'' and the working branch is ''my-feature''

git rebase master my-feature

===Experimenting with Git===

When you are first working with git, try this from any branch:
$ git branch tmp

This will copy it to a branch called <tt>tmp</tt>. You can then do whatever you want, such as
$ git reset XXX --hard

If later you decide that's not what you wanted, you can try to get it back with
$ git reset --hard tmp

Also, you can use
$ git reflog

to get a history.

===Extracting Diff from History===

To get historical changes from git, you can use <tt>git diff</tt> like this:
$ git diff 7cc3f0ce846952196dde68c62595f9 0069e2e46ad591bf4b7cf169d493b9

This will produce a diff file which you can then use the <tt>patch</tt> command to apply to other files.

Note that <tt>git diff</tt> parameters are in opposite sequence of <tt>svn diff</tt>:

$ svn diff <earlier>:<later>

is the same as
$ git diff <later> <earlier>

===Working with Additional Remote Repositories===

The other neat thing about git is that you can add additional remote repositories. For example, you may have cloned your own repository, but then you want to merge in changes from opentaps, or merge some of your changes back against opentaps. You can do this by adding the gitorious opentaps:
$ git remote add gitorious git://gitorious.org/opentaps/opentaps.git
$ git fetch -all
....
From git://gitorious.org/opentaps/opentaps
....
* [new branch] master -> gitorious/master

Now if you check your branches, you will see that there is a new <tt>remotes/gitorious/master</tt> branch:
$ git branch -a
....
remotes/gitorious/master

To merge in from gitorious opentaps:
$ git merge gitorious/master

(That's it!)

To merge back to opentaps, you need to create a patch file
$ git diff -p gitorious/master origin/master

or just the specified directories:
$ git diff -p gitorious/master origin/master -- opentaps
$ git diff -p gitorious/master origin/master -- opentaps/crmsfa opentaps/financials

and use the patch file for merging.

==Other Notes==

===File Formats===

With more frequent branching and merging, it's important that you keep file formats consistent and avoid Unix/Windows file differences. Make sure your editor is set to use Unix line terminations (use LF instead or CRLF). '''Before pushing to GIT, make sure your commit does not change the line terminations!''' Use $ git diff, and you will see the diff change all the file instead of just the relevant part.

If you are not sure about your editor you can also try to find the DOS2UNIX.EXE utility to set the proper formating.

===Untracked Files===

To get a list of files not tracked by git,
$ git status

You can remove files which are not tracked by git with
$ git clean -x -f -d

It will remove all the untracked files and directories from your current directory.

==References==
* http://git.or.cz/course/svn.html
* http://www-cs-students.stanford.edu/~blynn/gitmagic/ch01.html
* http://jonas.iki.fi/git_guides/HTML/git_guide/
* http://www.bitsun.com/documents/gittutorcn.htm
* http://wenku.baidu.com/view/a3490b22192e45361066f56a.html
* http://wiki.eclipse.org/EGit/User_Guide

File:Download authorize dot net SSL certificate.png

2015-05-28T16:05:03Z

Sichen: Protected "Image:Download authorize dot net SSL certificate.png": Sysop page [edit=sysop:move=sysop]

File:Download authorize dot net SSL certificate.png

2015-05-28T16:05:02Z

Sichen:

CRM-2 Social API

2015-03-20T00:29:42Z

Sichen: New page: The social API allows you to record social interactions of your customers, such as views, likes (faves), votes for and against, and comments. They can be related to other activities or to...

The social API allows you to record social interactions of your customers, such as views, likes (faves), votes for and against, and comments. They can be related to other activities or to other nodes, such as web pages or blog posts. The API does not include the user interface but is meant to be called from the user interface to record the interactions.

=== Views ===

Records or retrieves the number of times the activity has been viewed.

=== Like ===

Records or retrieves the likes or faves of an activity.

=== Thumb Up and Thumb Down ===

Records and retrieves votes either for or against.

=== Comments ===

Records comments. A comment is first created in the pending state and will be emailed to the domain administrator (user with DOMAIN_CONF permission), who needs to approve or reject the comment. Only approved comments will be retrieved for display.

CRM-2 Social API

2015-03-20T00:29:42Z

Sichen: Protected "CRM-2 Social API": Sysop page [edit=sysop:move=sysop]

CRM-2 API

2015-03-20T00:20:28Z

Sichen:

CRM-2 API is accessed via RESTful services using your authorization token key. All access to CRM-2 API follow this common pattern:
* URL: RESTful URL of the CRM-2 resource
* operation:
** POST: creates new value
** GET: get existing value(s)
** PUT: update existing value
** DELETE: delete existing value
* clientDomain: name of your domain, ie xyz.com
* authToken: your access token key, a very long alphanumeric string
* parameters: key value pairs for your API operation

You can also use curl or a visual RESTful client to test the API. For example,

<pre>
$ curl -X POST 'http://crm-2-url/admin/activity-type' -d clientDomain=newdomain.com -d activityType="PINNED"
-d authToken=<token>
$ curl -X GET "http://crm-2-url/admin/activity-type?clientDomain=newdomain.com
&authToken=<token>"
$ curl -X DELETE 'http://crm-2-url/admin/activity-type' -d clientDomain=newdomain.com -d activityType="PINNED" -d authToken=<token>
</pre>

can be used to create, read, and delete data.

To update data, a PUT operation is used

<pre>
$ curl -X PUT --data "clientDomain=xyz.com&mailUser=newemail@gmail.com&mailStoreProtocol="imaps"&
mailHost="pop.googlemail.com"&mailPass="123456"
&authToken=<token>"
http://crm-2-url/admin/email-to-poll
</pre>

API available, grouped by section, are:
* [[CRM-2 Security Model]]
* [[CRM-2 Administrative API]]
* [[CRM-2 Contacts API]]
* [[CRM-2 Activities API]]
* [[CRM-2 Tags API]]
* [[CRM-2 Social API]]

Opentaps Analytics Ranking Product Categories

2014-12-20T00:45:12Z

Sichen:

With your sale data, opentaps Analytics can help you rank a list of products and present the best sellers to your customers first.

But what is a best seller? This is not as simple as it may first sound. Should you show your customers the products which have sold the most units, or the products that have higher prices but may sell less frequently? What if a product is new or hasn't sold too many times, but its brand sells much better than the other brands you carry? Finally, should you show a product by itself or a category of products first?

opentaps Analytics takes into consideration several factors when ranking your product category's members, including:
* Value of sales
* Units sold
* Sales of the brand
* Newness of the products
* Number of clicks for the product or sub-category's web page

So, it could help you balance showing high value/low volume versus low value/high volume products. In the event several products have similar sales (or no sales), it could help you prioritize based on better-selling brands. Finally, it'll push the newest products in your category higher. All these factors are controlled by parameters which you can use to adjust the relative weights or rankings of each one.

To rank your product category, call the API at URL
<pre>
http://analytics.opentaps.com/analytics/control/productCategoriesRank?userlogin=your_user_name&password=your_password&webkey=your_webkey
</pre>

with a JSON string in this format:
<pre>
{
"categories":[
{
"id":"CATEGORY1",
"introductionDate":"2012-03-15T21:52:10",
"products":[
{
"id":"PRODUCT1001",
"introductionDate":"2012-03-15T21:56:09"
}
]
},
{
"id":"CATEGORY2",
"introductionDate":"2012-02-23T01:47:10",
"products":[
{
"id":"CATEGORY2001",
"introductionDate":"2012-02-10T19:49:14"
},
{
"id":"CATEGORY2002",
"introductionDate":"2012-02-10T19:49:16"
}
]
}
],
"products":[
{
"id":"PRODUCT3001",
"introductionDate":"2007-08-09T21:19:28"
},
{
"id":"PRODUCT3002",
"introductionDate":"2007-08-09T21:19:28"
}
],
"dateFrom":"2013-01-01T00:00:00",
"dateTo":"2013-12-31T00:00:00",
"brandBoostFactor":"1.00",
"newnessBoostFactor":"1.00",
"quantityBoostFactor":"2.00"
}
</pre>

Note that you are passing both a list of products and a list of categories, plus your parameters. opentaps Analytics will look through your categories and sum up the sales of the products within those categories.

The additional parameters are:
* dateFrom and dateTo - date range of sales, in JSON format (i.e. 2014-12-01T00:00:00)
* brand boost factor - weighting of relative sales of this product's or category's brand relative to the average sale of brands, during the time period. A weight of 1.0 means that the brand weighting is equal to the relative sales weighting.
* newness factor - relative weight for newness. Newness starts at 1.0 for new products and linearly amortizes to 0.0 over 30 days. You can use this boost the factor.
* quantity boost factor - relative factor for quantity (units) of sales versus value (dollar amount) of sales. 1.0 means quantity and value of sales are equally important.
* click weight - relative weighting of number of clicks the product or sub-category has received versus the sales data. This should be a very small number, such as 0.01, since sales are the most important determining factor. However, it could be used as a "tie breaker" for products with very similar amounts of sales. You can also use a negative value here in case you want to penalize products that get a lot of clicks but no sales.

The response will be a JSON string with each of the products and categories which are members of your original category and the ranking score from opentaps Analytics:
<pre>
{
"categories":{
"CATEGORY1":4.227991,
"CATEGORY2":1.712083,
},
"products":{
"PRODUCT3001":24.52276,
"PRODUCT3002":24.52276
}
}
</pre>

The higher rankings are the ones that opentaps Analytics recommends more heavily. Use them in your ecommerce system to rank the category's products and sub-categories.

You should try different combinations of parameters to see if the recommendations make sense. For example, is it over-relying on brand for this particular category? Might a brand overall have high sales but in another category altogether? Should we give the new products more of a chance to prove themselves and increase the newness factor? Are we over-emphasizing high value, low volume products? These can all be tweaked with the parameters to get new sets of rankings.

Opentaps Analytics Ranking Product Categories

2014-12-20T00:37:38Z

Sichen:

With your sale data, opentaps Analytics can help you rank a list of products and present the best sellers to your customers first.

But what is a best seller? This is not as simple as it may first sound. Should you show your customers the products which have sold the most units, or the products that have higher prices but may sell less frequently? What if a product is new or hasn't sold too many times, but its brand sells much better than the other brands you carry? Finally, should you show a product by itself or a category of products first?

opentaps Analytics takes into consideration several factors when ranking your product category's members, including:
* Value of sales
* Units sold
* Sales of the brand
* Newness of the products

So, it could help you balance showing high value/low volume versus low value/high volume products. In the event several products have similar sales (or no sales), it could help you prioritize based on better-selling brands. Finally, it'll push the newest products in your category higher. All these factors are controlled by parameters which you can use to adjust the relative weights or rankings of each one.

To rank your product category, call the API at URL
<pre>
http://analytics.opentaps.com/analytics/control/productCategoriesRank?userlogin=your_user_name&password=your_password&webkey=your_webkey
</pre>

with a JSON string in this format:
<pre>
{
"categories":[
{
"id":"CATEGORY1",
"introductionDate":"2012-03-15T21:52:10",
"products":[
{
"id":"PRODUCT1001",
"introductionDate":"2012-03-15T21:56:09"
}
]
},
{
"id":"CATEGORY2",
"introductionDate":"2012-02-23T01:47:10",
"products":[
{
"id":"CATEGORY2001",
"introductionDate":"2012-02-10T19:49:14"
},
{
"id":"CATEGORY2002",
"introductionDate":"2012-02-10T19:49:16"
}
]
}
],
"products":[
{
"id":"PRODUCT3001",
"introductionDate":"2007-08-09T21:19:28"
},
{
"id":"PRODUCT3002",
"introductionDate":"2007-08-09T21:19:28"
}
],
"dateFrom":"2013-01-01T00:00:00",
"dateTo":"2013-12-31T00:00:00",
"brandBoostFactor":"1.00",
"newnessBoostFactor":"1.00",
"quantityBoostFactor":"2.00"
}
</pre>

Note that you are passing both a list of products and a list of categories, plus your parameters. opentaps Analytics will look through your categories and sum up the sales of the products within those categories.

The additional parameters are:
* dateFrom and dateTo - date range of sales, in JSON format (i.e. 2014-12-01T00:00:00)
* brand boost factor - weighting of relative sales of this product's or category's brand relative to the average sale of brands, during the time period. A weight of 1.0 means that the brand weighting is equal to the relative sales weighting.
* newness factor - relative weight for newness. Newness starts at 1.0 for new products and linearly amortizes to 0.0 over 30 days. You can use this boost the factor.
* quantity boost factor - relative factor for quantity (units) of sales versus value (dollar amount) of sales. 1.0 means quantity and value of sales are equally important.

The response will be a JSON string with each of the products and categories which are members of your original category and the ranking score from opentaps Analytics:
<pre>
{
"categories":{
"CATEGORY1":4.227991,
"CATEGORY2":1.712083,
},
"products":{
"PRODUCT3001":24.52276,
"PRODUCT3002":24.52276
}
}
</pre>

The higher rankings are the ones that opentaps Analytics recommends more heavily. Use them in your ecommerce system to rank the category's products and sub-categories.

You should try different combinations of parameters to see if the recommendations make sense. For example, is it over-relying on brand for this particular category? Might a brand overall have high sales but in another category altogether? Should we give the new products more of a chance to prove themselves and increase the newness factor? Are we over-emphasizing high value, low volume products? These can all be tweaked with the parameters to get new sets of rankings.

CRM-2 Security Model

2014-11-19T22:57:30Z

Sichen: New page: ===How opentaps CRM2 Security Works=== A Contact may have many User logins, but the Contact (not each of its Users) has security settings for to each domain. This is an important differen...

===How opentaps CRM2 Security Works===

A Contact may have many User logins, but the Contact (not each of its Users) has security settings for to each domain. This is an important difference from opentaps 1.x/ofbiz: security is associated with the Contact (Party), not the User. This means you get the same permissions to the system if you're logged in with your Google, Twitter, or Facebook account.

Security is accessed via authorization tokens. Each user ID is associated with a permanent authorization token, which is a random alphanumeric string that identifies the user to the system. This authorization token should be kept secret -- it is the same as having the password for that user.

We recommend that you obtain a temporary auth token programatically, instead of using the authorization token or asking each user to login.

You can POST a request to https://crm2.opentaps.com/oauth/temp-token with your permanent auth token to obtain a temporary authorization token for the same user as the auth token (ie, your admin user). The temporary token is by default set to expire in 60 minutes. Store it locally in your session to access the crm2 server.

To make sure your temporary token is valid before a call, use /oauth/validate and pass your temporary token.

A good practice is to:

# see if you have a temporary token in your session
# if so, use /oauth/validate to see if it is still valid
# if there is no temporary token or it is no longer valid, call /oauth/temp-token to get a new one

See https://github.com/opentaps/opentaps-crm2 for examples of how the authorization token is used.

CRM-2 Security Model

2014-11-19T22:57:30Z

Sichen: Protected "CRM-2 Security Model": Sysop page [edit=sysop:move=sysop]

CRM-2 API

2014-11-19T22:52:33Z

Sichen:

CRM-2 Tags API

2014-11-19T20:52:14Z

Sichen:

Tags are a way to group your activities and tasks and link them to the outside world. The tags in opentaps crm2 have a tag name, which is the description, plus a URL and keywords. The URL can be used to link tagged activities to outside data, such as linking emails and notes to a sales order in another system. The keywords can be used to search for activities which may be related to the tag. For example, we can use it to search for emails which may be related to an invoice.

Tags are inherited in the following way:
# When an activity is tagged, a new task created from the activity will have the same tags
# When a task is tagged, any activity created from the task will be tagged as well.
# When an existing activity is linked to an existing task, the tags from that task will be inherited by the activity. However, the activity may have existing tags, and those will still be there as well -- they are not erased when an activity is transferred from one task to another.

==== Tags ====

A tag can store the following data:
* tagId - unique identifier
* tag name - descriptive text of the tag
* an optional URL link which can be used to link to an outside system, such as the order ID or party ID of a legacy ERP or CRM system.
* keywords which can be used for searching similar documents

Tag names are case insensitive, so the tags opentaps, OPENTAPs, and OpenTaps would all be considered the same.

Tags have a hierarchy based on their name. If a tag has two colons (<tt>::</tt>) in its name, then the first part before the <tt>::</tt> is the parent tag of all tags which contains it. For example, <tt>Sales Order::</tt> would be the parent tag of <tt>Sales Order::12345</tt>, <tt>Sales Order::45678</tt> In the user interface, the parent tags are shown in the Tags tab, and when you click on a parent tag, the child tags are shown.

===== API =====

Endpoint: https://crm2.opentaps.com/tag

'''POST''': Create a new tag

Parameters:
* clientDomain
* authToken
* tagName
* tagUrl
* tagKeywords

Returns
* tagId: unique identifier of your tag

If the same tagName (case insensitive) already exists, then the operation would return an error.

'''PUT''': Update an existing tag using the unique tagId

Parameters:
* clientDomain
* authToken
* tagId

'''DELETE''': Delete an existing tag using the unique tagId

Parameters:
* clientDomain
* authToken
* tagId

'''GET''': Search for existing tags which contain your tag name (case insensitive)

Parameters:
* clientDomain
* authToken
* tagName

Returns
* List of tags, including tagId, tagName, tagUrl, tagKeywords for each tag

===== Relating Tags to Tasks and Activities =====

A tag can be added to any task or activity.

If you append the fields <tt>tagName</tt>, <tt>tagUrl</tt>, <tt>tagKeywords</tt>, <tt>parentTagId</tt> to any POST API call to [[CRM-2 Activities API|create an activity or task]], crm2 will check if the tagName already exists. If so, the activity or task will be associated with your tag. In that case, the URL and keywords will be ignored. If the tag name is not found, it will automatically create a new tag with the name, URL, and keywords and associate it with your task or activity.

You can get all the activities and tasks related to a tag with the API call to https://crm2.opentaps.com/tagActivities

'''GET''': Get all activities and tasks related to a task

Parameters:
* clientDomain
* authToken
* tagId

Returns
* List of activities and tasks related to the tag

'''GET''': Get all the tags related to an activity

Parameters:
* clientDomain
* authToken
* activityId

Returns
* List of tags, including all their tagId, tagName, tagUrl, tagKeywords, related to the activity

'''POST''': Add a tag to an activity

Parameters:
* clientDomain
* authToken
* activityId
* tagId

'''DELETE''': Delete a tag from an activity

Parameters:
* clientDomain
* authToken
* activityId
* tagId

CRM-2 Tags API

2014-11-05T02:20:38Z

Sichen: /* Relating Tags to Tasks and Activities */

Tags are a way to group your activities and tasks and link them to the outside world. The tags in opentaps crm2 have a tag name, which is the description, plus a URL and keywords. The URL can be used to link tagged activities to outside data, such as linking emails and notes to a sales order in another system. The keywords can be used to search for activities which may be related to the tag. For example, we can use it to search for emails which may be related to an invoice.

Tags are inherited in the following way:
# When an activity is tagged, a new task created from the activity will have the same tags
# When a task is tagged, any activity created from the task will be tagged as well.
# When an existing activity is linked to an existing task, the tags from that task will be inherited by the activity. However, the activity may have existing tags, and those will still be there as well -- they are not erased when an activity is transferred from one task to another.

==== Tags ====

A tag can store the following data:
* tagId - unique identifier
* parentTagId - unique ID of the parent tag, or blank if this tag is at the top level. For example, a parent tag could be "Sales Orders", and the tag could be "Sales Order 1", "Sales Order 2", etc.
* tag name - descriptive text of the tag
* an optional URL link which can be used to link to an outside system, such as the order ID or party ID of a legacy ERP or CRM system.
* keywords which can be used for searching similar documents

Tag names are case insensitive, so the tags opentaps, OPENTAPs, and OpenTaps would all be considered the same.

===== API =====

Endpoint: https://crm2.opentaps.com/tag

'''POST''': Create a new tag

Parameters:
* clientDomain
* authToken
* tagName
* parentTagId
* tagUrl
* tagKeywords

Returns
* tagId: unique identifier of your tag

If the same tagName (case insensitive) already exists, then the operation would return an error.

'''PUT''': Update an existing tag using the unique tagId

Parameters:
* clientDomain
* authToken
* tagId
* parentTagId

'''DELETE''': Delete an existing tag using the unique tagId

Parameters:
* clientDomain
* authToken
* tagId

'''GET''': Search for existing tags which contain your tag name (case insensitive)

Parameters:
* clientDomain
* authToken
* tagName

Returns
* List of tags, including tagId, tagName, tagUrl, tagKeywords for each tag

===== Relating Tags to Tasks and Activities =====

A tag can be added to any task or activity.

If you append the fields <tt>tagName</tt>, <tt>tagUrl</tt>, <tt>tagKeywords</tt>, <tt>parentTagId</tt> to any POST API call to [[CRM-2 Activities API|create an activity or task]], crm2 will check if the tagName already exists. If so, the activity or task will be associated with your tag. In that case, the URL and keywords will be ignored. If the tag name is not found, it will automatically create a new tag with the name, URL, and keywords and associate it with your task or activity.

You can get all the activities and tasks related to a tag with the API call to https://crm2.opentaps.com/tagActivities

'''GET''': Get all activities and tasks related to a task

Parameters:
* clientDomain
* authToken
* tagId

Returns
* List of activities and tasks related to the tag

'''GET''': Get all the tags related to an activity

Parameters:
* clientDomain
* authToken
* activityId

Returns
* List of tags, including all their tagId, tagName, tagUrl, tagKeywords, related to the activity

'''POST''': Add a tag to an activity

Parameters:
* clientDomain
* authToken
* activityId
* tagId

'''DELETE''': Delete a tag from an activity

Parameters:
* clientDomain
* authToken
* activityId
* tagId

CRM-2 Tags API

2014-11-05T02:18:52Z

Sichen: /* Tags */

Tags are a way to group your activities and tasks and link them to the outside world. The tags in opentaps crm2 have a tag name, which is the description, plus a URL and keywords. The URL can be used to link tagged activities to outside data, such as linking emails and notes to a sales order in another system. The keywords can be used to search for activities which may be related to the tag. For example, we can use it to search for emails which may be related to an invoice.

Tags are inherited in the following way:
# When an activity is tagged, a new task created from the activity will have the same tags
# When a task is tagged, any activity created from the task will be tagged as well.
# When an existing activity is linked to an existing task, the tags from that task will be inherited by the activity. However, the activity may have existing tags, and those will still be there as well -- they are not erased when an activity is transferred from one task to another.

==== Tags ====

A tag can store the following data:
* tagId - unique identifier
* parentTagId - unique ID of the parent tag, or blank if this tag is at the top level. For example, a parent tag could be "Sales Orders", and the tag could be "Sales Order 1", "Sales Order 2", etc.
* tag name - descriptive text of the tag
* an optional URL link which can be used to link to an outside system, such as the order ID or party ID of a legacy ERP or CRM system.
* keywords which can be used for searching similar documents

Tag names are case insensitive, so the tags opentaps, OPENTAPs, and OpenTaps would all be considered the same.

===== API =====

Endpoint: https://crm2.opentaps.com/tag

'''POST''': Create a new tag

Parameters:
* clientDomain
* authToken
* tagName
* parentTagId
* tagUrl
* tagKeywords

Returns
* tagId: unique identifier of your tag

If the same tagName (case insensitive) already exists, then the operation would return an error.

'''PUT''': Update an existing tag using the unique tagId

Parameters:
* clientDomain
* authToken
* tagId
* parentTagId

'''DELETE''': Delete an existing tag using the unique tagId

Parameters:
* clientDomain
* authToken
* tagId

'''GET''': Search for existing tags which contain your tag name (case insensitive)

Parameters:
* clientDomain
* authToken
* tagName

Returns
* List of tags, including tagId, tagName, tagUrl, tagKeywords for each tag

===== Relating Tags to Tasks and Activities =====

A tag can be added to any task or activity.

If you append the fields <tt>tagName</tt>, <tt>tagUrl</tt>, <tt>tagKeywords</tt> to any POST API call to [[CRM-2 Activities API|create an activity or task]], crm2 will check if the tagName already exists. If so, the activity or task will be associated with your tag. In that case, the URL and keywords will be ignored. If the tag name is not found, it will automatically create a new tag with the name, URL, and keywords and associate it with your task or activity.

You can get all the activities and tasks related to a tag with the API call to https://crm2.opentaps.com/tagActivities

'''GET''': Get all activities and tasks related to a task

Parameters:
* clientDomain
* authToken
* tagId

Returns
* List of activities and tasks related to the tag

'''GET''': Get all the tags related to an activity

Parameters:
* clientDomain
* authToken
* activityId

Returns
* List of tags, including all their tagId, tagName, tagUrl, tagKeywords, related to the activity

'''POST''': Add a tag to an activity

Parameters:
* clientDomain
* authToken
* activityId
* tagId

'''DELETE''': Delete a tag from an activity

Parameters:
* clientDomain
* authToken
* activityId
* tagId

Set up CRM2

2014-11-03T22:41:52Z

Sichen: /* Setting up the WordPress Contact Form */

__TOC__

== First Steps ==

First, go to [http://www.opentaps.com opentaps.com] to sign up for opentaps CRM2.

Once you have received your permanent authorization token key by email, reset it

<pre>
$ curl -X POST 'https://crm2.opentaps.com/admin/reset-token' -d clientDomain= ${yourDomain} -d authToken=${authToken}
</pre>

'''Keep your new auth token secret!''' Someone with this token will be able to access everything in your account.

== opentaps 1.x ==

=== Setting Up with opentaps in the Cloud ===

If you are using an [http://www.opentaps.org/cloud opentaps in the Cloud] Amazon EC2 instance from an instance which says "crm2", then CRM2 is already pre-loaded for you. Simply edit the file <tt>hot-deploy/crm2/config/crm2.properties</tt> and populate your settings:

<pre>
crm2.activities.widget.baseOpentapsUrl = https://your-ec2-instance-ip.compute-1.amazonaws.com
crm2.activities.widget.authToken = your-auth-token-value
crm2.activities.widget.clientDomain = your-domain.com
</pre>

Then, restart opentaps

<pre>
$ /etc/init.d/opentaps restart
</pre>

You should see an activities widget similar to those from [[Tour of CRM2]] in your CRM system.

=== Setting up for opentaps 1.x ===

If you are using an older AMI which does not have "crm2" in its name, or if you are running opentaps on your own server, then you will have to get the code for crm2. This is available directly from github at https://github.com/opentaps/opentaps-crm2, and you can check it out with

<pre>
$ git clone ssh://git@github.com:opentaps/opentaps-crm2.git opentaps-crm2
</pre>

Then copy it to your hot-deploy directory:
<pre>
$ cp -r opentaps-crm2/opentaps-1.5/ path-to-opentaps-1.5/hot-deploy/crm2
</pre>

Out of the box, this code works for opentaps 1.5. If you are using opentaps 1.4 or earlier versions, you will need to replace some of the lines which are for opentaps 1.5 with those for earlier versions. Edit the file <tt>src/com/opentaps/crm2/ContactExportService.java</tt> and search for "opentaps 1.5" and follow the instructions to comment out and uncomment the appropriate lines.

Next, compile the new module with

<pre>
$ ant
</pre>

Add the new module to either opentaps/component-load.xml or hot-deploy/component-load.xml file with

<pre>
<load-component component-location="crm2"/>
</pre>

If you have the [http://www.opentaps.org/services-support/professional-edition opentaps Professional Edition], just uncomment lines between
<pre>

</pre>
in the following files:
<pre>
opentaps/crmsfa/webapp/crmsfa/orders/viewOrder.ftl
opentaps/crmsfa/widget/crmsfa/screens/accounts/AccountsScreens.xml
opentaps/crmsfa/widget/crmsfa/screens/contacts/ContactsScreens.xml
opentaps/crmsfa/widget/crmsfa/screens/leads/LeadsScreens.xml
opentaps/crmsfa/widget/crmsfa/screens/orders/OrdersScreens.xml
opentaps/opentaps-common/webapp/common/WEB-INF/common-controller.xml
opentaps/purchasing/webapp/purchasing/order/viewOrder.ftl
opentaps/purchasing/widget/purchasing/screens/order/OrderScreens.xml
opentaps/purchasing/widget/purchasing/screens/supplier/SupplierScreens.xml
</pre>

If not, download the [http://sourceforge.net/projects/opentaps/files/opentaps%202/CRM2/opentaps-1.5-crm2.patch/download patch file for crm2] and apply it to your opentaps.

Finally, follow the instructions above to configure your <tt>crm2/config/crm2.properties</tt> file and restart opentaps.

=== Exporting Users to CRM2 ===

To export your users to CRM2, run the service <tt>exportContactsToCrm2</tt> with the following parameters:
* authToken
* clientDomain
* exportContactUrl: https://crm2.opentaps.com/crm2/contact-import
* exportUserUrl: https://crm2.opentaps.com/crm2/users

This services uses entity sync. Newly created or updated contacts will be added. If the party has a user_login which has _VIEW permission to CRMSFA or FINANCIALS (through any of his user_login_security_permission_group), his user_login_id will be imported as a user_id without password

This service can be set up to run regularly as a job, so new users are automatically added to CRM2.

== Setting up the WordPress Contact Form ==

* Copy opentaps_crm2/wordpress/template-crm2-contact.php to your wordpress curent theme directory
* Modify template-crm2-contact.php to set up your authToken and clientDomain
* Create new wordpress Page with template-crm2-contact.php template

Set up CRM2

2014-11-03T22:41:30Z

Sichen: /* Setting up for opentaps 1.x */

__TOC__

== First Steps ==

First, go to [http://www.opentaps.com opentaps.com] to sign up for opentaps CRM2.

Once you have received your permanent authorization token key by email, reset it

<pre>
$ curl -X POST 'https://crm2.opentaps.com/admin/reset-token' -d clientDomain= ${yourDomain} -d authToken=${authToken}
</pre>

'''Keep your new auth token secret!''' Someone with this token will be able to access everything in your account.

== opentaps 1.x ==

=== Setting Up with opentaps in the Cloud ===

If you are using an [http://www.opentaps.org/cloud opentaps in the Cloud] Amazon EC2 instance from an instance which says "crm2", then CRM2 is already pre-loaded for you. Simply edit the file <tt>hot-deploy/crm2/config/crm2.properties</tt> and populate your settings:

<pre>
crm2.activities.widget.baseOpentapsUrl = https://your-ec2-instance-ip.compute-1.amazonaws.com
crm2.activities.widget.authToken = your-auth-token-value
crm2.activities.widget.clientDomain = your-domain.com
</pre>

Then, restart opentaps

<pre>
$ /etc/init.d/opentaps restart
</pre>

You should see an activities widget similar to those from [[Tour of CRM2]] in your CRM system.

=== Setting up for opentaps 1.x ===

If you are using an older AMI which does not have "crm2" in its name, or if you are running opentaps on your own server, then you will have to get the code for crm2. This is available directly from github at https://github.com/opentaps/opentaps-crm2, and you can check it out with

<pre>
$ git clone ssh://git@github.com:opentaps/opentaps-crm2.git opentaps-crm2
</pre>

Then copy it to your hot-deploy directory:
<pre>
$ cp -r opentaps-crm2/opentaps-1.5/ path-to-opentaps-1.5/hot-deploy/crm2
</pre>

Out of the box, this code works for opentaps 1.5. If you are using opentaps 1.4 or earlier versions, you will need to replace some of the lines which are for opentaps 1.5 with those for earlier versions. Edit the file <tt>src/com/opentaps/crm2/ContactExportService.java</tt> and search for "opentaps 1.5" and follow the instructions to comment out and uncomment the appropriate lines.

Next, compile the new module with

<pre>
$ ant
</pre>

Add the new module to either opentaps/component-load.xml or hot-deploy/component-load.xml file with

<pre>
<load-component component-location="crm2"/>
</pre>

If you have the [http://www.opentaps.org/services-support/professional-edition opentaps Professional Edition], just uncomment lines between
<pre>

</pre>
in the following files:
<pre>
opentaps/crmsfa/webapp/crmsfa/orders/viewOrder.ftl
opentaps/crmsfa/widget/crmsfa/screens/accounts/AccountsScreens.xml
opentaps/crmsfa/widget/crmsfa/screens/contacts/ContactsScreens.xml
opentaps/crmsfa/widget/crmsfa/screens/leads/LeadsScreens.xml
opentaps/crmsfa/widget/crmsfa/screens/orders/OrdersScreens.xml
opentaps/opentaps-common/webapp/common/WEB-INF/common-controller.xml
opentaps/purchasing/webapp/purchasing/order/viewOrder.ftl
opentaps/purchasing/widget/purchasing/screens/order/OrderScreens.xml
opentaps/purchasing/widget/purchasing/screens/supplier/SupplierScreens.xml
</pre>

If not, download the [http://sourceforge.net/projects/opentaps/files/opentaps%202/CRM2/opentaps-1.5-crm2.patch/download patch file for crm2] and apply it to your opentaps.

Finally, follow the instructions above to configure your <tt>crm2/config/crm2.properties</tt> file and restart opentaps.

=== Exporting Users to CRM2 ===

To export your users to CRM2, run the service <tt>exportContactsToCrm2</tt> with the following parameters:
* authToken
* clientDomain
* exportContactUrl: https://crm2.opentaps.com/crm2/contact-import
* exportUserUrl: https://crm2.opentaps.com/crm2/users

This services uses entity sync. Newly created or updated contacts will be added. If the party has a user_login which has _VIEW permission to CRMSFA or FINANCIALS (through any of his user_login_security_permission_group), his user_login_id will be imported as a user_id without password

This service can be set up to run regularly as a job, so new users are automatically added to CRM2.

=== Setting up the WordPress Contact Form ===

* Copy opentaps_crm2/wordpress/template-crm2-contact.php to your wordpress curent theme directory
* Modify template-crm2-contact.php to set up your authToken and clientDomain
* Create new wordpress Page with template-crm2-contact.php template

Set up CRM2

2014-11-03T22:37:06Z

Sichen:

__TOC__

== First Steps ==

First, go to [http://www.opentaps.com opentaps.com] to sign up for opentaps CRM2.

Once you have received your permanent authorization token key by email, reset it

<pre>
$ curl -X POST 'https://crm2.opentaps.com/admin/reset-token' -d clientDomain= ${yourDomain} -d authToken=${authToken}
</pre>

'''Keep your new auth token secret!''' Someone with this token will be able to access everything in your account.

== opentaps 1.x ==

=== Setting Up with opentaps in the Cloud ===

If you are using an [http://www.opentaps.org/cloud opentaps in the Cloud] Amazon EC2 instance from an instance which says "crm2", then CRM2 is already pre-loaded for you. Simply edit the file <tt>hot-deploy/crm2/config/crm2.properties</tt> and populate your settings:

<pre>
crm2.activities.widget.baseOpentapsUrl = https://your-ec2-instance-ip.compute-1.amazonaws.com
crm2.activities.widget.authToken = your-auth-token-value
crm2.activities.widget.clientDomain = your-domain.com
</pre>

Then, restart opentaps

<pre>
$ /etc/init.d/opentaps restart
</pre>

You should see an activities widget similar to those from [[Tour of CRM2]] in your CRM system.

=== Setting up for opentaps 1.x ===

If you are using an older AMI which does not have "crm2" in its name, or if you are running opentaps on your own server, then you will have to get the code for crm2. This is available directly from github at https://github.com/opentaps/opentaps-crm2, and you can check it out with

<pre>
$ git clone ssh://git@github.com:opentaps/opentaps-crm2.git opentaps-crm2
</pre>

Then copy it to your hot-deploy directory:
<pre>
$ cp -r opentaps-crm2/opentaps-1.5/ path-to-opentaps-1.5/hot-deploy/
</pre>

Out of the box, this code works for opentaps 1.5. If you are using opentaps 1.4 or earlier versions, you will need to replace some of the lines which are for opentaps 1.5 with those for earlier versions. Edit the file <tt>src/com/opentaps/crm2/ContactExportService.java</tt> and search for "opentaps 1.5" and follow the instructions to comment out and uncomment the appropriate lines.

Next, compile the new module with

<pre>
$ ant
</pre>

Add the new module to either opentaps/component-load.xml or hot-deploy/component-load.xml file with

<pre>
<load-component component-location="crm2"/>
</pre>

If you have the [http://www.opentaps.org/services-support/professional-edition opentaps Professional Edition], just uncomment lines between
<pre>

</pre>
in the following files:
<pre>
opentaps/crmsfa/webapp/crmsfa/orders/viewOrder.ftl
opentaps/crmsfa/widget/crmsfa/screens/accounts/AccountsScreens.xml
opentaps/crmsfa/widget/crmsfa/screens/contacts/ContactsScreens.xml
opentaps/crmsfa/widget/crmsfa/screens/leads/LeadsScreens.xml
opentaps/crmsfa/widget/crmsfa/screens/orders/OrdersScreens.xml
opentaps/opentaps-common/webapp/common/WEB-INF/common-controller.xml
opentaps/purchasing/webapp/purchasing/order/viewOrder.ftl
opentaps/purchasing/widget/purchasing/screens/order/OrderScreens.xml
opentaps/purchasing/widget/purchasing/screens/supplier/SupplierScreens.xml
</pre>

If not, download the [http://sourceforge.net/projects/opentaps/files/opentaps%202/CRM2/opentaps-1.5-crm2.patch/download patch file for crm2] and apply it to your opentaps.

Finally, follow the instructions above to configure your <tt>crm2/config/crm2.properties</tt> file and restart opentaps.

=== Exporting Users to CRM2 ===

To export your users to CRM2, run the service <tt>exportContactsToCrm2</tt> with the following parameters:
* authToken
* clientDomain
* exportContactUrl: https://crm2.opentaps.com/crm2/contact-import
* exportUserUrl: https://crm2.opentaps.com/crm2/users

This services uses entity sync. Newly created or updated contacts will be added. If the party has a user_login which has _VIEW permission to CRMSFA or FINANCIALS (through any of his user_login_security_permission_group), his user_login_id will be imported as a user_id without password

This service can be set up to run regularly as a job, so new users are automatically added to CRM2.

=== Setting up the WordPress Contact Form ===

* Copy opentaps_crm2/wordpress/template-crm2-contact.php to your wordpress curent theme directory
* Modify template-crm2-contact.php to set up your authToken and clientDomain
* Create new wordpress Page with template-crm2-contact.php template

CRM-2 Tags API

2014-10-14T17:53:00Z

Sichen:

Tags are a way to group your activities and tasks and link them to the outside world. The tags in opentaps crm2 have a tag name, which is the description, plus a URL and keywords. The URL can be used to link tagged activities to outside data, such as linking emails and notes to a sales order in another system. The keywords can be used to search for activities which may be related to the tag. For example, we can use it to search for emails which may be related to an invoice.

Tags are inherited in the following way:
# When an activity is tagged, a new task created from the activity will have the same tags
# When a task is tagged, any activity created from the task will be tagged as well.
# When an existing activity is linked to an existing task, the tags from that task will be inherited by the activity. However, the activity may have existing tags, and those will still be there as well -- they are not erased when an activity is transferred from one task to another.

==== Tags ====

A tag can store the following data:
* tagId - unique identifier
* tag name - descriptive text of the tag
* an optional URL link which can be used to link to an outside system, such as the order ID or party ID of a legacy ERP or CRM system.
* keywords which can be used for searching similar documents

Tag names are case insensitive, so the tags opentaps, OPENTAPs, and OpenTaps would all be considered the same.

===== API =====

Endpoint: https://crm2.opentaps.com/tag

'''POST''': Create a new tag

Parameters:
* clientDomain
* authToken
* tagName
* tagUrl
* tagKeywords

Returns
* tagId: unique identifier of your tag

If the same tagName (case insensitive) already exists, then the operation would return an error.

'''PUT''': Update an existing tag using the unique tagId

Parameters:
* clientDomain
* authToken
* tagId

'''DELETE''': Delete an existing tag using the unique tagId

Parameters:
* clientDomain
* authToken
* tagId

'''GET''': Search for existing tags which contain your tag name (case insensitive)

Parameters:
* clientDomain
* authToken
* tagName

Returns
* List of tags, including tagId, tagName, tagUrl, tagKeywords for each tag

===== Relating Tags to Tasks and Activities =====

A tag can be added to any task or activity.

If you append the fields <tt>tagName</tt>, <tt>tagUrl</tt>, <tt>tagKeywords</tt> to any POST API call to [[CRM-2 Activities API|create an activity or task]], crm2 will check if the tagName already exists. If so, the activity or task will be associated with your tag. In that case, the URL and keywords will be ignored. If the tag name is not found, it will automatically create a new tag with the name, URL, and keywords and associate it with your task or activity.

You can get all the activities and tasks related to a tag with the API call to https://crm2.opentaps.com/tagActivities

'''GET''': Get all activities and tasks related to a task

Parameters:
* clientDomain
* authToken
* tagId

Returns
* List of activities and tasks related to the tag

'''GET''': Get all the tags related to an activity

Parameters:
* clientDomain
* authToken
* activityId

Returns
* List of tags, including all their tagId, tagName, tagUrl, tagKeywords, related to the activity

'''POST''': Add a tag to an activity

Parameters:
* clientDomain
* authToken
* activityId
* tagId

'''DELETE''': Delete a tag from an activity

Parameters:
* clientDomain
* authToken
* activityId
* tagId

CRM-2 Tags API

2014-10-06T22:24:48Z

Sichen: /* Relating Tags to Tasks and Activities */

==== Tags ====

A tag can store the following data:
* tagId - unique identifier
* tag name - descriptive text of the tag
* an optional URL link which can be used to link to an outside system, such as the order ID or party ID of a legacy ERP or CRM system.
* keywords which can be used for searching similar documents

Tag names are case insensitive, so the tags opentaps, OPENTAPs, and OpenTaps would all be considered the same.

===== API =====

Endpoint: https://crm2.opentaps.com/tag

'''POST''': Create a new tag

Parameters:
* clientDomain
* authToken
* tagName
* tagUrl
* tagKeywords

Returns
* tagId: unique identifier of your tag

If the same tagName (case insensitive) already exists, then the operation would return an error.

'''PUT''': Update an existing tag using the unique tagId

Parameters:
* clientDomain
* authToken
* tagId

'''DELETE''': Delete an existing tag using the unique tagId

Parameters:
* clientDomain
* authToken
* tagId

'''GET''': Search for existing tags which contain your tag name (case insensitive)

Parameters:
* clientDomain
* authToken
* tagName

Returns
* List of tags, including tagId, tagName, tagUrl, tagKeywords for each tag

===== Relating Tags to Tasks and Activities =====

A tag can be added to any task or activity.

If you append the fields <tt>tagName</tt>, <tt>tagUrl</tt>, <tt>tagKeywords</tt> to any POST API call to [[CRM-2 Activities API|create an activity or task]], crm2 will check if the tagName already exists. If so, the activity or task will be associated with your tag. In that case, the URL and keywords will be ignored. If the tag name is not found, it will automatically create a new tag with the name, URL, and keywords and associate it with your task or activity.

You can get all the activities and tasks related to a tag with the API call to https://crm2.opentaps.com/tagActivities

'''GET''': Get all activities and tasks related to a task

Parameters:
* clientDomain
* authToken
* tagId

Returns
* List of activities and tasks related to the tag

'''GET''': Get all the tags related to an activity

Parameters:
* clientDomain
* authToken
* activityId

Returns
* List of tags, including all their tagId, tagName, tagUrl, tagKeywords, related to the activity

'''POST''': Add a tag to an activity

Parameters:
* clientDomain
* authToken
* activityId
* tagId

'''DELETE''': Delete a tag from an activity

Parameters:
* clientDomain
* authToken
* activityId
* tagId

CRM-2 Tags API

2014-10-06T22:03:31Z

Sichen: /* Relating Tags to Tasks and Activities */

CRM-2 Tags API

2014-10-06T22:03:11Z

Sichen: Protected "CRM-2 Tags API": Sysop page [edit=sysop:move=sysop]

CRM-2 Tags API

2014-10-06T22:03:10Z

Sichen: New page: ==== Tags ==== A tag can store the following data: * tagId - unique identifier * tag name - descriptive text of the tag * an optional URL link which can be used to link to an outside syst...

CRM-2 API

2014-10-06T21:46:07Z

Sichen:

CRM-2 API is accessed via RESTful services using your authorization token key. All access to CRM-2 API follow this common pattern:
* URL: RESTful URL of the CRM-2 resource
* operation:
** POST: creates new value
** GET: get existing value(s)
** PUT: update existing value
** DELETE: delete existing value
* clientDomain: name of your domain, ie xyz.com
* authToken: your access token key, a very long alphanumeric string
* parameters: key value pairs for your API operation

You can also use curl or a visual RESTful client to test the API. For example,

<pre>
$ curl -X POST 'http://crm-2-url/admin/activity-type' -d clientDomain=newdomain.com -d activityType="PINNED"
-d authToken=<token>
$ curl -X GET "http://crm-2-url/admin/activity-type?clientDomain=newdomain.com
&authToken=<token>"
$ curl -X DELETE 'http://crm-2-url/admin/activity-type' -d clientDomain=newdomain.com -d activityType="PINNED" -d authToken=<token>
</pre>

can be used to create, read, and delete data.

To update data, a PUT operation is used

<pre>
$ curl -X PUT --data "clientDomain=xyz.com&mailUser=newemail@gmail.com&mailStoreProtocol="imaps"&
mailHost="pop.googlemail.com"&mailPass="123456"
&authToken=<token>"
http://crm-2-url/admin/email-to-poll
</pre>

API available, grouped by section, are:
* [[CRM-2 Administrative API]]
* [[CRM-2 Contacts API]]
* [[CRM-2 Activities API]]
* [[CRM-2 Tags API]]

Opentaps 2

2014-10-06T21:45:33Z

Sichen: /* For Developers */

opentaps CRM2 has been completely re-designed is a CRM system that helps your team work more effectively using your current tools, without installing or learning new software. You can access it from the web, from Gmail, and even embed it into your existing order management or business application system. It lets everybody in your organization work together by sharing their emails, discussions, and activities while using their favorite tools to get their jobs done.

'''opentaps CRM2 is available for a limited time as a free trial, so sign up today at https://crm2.opentaps.com/signup'''

===Features ===

Please see [http://www.opentaps.com opentaps.com]

=== How to Get It ===

See [http://www.opentaps.com www.opentaps.com]

=== Where to Get Help ===

Use our [http://opentaps.org/forum forum] if you have any questions about using CRM2, or just want to give us your suggestions. Or just want to say something nice :)

=== User's Manual ===

==== Collaboration ====

When the user enters a note with one or more '@<userid>', this means that he is trying to communicate with that person. For example, this message
<pre>
@sichen The customer just called about this invoice.
</pre>

on the page of invoice 10001 means that this is a message for the user sichen.

An email would be sent to the contact corresponding to that user. If the user replies to the email, then the reply is added as an additional note to the same attributes (ie, order, invoice, payment, or party). The email could also embed a link to take the user to chat on the page of the order/invoice/payment/party. In the body of the email, `-----` is a separator. Content below the separator in the response will not be recorded in the note. If you want to have a signature block in your email, put the separator above your signature line.

There is also a line of the @names that will be sent copies of the email. You can add or remove the forwarding list here.

The person who writes the note or the reply will not be sent an email.

At the bottom is a line with the UUID of the attributes. This is used to identify reply emails with the attributes of the message (ie, order/invoice/payment/party).

==== Contacts ====

Contacts are people in the system. A Contact has first name, last name, and company name. It could have as many addresses, phone numbers, emails as you'd like, identified by purposes. The purposes are for your own benefit and have no special meaning for the system. Each contact is identified by a unique ID.

==== Users ====

A Contact could also have as many user logins as needed. We currently support authentication with both Google Apps (Gmail) and twitter logins. You can also import your old opentaps 1.x series with type "INTERNAL", but we currently don't support logging in with opentaps 1.x usernames and passwords.

The User is not associated with a domain but rather with a Contact. The security permissions of a User are mapped to a particular domain, so it is possible theoretically for your User to have access to several domains.

However, the user interface is currently implemented so that
# A User is set up along with a Contact, and the screens for managing the User manages the Contact details as well.
# The User is particular to your domain, set up by the domain's administrative user.

==== Contact Groups ====

You can also create a group of your contacts:

[[Image:Contact-group-contacts.png|700px]]

and then track all their activities, including emails, notes, and tweets:

[[Image:Contact-group-activities.png|700px]]

opentaps CRM2 will analyze their activities together and show you what they're all talking about, and with whom:

[[Image:Contact-group-summary.png|700px]]

==== Tasks ====

For any contact, contact group, or any order, invoice, or payment, you can create tasks as well as notes:

[[Image:Crm2-create-new-task-widget.png|700px]]

Once you've created your task, you can see it in the Tasks tab:

[[Image:Crm2-task-list-and-task-view.png|700px]]

Tasks can have notes and tasks of their own, like this:

[[Image:Crm2-task-add-notes.png|700px]]

The dashboard in the web interface shows you all the activities and a summary of the different tasks:

[[Image:Crm2-task-activities-dashboard.png|700px]]

==== Twitter Integration ====

opentaps CRM2 integrates with Twitter, so you can
* Monitor your contacts' and groups' tweets
* Analyze tweets to identify trending topics and people
* Tweet and reply to tweets
* See the number of people your Contact is following and their number of followers

To use the twitter integration, you must set up a twitter login for yourself and then login at least once with your twitter login to authorize opentaps CRM2 to use your twitter account. opentaps CRM2 will store your twitter login and authentication token for future use. If you have multiple users, they will all be authorized to use twitter. opentaps CRM2 will use the first twitter login stored to interact with twitter.

Tweet history:

[[Image:Opentaps CRM2 Twitter Activities Stream.png]]

Summary of tweets:

[[Image:Opentaps CRM2 Activities Summary.png]]

Composing a new tweet:

[[Image:Crm2-new-tweet.png]]

Reply to a tweet:

[[Image:Crm2-reply-to-tweet.png]]

==== Gmail User Interface ====

The new Gmail user interface lets you see your contact's activities, includes other notes, discussions, and tweets, from Gmail, as you are emailing them:

[[Image:Opentaps CRM2 Gmail UI.png|700px]]

=== For Developers ===

[https://crm2.opentaps.com/signup Sign up for a free trial] and learn how to [[Administer CRM2]]

Learn how to [[Set up CRM2]] with your legacy opentaps 1.x system and with wordpress.

==== CRM2 API ====

For developers, please see the [[CRM-2 API]] documentation.

==== Embedded User Interface ====

CRM2 comes with a set of widgets which could be plugged right into your opentaps 1.x series, so that your users can use it on their pages for contacts, orders, invoices, and payments without going to a different application. This allows them to discuss issues, see history of notes and discussions, and even find relevant emails while they're processing orders/invoices/payments. These widgets can also be extended to other parts of the system and to other legacy ERP or CRM systems.

See [[Tour of CRM2]] for how it works and [[Set up CRM2]] for instructions on configuring it to work with your legacy opentaps 1.x system.

Opentaps 2

2014-10-06T21:45:13Z

Sichen: /* Tags */

opentaps CRM2 has been completely re-designed is a CRM system that helps your team work more effectively using your current tools, without installing or learning new software. You can access it from the web, from Gmail, and even embed it into your existing order management or business application system. It lets everybody in your organization work together by sharing their emails, discussions, and activities while using their favorite tools to get their jobs done.

'''opentaps CRM2 is available for a limited time as a free trial, so sign up today at https://crm2.opentaps.com/signup'''

===Features ===

Please see [http://www.opentaps.com opentaps.com]

=== How to Get It ===

See [http://www.opentaps.com www.opentaps.com]

=== Where to Get Help ===

Use our [http://opentaps.org/forum forum] if you have any questions about using CRM2, or just want to give us your suggestions. Or just want to say something nice :)

=== User's Manual ===

==== Collaboration ====

When the user enters a note with one or more '@<userid>', this means that he is trying to communicate with that person. For example, this message
<pre>
@sichen The customer just called about this invoice.
</pre>

on the page of invoice 10001 means that this is a message for the user sichen.

An email would be sent to the contact corresponding to that user. If the user replies to the email, then the reply is added as an additional note to the same attributes (ie, order, invoice, payment, or party). The email could also embed a link to take the user to chat on the page of the order/invoice/payment/party. In the body of the email, `-----` is a separator. Content below the separator in the response will not be recorded in the note. If you want to have a signature block in your email, put the separator above your signature line.

There is also a line of the @names that will be sent copies of the email. You can add or remove the forwarding list here.

The person who writes the note or the reply will not be sent an email.

At the bottom is a line with the UUID of the attributes. This is used to identify reply emails with the attributes of the message (ie, order/invoice/payment/party).

==== Contacts ====

Contacts are people in the system. A Contact has first name, last name, and company name. It could have as many addresses, phone numbers, emails as you'd like, identified by purposes. The purposes are for your own benefit and have no special meaning for the system. Each contact is identified by a unique ID.

==== Users ====

A Contact could also have as many user logins as needed. We currently support authentication with both Google Apps (Gmail) and twitter logins. You can also import your old opentaps 1.x series with type "INTERNAL", but we currently don't support logging in with opentaps 1.x usernames and passwords.

The User is not associated with a domain but rather with a Contact. The security permissions of a User are mapped to a particular domain, so it is possible theoretically for your User to have access to several domains.

However, the user interface is currently implemented so that
# A User is set up along with a Contact, and the screens for managing the User manages the Contact details as well.
# The User is particular to your domain, set up by the domain's administrative user.

==== Contact Groups ====

You can also create a group of your contacts:

[[Image:Contact-group-contacts.png|700px]]

and then track all their activities, including emails, notes, and tweets:

[[Image:Contact-group-activities.png|700px]]

opentaps CRM2 will analyze their activities together and show you what they're all talking about, and with whom:

[[Image:Contact-group-summary.png|700px]]

==== Tasks ====

For any contact, contact group, or any order, invoice, or payment, you can create tasks as well as notes:

[[Image:Crm2-create-new-task-widget.png|700px]]

Once you've created your task, you can see it in the Tasks tab:

[[Image:Crm2-task-list-and-task-view.png|700px]]

Tasks can have notes and tasks of their own, like this:

[[Image:Crm2-task-add-notes.png|700px]]

The dashboard in the web interface shows you all the activities and a summary of the different tasks:

[[Image:Crm2-task-activities-dashboard.png|700px]]

==== Twitter Integration ====

opentaps CRM2 integrates with Twitter, so you can
* Monitor your contacts' and groups' tweets
* Analyze tweets to identify trending topics and people
* Tweet and reply to tweets
* See the number of people your Contact is following and their number of followers

To use the twitter integration, you must set up a twitter login for yourself and then login at least once with your twitter login to authorize opentaps CRM2 to use your twitter account. opentaps CRM2 will store your twitter login and authentication token for future use. If you have multiple users, they will all be authorized to use twitter. opentaps CRM2 will use the first twitter login stored to interact with twitter.

Tweet history:

[[Image:Opentaps CRM2 Twitter Activities Stream.png]]

Summary of tweets:

[[Image:Opentaps CRM2 Activities Summary.png]]

Composing a new tweet:

[[Image:Crm2-new-tweet.png]]

Reply to a tweet:

[[Image:Crm2-reply-to-tweet.png]]

==== Gmail User Interface ====

The new Gmail user interface lets you see your contact's activities, includes other notes, discussions, and tweets, from Gmail, as you are emailing them:

[[Image:Opentaps CRM2 Gmail UI.png|700px]]

=== For Developers ===

[https://crm2.opentaps.com/signup Sign up for a free trial] and learn how to [[Administer CRM2]]

Learn how to [[Set up CRM2]] with your legacy opentaps 1.x system and with wordpress.

For developers, please see the [[CRM-2 API]] documentation.

==== Embedded User Interface ====

CRM2 comes with a set of widgets which could be plugged right into your opentaps 1.x series, so that your users can use it on their pages for contacts, orders, invoices, and payments without going to a different application. This allows them to discuss issues, see history of notes and discussions, and even find relevant emails while they're processing orders/invoices/payments. These widgets can also be extended to other parts of the system and to other legacy ERP or CRM systems.

See [[Tour of CRM2]] for how it works and [[Set up CRM2]] for instructions on configuring it to work with your legacy opentaps 1.x system.

Opentaps 2

2014-10-06T21:39:51Z

Sichen: /* Tasks */

opentaps CRM2 has been completely re-designed is a CRM system that helps your team work more effectively using your current tools, without installing or learning new software. You can access it from the web, from Gmail, and even embed it into your existing order management or business application system. It lets everybody in your organization work together by sharing their emails, discussions, and activities while using their favorite tools to get their jobs done.

'''opentaps CRM2 is available for a limited time as a free trial, so sign up today at https://crm2.opentaps.com/signup'''

===Features ===

Please see [http://www.opentaps.com opentaps.com]

=== How to Get It ===

See [http://www.opentaps.com www.opentaps.com]

=== Where to Get Help ===

Use our [http://opentaps.org/forum forum] if you have any questions about using CRM2, or just want to give us your suggestions. Or just want to say something nice :)

=== User's Manual ===

==== Collaboration ====

When the user enters a note with one or more '@<userid>', this means that he is trying to communicate with that person. For example, this message
<pre>
@sichen The customer just called about this invoice.
</pre>

on the page of invoice 10001 means that this is a message for the user sichen.

An email would be sent to the contact corresponding to that user. If the user replies to the email, then the reply is added as an additional note to the same attributes (ie, order, invoice, payment, or party). The email could also embed a link to take the user to chat on the page of the order/invoice/payment/party. In the body of the email, `-----` is a separator. Content below the separator in the response will not be recorded in the note. If you want to have a signature block in your email, put the separator above your signature line.

There is also a line of the @names that will be sent copies of the email. You can add or remove the forwarding list here.

The person who writes the note or the reply will not be sent an email.

At the bottom is a line with the UUID of the attributes. This is used to identify reply emails with the attributes of the message (ie, order/invoice/payment/party).

==== Contacts ====

Contacts are people in the system. A Contact has first name, last name, and company name. It could have as many addresses, phone numbers, emails as you'd like, identified by purposes. The purposes are for your own benefit and have no special meaning for the system. Each contact is identified by a unique ID.

==== Users ====

A Contact could also have as many user logins as needed. We currently support authentication with both Google Apps (Gmail) and twitter logins. You can also import your old opentaps 1.x series with type "INTERNAL", but we currently don't support logging in with opentaps 1.x usernames and passwords.

The User is not associated with a domain but rather with a Contact. The security permissions of a User are mapped to a particular domain, so it is possible theoretically for your User to have access to several domains.

However, the user interface is currently implemented so that
# A User is set up along with a Contact, and the screens for managing the User manages the Contact details as well.
# The User is particular to your domain, set up by the domain's administrative user.

==== Contact Groups ====

You can also create a group of your contacts:

[[Image:Contact-group-contacts.png|700px]]

and then track all their activities, including emails, notes, and tweets:

[[Image:Contact-group-activities.png|700px]]

opentaps CRM2 will analyze their activities together and show you what they're all talking about, and with whom:

[[Image:Contact-group-summary.png|700px]]

==== Tasks ====

For any contact, contact group, or any order, invoice, or payment, you can create tasks as well as notes:

[[Image:Crm2-create-new-task-widget.png|700px]]

Once you've created your task, you can see it in the Tasks tab:

[[Image:Crm2-task-list-and-task-view.png|700px]]

Tasks can have notes and tasks of their own, like this:

[[Image:Crm2-task-add-notes.png|700px]]

The dashboard in the web interface shows you all the activities and a summary of the different tasks:

[[Image:Crm2-task-activities-dashboard.png|700px]]

==== Tags ====

==== Twitter Integration ====

opentaps CRM2 integrates with Twitter, so you can
* Monitor your contacts' and groups' tweets
* Analyze tweets to identify trending topics and people
* Tweet and reply to tweets
* See the number of people your Contact is following and their number of followers

To use the twitter integration, you must set up a twitter login for yourself and then login at least once with your twitter login to authorize opentaps CRM2 to use your twitter account. opentaps CRM2 will store your twitter login and authentication token for future use. If you have multiple users, they will all be authorized to use twitter. opentaps CRM2 will use the first twitter login stored to interact with twitter.

Tweet history:

[[Image:Opentaps CRM2 Twitter Activities Stream.png]]

Summary of tweets:

[[Image:Opentaps CRM2 Activities Summary.png]]

Composing a new tweet:

[[Image:Crm2-new-tweet.png]]

Reply to a tweet:

[[Image:Crm2-reply-to-tweet.png]]

==== Gmail User Interface ====

The new Gmail user interface lets you see your contact's activities, includes other notes, discussions, and tweets, from Gmail, as you are emailing them:

[[Image:Opentaps CRM2 Gmail UI.png|700px]]

=== For Developers ===

[https://crm2.opentaps.com/signup Sign up for a free trial] and learn how to [[Administer CRM2]]

Learn how to [[Set up CRM2]] with your legacy opentaps 1.x system and with wordpress.

For developers, please see the [[CRM-2 API]] documentation.

==== Embedded User Interface ====

CRM2 comes with a set of widgets which could be plugged right into your opentaps 1.x series, so that your users can use it on their pages for contacts, orders, invoices, and payments without going to a different application. This allows them to discuss issues, see history of notes and discussions, and even find relevant emails while they're processing orders/invoices/payments. These widgets can also be extended to other parts of the system and to other legacy ERP or CRM systems.

See [[Tour of CRM2]] for how it works and [[Set up CRM2]] for instructions on configuring it to work with your legacy opentaps 1.x system.

CRM-2 Administrative API

2014-08-08T01:09:57Z

Sichen: /* User Permissions */

Administrative API is used to manage your domain.

The API calls follow the general RESTful pattern of [[CRM-2 API]]. The base URL is <tt>https://crm2.opentaps.com/admin/</tt>

To access the admin API, your user must have the '''DOMAIN_CONF''' permission.

For all requests the clientDomain and authToken parameters are required.

Here are the additional resources available:

=== Reset (Permanent) Token ===

Method: POST
URL extension: <tt>/admin/reset-token</tt>
Parameter:
* Current permanent auth token for your user
* Client domain

This API expires (deletes) the current permanent auth token, generates a new one, and returns it to you as the result. After this, you must use the new one to access the system. The API will validate that the token you've supplied is for a user of your domain.

=== Users ===

Add or remove users for a Contact

URL extension: <tt>/admin/user</tt>

Parameters:
* contactId : unique ID of your Contact
* userId: id of user. For Gmail, use full email (someone@gmail.com). For twitter, use username without the initial @ (someone)
* userIdType: type of your user id. Use GOOGLE_APPS for Gmail or TWITTER_LOGIN for Twitter.

Add a new User and Contact at the same time with

URL extension: <tt>/admin/user-contact</tt>

Parameters:
* firstName
* lastName
* companyName
* emailAddress
* userId
* userIdType: Same as above

=== User Permissions ===

Add or remove a security permission from a user

URL extension: <tt>/admin/user-permission</tt>

Parameters:
* userId: unique id of the user
* permission: Permission string

If the permission you are trying to add is not a valid permission, you will get an error message with a list of the valid permissions.

Valid permissions are:
* CONTACT_VIEW - view contacts and contact groups
* CONTACT_UPDATE - create, update, delete contacts and contact groups
* ACTIVITY_VIEW - view activities, such as tasks
* ACTIVITY_UPDATE - create, update, delete activities
* DOMAIN_CONF - administer the domain.

=== Email Notifications ===

Configure the email account to use when sending notification emails for your domain. You must also configure the same email as an email to poll (see below) separately so that the responses are also registered. Otherwise, response to your notification emails will be ignored.

URL extension: <tt>/admin/email-notifications</tt> (ie, <tt>https://crm2.opentaps.com/admin/email-notifications</tt>)

Parameters are the ones for your mail server, ie <tt>mailUser</tt>, <tt>mailPass</tt>, <tt>mailStoreProtocol</tt>, <tt>mailHost</tt>. For gmail, use <tt>smtps</tt> and <tt>smtp.gmail.com</tt> for protocol and host.

For all requests the clientDomain and authToken parameters are required.

* The method POST and PUT is used to SET the email notification account settings.
* The method DELETE is used to REMOVE the email notification account settings.
* The method GET is used to GET the current email notification account settings.

Note: the password is encrypted in the DB and won't be returned in the replies.

=== Emails To Poll ===

Configures the emails to be polled for your domain.

URL extension: <tt>/admin/email-to-poll</tt> (ie, <tt>https://crm2.opentaps.com/admin/email-to-poll</tt>)

Parameters are the ones for your mail server, ie <tt>mailUser</tt>, <tt>mailPass</tt>, <tt>mailStoreProtocol</tt>, <tt>mailHost</tt>. For gmail, use <tt>gimap</tt> and <tt>pop.googlemail.com</tt> for protocol and host.

* The method POST is used to ADD email to poll.
* The method PUT is used to UPDATE email to poll.
* The method DELETE is used to REMOVE email to poll.
* The method GET is used to GET list of the emails to poll.

For POST, PUT and DELETE, mailUser is required.

Note: the password is encrypted in the DB and won't be returned in the replies.

=== Valid Activity Types ===

Configures the valid activity types for your domain's application settings. Activity types are always capitalized and automatically capitalized when you add them.

URL: <tt>https://crm2.opentaps.com/admin/activity-type</tt>

* POST adds a single activityType
* GET returns a list of valid activity types
* DELETE removes a single activityType

=== Twitter ===

Configures the twitter users which opentaps CRM2 uses to interact with twitter. Normally this is done automatically when somebody logs into twitter.com once from the login page, but you can control it more explicitly using this API to add a user or remove one that you don't want to use.

URL: <tt>https://crm2.opentaps.com/admin/twitter</tt>

* POST adds a new user to use with twitter. Parameters are <tt>userName</tt>, <tt>userId</tt>, <tt>token</tt>, and <tt>tokenSecret</tt>
* GET returns a list of users to use with twitter
* DELETE removes a user. Parameter is <tt>userName</tt>

Opentaps 2

2014-08-06T22:18:33Z

Sichen: /* Twitter Integration */

opentaps CRM2 has been completely re-designed is a CRM system that helps your team work more effectively using your current tools, without installing or learning new software. You can access it from the web, from Gmail, and even embed it into your existing order management or business application system. It lets everybody in your organization work together by sharing their emails, discussions, and activities while using their favorite tools to get their jobs done.

'''opentaps CRM2 is available for a limited time as a free trial, so sign up today at https://crm2.opentaps.com/signup'''

===Features ===

Please see [http://www.opentaps.com opentaps.com]

=== How to Get It ===

See [http://www.opentaps.com www.opentaps.com]

=== Where to Get Help ===

Use our [http://opentaps.org/forum forum] if you have any questions about using CRM2, or just want to give us your suggestions. Or just want to say something nice :)

=== User's Manual ===

==== Collaboration ====

When the user enters a note with one or more '@<userid>', this means that he is trying to communicate with that person. For example, this message
<pre>
@sichen The customer just called about this invoice.
</pre>

on the page of invoice 10001 means that this is a message for the user sichen.

An email would be sent to the contact corresponding to that user. If the user replies to the email, then the reply is added as an additional note to the same attributes (ie, order, invoice, payment, or party). The email could also embed a link to take the user to chat on the page of the order/invoice/payment/party. In the body of the email, `-----` is a separator. Content below the separator in the response will not be recorded in the note. If you want to have a signature block in your email, put the separator above your signature line.

There is also a line of the @names that will be sent copies of the email. You can add or remove the forwarding list here.

The person who writes the note or the reply will not be sent an email.

At the bottom is a line with the UUID of the attributes. This is used to identify reply emails with the attributes of the message (ie, order/invoice/payment/party).

==== Contacts ====

Contacts are people in the system. A Contact has first name, last name, and company name. It could have as many addresses, phone numbers, emails as you'd like, identified by purposes. The purposes are for your own benefit and have no special meaning for the system. Each contact is identified by a unique ID.

==== Users ====

A Contact could also have as many user logins as needed. We currently support authentication with both Google Apps (Gmail) and twitter logins. You can also import your old opentaps 1.x series with type "INTERNAL", but we currently don't support logging in with opentaps 1.x usernames and passwords.

The User is not associated with a domain but rather with a Contact. The security permissions of a User are mapped to a particular domain, so it is possible theoretically for your User to have access to several domains.

However, the user interface is currently implemented so that
# A User is set up along with a Contact, and the screens for managing the User manages the Contact details as well.
# The User is particular to your domain, set up by the domain's administrative user.

==== Contact Groups ====

You can also create a group of your contacts:

[[Image:Contact-group-contacts.png|700px]]

and then track all their activities, including emails, notes, and tweets:

[[Image:Contact-group-activities.png|700px]]

opentaps CRM2 will analyze their activities together and show you what they're all talking about, and with whom:

[[Image:Contact-group-summary.png|700px]]

==== Tasks ====

For any contact, contact group, or any order, invoice, or payment, you can create tasks as well as notes:

[[Image:Crm2-create-new-task-widget.png|700px]]

Once you've created your task, you can see it in the Tasks tab:

[[Image:Crm2-task-list-and-task-view.png|700px]]

Tasks can have notes and tasks of their own, like this:

[[Image:Crm2-task-add-notes.png|700px]]

The dashboard in the web interface shows you all the activities and a summary of the different tasks:

[[Image:Crm2-task-activities-dashboard.png|700px]]

==== Twitter Integration ====

opentaps CRM2 integrates with Twitter, so you can
* Monitor your contacts' and groups' tweets
* Analyze tweets to identify trending topics and people
* Tweet and reply to tweets
* See the number of people your Contact is following and their number of followers

To use the twitter integration, you must set up a twitter login for yourself and then login at least once with your twitter login to authorize opentaps CRM2 to use your twitter account. opentaps CRM2 will store your twitter login and authentication token for future use. If you have multiple users, they will all be authorized to use twitter. opentaps CRM2 will use the first twitter login stored to interact with twitter.

Tweet history:

[[Image:Opentaps CRM2 Twitter Activities Stream.png]]

Summary of tweets:

[[Image:Opentaps CRM2 Activities Summary.png]]

Composing a new tweet:

[[Image:Crm2-new-tweet.png]]

Reply to a tweet:

[[Image:Crm2-reply-to-tweet.png]]

==== Gmail User Interface ====

The new Gmail user interface lets you see your contact's activities, includes other notes, discussions, and tweets, from Gmail, as you are emailing them:

[[Image:Opentaps CRM2 Gmail UI.png|700px]]

=== For Developers ===

[https://crm2.opentaps.com/signup Sign up for a free trial] and learn how to [[Administer CRM2]]

Learn how to [[Set up CRM2]] with your legacy opentaps 1.x system and with wordpress.

For developers, please see the [[CRM-2 API]] documentation.

==== Embedded User Interface ====

CRM2 comes with a set of widgets which could be plugged right into your opentaps 1.x series, so that your users can use it on their pages for contacts, orders, invoices, and payments without going to a different application. This allows them to discuss issues, see history of notes and discussions, and even find relevant emails while they're processing orders/invoices/payments. These widgets can also be extended to other parts of the system and to other legacy ERP or CRM systems.

See [[Tour of CRM2]] for how it works and [[Set up CRM2]] for instructions on configuring it to work with your legacy opentaps 1.x system.

Opentaps 2

2014-08-06T22:14:38Z

Sichen: /* Twitter Integration */

opentaps CRM2 has been completely re-designed is a CRM system that helps your team work more effectively using your current tools, without installing or learning new software. You can access it from the web, from Gmail, and even embed it into your existing order management or business application system. It lets everybody in your organization work together by sharing their emails, discussions, and activities while using their favorite tools to get their jobs done.

'''opentaps CRM2 is available for a limited time as a free trial, so sign up today at https://crm2.opentaps.com/signup'''

===Features ===

Please see [http://www.opentaps.com opentaps.com]

=== How to Get It ===

See [http://www.opentaps.com www.opentaps.com]

=== Where to Get Help ===

Use our [http://opentaps.org/forum forum] if you have any questions about using CRM2, or just want to give us your suggestions. Or just want to say something nice :)

=== User's Manual ===

==== Collaboration ====

When the user enters a note with one or more '@<userid>', this means that he is trying to communicate with that person. For example, this message
<pre>
@sichen The customer just called about this invoice.
</pre>

on the page of invoice 10001 means that this is a message for the user sichen.

An email would be sent to the contact corresponding to that user. If the user replies to the email, then the reply is added as an additional note to the same attributes (ie, order, invoice, payment, or party). The email could also embed a link to take the user to chat on the page of the order/invoice/payment/party. In the body of the email, `-----` is a separator. Content below the separator in the response will not be recorded in the note. If you want to have a signature block in your email, put the separator above your signature line.

There is also a line of the @names that will be sent copies of the email. You can add or remove the forwarding list here.

The person who writes the note or the reply will not be sent an email.

At the bottom is a line with the UUID of the attributes. This is used to identify reply emails with the attributes of the message (ie, order/invoice/payment/party).

==== Contacts ====

Contacts are people in the system. A Contact has first name, last name, and company name. It could have as many addresses, phone numbers, emails as you'd like, identified by purposes. The purposes are for your own benefit and have no special meaning for the system. Each contact is identified by a unique ID.

==== Users ====

A Contact could also have as many user logins as needed. We currently support authentication with both Google Apps (Gmail) and twitter logins. You can also import your old opentaps 1.x series with type "INTERNAL", but we currently don't support logging in with opentaps 1.x usernames and passwords.

The User is not associated with a domain but rather with a Contact. The security permissions of a User are mapped to a particular domain, so it is possible theoretically for your User to have access to several domains.

However, the user interface is currently implemented so that
# A User is set up along with a Contact, and the screens for managing the User manages the Contact details as well.
# The User is particular to your domain, set up by the domain's administrative user.

==== Contact Groups ====

You can also create a group of your contacts:

[[Image:Contact-group-contacts.png|700px]]

and then track all their activities, including emails, notes, and tweets:

[[Image:Contact-group-activities.png|700px]]

opentaps CRM2 will analyze their activities together and show you what they're all talking about, and with whom:

[[Image:Contact-group-summary.png|700px]]

==== Tasks ====

For any contact, contact group, or any order, invoice, or payment, you can create tasks as well as notes:

[[Image:Crm2-create-new-task-widget.png|700px]]

Once you've created your task, you can see it in the Tasks tab:

[[Image:Crm2-task-list-and-task-view.png|700px]]

Tasks can have notes and tasks of their own, like this:

[[Image:Crm2-task-add-notes.png|700px]]

The dashboard in the web interface shows you all the activities and a summary of the different tasks:

[[Image:Crm2-task-activities-dashboard.png|700px]]

==== Twitter Integration ====

opentaps CRM2 integrates with Twitter, so you can
* Monitor your contacts' and groups' tweets
* Analyze tweets to identify trending topics and people
* Tweet and reply to tweets
* See the number of people your Contact is following and their number of followers

To use the twitter integration, you must set up a twitter login for yourself and then login at least once with your twitter login to authorize opentaps CRM2 to use your twitter account. opentaps CRM2 will store your twitter login and authentication token for future use. If you have multiple users, they will all be authorized to use twitter. opentaps CRM2 will use the first twitter login stored to interact with twitter.

[[Image:Opentaps CRM2 Twitter Activities Stream.png|700px]]

[[Image:Opentaps CRM2 Activities Summary.png|700px]]

[[Image:Crm2-new-tweet.png]]

[[Image:Crm2-reply-to-tweet.png]]

==== Gmail User Interface ====

The new Gmail user interface lets you see your contact's activities, includes other notes, discussions, and tweets, from Gmail, as you are emailing them:

[[Image:Opentaps CRM2 Gmail UI.png|700px]]

=== For Developers ===

[https://crm2.opentaps.com/signup Sign up for a free trial] and learn how to [[Administer CRM2]]

Learn how to [[Set up CRM2]] with your legacy opentaps 1.x system and with wordpress.

For developers, please see the [[CRM-2 API]] documentation.

==== Embedded User Interface ====

CRM2 comes with a set of widgets which could be plugged right into your opentaps 1.x series, so that your users can use it on their pages for contacts, orders, invoices, and payments without going to a different application. This allows them to discuss issues, see history of notes and discussions, and even find relevant emails while they're processing orders/invoices/payments. These widgets can also be extended to other parts of the system and to other legacy ERP or CRM systems.

See [[Tour of CRM2]] for how it works and [[Set up CRM2]] for instructions on configuring it to work with your legacy opentaps 1.x system.

File:Crm2-reply-to-tweet.png

2014-08-06T22:14:18Z

Sichen:

File:Crm2-reply-to-tweet.png

2014-08-06T22:14:18Z

Sichen: Protected "Image:Crm2-reply-to-tweet.png": Sysop page [edit=sysop:move=sysop]

File:Crm2-new-tweet.png

2014-08-06T22:13:26Z

Sichen:

File:Crm2-new-tweet.png

2014-08-06T22:13:26Z

Sichen: Protected "Image:Crm2-new-tweet.png": Sysop page [edit=sysop:move=sysop]

CRM-2 Administrative API

2014-08-06T21:28:31Z

Sichen: /* Valid Activity Types */

Administrative API is used to manage your domain.

The API calls follow the general RESTful pattern of [[CRM-2 API]]. The base URL is <tt>https://crm2.opentaps.com/admin/</tt>

To access the admin API, your user must have the '''DOMAIN_CONF''' permission.

For all requests the clientDomain and authToken parameters are required.

Here are the additional resources available:

=== Reset (Permanent) Token ===

Method: POST
URL extension: <tt>/admin/reset-token</tt>
Parameter:
* Current permanent auth token for your user
* Client domain

This API expires (deletes) the current permanent auth token, generates a new one, and returns it to you as the result. After this, you must use the new one to access the system. The API will validate that the token you've supplied is for a user of your domain.

=== Users ===

Add or remove users for a Contact

URL extension: <tt>/admin/user</tt>

Parameters:
* contactId : unique ID of your Contact
* userId: id of user. For Gmail, use full email (someone@gmail.com). For twitter, use username without the initial @ (someone)
* userIdType: type of your user id. Use GOOGLE_APPS for Gmail or TWITTER_LOGIN for Twitter.

Add a new User and Contact at the same time with

URL extension: <tt>/admin/user-contact</tt>

Parameters:
* firstName
* lastName
* companyName
* emailAddress
* userId
* userIdType: Same as above

=== User Permissions ===

Add or remove a security permission from a user

URL extension: <tt>/admin/user-permission</tt>

Parameters:
* userId: unique id of the user
* permission: Permission string

If the permission you are trying to add is not a valid permission, you will get an error message with a list of the valid permissions.

=== Email Notifications ===

Configure the email account to use when sending notification emails for your domain. You must also configure the same email as an email to poll (see below) separately so that the responses are also registered. Otherwise, response to your notification emails will be ignored.

URL extension: <tt>/admin/email-notifications</tt> (ie, <tt>https://crm2.opentaps.com/admin/email-notifications</tt>)

Parameters are the ones for your mail server, ie <tt>mailUser</tt>, <tt>mailPass</tt>, <tt>mailStoreProtocol</tt>, <tt>mailHost</tt>. For gmail, use <tt>smtps</tt> and <tt>smtp.gmail.com</tt> for protocol and host.

For all requests the clientDomain and authToken parameters are required.

* The method POST and PUT is used to SET the email notification account settings.
* The method DELETE is used to REMOVE the email notification account settings.
* The method GET is used to GET the current email notification account settings.

Note: the password is encrypted in the DB and won't be returned in the replies.

=== Emails To Poll ===

Configures the emails to be polled for your domain.

URL extension: <tt>/admin/email-to-poll</tt> (ie, <tt>https://crm2.opentaps.com/admin/email-to-poll</tt>)

Parameters are the ones for your mail server, ie <tt>mailUser</tt>, <tt>mailPass</tt>, <tt>mailStoreProtocol</tt>, <tt>mailHost</tt>. For gmail, use <tt>gimap</tt> and <tt>pop.googlemail.com</tt> for protocol and host.

* The method POST is used to ADD email to poll.
* The method PUT is used to UPDATE email to poll.
* The method DELETE is used to REMOVE email to poll.
* The method GET is used to GET list of the emails to poll.

For POST, PUT and DELETE, mailUser is required.

Note: the password is encrypted in the DB and won't be returned in the replies.

=== Valid Activity Types ===

Configures the valid activity types for your domain's application settings. Activity types are always capitalized and automatically capitalized when you add them.

URL: <tt>https://crm2.opentaps.com/admin/activity-type</tt>

* POST adds a single activityType
* GET returns a list of valid activity types
* DELETE removes a single activityType

=== Twitter ===

Configures the twitter users which opentaps CRM2 uses to interact with twitter. Normally this is done automatically when somebody logs into twitter.com once from the login page, but you can control it more explicitly using this API to add a user or remove one that you don't want to use.

URL: <tt>https://crm2.opentaps.com/admin/twitter</tt>

* POST adds a new user to use with twitter. Parameters are <tt>userName</tt>, <tt>token</tt>, and <tt>tokenSecret</tt>
* GET returns a list of users to use with twitter
* DELETE removes a user. Parameter is <tt>userName</tt>

Opentaps 2

2014-07-16T23:28:47Z

Sichen: /* How Does it Look? */

opentaps CRM2 has been completely re-designed is a CRM system that helps your team work more effectively using your current tools, without installing or learning new software. You can access it from the web, from Gmail, and even embed it into your existing order management or business application system. It lets everybody in your organization work together by sharing their emails, discussions, and activities while using their favorite tools to get their jobs done.

'''opentaps CRM2 is available for a limited time as a free trial, so sign up today at https://crm2.opentaps.com/signup'''

===Features ===

Please see [http://www.opentaps.com opentaps.com]

=== How to Get It ===

See [http://www.opentaps.com www.opentaps.com]

=== Where to Get Help ===

Use our [http://opentaps.org/forum forum] if you have any questions about using CRM2, or just want to give us your suggestions. Or just want to say something nice :)

=== User's Manual ===

==== Collaboration ====

When the user enters a note with one or more '@<userid>', this means that he is trying to communicate with that person. For example, this message
<pre>
@sichen The customer just called about this invoice.
</pre>

on the page of invoice 10001 means that this is a message for the user sichen.

An email would be sent to the contact corresponding to that user. If the user replies to the email, then the reply is added as an additional note to the same attributes (ie, order, invoice, payment, or party). The email could also embed a link to take the user to chat on the page of the order/invoice/payment/party. In the body of the email, `-----` is a separator. Content below the separator in the response will not be recorded in the note. If you want to have a signature block in your email, put the separator above your signature line.

There is also a line of the @names that will be sent copies of the email. You can add or remove the forwarding list here.

The person who writes the note or the reply will not be sent an email.

At the bottom is a line with the UUID of the attributes. This is used to identify reply emails with the attributes of the message (ie, order/invoice/payment/party).

==== Contacts ====

Contacts are people in the system. A Contact has first name, last name, and company name. It could have as many addresses, phone numbers, emails as you'd like, identified by purposes. The purposes are for your own benefit and have no special meaning for the system. Each contact is identified by a unique ID.

==== Users ====

A Contact could also have as many user logins as needed. We currently support authentication with both Google Apps (Gmail) and twitter logins. You can also import your old opentaps 1.x series with type "INTERNAL", but we currently don't support logging in with opentaps 1.x usernames and passwords.

The User is not associated with a domain but rather with a Contact. The security permissions of a User are mapped to a particular domain, so it is possible theoretically for your User to have access to several domains.

However, the user interface is currently implemented so that
# A User is set up along with a Contact, and the screens for managing the User manages the Contact details as well.
# The User is particular to your domain, set up by the domain's administrative user.

==== Contact Groups ====

You can also create a group of your contacts:

[[Image:Contact-group-contacts.png|700px]]

and then track all their activities, including emails, notes, and tweets:

[[Image:Contact-group-activities.png|700px]]

opentaps CRM2 will analyze their activities together and show you what they're all talking about, and with whom:

[[Image:Contact-group-summary.png|700px]]

==== Tasks ====

For any contact, contact group, or any order, invoice, or payment, you can create tasks as well as notes:

[[Image:Crm2-create-new-task-widget.png|700px]]

Once you've created your task, you can see it in the Tasks tab:

[[Image:Crm2-task-list-and-task-view.png|700px]]

Tasks can have notes and tasks of their own, like this:

[[Image:Crm2-task-add-notes.png|700px]]

The dashboard in the web interface shows you all the activities and a summary of the different tasks:

[[Image:Crm2-task-activities-dashboard.png|700px]]

==== Twitter Integration ====

With the new Twitter integration, you can monitor your contacts' tweets:

[[Image:Opentaps CRM2 Twitter Activities Stream.png|700px]]

You can also see what they like talking about, and who they like talking with:

[[Image:Opentaps CRM2 Activities Summary.png|700px]]

==== Gmail User Interface ====

The new Gmail user interface lets you see your contact's activities, includes other notes, discussions, and tweets, from Gmail, as you are emailing them:

[[Image:Opentaps CRM2 Gmail UI.png|700px]]

=== For Developers ===

[https://crm2.opentaps.com/signup Sign up for a free trial] and learn how to [[Administer CRM2]]

Learn how to [[Set up CRM2]] with your legacy opentaps 1.x system and with wordpress.

For developers, please see the [[CRM-2 API]] documentation.

==== Embedded User Interface ====

CRM2 comes with a set of widgets which could be plugged right into your opentaps 1.x series, so that your users can use it on their pages for contacts, orders, invoices, and payments without going to a different application. This allows them to discuss issues, see history of notes and discussions, and even find relevant emails while they're processing orders/invoices/payments. These widgets can also be extended to other parts of the system and to other legacy ERP or CRM systems.

See [[Tour of CRM2]] for how it works and [[Set up CRM2]] for instructions on configuring it to work with your legacy opentaps 1.x system.

Opentaps 2

2014-07-16T23:28:00Z

Sichen: /* Giving Customers Real Service */

opentaps CRM2 has been completely re-designed is a CRM system that helps your team work more effectively using your current tools, without installing or learning new software. You can access it from the web, from Gmail, and even embed it into your existing order management or business application system. It lets everybody in your organization work together by sharing their emails, discussions, and activities while using their favorite tools to get their jobs done.

'''opentaps CRM2 is available for a limited time as a free trial, so sign up today at https://crm2.opentaps.com/signup'''

=== How Does it Look? ===

The web user interface of opentaps CRM2 has been completely redesigned:

[[Image:Opentaps_CRM2_Web_UI.png|700px]]

Take a [[Tour of CRM2]] and see how it could get everyone at your business to work together.

===Features ===

Please see [http://www.opentaps.com opentaps.com]

=== How to Get It ===

See [http://www.opentaps.com www.opentaps.com]

=== Where to Get Help ===

Use our [http://opentaps.org/forum forum] if you have any questions about using CRM2, or just want to give us your suggestions. Or just want to say something nice :)

=== User's Manual ===

==== Collaboration ====

When the user enters a note with one or more '@<userid>', this means that he is trying to communicate with that person. For example, this message
<pre>
@sichen The customer just called about this invoice.
</pre>

on the page of invoice 10001 means that this is a message for the user sichen.

An email would be sent to the contact corresponding to that user. If the user replies to the email, then the reply is added as an additional note to the same attributes (ie, order, invoice, payment, or party). The email could also embed a link to take the user to chat on the page of the order/invoice/payment/party. In the body of the email, `-----` is a separator. Content below the separator in the response will not be recorded in the note. If you want to have a signature block in your email, put the separator above your signature line.

There is also a line of the @names that will be sent copies of the email. You can add or remove the forwarding list here.

The person who writes the note or the reply will not be sent an email.

At the bottom is a line with the UUID of the attributes. This is used to identify reply emails with the attributes of the message (ie, order/invoice/payment/party).

==== Contacts ====

Contacts are people in the system. A Contact has first name, last name, and company name. It could have as many addresses, phone numbers, emails as you'd like, identified by purposes. The purposes are for your own benefit and have no special meaning for the system. Each contact is identified by a unique ID.

==== Users ====

A Contact could also have as many user logins as needed. We currently support authentication with both Google Apps (Gmail) and twitter logins. You can also import your old opentaps 1.x series with type "INTERNAL", but we currently don't support logging in with opentaps 1.x usernames and passwords.

The User is not associated with a domain but rather with a Contact. The security permissions of a User are mapped to a particular domain, so it is possible theoretically for your User to have access to several domains.

However, the user interface is currently implemented so that
# A User is set up along with a Contact, and the screens for managing the User manages the Contact details as well.
# The User is particular to your domain, set up by the domain's administrative user.

==== Contact Groups ====

You can also create a group of your contacts:

[[Image:Contact-group-contacts.png|700px]]

and then track all their activities, including emails, notes, and tweets:

[[Image:Contact-group-activities.png|700px]]

opentaps CRM2 will analyze their activities together and show you what they're all talking about, and with whom:

[[Image:Contact-group-summary.png|700px]]

==== Tasks ====

For any contact, contact group, or any order, invoice, or payment, you can create tasks as well as notes:

[[Image:Crm2-create-new-task-widget.png|700px]]

Once you've created your task, you can see it in the Tasks tab:

[[Image:Crm2-task-list-and-task-view.png|700px]]

Tasks can have notes and tasks of their own, like this:

[[Image:Crm2-task-add-notes.png|700px]]

The dashboard in the web interface shows you all the activities and a summary of the different tasks:

[[Image:Crm2-task-activities-dashboard.png|700px]]

==== Twitter Integration ====

With the new Twitter integration, you can monitor your contacts' tweets:

[[Image:Opentaps CRM2 Twitter Activities Stream.png|700px]]

You can also see what they like talking about, and who they like talking with:

[[Image:Opentaps CRM2 Activities Summary.png|700px]]

==== Gmail User Interface ====

The new Gmail user interface lets you see your contact's activities, includes other notes, discussions, and tweets, from Gmail, as you are emailing them:

[[Image:Opentaps CRM2 Gmail UI.png|700px]]

=== For Developers ===

[https://crm2.opentaps.com/signup Sign up for a free trial] and learn how to [[Administer CRM2]]

Learn how to [[Set up CRM2]] with your legacy opentaps 1.x system and with wordpress.

For developers, please see the [[CRM-2 API]] documentation.

==== Embedded User Interface ====

CRM2 comes with a set of widgets which could be plugged right into your opentaps 1.x series, so that your users can use it on their pages for contacts, orders, invoices, and payments without going to a different application. This allows them to discuss issues, see history of notes and discussions, and even find relevant emails while they're processing orders/invoices/payments. These widgets can also be extended to other parts of the system and to other legacy ERP or CRM systems.

See [[Tour of CRM2]] for how it works and [[Set up CRM2]] for instructions on configuring it to work with your legacy opentaps 1.x system.

Opentaps 2

2014-07-16T23:27:51Z

Sichen: /* Talking to Each Other */

opentaps CRM2 has been completely re-designed is a CRM system that helps your team work more effectively using your current tools, without installing or learning new software. You can access it from the web, from Gmail, and even embed it into your existing order management or business application system. It lets everybody in your organization work together by sharing their emails, discussions, and activities while using their favorite tools to get their jobs done.

'''opentaps CRM2 is available for a limited time as a free trial, so sign up today at https://crm2.opentaps.com/signup'''

=== How Does it Look? ===

The web user interface of opentaps CRM2 has been completely redesigned:

[[Image:Opentaps_CRM2_Web_UI.png|700px]]

Take a [[Tour of CRM2]] and see how it could get everyone at your business to work together.

===Features ===

Please see [http://www.opentaps.com opentaps.com]

=== Giving Customers Real Service ===

Do your customers hate calling you as much as you hate calling your insurance company?

Let's see...
# Do your customers get a different person each time they call?
# Do your reps have no idea what the same customer called about the last time?
# Do they have no access to emails she's sent in, or forms she's filled out online?
# If she's already started working with one rep to solve a problem, will your other reps tell her they have no idea who that rep is, or what he's discussed with her, or be able to follow up on what the first rep started?
# Is your customer told a different "company policy" each time she calls?

If the answer to any of the above is "yes," then your customers probably hate calling you. Just like you hate calling your insurance company.

=== How to Get It ===

See [http://www.opentaps.com www.opentaps.com]

=== Where to Get Help ===

Use our [http://opentaps.org/forum forum] if you have any questions about using CRM2, or just want to give us your suggestions. Or just want to say something nice :)

=== User's Manual ===

==== Collaboration ====

When the user enters a note with one or more '@<userid>', this means that he is trying to communicate with that person. For example, this message
<pre>
@sichen The customer just called about this invoice.
</pre>

on the page of invoice 10001 means that this is a message for the user sichen.

An email would be sent to the contact corresponding to that user. If the user replies to the email, then the reply is added as an additional note to the same attributes (ie, order, invoice, payment, or party). The email could also embed a link to take the user to chat on the page of the order/invoice/payment/party. In the body of the email, `-----` is a separator. Content below the separator in the response will not be recorded in the note. If you want to have a signature block in your email, put the separator above your signature line.

There is also a line of the @names that will be sent copies of the email. You can add or remove the forwarding list here.

The person who writes the note or the reply will not be sent an email.

At the bottom is a line with the UUID of the attributes. This is used to identify reply emails with the attributes of the message (ie, order/invoice/payment/party).

==== Contacts ====

Contacts are people in the system. A Contact has first name, last name, and company name. It could have as many addresses, phone numbers, emails as you'd like, identified by purposes. The purposes are for your own benefit and have no special meaning for the system. Each contact is identified by a unique ID.

==== Users ====

A Contact could also have as many user logins as needed. We currently support authentication with both Google Apps (Gmail) and twitter logins. You can also import your old opentaps 1.x series with type "INTERNAL", but we currently don't support logging in with opentaps 1.x usernames and passwords.

The User is not associated with a domain but rather with a Contact. The security permissions of a User are mapped to a particular domain, so it is possible theoretically for your User to have access to several domains.

However, the user interface is currently implemented so that
# A User is set up along with a Contact, and the screens for managing the User manages the Contact details as well.
# The User is particular to your domain, set up by the domain's administrative user.

==== Contact Groups ====

You can also create a group of your contacts:

[[Image:Contact-group-contacts.png|700px]]

and then track all their activities, including emails, notes, and tweets:

[[Image:Contact-group-activities.png|700px]]

opentaps CRM2 will analyze their activities together and show you what they're all talking about, and with whom:

[[Image:Contact-group-summary.png|700px]]

==== Tasks ====

For any contact, contact group, or any order, invoice, or payment, you can create tasks as well as notes:

[[Image:Crm2-create-new-task-widget.png|700px]]

Once you've created your task, you can see it in the Tasks tab:

[[Image:Crm2-task-list-and-task-view.png|700px]]

Tasks can have notes and tasks of their own, like this:

[[Image:Crm2-task-add-notes.png|700px]]

The dashboard in the web interface shows you all the activities and a summary of the different tasks:

[[Image:Crm2-task-activities-dashboard.png|700px]]

==== Twitter Integration ====

With the new Twitter integration, you can monitor your contacts' tweets:

[[Image:Opentaps CRM2 Twitter Activities Stream.png|700px]]

You can also see what they like talking about, and who they like talking with:

[[Image:Opentaps CRM2 Activities Summary.png|700px]]

==== Gmail User Interface ====

The new Gmail user interface lets you see your contact's activities, includes other notes, discussions, and tweets, from Gmail, as you are emailing them:

[[Image:Opentaps CRM2 Gmail UI.png|700px]]

=== For Developers ===

[https://crm2.opentaps.com/signup Sign up for a free trial] and learn how to [[Administer CRM2]]

Learn how to [[Set up CRM2]] with your legacy opentaps 1.x system and with wordpress.

For developers, please see the [[CRM-2 API]] documentation.

==== Embedded User Interface ====

CRM2 comes with a set of widgets which could be plugged right into your opentaps 1.x series, so that your users can use it on their pages for contacts, orders, invoices, and payments without going to a different application. This allows them to discuss issues, see history of notes and discussions, and even find relevant emails while they're processing orders/invoices/payments. These widgets can also be extended to other parts of the system and to other legacy ERP or CRM systems.

See [[Tour of CRM2]] for how it works and [[Set up CRM2]] for instructions on configuring it to work with your legacy opentaps 1.x system.

Opentaps 2

2014-07-16T23:27:14Z

Sichen: /* Conquering Email */

opentaps CRM2 has been completely re-designed is a CRM system that helps your team work more effectively using your current tools, without installing or learning new software. You can access it from the web, from Gmail, and even embed it into your existing order management or business application system. It lets everybody in your organization work together by sharing their emails, discussions, and activities while using their favorite tools to get their jobs done.

'''opentaps CRM2 is available for a limited time as a free trial, so sign up today at https://crm2.opentaps.com/signup'''

=== How Does it Look? ===

The web user interface of opentaps CRM2 has been completely redesigned:

[[Image:Opentaps_CRM2_Web_UI.png|700px]]

Take a [[Tour of CRM2]] and see how it could get everyone at your business to work together.

===Features ===

Please see [http://www.opentaps.com opentaps.com]

=== Talking to Each Other ===

How do your people ''really'' work together? Probably by email, chat, or text.

Do you know how they're making business decisions every day? Probably not, unless you offer them a convenient way to connect and communicate about the problems at work. That's why you're scratching your head when you see an order, quote, or project and say "Who decided to do that?"

=== Giving Customers Real Service ===

Do your customers hate calling you as much as you hate calling your insurance company?

Let's see...
# Do your customers get a different person each time they call?
# Do your reps have no idea what the same customer called about the last time?
# Do they have no access to emails she's sent in, or forms she's filled out online?
# If she's already started working with one rep to solve a problem, will your other reps tell her they have no idea who that rep is, or what he's discussed with her, or be able to follow up on what the first rep started?
# Is your customer told a different "company policy" each time she calls?

If the answer to any of the above is "yes," then your customers probably hate calling you. Just like you hate calling your insurance company.

=== How to Get It ===

See [http://www.opentaps.com www.opentaps.com]

=== Where to Get Help ===

Use our [http://opentaps.org/forum forum] if you have any questions about using CRM2, or just want to give us your suggestions. Or just want to say something nice :)

=== User's Manual ===

==== Collaboration ====

When the user enters a note with one or more '@<userid>', this means that he is trying to communicate with that person. For example, this message
<pre>
@sichen The customer just called about this invoice.
</pre>

on the page of invoice 10001 means that this is a message for the user sichen.

An email would be sent to the contact corresponding to that user. If the user replies to the email, then the reply is added as an additional note to the same attributes (ie, order, invoice, payment, or party). The email could also embed a link to take the user to chat on the page of the order/invoice/payment/party. In the body of the email, `-----` is a separator. Content below the separator in the response will not be recorded in the note. If you want to have a signature block in your email, put the separator above your signature line.

There is also a line of the @names that will be sent copies of the email. You can add or remove the forwarding list here.

The person who writes the note or the reply will not be sent an email.

At the bottom is a line with the UUID of the attributes. This is used to identify reply emails with the attributes of the message (ie, order/invoice/payment/party).

==== Contacts ====

Contacts are people in the system. A Contact has first name, last name, and company name. It could have as many addresses, phone numbers, emails as you'd like, identified by purposes. The purposes are for your own benefit and have no special meaning for the system. Each contact is identified by a unique ID.

==== Users ====

A Contact could also have as many user logins as needed. We currently support authentication with both Google Apps (Gmail) and twitter logins. You can also import your old opentaps 1.x series with type "INTERNAL", but we currently don't support logging in with opentaps 1.x usernames and passwords.

The User is not associated with a domain but rather with a Contact. The security permissions of a User are mapped to a particular domain, so it is possible theoretically for your User to have access to several domains.

However, the user interface is currently implemented so that
# A User is set up along with a Contact, and the screens for managing the User manages the Contact details as well.
# The User is particular to your domain, set up by the domain's administrative user.

==== Contact Groups ====

You can also create a group of your contacts:

[[Image:Contact-group-contacts.png|700px]]

and then track all their activities, including emails, notes, and tweets:

[[Image:Contact-group-activities.png|700px]]

opentaps CRM2 will analyze their activities together and show you what they're all talking about, and with whom:

[[Image:Contact-group-summary.png|700px]]

==== Tasks ====

For any contact, contact group, or any order, invoice, or payment, you can create tasks as well as notes:

[[Image:Crm2-create-new-task-widget.png|700px]]

Once you've created your task, you can see it in the Tasks tab:

[[Image:Crm2-task-list-and-task-view.png|700px]]

Tasks can have notes and tasks of their own, like this:

[[Image:Crm2-task-add-notes.png|700px]]

The dashboard in the web interface shows you all the activities and a summary of the different tasks:

[[Image:Crm2-task-activities-dashboard.png|700px]]

==== Twitter Integration ====

With the new Twitter integration, you can monitor your contacts' tweets:

[[Image:Opentaps CRM2 Twitter Activities Stream.png|700px]]

You can also see what they like talking about, and who they like talking with:

[[Image:Opentaps CRM2 Activities Summary.png|700px]]

==== Gmail User Interface ====

The new Gmail user interface lets you see your contact's activities, includes other notes, discussions, and tweets, from Gmail, as you are emailing them:

[[Image:Opentaps CRM2 Gmail UI.png|700px]]

=== For Developers ===

[https://crm2.opentaps.com/signup Sign up for a free trial] and learn how to [[Administer CRM2]]

Learn how to [[Set up CRM2]] with your legacy opentaps 1.x system and with wordpress.

For developers, please see the [[CRM-2 API]] documentation.

==== Embedded User Interface ====

CRM2 comes with a set of widgets which could be plugged right into your opentaps 1.x series, so that your users can use it on their pages for contacts, orders, invoices, and payments without going to a different application. This allows them to discuss issues, see history of notes and discussions, and even find relevant emails while they're processing orders/invoices/payments. These widgets can also be extended to other parts of the system and to other legacy ERP or CRM systems.

See [[Tour of CRM2]] for how it works and [[Set up CRM2]] for instructions on configuring it to work with your legacy opentaps 1.x system.

Opentaps 2

2014-07-10T17:41:57Z

Sichen:

opentaps CRM2 has been completely re-designed is a CRM system that helps your team work more effectively using your current tools, without installing or learning new software. You can access it from the web, from Gmail, and even embed it into your existing order management or business application system. It lets everybody in your organization work together by sharing their emails, discussions, and activities while using their favorite tools to get their jobs done.

'''opentaps CRM2 is available for a limited time as a free trial, so sign up today at https://crm2.opentaps.com/signup'''

=== How Does it Look? ===

The web user interface of opentaps CRM2 has been completely redesigned:

[[Image:Opentaps_CRM2_Web_UI.png|700px]]

Take a [[Tour of CRM2]] and see how it could get everyone at your business to work together.

===Features ===

Please see [http://www.opentaps.com opentaps.com]

=== Conquering Email ===

Email is the water of your business: You can't live without it, but you could just as easily drown in it. The volume of emails at your business probably exceeds that of phone calls, texts, and social tweets and likes combined. Email is where it all happens -- customers ask for quotes, employees discuss problems, and accounting gets you paid. Many employees spend their whole day in front of a screen, reading and writing emails.

But what are they reading and writing? Are customer problems being resolved? Who is making the decisions? How should problems be solved?

If you're lucky, you're searching back and forth in your inbox to find the answers. If you're like the rest of us, you simply can't find it -- the answer is lost in all the different mailboxes of all the different people. Emails go unanswered when employees go on leave or quit. Customers get upset until they leave or quit.

=== Talking to Each Other ===

How do your people ''really'' work together? Probably by email, chat, or text.

Do you know how they're making business decisions every day? Probably not, unless you offer them a convenient way to connect and communicate about the problems at work. That's why you're scratching your head when you see an order, quote, or project and say "Who decided to do that?"

=== Giving Customers Real Service ===

Do your customers hate calling you as much as you hate calling your insurance company?

Let's see...
# Do your customers get a different person each time they call?
# Do your reps have no idea what the same customer called about the last time?
# Do they have no access to emails she's sent in, or forms she's filled out online?
# If she's already started working with one rep to solve a problem, will your other reps tell her they have no idea who that rep is, or what he's discussed with her, or be able to follow up on what the first rep started?
# Is your customer told a different "company policy" each time she calls?

If the answer to any of the above is "yes," then your customers probably hate calling you. Just like you hate calling your insurance company.

=== How to Get It ===

See [http://www.opentaps.com www.opentaps.com]

=== Where to Get Help ===

Use our [http://opentaps.org/forum forum] if you have any questions about using CRM2, or just want to give us your suggestions. Or just want to say something nice :)

=== User's Manual ===

==== Collaboration ====

When the user enters a note with one or more '@<userid>', this means that he is trying to communicate with that person. For example, this message
<pre>
@sichen The customer just called about this invoice.
</pre>

on the page of invoice 10001 means that this is a message for the user sichen.

An email would be sent to the contact corresponding to that user. If the user replies to the email, then the reply is added as an additional note to the same attributes (ie, order, invoice, payment, or party). The email could also embed a link to take the user to chat on the page of the order/invoice/payment/party. In the body of the email, `-----` is a separator. Content below the separator in the response will not be recorded in the note. If you want to have a signature block in your email, put the separator above your signature line.

There is also a line of the @names that will be sent copies of the email. You can add or remove the forwarding list here.

The person who writes the note or the reply will not be sent an email.

At the bottom is a line with the UUID of the attributes. This is used to identify reply emails with the attributes of the message (ie, order/invoice/payment/party).

==== Contacts ====

Contacts are people in the system. A Contact has first name, last name, and company name. It could have as many addresses, phone numbers, emails as you'd like, identified by purposes. The purposes are for your own benefit and have no special meaning for the system. Each contact is identified by a unique ID.

==== Users ====

A Contact could also have as many user logins as needed. We currently support authentication with both Google Apps (Gmail) and twitter logins. You can also import your old opentaps 1.x series with type "INTERNAL", but we currently don't support logging in with opentaps 1.x usernames and passwords.

The User is not associated with a domain but rather with a Contact. The security permissions of a User are mapped to a particular domain, so it is possible theoretically for your User to have access to several domains.

However, the user interface is currently implemented so that
# A User is set up along with a Contact, and the screens for managing the User manages the Contact details as well.
# The User is particular to your domain, set up by the domain's administrative user.

==== Contact Groups ====

You can also create a group of your contacts:

[[Image:Contact-group-contacts.png|700px]]

and then track all their activities, including emails, notes, and tweets:

[[Image:Contact-group-activities.png|700px]]

opentaps CRM2 will analyze their activities together and show you what they're all talking about, and with whom:

[[Image:Contact-group-summary.png|700px]]

==== Tasks ====

For any contact, contact group, or any order, invoice, or payment, you can create tasks as well as notes:

[[Image:Crm2-create-new-task-widget.png|700px]]

Once you've created your task, you can see it in the Tasks tab:

[[Image:Crm2-task-list-and-task-view.png|700px]]

Tasks can have notes and tasks of their own, like this:

[[Image:Crm2-task-add-notes.png|700px]]

The dashboard in the web interface shows you all the activities and a summary of the different tasks:

[[Image:Crm2-task-activities-dashboard.png|700px]]

==== Twitter Integration ====

With the new Twitter integration, you can monitor your contacts' tweets:

[[Image:Opentaps CRM2 Twitter Activities Stream.png|700px]]

You can also see what they like talking about, and who they like talking with:

[[Image:Opentaps CRM2 Activities Summary.png|700px]]

==== Gmail User Interface ====

The new Gmail user interface lets you see your contact's activities, includes other notes, discussions, and tweets, from Gmail, as you are emailing them:

[[Image:Opentaps CRM2 Gmail UI.png|700px]]

=== For Developers ===

[https://crm2.opentaps.com/signup Sign up for a free trial] and learn how to [[Administer CRM2]]

Learn how to [[Set up CRM2]] with your legacy opentaps 1.x system and with wordpress.

For developers, please see the [[CRM-2 API]] documentation.

==== Embedded User Interface ====

CRM2 comes with a set of widgets which could be plugged right into your opentaps 1.x series, so that your users can use it on their pages for contacts, orders, invoices, and payments without going to a different application. This allows them to discuss issues, see history of notes and discussions, and even find relevant emails while they're processing orders/invoices/payments. These widgets can also be extended to other parts of the system and to other legacy ERP or CRM systems.

See [[Tour of CRM2]] for how it works and [[Set up CRM2]] for instructions on configuring it to work with your legacy opentaps 1.x system.