With this module, your customers can generate the contract for commissioned data processing via their customer area and then send it to you signed in printed form. The module only provides the basis for your customers to create the contract, it does not contain a prefabricated and ready-to-use AV contract.

System requirements

To use the AV Contract Module, the following requirements must be met:

• WHMCS 8.6 – 8.11
• Admin access to WHMCS
• IonCube Loader min 13.0
• PHP 7.4, 8.1 or 8.2

Installation

1. 1. Please upload the module files to your webspace and then activate the module in the admin area of WHMCS.
   2. You will find the required licence code in your customer account at Plambee.de Webhosting.
   3. If you want the module to send e-mail notifications, please activate the corresponding checkboxes. The e-mail template for the client can be edited in the e-mail template area of WHMCS, the template is called: AV Contract Confirmation

   4. Please select which Bootstrap version your customer area template is based on so that the module uses the appropriate file for the module’s customer area.

   5. Then go to the module and enter your AV contract there.

   6. Adapt the supplied template files pdf_footer_rename.tpl and pdf_header_rename.tpl for PDF creation and remove the “_rename” from the file name. You can work with HTML in the files, the PDF generator dompdf used also partially supports CSS.

   7. The customer area for this module, where the customer can generate the contract, can be found at https://ihr-whmcs.de/index.php?m=av_contract.

   8. If you do not use the WHMCS own number for the customer number, but use your own number as a custom customer field, please go to the addon listing (where you enter the licence key) and select the custom field for the customer number there.

Available variables

Contract text

The following variables are available for the contract text:
$kid = Client number
$frstname = Client Firstname
$lastname = Client Lastname
$clientcompany = Client Company
$address = Client Address
$postcode = Client Postcode
$city = Client City
$country = Client Country
$current_date = Current Date
$owncompany = Your Companyname
$contract_created_from_ip = Contract created by IP
$contract_created_at = Contract created on
$data_category = Type of data
$afected_data = Affected

E-Mail Template

For the e-mail template “AV Contract Confirmation”, which is sent to the client upon receipt of the signed contract, the following variable is available in addition to the WHMCS variables:

$create_date = Creation date of the contract (date when the customer generated the contract via the customer area)
$contract_created_from_ip = From which IP the contract was generated

Own variables

As of version 1.2.0, you can store your own variables for the type of data and for the persons concerned in order to expand these data fields as you wish. Please proceed as follows:

Open the clientarea.tpl file of the module

• Search for the form block
  <form role="form" method="post" action="" id="form2">
• For example, if you want to expand the type of data, hang after the block:
  <div><input id="kind-3" class="checkbox-custom" name="kind-3" type="checkbox"><label for="kind-3" class="checkbox-customlabel">{$av_contract_details.contract_data}</label></div>

another block in this format:
<div><input id="kind-4" class="checkbox-custom" name="kind[]" value="kind-4" type="checkbox"> <label for="kind-4" class="checkbox-custom-label">{$av_contract_lang.custom_kind_4}</label></div>

• Open the language files of the module and extend them with a language string named $_ADDONLANG[‘custom_kind_4’] = “NEW DATA TYPE”;
• Repeat for each record you want to add (increasing kind-4 by 1 with each new record)
• To expand the data field of the persons concerned, please proceed in the same way, only replace the “child”.

by “affected

Update notes

Update to version 1.2.0

After you have uploaded the new files to your web space, please go to the WHMCS admin area to the addon listing /admin/configaddonmods.php, click on “Configure” for the AV Contract module and then on Save. This is necessary to make a database change.

If your WHMCS version is older than version 7.6, please rename clientarea_under_76.tpl to clientarea.tpl.

Update to version 1.5.2

If you use your own variables, please open the template file of the module and replace there
{$av_contract_lang.custom_kind-4}
by {$av_contract_lang.custom_kind_4} and accordingly in the long files
$_ADDONLANG['custom_kind-4']
by
$_ADDONLANG['custom_kind_4']
this is necessary because newer smarty versions no longer allow the hyphen.

Update to Version 1.7.0

With version 1.7.0 it is possible to use a custom customer field for the customer number. If you want to use this function, please go to the addon listing (where you enter the licence key) and select the custom field for the customer number.

Update to Version 1.8.0

In this version, an option has been added so that the customer receives a notification in the customer area when you have updated the contract text. To activate this option, please go to the addon listing (where you enter the licence key) and activate it there.

There has been a small change to the template file for the client area, if you are using your own clientarea.tpl file please manually match the change. If you use our original template file, please rename the clientarea_rename.tpl from the archive to clientarea.tpl.

Update to Version 2.1.0

This version requires an update of the WHMCS database table, so that WHMCS can import this, please go to the addon listing (where you enter the licence key), click on “Configure” for the AV Contract module and then on Save. The necessary changes will be applied automatically. This version comes with 2 TPL files for the client area, if you use a Bootstrap 4 based template (e.g. twenty-one) then please rename the clientarea_rename_bs4.tpl to clientarea.tpl.

Update to Version 2.5.0

The template files for the customer area are now called clientarea.tpl and clientarea_bs4.tpl, renaming the files is no longer necessary. If you have adapted your template file, please take care not to overwrite your own adaptations with the template file from the modular archive when uploading.
After uploading all module files, please go to the addon listing page in WHMCS, click on Configure for the AV Contract module and select the bootstrap version used by your customer area template.

Update to Version 3.0.0

With version 3.0, CKEditor was updated to version 5. Please note that this version may have different functions and displays. If you want to make changes to the contract texts after the update, the text may be displayed differently; please check your contract text completely if you want to make changes. If the contract texts are not changed after the module update, the old version is still retained in the database, it only affects new saves.