.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.

.. include:: ../Includes.txt


.. _admin-manual:

Administrator Manual
====================

Target group: **Administrators**

.. _admin-installation:

Installation
------------

To install the extension, perform the following steps:

#. Go to the Extension Manager
#. Install the extension
#. Done

.. _admin-configuration:

Configuration
-------------

The extension can be configured only by extension manager.
In order to use the extension you have to configure it in the extension manager.

Properties
^^^^^^^^^^

.. container:: ts-properties

===================================================== ================================================ =========================
Property                                              Data type                                        Default
===================================================== ================================================ =========================
iahURL_                                               :ref:`t3tsref:data-type-string`                  http://localhost/json.php
iahAdminUserName_                                     :ref:`t3tsref:data-type-string`                  admin
iahAdminPassword_                                     :ref:`t3tsref:data-type-string`                  adminpw
testIahContactId_                                     :ref:`t3tsref:data-type-string`
testIahAccountId_                                     :ref:`t3tsref:data-type-string`
testIahUserId_                                        :ref:`t3tsref:data-type-string`
testPortalUserName_                                   :ref:`t3tsref:data-type-string`
testPortalUserPassword_                               :ref:`t3tsref:data-type-string`
===================================================== ================================================ =========================


Property details
^^^^^^^^^^^^^^^^^^

.. _settings-iahURL:

iahURL
""""""""""""""""""""""""""""""""

crm JSON URL

.. _settings-iahAdminUserName:

iahAdminUserName
""""""""""""""""""""""""""""""""

crm administrator user name

.. _settings-iahAdminPassword:

iahAdminPassword
""""""""""""""""""""""""""""""""

crm administrator password

.. _settings-testIahContactId:

testIahContactId
""""""""""""""""""""""""""""""""

test crm contact identifier

.. _settings-testIahAccountId:

testIahAccountId
""""""""""""""""""""""""""""""""

test crm account identifier

.. _settings-testIahUserId:

testIahUserId
""""""""""""""""""""""""""""""""

test crm user identifier

.. _settings-testPortalUserName:

testPortalUserName
""""""""""""""""""""""""""""""""

test crm portal user name

.. _settings-testPortalUserPassword:

testPortalUserPassword
""""""""""""""""""""""""""""""""

test crm portal user password

Testing
-------------

| There are unit tests in the extension.
| For executing these tests please install the phpunit extension.
|
| At the moment there are two test cases:
| *v4CrmAgentAdminTest*
| *v4CrmAgentPortalUserTest*
|

In the *v4CrmAgentAdminTest* the following single test are:

===================================== =======
Single test name                      Details
===================================== =======
testCreation                          Test for v4_crm_agent_admin object creation.
testLogin                             Test for loging to 1CRM as admin user.
testLogout                            Test for logout from 1CRM.
testGetItemContact                    Test for getting contact item (uses *testCrmContactId* configuration).
testGetItemAccount                    Test for getting account item (uses *testCrmAccountId* configuration).
testGetItemUser                       Test for getting user item (uses *testCrmUserId* configuration).
testGetListLead                       Test for getting lead list.
testGetFieldListOfCrmModuleContact    Test for getting contact module field list.
testGetFieldListOfCrmModuleAccount    Test for getting account module field list.
testGetFieldListOfCrmModuleUser       Test for getting user module field list.
===================================== =======

In the *v4CrmAgentPortalUserTest* the following single test are:

===================================== =======
Single test name                      Details
===================================== =======
testCreation                          Test for v4_crm_agent_portal_user object creation.
testLogin                             Test for loging to 1CRM as portal user.
testLogout                            Test for logout from 1CRM.
testGetItemContact                    Test for getting contact item (uses *testCrmContactId* configuration).
testGetItemAccount                    Test for getting account item (uses *testCrmAccountId* configuration).
testGetListLead                       Test for getting lead list.
===================================== =======