.. ==================================================
.. 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 prerequisite extension (if you haven't yet): v4_crm_agent
#. Install the extension itself
#. Done

*You don't need including static typoscript template.*

.. _admin-configuration:

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

| The extension can be configured only by extension manager.
| There isn't typoscript configuration.

Properties
^^^^^^^^^^

.. container:: ts-properties

===================================================== ================================================ =========================
Property                                              Data type                                        Default
===================================================== ================================================ =========================
testCrmContactId_                                     :ref:`t3tsref:data-type-string`
testCrmContactNameFirst_                              :ref:`t3tsref:data-type-string`
testCrmAccountId_                                     :ref:`t3tsref:data-type-string`
testCrmAccountName_                                   :ref:`t3tsref:data-type-string`
testCrmUserId_                                        :ref:`t3tsref:data-type-string`
testCrmUserName_                                      :ref:`t3tsref:data-type-string`
===================================================== ================================================ =========================

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

.. _settings-testCrmContactId:

testCrmContactId
""""""""""""""""""""""""""""""""

test infoathand contact identifier

.. _settings-testCrmContactNameFirst:

testCrmContactNameFirst
""""""""""""""""""""""""""""""""

test infoathand contact first name

.. _settings-testCrmAccountId:

testCrmAccountId
""""""""""""""""""""""""""""""""

test infoathand account identifier

.. _settings-testCrmAccountName:

testCrmAccountName
""""""""""""""""""""""""""""""""

test infoathand account name

.. _settings-testCrmUserId:

testCrmUserId
""""""""""""""""""""""""""""""""

test infoathand user identifier

.. _settings-testCrmUserName:

testCrmUserName
""""""""""""""""""""""""""""""""

test infoathand user name

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

| There are unit tests in the extension.
| For executing these tests please install the phpunit extension.
|
| At the moment there are three test cases:
| *Tx_V4CrmLibrary_Domain_Repository_CrmAccountRepositoryTest*
| *Tx_V4CrmLibrary_Domain_Repository_CrmContactRepositoryTest*
| *Tx_V4CrmLibrary_Domain_Repository_CrmUserRepositoryTest*
|

In the *Tx_V4CrmLibrary_Domain_Repository_CrmAccountRepositoryTest* the following single tests are:

===================================== =======
Single test name                      Details
===================================== =======
testCreation                          Test for Tx_V4CrmLibrary_Domain_Repository_CrmAccountRepository object creation.
testAccountFindByUid                  Test for getting 1CRM Account object (uses *testCrmAccountId* configuration).
testAccountFindAllByName              Test for getting 1CRM Account object (uses *testCrmAccountName* configuration).
testAccountAdd                        Test for adding 1CRM Account object to 1CRM.
===================================== =======

In the *Tx_V4CrmLibrary_Domain_Repository_CrmContactRepositoryTest* the following single tests are:

===================================== =======
Single test name                      Details
===================================== =======
testCreation                          Test for Tx_V4CrmLibrary_Domain_Repository_CrmContactRepository object creation.
testContactFindByUid                  Test for getting 1CRM Contact object (uses *testCrmContactId* configuration).
testContactFindAllByFirstName         Test for getting 1CRM Contact object (uses *testCrmContactNameFirst* configuration).
testContactAdd                        Test for adding 1CRM Contact object to 1CRM.
testContactUpdate                     Test for updating 1CRM Contact object in 1CRM (uses *testCrmContactId*).
===================================== =======

In the *Tx_V4CrmLibrary_Domain_Repository_CrmUserRepositoryTest* the following single tests are:

===================================== =======
Single test name                      Details
===================================== =======
testCreation                          Test for Tx_V4CrmLibrary_Domain_Repository_CrmUserRepository object creation.
testUserFindByUid                     Test for getting 1CRM User object (uses *testCrmUserId* configuration).
testFindOneByUserName                 Test for getting 1CRM User object (uses *testCrmUserName* configuration).
===================================== =======