User Tools
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
en:extensions:coreboscp:installconfig [2014/04/22 18:32] joebordes created |
en:extensions:coreboscp:installconfig [2019/07/30 23:58] (current) joebordes [coreBOSCP Install and Configuration] |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== vtigerCRM-Spain::vtyiicpng - Installation and Configuration ====== | + | ====== coreBOSCP - Installation and Configuration ====== |
| - | The vtyiiCPNG application is a rest/webservice interface program to an existing vtiger CRM application. This means that it has no need for a database of it's own, all the information it manipulates is read from or sent to an associated vtiger CRM which saves it to the configured database there. | + | The coreBOSCP application is a rest/webservice interface program to an existing coreBOS application. This means that it has no need for a database of it's own, all the information it manipulates is read from or sent to an associated coreBOS which saves it to the configured database there. |
| - | This makes installing and configuring the application rather easy and mostly a case of configuring a vtiger CRM user and pointing the vtyiiCPNG application to it's associated vtiger CRM. | + | This makes installing and configuring the application rather easy and mostly a case of configuring a coreBOS user and pointing the coreBOSCP application to it's associated coreBOS. |
| - | ===== vtiger CRM Webservice Enhancements ===== | + | ===== coreBOS Webservice Enhancements ===== |
| - | To get vtyiiCPNG to do all the things needed we have had to extend the default vtiger CRM webservice considerably. We have tried to minimize the set of changes to a minimum but still a patch must be applied. | + | If you are trying to get this working on a vtiger CRM 5.4 (6.x), we have had to extend the default vtiger CRM web service considerably. |
| - | * download the set of changes vtyiicpngWS.zip and uncompress the file from the root of your vtiger CRM install | + | {{:en:coreboscp:coreboscp_vt54.zip|This patch and file set}} should do the trick but it is obsolete, the tickets above describe much better the necessary code changes. Copy the files into the root of your install, apply the patch to the code and execute the SQL in your database. |
| - | * apply the patch file vtyiicpngWS.diff which is now in the root of you install | + | <WRAP center round alert 70%> |
| - | * execute the script vtyiicpngWS.sql in your database to get the required database changes | + | Please backup your code and database before applying to any production site and please test on a copy before doing so. |
| + | </WRAP> | ||
| - | ===== vtiger CRM Customer Portal User ===== | ||
| - | To access your vtiger CRM through the webservice interface an active user in the application must be given. So the first step of the installation process is to access your vtiger CRM install and create a new user. This user should be assigned it's own role and profile, and the profile should be configured with the correct permissions with which we would like to have available on the customer portal. | + | ===== coreBOS Customer Portal User ===== |
| - | vtyiiCPNG portal application will use this user to access vtiger CRM and will respect the role and profile permissions assigned to that user. So if some field on Contacts shouldn't be seen on the portal it should be hidden in this user's profile. The same approach is taken for modules. Although vtyiiCPNG has a set of hard coded modules which it supports, which cannot be extended without programming, we can restrict this set by not giving access to a module to the customer portal user created in the vtiger CRM application. | + | To access your coreBOS through the webservice interface an active user in the application must be given. So the first step of the installation process is to access your coreBOS install and create a new user. This user should be assigned it's own role and profile, and the profile should be configured with the correct permissions to show information on the customer portal. |
| - | Certain "relation" fields are mandatory. All access to entities through the customer portal are restricted by the contact and his account. So all entities will be filtered by their relation field to contacts and accounts. For example, we will only see invoice that belong to the contact or his account, likewise we will only see trouble tickets related to the contact and his account. To be able to achieve this, the portal user MUST have access to the fields that establish this relation. | + | coreBOSCP portal application will use this user to access coreBOS and will respect the role and profile permissions assigned to that user. So if some field on Contacts shouldn't be seen on the portal it should be hidden in this user's profile. The same approach is taken for modules. Although coreBOSCP has a set of hard coded modules which it supports, which cannot be extended without programming, we can restrict this set by not giving access to a module to the customer portal user created in the coreBOS application. |
| - | NOTE: vtyiiCPNG does not use nor respect the customer portal extension of vtiger CRM. That extension is used by the vtiger CRM Customer Portal, we do not use any of that configuration. | + | Certain "//relation//" fields are mandatory. All access to entities through the customer portal are restricted by the contact and his account. So all entities will be filtered by their relation field to contacts and accounts. For example, we will only see invoice that belong to the contact or his account, likewise we will only see trouble tickets related to the contact and his account. To be able to achieve this, the portal user MUST have access to the fields that establish this relation. |
| - | On the new user's detail or preferences view we will find a field call access key, the value of this field is needed to configure vtyiiCPNG | + | <WRAP center round important 70%> |
| + | NOTE: coreBOSCP **does not** use nor respect the customer portal extension of vtigerCRM. That extension is used by the vtiger CRM Customer Portal, we do not use any of that configuration. | ||
| + | </WRAP> | ||
| - | ===== vtyiiCPNG Install and Configuration ===== | + | On the new user's detail or preferences view we will find a field call **access key**, the value of this field is needed to configure coreBOSCP |
| - | - copy the code to a directory accessible from the web user on the server where you want to have the customer portal | + | |
| - | - give read/write permission to the web user to all directories in the structure. Specially important are: assets and protected/runtime | + | ===== coreBOSCP Install and Configuration ===== |
| + | |||
| + | - copy the code to a directory accessible from the web user on the server where you want to have the customer portal. It is recommendable that you version that code using git:<code>git clone https://github.com/tsolucio/coreBOSCP.git coreboscp</code> | ||
| + | - give read/write permission to the web user to all directories in the structure. Especially important are: assets and protected/runtime | ||
| - edit protected/config/PortalConfig.php and set the variables | - edit protected/config/PortalConfig.php and set the variables | ||
| - | - $vtyiicpng_Server_Path: must be the full URL to the associated vtiger CRM install. Obviously this implies that the server you are doing the install on MUST have continuous access to the vtiger CRM application | + | - **$evocp_Server_Path** must be the full URL to the associated coreBOS install. Obviously, this implies that the server you are doing the install on MUST have continuous access to the coreBOS application |
| - | - $vtyiicpng_Login_User and $vtyiicpng_Access_Key define the user with which we will access vtiger CRM as defined in the previous section. | + | - **$evocp_Login_User** and **$coreBOSCP_Access_Key** define the user with which we will access coreBOS as defined in the previous section. |
| - | - $vtyiicpng_AttachmentFolderName is the name of the folder within which you want any trouble ticket attachments to be uploaded | + | - **$evocp_AttachmentFolderName** is the name of the folder within which you want any trouble ticket attachments to be uploaded |
| + | This screencast shows a live session of installing and configuring access. | ||
| + | {{youtube>03kOfVyDDH0}} | ||
| ===== Contacts Access ===== | ===== Contacts Access ===== | ||
| - | As with vtiger CRM Customer Portal we must now explicitly give access to each contact we want by means of the fields designated for this on the contact's record in vtiger CRM. | + | We must now explicitly give access to each contact we want by means of the fields designated for this on the contact's record in coreBOS. |
