Latest revision as of 14:30, 11 September 2024

[edit] About Recurring Contract Billing For WHMCS

Recurring Contract Billing For WHMCS will allow you to draw up fixed-term contracts for your clients concerning the offered products and services.

You will be able to define which products require contract acceptance, then set the time span of each contract along with its possible discount and penalty amount.
The module will also let you preview vital statistics and logs gathered in a transparent manner on the dashboard.

Admin Area Features:

✔ Create, View And Manage Signed Contracts

✔ Create Multiple Contracts Per Product

✔ Request Contract Signing For Selected Service

✔ View Recently Signed And Ended Contracts

✔ View Contracts And Revenue Summaries

✔ Configure Contract Content

✔ Configure Contract Signature Types

✔ Define Time Of Notifications Before Contract Expiration

✔ Define Time After Which Contract Is Defined As Broken

✔ Define Services Suspension Rules

✔ Customize Module Language Files With "Translations" Tool

✔ Control Staff Access Level To Specific Resources With ACL

✔ View And Manage Logs

Contact Features:

✔ Define Contract Content In Multiple Languages:

✔ Create Contract Content With WYSIWYG Editor

✔ Use Merge Fields For Contract Template

✔ Create Contract Templates:

✔ Assign Product To Contract Template

✔ Define Discounts And Penalty Types

✔ Define Multiple Contracts Sets For Specified Currencies And Billing Cycles:

✔ Define Contract Length - Up To 5 Years

✔ Define Discount And Penalty Amounts

✔ Define Days Before Expiration To Cancel Contract Without Penalty

✔ Define Trial Period Length

✔ Define Time To Send Renewal Notification

✔ View Total And Recurring Prices

✔ View Amount Of Penalty

✔ Choose Contract Signature Type:

✔ Adobe Acrobat Sign

✔ Checkbox

✔ DocuSign

✔ Dropbox Sign

✔ File Upload

✔ SignNow

✔ Define Contract Length Selection Type:

✔ Dropdown Menu

✔ Radio-Button

✔ Allow Orders Without Contract

✔ Define Renewal Type

✔ Renewal Without Contract

✔ Renewal With Contract

✔ Cancel

✔ Toggle Availability Of Cancellation Request

Client Area Features:

✔ Choose Contract Length During Order

✔ View Contract Content Before Accepting It

✔ Sign Contract Using Configured Signature Type

✔ View Details Of All Signed Contracts

✔ View History Of Any Signed Contract

✔ Receive Contract Email Notification Upon Order Creation

General Info:

✔ Multi-Language Support With Custom Translations Tool

✔ Supports PHP 8.2 Back To PHP V8.1

✔ Supports WHMCS Themes "Six", "Twenty-One" And "Lagom WHMCS Client Theme"

✔ Supports WHMCS V8.11 Back To WHMCS V8.8

✔ Requires ionCube Loader V13 Or Later

✔ Easy Module Upgrade To Open Source Version

[edit] Installation and Activation

This tutorial will show you how to successfully install and configure Recurring Contract Billing For WHMCS.

We will guide you step by step through the whole installation and configuration process.

Note: If you are still using any versions of Recurring Contract Billing For WHMCS prior to v2.x, read about it here.

[edit] Installation

1. Log in to our client area and download the module.

2. Extract the package and upload its content into the main WHMCS directory.

The content of the package to upload should look like this.

3. When you install Recurring Contract Billing For WHMCS for the first time you have to rename 'license_RENAME.php' file.

The file is located in 'modules/addons/recurring_billing/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

4. To configure your license key, you have to edit the previously renamed 'license.php' file.

Enter your license key between quotation marks as presented on the following screen. You can find your license key in our client area → 'My Products'.

5. The next step is setting up 'storage' folder as recursively writable.

It is located in 'your_whmcs/modules/addons/RecurringContractBilling/'.

[edit] Activation

7. Now, you have to activate the module in your WHMCS system.

Log in to your WHMCS admin area and proceed to 'Setup' → 'Addon Modules'.
Afterwards, find 'Recurring Contract Billing' and press 'Activate' button.

8. In the next step, you need to permit access to this module.

To do so, click on 'Configure' button, tick checkboxes to assign desired admin roles.
Press 'Save Changes'.

9. Finally, set up the cron command line provided below and define its frequency (1 day interval is suggested).

php -q /yourWHMCS/modules/addons/RecurringContractBilling/cron/cron.php dailyCron

The cron features multiple commands:

dailyCron – Includes every option in one cron, so there is no need to set up the other ones.
contractNotifications – Sends out notifications to the clients whose contracts are about to expire. You can define the timing in the 'module configuration'.
finishContracts – Necessary to automatically finalize a contract when it ends. How long a contract lasts can be defined while setting up 'contract lengths', which the client can choose between while ordering a product.
generatePenaltyInvoices – Generates invoices when a contract is breached, you can specify the penalty when setting up a 'contract template'.
suspendNotContractedServices – Suspend services without an active contract when that is required. It will automatically suspend any active service that requires a contract if no signed contract is detected.

You can set up each function as a separate cron, or set up 'dailyCron' to utilize all functions simultaneously.

10. You have just successfully installed Recurring Contract Billing For WHMCS!

[edit] Configuration and Management

Once you have properly installed and activated the product you may move to its actual configuration.

Read the below sections to learn how to use Recurring Contract Billing For WHMCS completely.

[edit] Configuration

In order to start using your Recurring Contract Billing For WHMCS move to 'Addons → Recurring Contract Billing'.

By default, you will be moved to the addon's dashboard with a guide opened. You will find short notes on how to configure the product there.
In this article, we will expand these instructions a bit more.

Hide the guide when you have completed the configuration and learned how to reconstruct the process. You can do that under 'Utilities' → 'Configuration.'

[edit] Contract Content

First of all, create your first contract's content. To do so, move to the 'Contracts' → 'Contract Content' section and press the 'Create Content' button. Decide on a name for your contract content and press 'Confirm.'

You will be automatically moved to the content editing page. Here you can compose the content of a contract.

Fill out the field with 'Content', you may use 'Merge Fields' to do so, those are categorized into:

Product Fields
Hosting Fields
Client Fields
Contract Fields

Those can be combined Smarty functions such as {if},{elseif} or {else} statements and more.
Use the advanced edition tool to perfectly shape the contract.

You can also change the content's name in the 'Name' bracket. Moreover, you may compose the contract translation.
Select the pen icon to add or remove languages. Do not forget to 'Confirm' the changes once you have finished.

Use action buttons to edit the contract again or delete it if you are sure it is no longer needed.

[edit] Sign Types

Under 'Utilities' → 'Sign Types' you can configure the methods of signing contracts, which you will then be able to use for creating a contract template.
You can configure the following methods:

Adobe Acrobat Sign
DocuSign
Dropbox Sign
File Upload
SignNow

Note: The checkbox sign method does not require any configuration, but you will still be able to select it when creating a contract template.

[edit] Adobe Acrobat Sign

The Enterprise plan of Adobe Acrobat Sign is required to use this option. Take the following steps to set it up:

1. Log in to your Adobe Acrobat Sign profile.
2. Go to the 'Account' tab.
3. Choose the API Applications from the menu on the left and press the + button.

4. Enter the 'Name' and 'Display Name' of your application and select 'CUSTOMER' domain. Press 'Save' when ready.
5. Now, select the created application in the list and click on 'View/Edit.'
6. While there, you will find your 'Client ID' and 'Client Secret' which are required for the configuration. Please keep them safe.
7. Next, enter 'Configure OAuth for Application,' you need to provide a proper callback 'Redirect URIs' from your WHMCS installation in the following format:

https://yourdomain.com/modules/addons/RecurringContractBilling/app/Api/adobeSignAuthorize.php

Note: Provided URI also has to start with https:// .
8. Finally you have to enable all the scopes. Press 'Save' when ready.

9. Now return to the configuration of the WHMCS module and enter the previously obtained data.
As the 'Client Email' use the one from your Adobe Acrobat Sign login. The 'URL Shard' field contains your region identification. To find it, you need to log in to your Adobe Acrobat Sign.
The environment identifier is found in the URL address, just before the echosign.com (or adobesign.com) portion. For more info, please click here
Do not forget to 'Confirm' the settings first because only then you will be able to click the 'Authorization' button.

10. You will have to confirm your access to the authorization for Adobe Acrobat Sign.

11. Finally, if you provided all data correctly you should receive the notice that authorization has been completed successfully.

[edit] DocuSign

You need to have at least the Basic API plan of DocuSign to use this option.

1. You can set it up in to ways:

for the 'Demo' environment, log in here.
for the 'Live' environment, log in here.

2. After successful login to the selected environment, select 'Apps and Keys' tab under the 'Integrations' section on the left side menu.
3. Now press the 'Add App and Integration Key' button as presented below.
Important: Integrator keys can be created only through a developer demo account. To go live with your API integration, you need a live DocuSign production account to promote the key to!

4. Name the app/key.
5. You should now see the 'Integration Key'. Save the 'Integration Key' for later use.

6. Generate your Private Key, to do so press "Generate RSA" under 'Service Integration'. Once ready a new window with generated keys will appear, copy the private key.

7. In 'Redirect URIs' tab press 'ADD URI' button. There, you need to provide a proper callback 'Redirect URIs' from your WHMCS installation in the following format:

https://yourdomain.com/modules/addons/RecurringContractBilling/app/Api/docuSignAuthorize.php

Note: Provided URI also has to start with https:// .

8. You will also need your 'User ID:

9. Now return to the configuration of the WHMCS module where you can enter the previously obtained data.
Provide:

Impersonated User ID - it is your 'User ID.'
Integration Key - you saved the 'Integration Key' earlier.
RSA Key - the 'Private Key' you have generated.
Redirect URI - the 'Redirect URI' you included before.

Choose if you are using a demo environment
Do not forget to 'Confirm' first because only then you can click the 'Authorization' button.

10. You will have to confirm your access authorization for DocuSign.

11. Finally, if you provided all data correctly you should receive notice that authorization has been completed successfully.

[edit] Dropbox Sign

A Dropbox Sign standard account is required to use this option. Please take the following steps to set it up:

1. Log in to your Dropbox Sign profile.
2. Go to the 'API' tab.
3. Find the 'Generate Key' button, click on it, and give the key a name.
4. Copy the key.

5. Now return to the configuration of the WHMCS module and enter the API Key and your Dropbox Sign login email.
If you have a demo Dropbox Sign account, enable the test mode.
When ready, click 'Confirm' first, then 'Authorize.'

6. Finally, if you provided all data correctly you should receive the notice that authorization has been completed successfully.

[edit] File Upload

Here you can configure the minimum and maximum size of files uploaded by your clients as contract signs.

Note: Currently all image, MS Word and PDF formats are supported for upload.

The values provided here must be given as kilobyte (KB) units. E.g.:

1024 KB = 1MB
1048576 KB = 1024 MB = 1 GB

So, if you want to allow uploaded files e.g. being in between 1 and 8 megabytes in size provide '1024' and '8192' values accordingly.
If you do not want to limit the uploaded file sizes, leave the '0' value.

Important: The maximum value of the uploaded file size also depends on the configuration of these values in the php.ini file of the server.
If you want to give a higher value, you must also increase the 'post_max_size' and 'upload_max_filesize' in php.ini file accordingly.
Otherwise, the higher value specified in the module will automatically be decreased to the values specified in the php.ini configuration file.

[edit] SignNow

A SignNow account is required to use this option. Take the following steps to set it up:

1. Log in to your SignNow profile.
2. Go to the 'API' section. You can find it at the bottom of the left-side menu.
3. Click on the 'Add Application' button and name the application.

4. Copy your 'Basic Authorization Token'.

9. Now return to the configuration of the WHMCS module and enter the following fields.

Username - Your SignNow username.
Password - Your SignNow password.
Bacic Auth Token - The token you just copied.
Email - Any email, it will be used as SignNow email signature.

If you are using a trial SignNow account, enable the demo mode.
Do not forget to 'Confirm' the settings first because only then you can click the 'Authorization' button.

11. Finally, if you provided all data correctly you should receive the notice that authorization has been completed successfully.

[edit] Contract Templates

Now, that you have a contract's content draft, move to 'Contracts' → 'Contract Templates'.

In this section, you can predefine which contract content draft a specific product a template will refer to.
Press 'Create Template' to begin.

Fill out the contract template form. Name the template and choose content names from the ones you prepared previously (see the 'Contract Content' section).
Select the product that this template will be available with.
Note: You can assign only one template to a single product, it is not possible to alter the product assignment once you save the changes!

Define one of the methods by which your customers will be able to sign contracts. Choose from the following:

Adobe Acrobat Sign
DocuSign
Dropbox Sign
SignNow
File Upload
Checkbox

Note: Don't forget to set up their initial configuration.
Choose Fixed or Percentage values for Discount and Penalty amounts.
Define contract renewal option:

Renew with contract
Renew without contract
Cancel

Finally, you may decide whether to allow your clients to cancel the contract while it is active or not.
Once ready, remember to 'Confirm' the changes.

In the case of the DocuSign template, you may also define the exact position of the signature on the contract together with the page number and sign phrase.
Please refer to the following article to learn how to position the signature. If you cannot see the relevant section, make sure to choose DocuSign as Sign Type and confirm changes.
If you wish to provide the phrase under which a client will sign a contract (this phrase has to be included in its content), please use the 'Sign Phrase' configuration field.

Note: If you cannot see the relevant 'Signature' section next to the 'Template' section, try clicking on 'Confirm' first and see if it appears.

Once you have added a new template, you have to create 'Contract Lengths'. An appropriate box should appear next to the template form.
Pick a currency and billing circle. Once those are specified, click on 'Create Length' to begin.

In this form you can define:

Length - how long such a contract shall last. If you want, you can include 'Order Without Contract,' to allow clients to make orders, without signing a contract.
Discount Amount - a fixed amount or percentage for the discount, depending on the previously selected type in the template form.
Penalty Amount - a fixed amount or percentage, depending on the previously selected type in the template form.
Trial Period - number of days when a client may resign from the contract without any consequences or giving the reason for resignation.
Notice Time - define the time when a renewal notification will be sent.

Click on 'Confirm' when finished.

[edit] Module Configuration

The last step mentioned in the 'Guide' is setting up 'Notifications,' 'Default Penalty Grace Period,' and 'Service Suspension Rules'. These options can be found under 'Configuration' tab in 'Utilities' section.
Select which email notifications you want your clients to receive and enter the number of days before the due date to send the notification.

Move to 'System Settings' → 'System' → 'Email Templates' → 'General Messages' in your WHMCS to view and edit the notifications. You will find them under 'Ending Contract Notification' name.
Enabled notifications are sent automatically with the daily cron run.

Define how the 'Contract Lengths' will be displayed in the Client Area, by choosing the 'Field Type.'

Define number of days when a client can be late with payment.
If a client misses making payment for longer than the number of days specified here, a penalty will be imposed on such client.
Note: Penalty type and amount are specified in the 'Contract Template' details.

You may decide if services shall be automatically suspended after the provided number of days pass, without the client signing the contract.
You may exclude services ordered before a certain date from this option.

Finally, you can turn off the guide or turn it on again once you have hidden it.

'Save' the changes once your configuration is ready.

[edit] Management

In the following sections we will try to explain how previously configured contracts are imposed on clients.

[edit] Client Area

[edit] Place Order

To illustrate the process, let's say a client orders one of your products with recurring payment (it is important that you have previously prepared a contract for this product).

Once the client reaches checkout, the contract field appears. They may choose the contract length from available options, view the contract and sign in.

If the client tries to complete the order without signing the contract, this error message will be displayed.

Note: You can add an option to order the product without signing the contract by choosing 'Order Without Contract' while adding 'Contract Lengths' in the module addon.

[edit] Service Contracts

To view all accepted contracts, find the 'My Contracts' tab.

There is a full list of client's contracts with the most important information about them.
Including: 'Product/Service Name,' 'Recurring Amount,' 'Sign Date,' 'Contract Length' and 'End Date' as well as its 'Status.'

Use action buttons to:

View the contract details page.
Download a PDF version of the contract.
See the contract content changes history.

View the contract's details. Press 'Show' to see its details directly in the client area or press 'Download' to obtain its PDF version.

If conditions are met, at the bottom of the contract the client will find buttons to renew or cancel the contract.
The conditions are:

The contract is active.
The notice time, specified while creating the length, has passed.
The contract renewal type is set to: 'Renew With Contract.'

History of any changes in the contract content:

Click on the 'Page' icon to see the previous version of the contract.

[edit] Signed Contracts

In 'Signed Contracts' section under 'Contracts' you will find a list of all contracts accepted by your clients.

On the main page, you can see the name of the client with the service used, the recurring payment amount for their product, and contract details such as signing and ending dates, length and status.
Use action buttons to edit, cancel or delete contracts. If you use the edit button, you will be moved to a full view of the contract.

On this page, you can once again see details of a contract accepted between you and the client.

You are allowed to modify the content, status and details of this very contract. Note that used 'Contract Content' will not be altered, only the signed item.

In case you decide to make any changes to the contract, the previous (before changes) version of the contract is added to the 'History'.

Thanks to that, you may always come back to the original.
In this step you may also add notes for future reference. Make sure to save changes.

[edit] Create Contract

Above the list of 'Signed Contracts', you will find 2 buttons. 'Create Contract,' and 'Request Signing.'

Let us cover 'Create Contract' first. Clicking on the button will redirect you to the form where existing contracts, for example, signed manually, can be uploaded into the module and managed.

First of all, select the client. Then pick the service the uploaded contract is related to, or select none if your contract is an independent document.
Choose the contract length: strict period or a custom length; note that the ending date is selected automatically based on the contract length.
Select the contract's status and renewal type. Specify if cancellation is allowed. If you have the contract in the form of a file, you can upload it here.
Finally, you may also add your private notes. Confirm changes to finalize the action.

'Request Signing' allows you to send emails directly to your clients requesting them to sign a contract for a specific product and specific length.

[edit] Dashboard

On the Dashboard of your addon you will find the most important information in a nutshell.

These are:

Recently Signed Contracts
Recently Ended Contracts (including finished, canceled and broken ones)
Contract Summary
Revenue Summary

[edit] Translations

Customizing language files is now extremely easy with the "Translations" tool that is now available directly in the addon.
Its user-friendly design makes managing various language file tweaks a smooth and efficient process.

Prepare translations for the original English files with this handy built-in tool. For specific instructions on how to use this tool please refer to its dedicated article, you will find it here.

[edit] Access Control

'Access Control' allows you to specify and control exactly which sections of the module can be accessed by your administrators.

The way it works is that you create access control rules in which you decide if a specific admin, or admin role has full access, or is restricted to only specific sections.

[edit] Rules

Start with creating a new rule, click on the 'Create Rule' button and a dedicated form will appear. Below you will find a description of every field required in the form.

Fill out the following fields to create resources access rule:

Rule Name - Pick a name for your rule.
Grant Full Access - Enable to grant full access to all sections of the module to the specified personnel. Disable to specify in two additional fields below, to which resources access will be granted, and to which it will be denied.
Allow Access To - Designate the resources that the specified personnel will have access to.
Restrict Access To - Specify the resources that the specified personnel will not have access to.
Administrators - Specify which singular administrators will be subject to the new rule. If the specific administrator is already included in the group you have picked, you do not need to add him separately.
Note: All restrictions for specific administrators are summed with the restrictions on their role groups, across all rules.
Administrator Roles - Specify which administrator role groups will be subject to the new rule.

Important: When picking specific sections, keep in mind that allowing a parent section will also allow all of its children.
For example by allowing 'Translations' you allow 'Translations → Create,' 'Translations → Delete' and 'Translations → Export' etc.
If you would like to give access to everything about translations, but the ability to delete them, you can pick 'Translations' in 'Allow Access To' and then 'Translations → Delete' in 'Restrict Access To.'
Restrict takes precedence over Allow, so if a specific section is included in both, it will be restricted.

To edit or delete existing rules, use the icons to the right.

[edit] Resources

Use the toggles in the 'Resources' section to specify which of them should be subject to logging, found in the 'Logs' section.
Every time an administrator requests a toggled resource, it will be recorded.

[edit] Access Control Logs

The logs section includes:

Log ID
Name of the administrator
Requested resource
Applied Resource
Rule Name
Date

Use the trash bin icons to delete specific logs, or utilize the mass action function to delete multiple logs at once.

[edit] Logs

In the 'Logs' section any attempted actions on any contract are recorded and stored for your convenience.

Use the action buttons to see details or delete each log entry. Multiple logs can be deleted at once by utilizing the mass selection function.

Furthermore, the logs feature additional actions. Changing the logs' settings, exporting the logs to a '.csv' file, and a way to delete specific log types.

In the settings you can specify which log types should be recorded, and whether they should be deleted automatically after a specific time.

While exporting you will pick a time frame and the log types to export.

Here you can decide which log types to delete, you can also specify how old the logs have to be to qualify for deletion. Leave the first field empty to delete all logs.

[edit] Advanced Billing For WHMCS Integration

It is possible to combine your Recurring Contract Billing For WHMCS module with one of our most favored products: Advanced Billing For WHMCS.

In order to configure the two modules to work together move to 'Advanced Billing addon' → 'Configuration' and find the product you want to work with.
Move to 'Settings' → 'Recurring Billing' section, as billing type select 'Bill On Invoice Generation' option.
Learn more about Advanced Billing configuration here.

When ready, Recurring Contract Billing For WHMCS will be in constant cooperation with the other module within the configured product. If you want to combine the functionalities
of the two modules for more than one product, please remember to select the 'Bill On Invoice Generation' option for all of them.

[edit] Tips

1. The contracts are automatically broken in two cases:

The invoice has not been paid - module counts the number of days set up in configuration 'penalty after x days' until the moment the payment is noted in the system.
The client has sent a cancellation request for the product.

2. As this module supports a template system, any changes made in the module's template files will be saved after the update process.

[edit] Update Instructions

An essential guidance through the process of updating the module is offered here.

Ensure successful completion of the module update by carefully following each step, thereby preventing data loss or any unforeseen issues.
Additionally, you will find a current list of supplementary actions necessary for a smooth update process there.

Important: If you are updating the module from a version prior to 2.0.0, you must deactivate the old addon module and delete its files before performing the update.

This will ensure all potential conflicts are avoided. To migrate your data, after activation of the new version, use the migration cron prepared for you in 'Utilities' → 'Configuration' → 'Migration Tool'
It should look like this:

php -q /yourWHMCS/modules/addons/RecurringContractBilling/cron/cron.php migrate

Because of new redirect URIs, the connection between the module and the sign providers will need to be re-established.
You can find instructions on how to do this in the Sign Types section.

[edit] Upgrade Guide

Seeking a solution that offers greater flexibility, customization tailored to your precise needs, and unrestricted availability?
There is an option that not only proves to be cost-effective in the long run but also includes prioritized support services, making it a truly valuable investment.

Opt for the Open Source version of your Recurring Contract Billing For WHMCS module to unlock these benefits.
Simply click on either the Get Source Code or Upgrade To Lifetime button found on the product's page in our client area to complete the one-step upgrade process, with a dedicated discount already applied.

Follow a comprehensive guide covering the transition process, the advantages it brings, and step-by-step instructions on what to do next after the order has been successfully finalized.

[edit] Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.

2. Remember that Recurring Contract Billing For WHMCS contracts can be applied to products with recurring payment type only.

@@ Line 4: / Line 4: @@
 =About [https://www.modulesgarden.com/products/whmcs/recurring-contract-billing Recurring Contract Billing For WHMCS]=
 {|
-|style="padding: 10px 0px 5px 0px;"|'''Recurring Contract Billing For WHMCS''' will allow you to draw up fixed-term contracts for your clients in relation to the offered products and services.<br />
+|style="padding: 10px 0px 5px 0px;"|'''Recurring Contract Billing For WHMCS''' will allow you to draw up fixed-term contracts for your clients concerning the offered products and services.<br />
 You will be able to define which products require contract acceptance, then set the time span of each contract along with its possible discount and penalty amount.<br />
-The module will also let you preview vital statistics and logs gathered in transparent manner on the dashboard.
+The module will also let you preview vital statistics and logs gathered in a transparent manner on the dashboard.
 |}
 <!-- fixed -->
 *'''Admin Area Features:'''
 {|
-|style="padding: 10px 0px 0px 30px;"|✔ Create Multiple Contracts Per Product
+|style="padding: 10px 0px 0px 30px;"|✔ Create, View And Manage Signed Contracts
 |}
 {|
-|style="padding: 0px 0px 0px 30px;"|✔ View, Create And Manage Signed Contracts
+|style="padding: 0px 0px 0px 30px;"|✔ Create Multiple Contracts Per Product
 |}
 {|
-|style="padding: 0px 0px 0px 30px;"|✔ Send Contract To Sign Upon Creating Order
+|style="padding: 0px 0px 0px 30px;"|✔ Request Contract Signing For Selected Service
 |}
 {|
-|style="padding: 0px 0px 0px 30px;"|✔ Configure Contract Signature Types
+|style="padding: 0px 0px 0px 30px;"|✔ View Recently Signed And Ended Contracts
 |}
 {|
-|style="padding: 0px 0px 0px 30px;"|✔ Define Time & Modify Contract End Notifications
+|style="padding: 0px 0px 0px 30px;"|✔ View Contracts And Revenue Summaries
 |}
 {|
-|style="padding: 0px 0px 0px 30px;"|✔ Modify Contract Renewal Notifications
+|style="padding: 0px 0px 0px 30px;"|✔ Configure Contract Content
+|}
+{|
+|style="padding: 0px 0px 0px 30px;"|✔ Configure Contract Signature Types
+|}
+{|
+|style="padding: 0px 0px 0px 30px;"|✔ Define Time Of Notifications Before Contract Expiration
 |}
 {|
@@ Line 32: / Line 38: @@
 |}
 {|
-|style="padding: 0px 0px 10px 30px;"|✔ View Logs
+|style="padding: 0px 0px 0px 30px;"|✔ Define Services Suspension Rules
+|}
+{|
+|style="padding: 0px 0px 0px 30px;"|✔ Customize Module Language Files With "Translations" Tool
+|}
+{|
+|style="padding: 0px 0px 0px 30px;"|✔ Control Staff Access Level To Specific Resources With ACL
+|}
+{|
+|style="padding: 0px 0px 10px 30px;"|✔ View And Manage Logs
 |}
 *'''Contact Features:'''
 {|
-|style="padding: 10px 0px 0px 30px;"|✔ Define Contract Content In Multiple Languages
+|style="padding: 10px 0px 0px 30px;"|✔ Define Contract Content In Multiple Languages:
+|}
+{|
+|style="padding: 0px 0px 0px 45px;"|✔ Create Contract Content With WYSIWYG Editor
+|}
+{|
+|style="padding: 0px 0px 0px 45px;"|✔ Use Merge Fields For Contract Template
+|}
+{|
+|style="padding: 0px 0px 0px 30px;"|✔ Create Contract Templates:
+|}
+{|
+|style="padding: 0px 0px 0px 45px;"|✔ Assign Product To Contract Template
 |}
 {|
-|style="padding: 0px 0px 0px 30px;"|✔ Assign Product To Contract
+|style="padding: 0px 0px 0px 45px;"|✔ Define Discounts And Penalty Types
 |}
 {|
-|style="padding: 0px 0px 0px 30px;"|✔ Define Promo And Penalty Types
+|style="padding: 0px 0px 0px 45px;"|✔ Define Multiple Contracts Sets For Specified Currencies And Billing Cycles:
 |}
 {|
-|style="padding: 0px 0px 0px 30px;"|✔ Define Multiple Contracts Sets:
+|style="padding: 0px 0px 0px 60px;"|✔ Define Contract Length - Up To 5 Years
 |}
 {|
-|style="padding: 0px 0px 0px 45px;"|✔ Define Contract Length - Up To 10 Years
+|style="padding: 0px 0px 0px 60px;"|✔ Define Discount And Penalty Amounts
 |}
 {|
-|style="padding: 0px 0px 0px 45px;"|✔ Define Promo And Penalty Amounts
+|style="padding: 0px 0px 0px 60px;"|✔ Define Days Before Expiration To Cancel Contract Without Penalty
 |}
 {|
-|style="padding: 0px 0px 0px 45px;"|✔ Define Days Before Expiration To Cancel Contract Without Penalty
+|style="padding: 0px 0px 0px 60px;"|✔ Define Trial Period Length
 |}
 {|
-|style="padding: 0px 0px 0px 45px;"|✔ Define Trial Period Length
+|style="padding: 0px 0px 0px 60px;"|✔ Define Time To Send Renewal Notification
 |}
 {|
-|style="padding: 0px 0px 0px 45px;"|✔ Define Time To Send Renewal Notification
+|style="padding: 0px 0px 0px 60px;"|✔ View Total And Recurring Prices
 |}
 {|
-|style="padding: 0px 0px 0px 45px;"|✔ View Total And Recurring Prices
+|style="padding: 0px 0px 0px 60px;"|✔ View Amount Of Penalty
 |}
 {|
-|style="padding: 0px 0px 0px 45px;"|✔ View Amount Of Penalty
+|style="padding: 0px 0px 0px 45px;"|✔ Choose Contract Signature Type:
 |}
 {|
-|style="padding: 0px 0px 0px 30px;"|✔ Choose Contract Signature Type:
+|style="padding: 0px 0px 0px 60px;"|✔ Adobe Acrobat Sign
 |}
 {|
-|style="padding: 0px 0px 0px 45px;"|✔ Checkbox
+|style="padding: 0px 0px 0px 60px;"|✔ Checkbox
 |}
 {|
-|style="padding: 0px 0px 0px 45px;"|✔ File Upload
+|style="padding: 0px 0px 0px 60px;"|✔ DocuSign
 |}
 {|
-|style="padding: 0px 0px 0px 45px;"|✔ Adobe Sign
+|style="padding: 0px 0px 0px 60px;"|✔ Dropbox Sign
 |}
 {|
-|style="padding: 0px 0px 0px 45px;"|✔ DocuSign
+|style="padding: 0px 0px 0px 60px;"|✔ File Upload
 |}
 {|
-|style="padding: 0px 0px 0px 30px;"|✔ Define Contract Signature Phrase And Placement
+|style="padding: 0px 0px 0px 60px;"|✔ SignNow
 |}
 {|
@@ Line 93: / Line 120: @@
 |}
 {|
-|style="padding: 0px 0px 0px 45px;"|✔ Radio Buttons
+|style="padding: 0px 0px 0px 45px;"|✔ Radio-Button
 |}
 {|
@@ Line 134: / Line 161: @@
 *'''General Info:'''
 {|
-|style="padding: 10px 0px 0px 30px;"|✔ Multi-Language Support
+|style="padding: 10px 0px 0px 30px;"|✔ Multi-Language Support With Custom Translations Tool
 |}
 {|
-|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 8.1 Back To PHP 7.4
+|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 8.2 Back To PHP V8.1
 |}
 {|
@@ Line 143: / Line 170: @@
 |}
 {|
-|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V8.9 Back To WHMCS V8.6
+|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V8.11 Back To WHMCS V8.8
 |}
 {|
-|style="padding: 0px 0px 0px 30px;"|✔ Requires ionCube Loader V12 Or Later
+|style="padding: 0px 0px 0px 30px;"|✔ Requires ionCube Loader V13 Or Later
 |}
 {|
@@ Line 152: / Line 179: @@
 |}
-=Installation=
+=Installation and Activation=
 {|
 |style="padding: 10px 0px 30px 15px;"|'''This tutorial will show you how to successfully install and configure [https://www.modulesgarden.com/products/whmcs/recurring-contract-billing Recurring Contract Billing For WHMCS.]''' <br />
-We will guide you step by step through the whole installation and configuration process.
+We will guide you step by step through the whole installation and configuration process.<br/><br/>
+'' '''Note:''' If you are still using any versions of Recurring Contract Billing For WHMCS '''prior to v2.x''', [https://www.docs.modulesgarden.com/Recurring_Contract_Billing_1.5.X_For_WHMCS read about it here].''
 |}
 ==Installation==
@@ Line 162: / Line 191: @@
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:RB_1.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:RB2_1.png]]
 |}
 {|
-|style="padding: 0px 0px 15px 15px;"|'''2. In the downloaded file you might find one or two packages that support different PHP versions.'''<br/>
+|style="padding: 0px 0px 15px 15px;"|'''2. Extract the package and upload its content into the main WHMCS directory.
-In the most recent versions of the module, you will find only one package that supports PHP 7.2 and later.<br/> <!-- If you need a package for the previous versions of PHP, please [https://www.modulesgarden.com/support/ticket/general-support contact our support]. -->
+The content of the package to upload should look like this.
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:PHP72_81.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:RB2_4.png]]
 |}
 {|
-|style="padding: 0px 0px 15px 15px;"|'''Previous updates of the module may contain two packages dedicated to various PHP versions.'''<br/>
+|style="padding: 0px 0px 15px 15px;"|'''3. When you install Recurring Contract Billing For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
-The first one that supports PHP 5.6 up to PHP 7.1, and the second one addressed to PHP 7.2 up to PHP 7.4.<br/>
+The file is located in '' 'modules/addons/recurring_billing/license_RENAME.php'.'' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
-'''''Note:''' Keep in mind that PHP versions 5.6 up to 7.1 are no longer officially supported and their security issues are not fixed or released any more. Find more info [http://php.net/supported-versions.php here].''
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:PHP56_81.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:RB2_5.png]]
 |}
 {|
-|style="padding: 0px 0px 10px 15px;"|<!-- '' '''Important''': This situation does not affect [https://www.modulesgarden.com/products/whmcs/recurring-billing-extended#open-source-version '''the open source version'''] of this module which can be applied to any PHP from version 5.6 and later.''<br/>''  --> '''Note''': You can check the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' → 'System' → 'PHP Info'.'''
+|style="padding: 0px 0px 15px 15px;"|'''4. To configure your license key, you have to edit the previously renamed '' 'license.php' file. '' '''<br />
+Enter your license key between quotation marks as presented on the following screen. You can find your license key in our client area → '' 'My Products'. ''
 |}
 {|
-|style="padding: 0px 0px 15px 15px;"|'''3. Extract the package and upload its content into the main WHMCS directory.
+|style="padding: 0px 0px 20px 25px;"|[[File:RB2_6.png]]
-The content of the package to upload should look like this.
-|}
-{|
-|style="padding: 0px 0px 20px 25px;"|[[File:drter.png]]
-|}
-{|
-|style="padding: 0px 0px 15px 15px;"|'''4. When you install Recurring Contract Billing For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
-File is located in '' 'modules/addons/recurring_billing/license_RENAME.php'.'' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
-|}
-{|
-|style="padding: 0px 0px 20px 25px;"|[[File:RB_3.png]]
 |}
 {|
 |style="padding: 0px 0px 15px 15px;"|'''5. The next step is setting up '' 'storage' '' folder as recursively writable.'''<br />
-It is located in '' 'your_whmcs/modules/addons/recurringBilling/'.''
+It is located in '' 'your_whmcs/modules/addons/RecurringContractBilling/'.''
-|}
-{|
-|style="padding: 0px 0px 30px 25px;"|[[File:RB_3_2.png]]
-|}
-{|
-|style="padding: 0px 0px 15px 15px;"|'''6. In order to configure your license key, you have to edit the previously renamed '' 'license.php' file. '' '''<br />
-Enter your license key between quotation marks as presented on the following screen. You can find your license key in our client area → '' 'My Products'. ''
 |}
 {|
-|style="padding: 0px 0px 30px 25px;"|[[File:RB_4.png]]
+|style="padding: 0px 0px 30px 25px;"|[[File:RB2_7.png]]
 |}
@@ Line 218: / Line 229: @@
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:RB_5.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:RB2_8.png]]
 |}
 {|
-|style="padding: 0px 0px 15px 15px;"|'''8. In the next step you need to permit access to this module.'''<br />
+|style="padding: 0px 0px 15px 15px;"|'''8. In the next step, you need to permit access to this module.'''<br />
 To do so, click on '' 'Configure' '' button, tick checkboxes to assign desired admin roles.<br />
 Press '' 'Save Changes'. ''
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:RB_6.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:RB2_9.png]]
 |}
+<!--
 {|
 |style="padding: 0px 0px 15px 15px;"|'''9. Now it is time to insert proper integration codes.'''<br/>
@@ Line 249: / Line 261: @@
 |}
 {|
-|style="padding: 0px 0px 20px 15px;"|''Note: For illustration purposes we have used '''standard_cart''' orderform, please make changes in the form you are using!<br/> Remember that the content of other order forms may slightly vary from the description above!<br/>Check the 'Utilities' → 'Integration Code' tab in your module for valid code.''<br/>
+|style="padding: 0px 0px 20px 15px;"|'''''Note''': For illustration purposes we have used '''standard_cart''' order form, please make changes in the form you are using!<br/> Remember that the content of other order forms may slightly vary from the description above!<br/>Check the 'Utilities' → 'Integration Code' tab in your module for valid code.''<br/>
 '''''Note:''' In case you are going to use '''Lagom WHMCS Client Theme''', please check the [[#Tips|Tips]] section to find a dedicated integration code.''<br/>
-'''''Note 2:''' In case there is no "checkout.tpl" file in your order form, please look for the template "parent" in the theme.yaml file. Place the integrations code in that parent file.''
+'''''Note 2:''' In case there is no "checkout.tpl" file in your order form, please look for the template "parent" in the theme.yaml file. Place the integration code in that parent file.''
+|}
+-->
+{|
+|style="padding: 0px 0px 15px 15px;"|'''9. Finally, set up the cron command line provided below and define its frequency (1 day interval is suggested).'''
+ php -q /yourWHMCS/modules/addons/RecurringContractBilling/cron/cron.php dailyCron
+The cron features multiple commands:
+* dailyCron – Includes every option in one cron, so there is no need to set up the other ones.
+* contractNotifications – Sends out notifications to the clients whose contracts are about to expire. You can define the timing in the '' '[[#Module_Configuration|module configuration]]'.''
+* finishContracts – Necessary to automatically finalize a contract when it ends. How long a contract lasts can be defined while setting up '' '[[#Contract_Templates|contract lengths]]','' which the client can choose between while ordering a product.
+* generatePenaltyInvoices – Generates invoices when a contract is breached, you can specify the penalty when setting up a '' '[[#Contract_Templates|contract template]]'.''
+* suspendNotContractedServices – Suspend services without an active contract when that is required. It will automatically suspend any active service that requires a contract if no signed contract is detected.
+You can set up each function as a separate cron, or set up '' 'dailyCron' '' to utilize all functions simultaneously.
 |}
 {|
@@ Line 265: / Line 289: @@
 {|
 |style="padding: 10px 0px 15px 15px;"|In order to start using your Recurring Contract Billing For WHMCS move to '' 'Addons → Recurring Contract Billing'. ''<br/>
-By default, you will be moved to the addon's dashboard with a guide opened. You will find there short notes on how to configure the product.<br/>
+By default, you will be moved to the addon's dashboard with a guide opened. You will find short notes on how to configure the product there.<br/>
-In this article we will expand these instructions a bit more.
+In this article, we will expand these instructions a bit more.
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:RB_7.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:RB2_10.png]]
 |}
 {|
-|style="padding: 0px 0px 30px 15px;"|Hide the guide when you have completed the configuration and learned how to reconstruct the process.
+|style="padding: 0px 0px 30px 15px;"|Hide the guide when you have completed the configuration and learned how to reconstruct the process. You can do that under '' 'Utilities' '' → '' 'Configuration.' ''
 |}
 ===Contract Content===
 {|
-|style="padding: 10px 0px 20px 15px;"|First off all, create your first contract's content. To do so, move to '' 'Contract Content' '' section and press '' 'Add New' '' button.
+|style="padding: 10px 0px 20px 15px;"|First of all, create your first contract's content. To do so, move to the '' 'Contracts' '' → '' 'Contract Content' '' section and press the'' 'Create Content' '' button. Decide on a name for your contract content and press '' 'Confirm.' ''
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:RB_8.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:RB2_11.png]]
 |}
 {|
-|style="padding: 0px 0px 20px 15px;"|Here you can compose the content of a contract.<br/>
+|style="padding: 0px 0px 20px 15px;"|You will be automatically moved to the content editing page. Here you can compose the content of a contract.<br/>
-*Type in the ''''' 'Name' ''''' of a contract
+Fill out the field with ''''' 'Content', ''''' you may use ''''' 'Merge Fields' '''''  to do so, those are categorized into:
-*Fill out the filed with ''''' 'Content', ''''' you may use ''''' 'Available Merge Fields' '''''  to do so
+*''Product Fields''
-**''Client Fields''
+*''Hosting Fields''
-**''Product Fields''
+*''Client Fields''
-**''Contract Fields''
+*''Contract Fields''
-*Use advanced edition tool to perfectly shape the contract. <br/>
+Those can be combined Smarty functions such as <code>{if}</code>,<code>{elseif}</code> or <code>{else}</code> statements and [https://www.smarty.net/docs/en/language.function.if.tpl more].<br/>
-*Compose the contract translation, just select required language from a dropdown menu and type in the translated content.
+Use the advanced edition tool to perfectly shape the contract. <br/>
-Do not forget to '' 'Save' '' the changes once you have finished.
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:RB_9.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:RB2_12.png]]
 |}
 {|
-|style="padding: 0px 0px 15px 15px;"|Your newly created contract draft is now visible on the list. <br/>
+|style="padding: 0px 0px 15px 15px;"|
-Use action buttons to edit the contract or delete it if you are sure it is useless.
+You can also change the content's name in the '' 'Name' '' bracket. Moreover, you may compose the contract translation.<br/>Select the pen icon to add or remove languages.
+Do not forget to '' 'Confirm' '' the changes once you have finished.
 |}
 {|
-|style="padding: 0px 0px 30px 25px;"|[[File:RB_11.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:RB2_12_1.png]]
 |}
+{|
+|style="padding: 0px 0px 15px 15px;"|
+Use action buttons to edit the contract again or delete it if you are sure it is no longer needed.
+|}
+{|
+|style="padding: 0px 0px 30px 25px;"|[[File:RB2_13.png]]
+|}
 ===Sign Types===
 {|
-|style="padding: 10px 0px 20px 15px;"|In this tab you can configure the methods of signing contracts, which you will then be able to use for creating a contract template.<br/>You can configure the following methods:
+|style="padding: 10px 0px 15px 15px;"|Under '' 'Utilities' '' → '' 'Sign Types' '' you can configure the methods of signing contracts, which you will then be able to use for creating a contract template.<br/>You can configure the following methods:
-*Adobe Sign
+*Adobe Acrobat Sign
 *DocuSign
+*Dropbox Sign
 *File Upload
-'' '''Note:''' The checkbox sign method does not require any configuration, so it is not visible in this tab, but you will still be able to select it when creating a [https://www.docs.modulesgarden.com/Recurring_Billing_Extended_For_WHMCS#Contract_Templates contract template].
+*SignNow
+'' '''Note:''' The checkbox sign method does not require any configuration, but you will still be able to select it when creating a [[#Contract_Templates|contract template]].
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:RB_42.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:RB2_14.png]]
 |}
-====Adobe Sign====
+====Adobe Acrobat Sign====
 {|
-|style="padding: 0px 0px 15px 15px;"|The Enterprise plan of ''' ''[https://acrobat.adobe.com/us/en/sign.html Adobe Sign]'' ''' is required to use this option. Take the following steps to set it up:<br />
+|style="padding: 10px 0px 15px 15px;"|The Enterprise plan of ''' ''[https://acrobat.adobe.com/us/en/sign.html Adobe Acrobat Sign]'' ''' is required to use this option. Take the following steps to set it up:<br />
-. [https://secure.echosign.com/public/login  Log in] to your Adobe Sign profile.<br />
+. [https://secure.echosign.com/public/login  Log in] to your Adobe Acrobat Sign profile.<br />
-. Go to the [https://secure.eu1.echosign.com/account/accountSettingsPage#pageId::API_INFORMATION API tab].<br />
+. Go to the '' 'Account' '' tab.<br />
-. Choose the [https://secure.eu1.echosign.com/account/accountSettingsPage#pageId::API_APPLICATIONS API Applications] from the menu on the left and press the '''+''' button
+. Choose the [https://secure.eu1.echosign.com/account/accountSettingsPage#pageId::API_APPLICATIONS API Applications] from the menu on the left and press the '''+''' button.
 |}
 {|
@@ Line 326: / Line 361: @@
 |style="padding: 0px 0px 15px 15px;"|
 . Enter the '' 'Name' '' and '' 'Display Name' '' of your application and select '' 'CUSTOMER' '' domain. Press '' 'Save' '' when ready.<br />
-. Now, select the created application in the list and click on '' 'Configure OAuth for Application' ''.<br />
+. Now, select the created application in the list and click on '' 'View/Edit.' ''<br />
 . While there, you will find your '' 'Client ID' '' and '' 'Client Secret' '' which are required for the configuration. '''Please keep them safe'''.<br />
-. Next, you need to provide a proper callback ''' '' 'Redirect URIs' '' ''' from your WHMCS installation in the following format:<br />
+. Next, enter '' 'Configure OAuth for Application,' '' you need to provide a proper callback ''' '' 'Redirect URIs' '' ''' from your WHMCS installation in the following format:<br />
-  <nowiki>https://yourdomain.com/includes/RecurringBilling/getCode.php</nowiki>
+  <nowiki>https://yourdomain.com/modules/addons/RecurringContractBilling/app/Api/adobeSignAuthorize.php</nowiki>
-'' '''Note:''' Provided URI also has to start with ''' https:// '''. You will find the already customized address in your module sign types configuration.''<br />
+'' '''Note:''' Provided URI also has to start with '''''https:// '''.''<br />
 . Finally you have to enable '''all''' the scopes. Press '' 'Save' '' when ready.
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:RB_44.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:RB2_141.png]]
 |}
 {|
 |style="padding: 0px 0px 15px 15px;"|
 . Now return to the configuration of the WHMCS module and enter the previously obtained data. <br/>
-As the '' 'Client Email' '' use the one from your ''Adobe Sign'' login. The '' 'URL Shard' '' field contains your region identification. To find it, you need to log in to your Adobe Sign. <br/> The environment identifier is found in the URL address, just before the ''echosign.com'' (or ''adobesign.com'') portion. For more info, please click [https://helpx.adobe.com/sign/using/identify-account-shard.html here]<br/>
+As the '' 'Client Email' '' use the one from your ''Adobe Acrobat Sign'' login. The '' 'URL Shard' '' field contains your region identification. To find it, you need to log in to your Adobe Acrobat Sign. <br/> The environment identifier is found in the URL address, just before the ''echosign.com'' (or ''adobesign.com'') portion. For more info, please click [https://helpx.adobe.com/sign/using/identify-account-shard.html here]<br/>
-Do not forget to '' 'Save' '' the settings first because only then you will be able to click the '' 'Authorization' '' button.
+Do not forget to '' 'Confirm' '' the settings first because only then you will be able to click the '' 'Authorization' '' button.
 |}
 {|
-|style="padding: 0px 0px 30px 25px;"|[[File:RB_45.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:RB2_15.png]]
 |}
 {|
 |style="padding: 0px 0px 20px 15px;"|
-. You will have to confirm your access to the authorization for Adobe Sign.
+. You will have to confirm your access to the authorization for Adobe Acrobat Sign.
 |}
 {|
@@ Line 354: / Line 389: @@
 {|
 |style="padding: 0px 0px 30px 15px;"|
 . Finally, if you provided all data correctly you should receive the notice that authorization has been completed successfully.
 |}
 ====DocuSign====
 {|
-|style="padding: 0px 0px 15px 15px;"|You need to have at least the Basic API plan of ''' ''[https://www.docusign.com/ DocuSign]'' ''' to use this option.<br />
+|style="padding: 10px 0px 15px 15px;"|You need to have at least the Basic API plan of ''' ''[https://www.docusign.com/ DocuSign]'' ''' to use this option.<br />
 . You can set it up in to ways:
 * for the ''' '' 'Demo' '' ''' environment, log in [https://admindemo.docusign.com/ here].
 * for the ''' '' 'Live' '' ''' environment, log in [https://admin.docusign.com/ here].
 . After successful login to the selected environment, select '' 'Apps and Keys' '' tab under the  '' 'Integrations' '' section on the left side menu.<br />
-. Now press the '' 'ADD APP/INTEGRATION KEY' '' button as presented below.<br />
+. Now press the '' 'Add App and Integration Key' '' button as presented below.<br />
 '' '''Important:''' Integrator keys can be created only through a developer demo account. To go live with your API integration, you need a live DocuSign production account to promote the key to!''
 |}
@@ Line 372: / Line 407: @@
 {|
 |style="padding: 0px 0px 15px 15px;"|
-. Provide your app name.
+. Name the app/key.<br />
+. You should now see the '' 'Integration Key'.'' Save the '' 'Integration Key' '' for later use.
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:RB_47_1.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:RB_48.png]]
 |}
 {|
-|style="padding: 0px 0px 15px 15px;"|
+|style="padding: 0px 0px 15px 15px;"|6. Generate your Private Key, to do so press "Generate RSA" under '' 'Service Integration'.'' Once ready a new window with generated keys will appear, copy the private key.<br/>
-. You should now see the '' 'Integration Key' ''. Save the '' 'Integration Key' '' which is your '' 'Client Secret' '' that you will use at a later stage of the configuration.<br />
-. Generate your Private Key, to do so press "Generate RSA" under '' 'Service Integration'.'' Once ready a new window with generated keys will appear, copy the private key.<br/>
 . In '' 'Redirect URIs' '' tab press '' 'ADD URI' '' button. There, you need to provide a proper callback ''' '' 'Redirect URIs' '' ''' from your WHMCS installation in the following format:<br />
-  <nowiki>https://yourdomain.com/includes/RecurringBilling/getCodeESignature.php</nowiki>
+  <nowiki>https://yourdomain.com/modules/addons/RecurringContractBilling/app/Api/docuSignAuthorize.php</nowiki>
-'' '''Note:''' You will find the already customized address in your module sign types configuration.''
+'' '''Note:''' Provided URI also has to start with '''''https:// '''.''
-|}
-{|
-|style="padding: 0px 0px 20px 25px;"|[[File:RB_48.png]]
 |}
 {|
@@ Line 399: / Line 430: @@
 {|
 |style="padding: 0px 0px 15px 15px;"|
-. Now return to the configuration of the WHMCS module and where you can enter the previously obtained data, but first choose if you are using demo environment.<br />
+. Now return to the configuration of the WHMCS module where you can enter the previously obtained data.<br />
-Next provide:
+Provide:
-*'''Client ID''' - it is your '' 'User ID' ''
+*'''Impersonated User ID''' - it is your '' 'User ID.' ''
-*'''Client Secret''' - it is your early created '' 'Integration Key' ''
+*'''Integration Key''' - you saved the '' 'Integration Key' '' earlier.
-*'''Client Password''' -  '' 'Private Key' '' - you ban generate in "Authentication" → "Service Integration" → "Generate RSA"
+*'''RSA Key''' - the '' 'Private Key' '' you have generated.
-Do not forget to '' 'Save' '' first because only then you will be able to click the '' 'Authorization' '' button.
+*'''Redirect URI''' - the '' 'Redirect URI' '' you included before.
+Choose if you are using a demo environment <br/>
+Do not forget to '' 'Confirm' '' first because only then you can click the '' 'Authorization' '' button.
 |}
 {|
-|style="padding: 0px 0px 30px 25px;"|[[File:RB_50.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:RB2_16.png]]
 |}
 {|
@@ Line 419: / Line 452: @@
 |style="padding: 0px 0px 30px 15px;"|
 . Finally, if you provided all data correctly you should receive notice that authorization has been completed successfully.
+|}
+====Dropbox Sign====
+{|
+|style="padding: 10px 0px 15px 15px;"|A ''' ''[https://www.dropbox.com/sign Dropbox Sign]'' ''' standard account is required to use this option. Please take the following steps to set it up:<br />
+. [https://app.hellosign.com/account/logIn  Log in] to your Dropbox Sign profile.<br />
+. Go to the '' 'API' '' tab.<br />
+. Find the '' 'Generate Key' '' button, click on it, and give the key a name.<br />
+. Copy the key.
+|}
+{|
+|style="padding: 0px 0px 20px 25px;"|[[File:RB2_15_1.png]]
+|}
+{|
+|style="padding: 0px 0px 15px 15px;"|
+. Now return to the configuration of the WHMCS module and enter the API Key and your Dropbox Sign login email. <br/>
+If you have a demo Dropbox Sign account, enable the test mode. <br/>
+When ready, click '' 'Confirm' '' first, then '' 'Authorize.'
+|}
+{|
+|style="padding: 0px 0px 20px 25px;"|[[File:RB2_15_3.png]]
+|}
+{|
+|style="padding: 0px 0px 30px 15px;"|
+. Finally, if you provided all data correctly you should receive the notice that authorization has been completed successfully.
 |}
 ====File Upload====
 {|
-|style="padding: 0px 0px 15px 15px;"|Here you can configure the minimum and maximum size of files uploaded by your clients as  contract signs. <br />
+|style="padding: 10px 0px 15px 15px;"|Here you can configure the minimum and maximum size of files uploaded by your clients as contract signs. <br />
 '' '''Note:''' Currently all image, MS Word and PDF formats are supported for upload.<br /><br />
-The values provided here must be given as bytes (B) units. E.g.:
+The values provided here must be given as kilobyte (KB) units. E.g.:
-*1024 B = 1 KB
+*1024 KB = 1MB
-*1048576 B = 1024 KB = 1 MB
+*1048576 KB = 1024 MB = 1 GB
-*1073741824 B = 1048576 KB = 1024 MB = 1 GB
+So, if you want to allow uploaded files e.g. being in between ''1'' and ''8'' megabytes in size provide '' '1024' '' and '' '8192' '' values accordingly. <br />
-So, if you want to allow uploaded files e.g. being in between ''1'' and ''8'' megabytes in size provide '' '1048576' '' and '' '8388608' '' values accordingly. <br />
+If you do not want to limit the uploaded file sizes, leave the'' '0' '' value. <br /><br />
-If you do not want to limit the uploaded file sizes, leave '' '0' '' value. <br /><br />
 '' '''Important:''' The maximum value of the uploaded file size also depends on the configuration of these values in the '''php.ini''' file of the server.''<br />
-''If you want to give a higher value, you must also increase the 'upload_max_filesize' and 'upload_max_filesize' in php.ini file accordingly.''<br />
+''If you want to give a higher value, you must also increase the 'post_max_size' and 'upload_max_filesize' in php.ini file accordingly.''<br />
 ''Otherwise, the higher value specified in the module will automatically be decreased to the values specified in the php.ini configuration file.''
+|}
+{|
+|style="padding: 0px 0px 30px 25px;"|[[File:RB2_17.png]]
+|}
+====SignNow====
+{|
+|style="padding: 10px 0px 15px 15px;"|A''' ''[https://www.signnow.com/ SignNow]'' ''' account is required to use this option. Take the following steps to set it up:<br />
+. [https://app.signnow.com/rctapp/login  Log in] to your SignNow profile.<br />
+. Go to the '' 'API' '' section. You can find it at the bottom of the left-side menu.<br />
+. Click on the '' 'Add Application' '' button and name the application.
 |}
 {|
-|style="padding: 0px 0px 30px 25px;"|[[File:RB_52.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:RB2_16_1.png]]
+|}
+{|
+|style="padding: 0px 0px 15px 15px;"|
+. Copy your '' 'Basic Authorization Token'.''
+|}
+{|
+|style="padding: 0px 0px 20px 25px;"|[[File:RB2_16_2.png]]
+|}
+{|
+|style="padding: 0px 0px 15px 15px;"|
+. Now return to the configuration of the WHMCS module and enter the following fields. <br/>
+*Username - Your SignNow username.
+*Password - Your SignNow password.
+*Bacic Auth Token - The token you just copied.
+*Email - Any email, it will be used as SignNow email signature.
+If you are using a trial SignNow account, enable the demo mode.<br/>
+Do not forget to '' 'Confirm' '' the settings first because only then you can click the '' 'Authorization' '' button.
+|}
+{|
+|style="padding: 0px 0px 20px 25px;"|[[File:RB2_16_3.png]]
+|}
+{|
+|style="padding: 0px 0px 30px 15px;"|
+. Finally, if you provided all data correctly you should receive the notice that authorization has been completed successfully.
 |}
 ===Contract Templates===
 {|
-|style="padding: 10px 0px 15px 15px;"|Now, that you have a contract's content draft, move to '' 'Contract Templates'. ''<br />
+|style="padding: 10px 0px 15px 15px;"|Now, that you have a contract's content draft, move to '' 'Contracts' '' → '' 'Contract Templates'. ''<br />
-In this section you can predefine which contract content draft a specific product a template will refer to.<br/>
+In this section, you can predefine which contract content draft a specific product a template will refer to.<br/>
-Press '' 'Add New' '' to begin.
+Press '' 'Create Template' '' to begin.
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:RB_12.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:RB2_18.png]]
 |}
 {|
-|style="padding: 0px 0px 15px 15px;"|Fill out the contract template form. Name the template, as mentioned before, choose content name from the ones you prepared previously (see '' 'Contract Content' '' section).<br/> Select product that this template will be available with.<br/> '' '''Note:''' You can assign only one template to a single product, it is not possible to alter the product assignment once you save the changes!''<br/>
+|style="padding: 0px 0px 15px 15px;"|Fill out the contract template form. Name the template and choose content names from the ones you prepared previously (see the [[#Contract_Content|'' 'Contract Content' '']] section).<br/> Select the product that this template will be available with.<br/> '' '''Note:''' You can assign only one template to a single product, it is not possible to alter the product assignment once you save the changes!''<br/>
 Define one of the methods by which your customers will be able to sign contracts. Choose from the following:
-*Adobe Sign
+*Adobe Acrobat Sign
-*Checkbox
 *DocuSign
+*Dropbox Sign
+*SignNow
 *File Upload
+*Checkbox
 '' '''Note:''' Don't forget to set up their initial [https://www.docs.modulesgarden.com/Recurring_Billing_Extended_For_WHMCS#Sign_Types configuration].''<br/>
-Choose ''Fixed'' or ''Percentage'' values for Promotion and Penalty amounts.<br/>
+Choose ''Fixed'' or ''Percentage'' values for Discount and Penalty amounts.<br/>
 Define contract renewal option:
 *Renew with contract
@@ Line 463: / Line 556: @@
 *Cancel<br/>
-Finally, you may decide whether ta allow your clients to cancel the contract while it is active or not.<br/>
+Finally, you may decide whether to allow your clients to cancel the contract while it is active or not.<br/>
-Once ready, remember to '' 'Save' '' the changes.
+Once ready, remember to '' 'Confirm' '' the changes.
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:RB_13.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:RB2_19.png]]
 |}
 {|
-|style="padding: 0px 0px 15px 15px;"|In case of the '''DocuSign''' template, you may also define the exact position of the signature on the contract together with the page number. <br/> Please refer to the following  [https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/fixed/ article] to learn how to position the signature.
+|style="padding: 0px 0px 15px 15px;"|In the case of the '''DocuSign''' template, you may also define the exact position of the signature on the contract together with the page number and sign phrase. <br/> Please refer to the following  [https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/fixed/ article] to learn how to position the signature. If you cannot see the relevant section, make sure to choose '''DocuSign''' as '''Sign Type''' and confirm changes.<br/> If you wish to provide the phrase under which a client will sign a contract (this phrase has to be included in its content), please use the '' 'Sign Phrase' '' configuration field. <br/>
+'''''Note:''' If you cannot see the relevant 'Signature' section next to the 'Template' section, try clicking on 'Confirm' first and see if it appears.
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:RB_13_1.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:RB2_20.png]]
 |}
 {|
-|style="padding: 0px 0px 15px 15px;"|Once you have added a new template, you have to fill out contract's details. An appropriate box should appear next to the template form.<br/>
+|style="padding: 0px 0px 15px 15px;"|Once you have added a new template, you have to create '' 'Contract Lengths'.'' An appropriate box should appear next to the template form.<br/> Pick a currency and billing circle. Once those are specified, click on '' 'Create Length' '' to begin.
-You will find there a payment type and the price, number of signed contracts and a checkbox,<br/> which, when selected, allows to order assigned product without the need to accept this contract.<br/>
-Press '' '+' '' to see more.
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:RB_14.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:RB2_21.png]]
 |}
 {|
 |style="padding: 0px 0px 20px 15px;"|In this form you can define:
-*Length - how long such contract shall last
+*Length - how long such a contract shall last. If you want, you can include '' 'Order Without Contract,' '' to allow clients to make orders, without signing a contract.
-*Promo Amount - as fixed amount or percentage for the discount, depending on the previously selected type in the template form
+*Discount Amount - a fixed amount or percentage for the discount, depending on the previously selected type in the template form.
-*Penalty Amount - as fixed amount or percentage, depending on the previously selected type in the template form
+*Penalty Amount - a fixed amount or percentage, depending on the previously selected type in the template form.
-*Days To Cancel - number of days to the end of the contract from which the customer will no longer have to pay a cancellation penalty
+<!-- *Days To Cancel - number of days to the end of the contract from which the customer will no longer have to pay a cancellation penalty. -->
-*Trial Period - number of days when a client may resign from the contact without any consequences or giving reason of resignation
+*Trial Period - number of days when a client may resign from the contract without any consequences or giving the reason for resignation.
-*Notice Time - define time when a renewal notification will be sent<br/>
+*Notice Time - define the time when a renewal notification will be sent.<br/>
-Next to each of the options ''(except 'Trial Period') '' there will appear counted pricing of product.<br/>
+Click on '' 'Confirm' '' when finished.
-Remember to '' 'Save' '' the changes again.
+<!-- Next to each of the options ''(except 'Trial Period') '' there will appear counted pricing of product.<br/> -->
 |}
 {|
-|style="padding: 0px 0px 30px 25px;"|[[File:RB_15.png]]
+|style="padding: 0px 0px 30px 25px;"|[[File:RB2_22.png]]
 |}
-===Configuration===
+===Module Configuration===
 {|
-|style="padding: 10px 0px 20px 15px;"|The last step mentioned in the '' 'Guide' '' is setting up '' 'Notifications' '' and '' 'Penalty'. '' These options can be found under '' 'Configuration' '' tab in '' 'Utilities' '' section.<br/> If you wish to provide the phrase under which a client will sign a contract (this phrase has to be included in its content), please use the '' 'Sign Phrase' '' configuration.
+|style="padding: 10px 0px 20px 15px;"|The last step mentioned in the '' 'Guide' '' is setting up '' 'Notifications,' '' '' 'Default Penalty Grace Period,' '' and '' 'Service Suspension Rules'. '' These options can be found under '' 'Configuration' '' tab in '' 'Utilities' '' section.<br/> Select which email notifications you want your clients to receive and enter the number of days before the due date to send the notification.
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:RB_16.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:RB2_23.png]]
 |}
 {|
-|style="padding: 0px 0px 15px 15px;"|Select which email notifications you want your clients to receive, enter number of days before due date to send the notification.<br/>
+|style="padding: 0px 0px 15px 15px;"|
-Move to '' 'Setup' → 'Email Templates' → 'General Messages' '' in your WHMCS to view and edit the notifications. You will find them under '' 'Ending Contract Notification' '' name.<br/>
+Move to '' 'System Settings' → 'System' → 'Email Templates' → 'General Messages' '' in your WHMCS to view and edit the notifications. You will find them under '' 'Ending Contract Notification' '' name.<br/>
-Enabled notifications are sent automatically with daily cron run.
+Enabled notifications are sent automatically with the daily cron run.
 |}
 {|
@@ Line 514: / Line 606: @@
 |}
 {|
-|style="padding: 0px 0px 20px 15px;"|Define number of days when a client can be late with payment.<br/> If a client misses to make payment for longer than the specified here number of days, a penalty will be imposed on such client.<br/> ''Note: penalty type and amount are specified in 'Contract Template' details.''
+|style="padding: 0px 0px 20px 15px;"| Define how the '' 'Contract Lengths' '' will be displayed in the Client Area, by choosing the '' 'Field Type.' ''
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:RB_18.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:RB2_24.png]]
 |}
 {|
-|style="padding: 0px 0px 20px 15px;"|Here you can also turn off the guide or turn it on again once you have hidden it.<br/>
+|style="padding: 0px 0px 20px 15px;"|Define number of days when a client can be late with payment.<br/> If a client misses making payment for longer than the number of days specified here, a penalty will be imposed on such client.<br/> '''''Note:''' Penalty type and amount are specified in the 'Contract Template' details.''
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:RB_19.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:RB2_25.png]]
 |}
 {|
-|style="padding: 0px 0px 15px 15px;"|Finally, you may decide if services shall be suspended after the provided number of days pass, without the client signing the contract.<br/> You may exclude services ordered before a certain date from this option.<br/>
+|style="padding: 0px 0px 15px 15px;"|You may decide if services shall be automatically suspended after the provided number of days pass, without the client signing the contract.<br/> You may exclude services ordered before a certain date from this option.
+|}
+{|
+|style="padding: 0px 0px 20px 25px;"|[[File:RB2_26.png]]
+|}
+{|
+|style="padding: 0px 0px 20px 15px;"|Finally, you can turn off the guide or turn it on again once you have hidden it.<br/>
 '' 'Save' '' the changes once your configuration is ready.
 |}
 {|
-|style="padding: 0px 0px 30px 25px;"|[[File:RB_19_1.png]]
+|style="padding: 0px 0px 30px 25px;"|[[File:RB2_27.png]]
 |}
 ==Management==
 {|
-|style="padding: 10px 0px 30px 15px;"|In the following sections we will try to explain how previously configured contracts are forced on clients.
+|style="padding: 10px 0px 30px 15px;"|In the following sections we will try to explain how previously configured contracts are imposed on clients.
 |}
 ===Client Area===
@@ Line 541: / Line 639: @@
 {|
 |style="padding: 10px 0px 15px 15px;"|To illustrate the process, let's say a client orders one of your products with recurring payment ''(it is important that you have previously prepared a contract for this product).''<br/>
-Once a billing cycle is chosen, in '' 'Additional Required Information' '' a client must select the contract length from the available.
+Once the client reaches checkout, the contract field appears. They may choose the contract length from available options, view the contract and sign in.
-|}
-{|
-|style="padding: 0px 0px 20px 25px;"|[[File:RB_22.png]]
-|}
-{|
-|style="padding: 0px 0px 20px 15px;"|Before accepting any Terms of Use, a client may view the contract and read it.
-|}
-{|
-|style="padding: 0px 0px 20px 25px;"|[[File:RB_23.png]]
-|}
-{|
-|style="padding: 0px 0px 15px 15px;"|Once familiar with the content of the contract accept '' 'Contract Terms of Use', '' only then you will be allowed to view the cart with the selected product.<br />
-'' '''Note:''' 'Checkbox' method is used in the following example.''
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:RB_24.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:RB2_28.png]]
 |}
 {|
-|style="padding: 0px 0px 20px 15px;"|If you do not accept the terms of use you will not be allowed to move to the cart.
+|style="padding: 0px 0px 20px 15px;"|If the client tries to complete the order without signing the contract, this error message will be displayed. <br/>
+'''''Note:''' You can add an option to order the product without signing the contract by choosing 'Order Without Contract' while adding [[#Contract_Templates|'Contract Lengths']] in the module addon.''
 |}
 {|
-|style="padding: 0px 0px 30px 25px;"|[[File:RB_25.png]]
+|style="padding: 0px 0px 30px 25px;"|[[File:RB2_29.png]]
 |}
 ====Service Contracts====
 {|
-|style="padding: 10px 0px 15px 15px;"|To view all accepted contracts, find '' 'My Contracts' '' tab or use a shortcut: '' 'Service Contracts'.''
+|style="padding: 10px 0px 20px 15px;"|To view all accepted contracts, find the '' 'My Contracts' '' tab.
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:RB_27.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:RB2_30.png]]
 |}
 {|
-|style="padding: 0px 0px 15px 15px;"|There is a full list of client's contracts with the most important information about them.<br/>
+|style="padding: 0px 0px 15px 15px;"|There is a full list of client's contracts with the most important information about them.<br/> Including: '' 'Product/Service Name,' '' '' 'Recurring Amount,' '' '' 'Sign Date,' '' '' 'Contract Length' '' and '' 'End Date' '' as well as its '' 'Status.' ''<br/>
 Use action buttons to:
-*view the contract details page
+*View the contract details page.
-*open a PDF version of the contract
+*Download a PDF version of the contract.
-*see the contract content changes history
+*See the contract content changes history.
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:RB_28.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:RB2_31.png]]
 |}
 {|
-|style="padding: 0px 0px 20px 15px;"|View the contract's details. Press '' 'Vie Contract' '' to see its details directly in the client area or press '' 'View Document' '' to download its PDF.
+|style="padding: 0px 0px 15px 15px;"|View the contract's details. Press '' 'Show' '' to see its details directly in the client area or press '' 'Download' '' to obtain its PDF version.<br/>
+If conditions are met, at the bottom of the contract the client will find buttons to renew or cancel the contract. <br/>
+The conditions are:
+*''The contract is active. ''
+*''The notice time, specified while creating the length, has passed.''
+*''The contract renewal type is set to: 'Renew With Contract.'''
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:RB_28_1.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:RB2_32.png]]
 |}
 {|
 |style="padding: 0px 0px 15px 15px;"|History of any changes in the contract content:<br/>
-''View PDF to see the previous version of the contract.''
+''Click on the 'Page' icon to see the previous version of the contract.''
 |}
 {|
-|style="padding: 0px 0px 30px 25px;"|[[File:RB_30.png]]
+|style="padding: 0px 0px 30px 25px;"|[[File:RB2_33.png]]
 |}
+<!--
 ===Admin Area===
 {|
-|style="padding: 10px 0px 15px 15px;"|Come back to your admin area product view page. <br/>
+|style="padding: 10px 0px 15px 15px;"|Come back to your admin area and find the new product page. <br/>
-After submitting a new order from the admin area, an email with a link to view and accept the contract will be sent to the client if only the service has a contract template assigned.
+After submitting a new order from the admin area, an email with a link to view and accept the contract will be sent to the client if only the service has a contract template assigned.<br/> You can resend the email from here.
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:RB_30_0.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:RB2_34.png]]
 |}
 {|
 |style="padding: 0px 0px 30px 15px;"|Now, go back to the addon view to manage signed contracts.
 |}
+-->
 ====Signed Contracts====
 {|
-|style="padding: 10px 0px 15px 15px;"|In '' 'Signed Contracts' '' section you will find a list of all contracts accepted by your clients.<br/>
+|style="padding: 10px 0px 15px 15px;"|In '' 'Signed Contracts' '' section under '' 'Contracts' '' you will find a list of all contracts accepted by your clients.<br/>
-On the main page you can see name of the client with service used, recurring payment amount for their product and contract details such as signing and ending dates, length and status. <br/>
+On the main page, you can see the name of the client with the service used, the recurring payment amount for their product, and contract details such as signing and ending dates, length and status. <br/>
-Use action buttons to cancel or edit contracts. If you use edit button, you will be moved to a full view of the contract.
+Use action buttons to edit, cancel or delete contracts. If you use the edit button, you will be moved to a full view of the contract.
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:RB_31.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:RB2_35.png]]
 |}
 {|
-|style="padding: 0px 0px 20px 15px;"|On this page you can see once again details of a contract accepted between a client and you. <br/>
+|style="padding: 0px 0px 15px 15px;"|On this page, you can once again see details of a contract accepted between you and the client. <br/>
-You are allowed to modify the content of this very contract. Note that used '' 'Contract Content' '' will not be altered, only the signed item.
+You are allowed to modify the content, status and details of this very contract. Note that used '' 'Contract Content' '' will not be altered, only the signed item.
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:RB_32.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:RB2_36.png]]
 |}
 {|
 |style="padding: 0px 0px 15px 15px;"|In case you decide to make any changes to the contract, the previous (before changes) version of the contract is added to the '' 'History'. '' <br/>
-Thanks to that, you may always come back to the original, restore it (changes made will be overwritten with the previous content) or view PDF version.<br/> In this step you may also add notes for future reference.
+Thanks to that, you may always come back to the original.<br/> In this step you may also add notes for future reference. Make sure to save changes.
 |}
 {|
-|style="padding: 0px 0px 30px 25px;"|[[File:RB_34.png]]
+|style="padding: 0px 0px 30px 25px;"|[[File:RB2_37.png]]
 |}
-=====Upload Signed Contracts=====
+=====Create Contract=====
 {|
-|style="padding: 10px 0px 15px 15px;"|Below the list of '' 'Signed Contracts','' you will find a button redirecting you to the form where existing contracts, for example signed manually, can be uploaded into the module and managed here.<br/> Press the button to see how to do that.
+|style="padding: 10px 0px 20px 15px;"|Above the list of '' 'Signed Contracts','' you will find 2 buttons. '' 'Create Contract,' '' and '' 'Request Signing.' ''
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:RB_34_1.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:RB2_37_1.png]]
 |}
 {|
-|style="padding: 0px 0px 15px 15px;"|First of all select the client. Then pick the service the uploaded contract is related to, or select 'None' if your contract is an independent document.<br/>
+|style="padding: 0px 0px 15px 15px;"|Let us cover '' 'Create Contract' '' first. Clicking on the button will redirect you to the form where existing contracts, for example, signed manually, can be uploaded into the module and managed. <br/>
-Choose the contract length: strict period or a custom length; note that the ending date is selected automatically based on the contract length.  <br/> You may also add your private notes. Save the changes to finalize the action.
+First of all, select the client. Then pick the service the uploaded contract is related to, or select none if your contract is an independent document.<br/>
+Choose the contract length: strict period or a custom length; note that the ending date is selected automatically based on the contract length.  <br/>
+Select the contract's status and renewal type. Specify if cancellation is allowed. If you have the contract in the form of a file, you can upload it here. <br/>  Finally, you may also add your private notes. Confirm changes to finalize the action.
 |}
 {|
-|style="padding: 0px 0px 30px 25px;"|[[File:RB_34_2.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:RB2_37_2.png]]
+|}
+{|
+|style="padding: 0px 0px 30px 15px;"|'' 'Request Signing' '' allows you to send emails directly to your clients requesting them to sign a contract for a specific product and specific length.
 |}
@@ Line 652: / Line 750: @@
 *Recently Signed Contracts
 *Recently Ended Contracts (including finished, canceled and broken ones)
-*Contract Status
+*Contract Summary
-*Logs
+*Revenue Summary
+|}
+{|
+|style="padding: 0px 0px 30px 25px;"|[[File:RB2_38.png]]
+|}
+===[https://www.docs.modulesgarden.com/Translations_Tool Translations]===
+{|
+|style="padding: 10px 0px 15px 15px;"|Customizing language files is now extremely easy with the '' "Translations" '' tool that is now available directly in the addon.<br.> Its user-friendly design makes managing various language file tweaks a smooth and efficient process. <br/>
+Prepare translations for the original English files with this handy built-in tool. For specific instructions on how to use this tool please refer to its dedicated article, you will find it [https://www.docs.modulesgarden.com/Translations_Tool here].
+|}
+{|
+|style="padding: 0px 0px 30px 25px;"|[[File:RB2_35_1.png]]
+|}
+===Access Control===
+{|
+|style="padding: 10px 0px 30px 15px;"|'' 'Access Control' '' allows you to specify and control exactly which sections of the module can be accessed by your administrators. <br/>
+The way it works is that you create access control rules in which you decide if a specific admin, or admin role has full access, or is restricted to only specific sections.
+|}
+====Rules====
+{|
+|style="padding: 10px 0px 20px 15px;"|Start with creating a new rule, click on the 'Create Rule' button and a dedicated form will appear. Below you will find a description of every field required in the form.
+|}
+{|
+|style="padding: 0px 0px 20px 25px;"|[[File:RB2_44.png]]
+|}
+{|
+|style="padding: 0px 0px 15px 15px;"|Fill out the following fields to create resources access rule:
+*'''Rule Name''' - Pick a name for your rule.
+*'''Grant Full Access''' - Enable to grant full access to all sections of the module to the specified personnel. Disable to specify in two additional fields below, to which resources access will be granted, and to which it will be denied.
+*'''Allow Access To''' - Designate the resources that the specified personnel will have access to.
+*'''Restrict Access To''' - Specify the resources that the specified personnel will not have access to.
+*'''Administrators''' - Specify which singular administrators will be subject to the new rule. If the specific administrator is already included in the group you have picked, you do not need to add him separately. <br/> '''''Note:''' All restrictions for specific administrators are summed with the restrictions on their role groups, across all rules.''
+*'''Administrator Roles''' - Specify which administrator role groups will be subject to the new rule.<br/>
+'''Important:''' When picking specific sections, keep in mind that allowing a parent section '''will also allow all of its children.''' <br/>
+For example by allowing 'Translations' you allow 'Translations → Create,' 'Translations → Delete' and 'Translations → Export' etc.<br/>
+If you would like to give access to everything about translations, but the ability to delete them, you can pick 'Translations' in 'Allow Access To' and then 'Translations → Delete' in 'Restrict Access To.'<br/> '''Restrict''' takes precedence over '''Allow,''' so if a specific section is included in both, it will be restricted.
+|}
+{|
+|style="padding: 0px 0px 20px 25px;"|[[File:RB2_45.png]]
+|}
+{|
+|style="padding: 0px 0px 20px 15px;"|To edit or delete existing rules, use the icons to the right.
+|}
+{|
+|style="padding: 0px 0px 30px 25px;"|[[File:RB2_46.png]]
+|}
+====Resources====
+{|
+|style="padding: 10px 0px 15px 15px;"|Use the toggles in the 'Resources' section to specify which of them should be subject to logging, found in the 'Logs' section. <br/> Every time an administrator requests a toggled resource, it will be recorded.
+|}
+{|
+|style="padding: 0px 0px 30px 25px;"|[[File:RB2_47.png]]
+|}
+====Access Control Logs====
+{|
+|style="padding: 10px 0px 15px 15px;"|The logs section includes:
+*Log ID
+*Name of the administrator
+*Requested resource
+*Applied Resource
+*Rule Name
+*Date
+Use the trash bin icons to delete specific logs, or utilize the mass action function to delete multiple logs at once.
+|}
+{|
+|style="padding: 0px 0px 30px 25px;"|[[File:RB2_48.png]]
+|}
+===Logs===
+{|
+|style="padding: 10px 0px 10px 15px;"|In the '' 'Logs' '' section any attempted actions on any contract are recorded and stored for your convenience. <br/>
+Use the action buttons to see details or delete each log entry. Multiple logs can be deleted at once by utilizing the mass selection function.
+|}
+{|
+|style="padding: 0px 0px 20px 25px;"|[[File:RB2_39.png]]
+|}
+{|
+|style="padding: 10px 0px 20px 15px;"|Furthermore, the logs feature additional actions. Changing the logs' settings, exporting the logs to a '' '.csv' '' file, and a way to delete specific log types.
+|}
+{|
+|style="padding: 0px 0px 20px 25px;"|[[File:RB2_40.png]]
+|}
+{|
+|style="padding: 10px 0px 20px 15px;"|In the settings you can specify which log types should be recorded, and whether they should be deleted automatically after a specific time.
+|}
+{|
+|style="padding: 0px 0px 20px 25px;"|[[File:RB2_41.png]]
+|}
+{|
+|style="padding: 10px 0px 20px 15px;"|While exporting you will pick a time frame and the log types to export.
 |}
 {|
-|style="padding: 0px 0px 30px 25px;"|[[File:RB_35.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:RB2_42.png]]
 |}
-====Logs====
 {|
-|style="padding: 10px 0px 20px 15px;"|In '' 'Logs' '' section you have a full view on any attempted action on any contract.
+|style="padding: 10px 0px 20px 15px;"|Here you can decide which log types to delete, you can also specify how old the logs have to be to qualify for deletion. Leave the first field empty to delete all logs.
 |}
 {|
-|style="padding: 0px 0px 30px 25px;"|[[File:RB_38.png]]
+|style="padding: 0px 0px 30px 25px;"|[[File:RB2_43.png]]
 |}
 ==Advanced Billing For WHMCS Integration==
 {|
-|style="padding: 10px 0px 15px 15px;"|It is possible to combine your Recurring Contract Billing For WHMCS module with one of our most favored products which is Advanced Billing For WHMCS.<br/>
+|style="padding: 10px 0px 15px 15px;"|It is possible to combine your Recurring Contract Billing For WHMCS module with one of our most favored products: Advanced Billing For WHMCS.<br/>
 In order to configure the two modules to work together move to '' 'Advanced Billing addon' → 'Configuration' '' and find the product you want to work with. <br/>Move to '' 'Settings' → 'Recurring Billing' '' section, as billing type select ''''' 'Bill On Invoice Generation' ''''' option.<br/>
 Learn more about Advanced Billing configuration [https://www.docs.modulesgarden.com/Advanced_Billing_For_WHMCS#Recurring_Billing here].
@@ Line 676: / Line 866: @@
 |}
 {|
-|style="padding: 0px 0px 20px 15px;"|When ready, Recurring Contract Billing For WHMCS will be in constant cooperation with the other module within the configured product. If you want to combine the functionalities<br/> of the two modules for more than one product, please remember to select '' 'Bill On Invoice Generation' '' option for all of them!
+|style="padding: 0px 0px 20px 15px;"|When ready, Recurring Contract Billing For WHMCS will be in constant cooperation with the other module within the configured product. If you want to combine the functionalities<br/> of the two modules for more than one product, please remember to select the'' 'Bill On Invoice Generation' '' option for all of them.
 |}
 <!--
@@ Line 686: / Line 876: @@
 =Tips=
+<!--
 {|
-|style="padding: 10px 0px 10px 15px;"|1. If you mark checkbox  '' 'Select to permit orders without contract' '' in a contract template, while placing an order a client will be allowed<br/>to select '' 'I do not want to sign a contract' '' option form '' 'Contract Length'.''<br/> No '' 'Terms of Use' '' will have to be accepted then and the client will not be charged according to the contract's details.
+|style="padding: 10px 0px 10px 15px;"|1. If you include '' 'Order Without Contract' '' in the contract template, while placing an order a client will be allowed<br/>to select '' 'I do not want to sign a contract' '' option form '' 'Contract Length'.''<br/> No '' 'Terms of Use' '' will have to be accepted then and the client will not be charged according to the contract's details.
 |}
 {|
 |style="padding: 0px 0px 20px 25px;"|[[File:RB_39.png]]
 |}
+-->
 {|
-|style="padding: 0px 0px 5px 15px;"|2. The contracts are automatically broken in two cases:
+|style="padding: 0px 0px 5px 15px;"|1. The contracts are automatically broken in two cases:
 *The invoice has not been paid - module counts the number of days set up in configuration '' 'penalty after x days' '' until the moment the payment is noted in the system.
-*Client has sent a cancellation request for the product.
+*The client has sent a cancellation request for the product.
 |}
 {|
-|style="padding: 0px 0px 0px 15px;"|3. As this module supports templates system, any changes made in the module's templates files will be saved after the upgrade process.
+|style="padding: 0px 0px 10px 15px;"|2. As this module supports a template system, any changes made in the module's template files will be saved after the update process.
 |}
+<!--
 {|
-|style="padding: 0px 0px 5px 15px;"|4. Please remember that the  '' 'Accept Contract' '' checkbox with the possibility to view the contract in the preview of placing an order is visible only for logged in users. <br/> For not logged in users, it will be visible when they proceed to the checkout step.
+|style="padding: 0px 0px 30px 15px;"|3. Please remember that the  '' 'Accept Contract' '' checkbox with the possibility to view the contract in the preview of placing an order is visible only for logged-in users. <br/> For not logged-in users, it will be visible when they proceed to the checkout step.
 |}
 {|
-|style="padding: 0px 0px 30px 15px;"|5. To assure correct integration of the module with the '' 'Lagom Client Theme', '' the following integration code must be added into '' ' viewcart.tpl'.''<br/>
+|style="padding: 0px 0px 30px 15px;"|4. To assure correct integration of the module with the '' 'Lagom Client Theme', '' the following integration code must be added into '' ' viewcart.tpl'.''<br/>
 Open the '' ' viewcart.tpl' '' file at ''/templates/orderforms/lagom2/viewcart.tpl'' directory, find following line:
 <pre> <input type="hidden" name="submit" value="true" />
@@ Line 733: / Line 927: @@
 |}
+-->
 =Update Instructions=
 {|
-|style="padding: 10px 0px 15px 15px;"|Essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.<br/><br/>
+|style="padding: 10px 0px 15px 15px;"|An essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.<br/>
-Keep in mind there is a quick and easy option in our client area that will let you upgrade the license of your module to an open source version at any time - and at a lower price!<br/>
+Ensure successful completion of the module update by carefully following each step, thereby preventing data loss or any unforeseen issues.<br/> Additionally, you will find a current list of supplementary actions necessary for a smooth update process there. <br/>
-To take advantage of it, simply use the '''License Upgrade''' button located on the product's page and a discounted invoice will be generated automatically.<br/>
 |}
+{|
+|style="padding: 0px 0px 30px 15px;"|'''''Important:''' If you are updating the module from a version prior to '''2.0.0''', '''you must deactivate the old addon module and delete its files before performing the update.''' <br/>
+This will ensure all potential conflicts are avoided. To migrate your data, after activation of the new version, use the migration cron prepared for you in '' 'Utilities' '' → '' 'Configuration' '' → '' 'Migration Tool' ''<br/>
+It should look like this:
+ php -q /yourWHMCS/modules/addons/RecurringContractBilling/cron/cron.php migrate
+Because of new redirect URIs, the '''connection between the module and the sign providers will need to be re-established'''.<br/>You can find instructions on how to do this in the [[#Sign_Types|Sign Types]] section.''
+|}
+<!--
 {|
 |style="padding: 0px 0px 30px 15px;"|The module rebranding from Recurring Billing For WHMCS to Recurring Contract Billing For WHMCS caused changes in the module file naming.<br/> If you are updating the module from version 1.3.x or lower to 1.4.0 or higher, you must remember to delete the previous module's files from your WHMCS directory. Keeping both ''recurringBilling'' and ''recurringContractBilling'' will cause errors.
+|}
+-->
+=Upgrade Guide=
+{|
+|style="padding: 10px 0px 30px 15px;"|Seeking a solution that offers greater flexibility, customization tailored to your precise needs, and unrestricted availability?<br/> There is an option that not only proves to be cost-effective in the long run but also includes prioritized support services, making it a truly valuable investment.<br/>
+Opt for the [https://www.modulesgarden.com/products/whmcs/recurring-contract-billing#open-source-version Open Source version] of your Recurring Contract Billing For WHMCS module to unlock these benefits.<br/> Simply click on either the '''Get Source Code''' or '''Upgrade To Lifetime''' button found on the product's page in our client area to complete the one-step upgrade process, with a '''dedicated discount''' already applied.<br/>
+Follow a [https://www.docs.modulesgarden.com/How_To_Upgrade_WHMCS_Module comprehensive guide] covering the transition process, the advantages it brings, and step-by-step instructions on what to do next after the order has been successfully finalized.
 |}

Personal tools

Namespaces

Variants

Views

Actions

Search

Recurring Contract Billing For WHMCS