[documentaion] Documentaion for setting up Integration Service

This commit is contained in:
Saurabh 2016-11-23 18:49:08 +05:30
parent f89f17cdde
commit 8cd1918a3c
30 changed files with 142 additions and 438 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 323 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 388 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 293 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 94 KiB

View File

Before

Width:  |  Height:  |  Size: 39 KiB

After

Width:  |  Height:  |  Size: 39 KiB

View File

Before

Width:  |  Height:  |  Size: 40 KiB

After

Width:  |  Height:  |  Size: 40 KiB

View File

Before

Width:  |  Height:  |  Size: 109 KiB

After

Width:  |  Height:  |  Size: 109 KiB

View File

Before

Width:  |  Height:  |  Size: 44 KiB

After

Width:  |  Height:  |  Size: 44 KiB

View File

Before

Width:  |  Height:  |  Size: 25 KiB

After

Width:  |  Height:  |  Size: 25 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 111 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 64 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 271 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 220 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 91 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 110 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 99 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 91 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 394 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 488 KiB

View File

@ -1,426 +0,0 @@
<!-- title: Material Request Item -->
<div class="dev-header">
<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 7.x.x</a>
<a class="btn btn-default btn-sm" href="https://github.com/frappe/erpnext/tree/develop/erpnext/stock/doctype/material_request_item"
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a>
</div>
<span class="label label-info">Child Table</span>
<p><b>Table Name:</b> <code>tabMaterial Request Item</code></p>
<h3>Fields</h3>
<table class="table table-bordered">
<thead>
<tr>
<th style="width: 5%">Sr</th>
<th style="width: 25%">Fieldname</th>
<th style="width: 20%">Type</th>
<th style="width: 25%">Label</th>
<th style="width: 25%">Options</th>
</tr>
</thead>
<tbody>
<tr >
<td>1</td>
<td class="danger" title="Mandatory"><code>item_code</code></td>
<td >
Link</td>
<td >
Item Code
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/stock/item">Item</a>
</td>
</tr>
<tr >
<td>2</td>
<td ><code>col_break1</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>3</td>
<td ><code>item_name</code></td>
<td >
Data</td>
<td >
Item Name
</td>
<td></td>
</tr>
<tr class="info">
<td>4</td>
<td ><code>section_break_4</code></td>
<td >
Section Break</td>
<td >
Description
</td>
<td></td>
</tr>
<tr >
<td>5</td>
<td class="danger" title="Mandatory"><code>description</code></td>
<td >
Text Editor</td>
<td >
Description
</td>
<td></td>
</tr>
<tr >
<td>6</td>
<td ><code>column_break_6</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>7</td>
<td ><code>image</code></td>
<td >
Attach Image</td>
<td >
Image
</td>
<td></td>
</tr>
<tr class="info">
<td>8</td>
<td ><code>quantity_and_warehouse</code></td>
<td >
Section Break</td>
<td >
Quantity and Warehouse
</td>
<td></td>
</tr>
<tr >
<td>9</td>
<td class="danger" title="Mandatory"><code>qty</code></td>
<td >
Float</td>
<td >
Quantity
</td>
<td></td>
</tr>
<tr >
<td>10</td>
<td class="danger" title="Mandatory"><code>uom</code></td>
<td >
Link</td>
<td >
Stock UOM
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/setup/uom">UOM</a>
</td>
</tr>
<tr >
<td>11</td>
<td ><code>warehouse</code></td>
<td >
Link</td>
<td >
For Warehouse
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/stock/warehouse">Warehouse</a>
</td>
</tr>
<tr >
<td>12</td>
<td ><code>col_break2</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>13</td>
<td class="danger" title="Mandatory"><code>schedule_date</code></td>
<td >
Date</td>
<td >
Required Date
</td>
<td></td>
</tr>
<tr class="info">
<td>14</td>
<td ><code>more_info</code></td>
<td >
Section Break</td>
<td >
More Information
</td>
<td></td>
</tr>
<tr >
<td>15</td>
<td ><code>item_group</code></td>
<td >
Link</td>
<td >
Item Group
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/setup/item_group">Item Group</a>
</td>
</tr>
<tr >
<td>16</td>
<td ><code>brand</code></td>
<td >
Link</td>
<td >
Brand
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/setup/brand">Brand</a>
</td>
</tr>
<tr >
<td>17</td>
<td ><code>lead_time_date</code></td>
<td >
Date</td>
<td >
Lead Time Date
</td>
<td></td>
</tr>
<tr >
<td>18</td>
<td ><code>sales_order</code></td>
<td >
Link</td>
<td >
Sales Order
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/selling/sales_order">Sales Order</a>
</td>
</tr>
<tr >
<td>19</td>
<td ><code>project</code></td>
<td >
Link</td>
<td >
Project
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/projects/project">Project</a>
</td>
</tr>
<tr >
<td>20</td>
<td ><code>col_break3</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>21</td>
<td ><code>min_order_qty</code></td>
<td >
Float</td>
<td >
Min Order Qty
</td>
<td></td>
</tr>
<tr >
<td>22</td>
<td ><code>projected_qty</code></td>
<td >
Float</td>
<td >
Projected Qty
</td>
<td></td>
</tr>
<tr >
<td>23</td>
<td ><code>actual_qty</code></td>
<td >
Float</td>
<td >
Actual Qty
</td>
<td></td>
</tr>
<tr >
<td>24</td>
<td ><code>ordered_qty</code></td>
<td >
Float</td>
<td >
Completed Qty
</td>
<td></td>
</tr>
<tr >
<td>25</td>
<td ><code>page_break</code></td>
<td >
Check</td>
<td >
Page Break
</td>
<td></td>
</tr>
</tbody>
</table>
<h4>Child Table Of</h4>
<ul>
<li>
<a href="https://frappe.github.io/erpnext/current/models/stock/material_request">Material Request</a>
</li>
</ul>
<!-- autodoc -->
<!-- jinja -->
<!-- static -->

View File

@ -9,5 +9,4 @@ managing-tree-structure-masters
naming-series-current-value
overwriting-data-from-data-import-tool
rename-user
setting-up-dropbox-backups
using-custom-domain-on-erpnext

View File

@ -4,35 +4,42 @@ We always recommend customers to maintain backup of their data in ERPNext. he da
You can automate database backup download of your ERPNext account into your Dropbox account.
####Step 1: Go to Setup
####Step 1: Create Dropbox service
`Explore > Setup > Integrations > Dropbox Backup`
`Explore > Setup > Integration Service`
Make a new Integration Service and select `Dropbox` as a service from dropdown then save the document.
####Step 2: Activate
In the Dropbox Backup, check "Send Backups to Dropbox" to active this feature. On checking this field, you will find field to set Frequency and notification Email.
After saving a document, click on `Dropbox Settings` button, to setup service.
<img class="screenshot" alt="create dropbox service" src="{{docs_base_url}}/assets/img/setup/integration-service/create_service.png">
####Step 3: Set Frequency
Set Frequency to download backup in your Dropbox account.
<img class="screenshot" alt="set frequency" src="{{docs_base_url}}/assets/img/setup/dropbox-1.png">
<img class="screenshot" alt="set frequency" src="{{docs_base_url}}/assets/img/setup/integration-service/setup-backup-frequency.png">
####Step 4: Allow Dropbox Access
After setting frequency and updating notification email, click on `Allow Dropbox access`. On clicking this button, the Dropbox login page will open in the new tab. This might require you to allow pop-up for your ERPNext account.
After setting frequency and updating other details, click on `Allow Dropbox access`. On clicking this button, the Dropbox login page will open in the new tab. This might require you to allow pop-up for your ERPNext account.
####Step 5: Login to Dropbox
Login to your Dropbox account by entering login credentials.
<img class="screenshot" alt="Login" src="{{docs_base_url}}/assets/img/setup/dropbox-2.png">
<img class="screenshot" alt="Login" src="{{docs_base_url}}/assets/img/setup/integration-service/dropbox-2.png">
####Step 6: Allow
On successfull login, you will find a confirmation message as following. Click on "Allow" to let your ERPNext account have access to your Dropbox account.
<img class="screenshot" alt="Allow" src="{{docs_base_url}}/assets/img/setup/dropbox-3.png">
<img class="screenshot" alt="Allow" src="{{docs_base_url}}/assets/img/setup/integration-service/dropbox-3.png">
####Step 7: Enable Service
After generating access token, go back to Dropbox Integration Service record and check `enable`. This will enable backup auto-download.
With this, a folder called "ERPNext" will be created in your Dropbox account, and database backup will start to auto-download in it.
@ -44,18 +51,18 @@ With this, a folder called "ERPNext" will be created in your Dropbox account, an
####Step 2:Create a new app
<img class="screenshot" alt="Create new" src="{{docs_base_url}}/assets/img/setup/dropbox-open-3.png">
<img class="screenshot" alt="Create new" src="{{docs_base_url}}/assets/img/setup/integration-service/dropbox-open-3.png">
####Step 3: Fill in details for the app
<img class="screenshot" alt="Create new" src="{{docs_base_url}}/assets/img/setup/dropbox-open-1.png">
<img class="screenshot" alt="Create new" src="{{docs_base_url}}/assets/img/setup/integration-service/dropbox-open-1.png">
-
<img class="screenshot" alt="Create new" src="{{docs_base_url}}/assets/img/setup/dropbox-open-2.png">
<img class="screenshot" alt="Create new" src="{{docs_base_url}}/assets/img/setup/integration-service/dropbox-open-2.png">
####Step 4: Settings in Site Config
After the app is created, note the app key and app secret and enter in `sites/{sitename}/site_config.json` as follows,
After the app is created, note the app key and app secret on Dropbox Settings page or enter in `sites/{sitename}/site_config.json` as follows,
<div>
<pre>

View File

@ -0,0 +1,5 @@
Integration Services is platform to configure 3rd Party Services.
###Services
{index}

View File

@ -0,0 +1,4 @@
dropbox-backup
paypal-integration
razorpay-integration
ldap-integration

View File

@ -0,0 +1,24 @@
#Setting up LDAP
Lightweight Directory Access Protocol is a centralised access controll system used by many small medium scale organisations.
By settings up LDAP service, you able to login to ERPNext account by using LDAP credentials.
####Step 1: Create Razorpay service
`Explore > Setup > Integration Service`
Make a new Integration Service and select `LDAP` as a service from dropdown then save the document.
After saving a document, click on `LDAP Settings` button, to setup service.
####Step 2: Setup ldap service
To enable ldap service, you need to configure parameters like LDAP Server Url, Organizational Unit, Base Distinguished Name (DN) and Password for Base DN
<img class="screenshot" alt="LDAP Settings" src="{{docs_base_url}}/assets/img/setup/integration-service/ldap_settings.png">
####Step 3: Enable Service
After setting up credentials on LDAP Settings, go back to LDAP Service record and enable it.
While enabling, it will validate LDAP details and on successful validation, it will enables LDAP login option.
<img class="screenshot" alt="LOGIN via LDAP" src="{{docs_base_url}}/assets/img/setup/integration-service/login_via_ldap.png">

View File

@ -0,0 +1,58 @@
#Setting up PayPal
A payment gateway is an e-commerce application service provider service that authorizes credit card payments for e-businesses, online retailers, bricks and clicks, or traditional brick and mortar.
A payment gateway facilitates the transfer of information between a payment portal (such as a website, mobile phone or interactive voice response service) and the Front End Processor or acquiring bank.
####Step 1: Create PayPal service
`Explore > Setup > Integration Service`
Make a new Integration Service and select `PayPal` as a service from dropdown then save the document.
After saving a document, click on `PayPal Settings` button, to setup service.
####Step 2: Setup payment service
To enable PayPal payment service, you need to configure parameters like API Username, API Password and Signature.
<img class="screenshot" alt="PayPal Settings" src="{{docs_base_url}}/assets/img/setup/integration-service/paypal_settings.png">
You also can set test payment environment, by settings `Use Sandbox`
####Step 3: Enable Service
After setting up credentials on PayPal Settings, go back to PayPal Service record and enable it.
On enabling service, the system will create Payment Gateway record and Account head in chart of account with account type as Bank.
<img class="screenshot" alt="PayPal COA" src="{{docs_base_url}}/assets/img/setup/integration-service/paypal_coa.png">
Also it will create Payment Gateway Account entry. Payment Gateway Account is configuration hub from this you can set account head from existing COA, default Payment Request email body template.
<img class="screenshot" alt="Payment Gateway Account" src="{{docs_base_url}}/assets/img/setup/integration-service/payment_gateway_account_paypal.png">
After enabling service and configuring Payment Gateway Account your system is able to accept online payments.
####Supporting transaction currencies
AUD, BRL, CAD, CZK, DKK, EUR, HKD, HUF, ILS, JPY, MYR, MXN, TWD, NZD, NOK, PHP, PLN, GBP, RUB, SGD, SEK, CHF, THB, TRY, USD
##Get PayPal credentials
#### Paypal Sanbox API Signature
- Login to paypal developer account, <a href="https://developer.paypal.com/">PayPal Developer Account</a>
- From **Accounts** tab. create a new business account.
<img class="screenshot" alt="Payment Request" src="{{ docs_base_url }}/assets/img/setup/integration-service/setup-sanbox-1.png">
- From this account profile you will get your sandbox api credentials
<img class="screenshot" alt="Payment Request" src="{{ docs_base_url }}/assets/img/setup/integration-service/sanbox-credentials.png">
---
#### PayPal Account API Signature
- Login to PayPal Account and go to profile
<img class="screenshot" alt="Payment Request" src="{{ docs_base_url }}/assets/img/setup/integration-service/api-step-1.png">
- From **My Selling Tools** go to **api Access**
<img class="screenshot" alt="Payment Request" src="{{ docs_base_url }}/assets/img/setup/integration-service/api-step-2.png">
- On API Access Page, choose option 2 to generate API credentials
<img class="screenshot" alt="Payment Request" src="{{ docs_base_url }}/assets/img/setup/integration-service/api-step-3.png">

View File

@ -0,0 +1,33 @@
#Setting up Razorpay
A payment gateway is an e-commerce application service provider service that authorizes credit card payments for e-businesses, online retailers, bricks and clicks, or traditional brick and mortar.
A payment gateway facilitates the transfer of information between a payment portal (such as a website, mobile phone or interactive voice response service) and the Front End Processor or acquiring bank.
####Step 1: Create Razorpay service
`Explore > Setup > Integration Service`
Make a new Integration Service and select `Razorpay` as a service from dropdown then save the document.
After saving a document, click on `Razorpay Settings` button, to setup service.
####Step 2: Setup payment service
To enable Razorpay payment service, you need to configure parameters like API Username, API Password and Signature.
<img class="screenshot" alt="Razorpay Settings" src="{{docs_base_url}}/assets/img/setup/integration-service/razorpay_settings.png">
####Step 3: Enable Service
After setting up credentials on Razorpay Settings, go back to Razorpay Service record and enable it.
On enabling service, the system will create Payment Gateway record and Account head in chart of account with account type as Bank.
<img class="screenshot" alt="Razorpay COA" src="{{docs_base_url}}/assets/img/setup/integration-service/razorpay_coa.png">
Also it will create Payment Gateway Account entry. Payment Gateway Account is configuration hub from this you can set account head from existing COA, default Payment Request email body template.
<img class="screenshot" alt="Payment Gateway Account" src="{{docs_base_url}}/assets/img/setup/integration-service/payment_gateway_account_razorpay.png">
After enabling service and configuring Payment Gateway Account your system is able to accept online payments.
####Supporting transaction currencies
INR