Entity Module

Block

El registro de entidad se representa visualmente como formulario en la vista de edicion / vista de detalle. El bloque se comprende de un grupo del campo del módulo. Puede haber uno o más bloques en el módulo. Layout Editor proporciona la capacidad para que el administrador agregue bloques personalizados.

Field

Field es la unidad fundamental de la gestión de datos. El módulo puede tener uno o más campos. Sin embargo, la presencia de campo de entidad es obligatoria para el módulo.

UItypes for Fields in Modules

Campo(s) principal(es) del módulo a través de los cuales el registro se identifica por nombre (etiqueta a.k.a) se denomina Campo de Entidad.

Sharing Access

Webservices

................

Extension Module

El módulo de extensión agrega un comportamiento adicional al CRM y funciona con los datos existentes del módulo Entity o de otras fuentes. Ejemplo: Dashboard, Reportes, etc ... La plataforma proporciona API para facilitar el trabajo con los datos del módulo de entidad y define la estructura general a seguir para la implementación del módulo.

Language Pack

Para empezar a usar Console Tool > Create New Language Pack

Actualice los archivos de idioma php creados en la carpeta languages / languagecode_countrycode.

Exporte el paquete de idioma utilizando Language Export API

Layouts

Application UI is controlled by layout. CRM administrator can choose the default layout through Configuration Editor (available 6.4.0 onwards).

Themes

...................

Server APIs

Server API enables data flow control for a module. It is recommended for use when a module needs to access of other module data / state. The Server API will take measure to apply the required Sharing / Profile access restriction as configured for the logged in user. Also triggers configured Event handlers (Workflow etc...) for operations like Save / Delete.

• Attention

Using direct database queries is discouraged as developers might induce data-security issues unknowingly and increase risk.

Webservice ID

include_once 'include/Webservices/Utils.php';

$crmid = '1'; // ID of Leads record.
$wsid = vtws_getWebserviceEntityId('Leads', $crmid);

List Types

include_once 'include/Webservices/ModuleTypes.php';

$current_user = CRMEntity::getInstance('Users');
$current_user->retrieveCurrentUserInfoFromFile(1);

try {
        $typeInformation = vtws_listtypes(array(), $current_user);
        foreach ($typeInformation['types'] as $name) {
                echo sprintf("%s\n", $name);
        }
        foreach ($typeInformation['information'] as $name => $information) {
                echo sprintf("Name: %s, Label: %s, SingluarLabel: %s, IsEntity: %s \n",
                        $name, $information['label'], $information['singular'], ($information['isEntity']? "yes": "no"));
        }
} catch (WebServiceException $ex) {
        echo $ex->getMessage();

Describe

include_once 'include/Webservices/DescribeObject.php';

try {
        $describe = vtws_describe('Leads', $current_user);
        foreach ($describe['fields'] as $field) {
                echo sprintf("%s (%s), Mandatory? %s \n", $field['name'],
                        $field['type']['name'], ($field['mandatory']? "yes": "no"));
        }
} catch (WebServiceException $ex) {
        echo $ex->getMessage();
}

Create

include_once 'include/Webservices/Create.php';
try {
        $data = array (
                'lastname' => 'LNAME',
                'firstname'=> 'FNAME',
                'company'  => 'CNAME',
                'assigned_user_id' => '19x1', // 19=Users Module ID, 1=First user Entity ID
        );
        $lead = vtws_create('Leads', $data, $current_user);

        print_r($lead);

} catch (WebServiceException $ex) {
        echo $ex->getMessage();
}

Retrieve

include_once 'include/Webservices/Retrieve.php';
try {
        $wsid = vtws_getWebserviceEntityId('Leads', 'CRMID') // Module_Webservice_ID x CRM_ID
        $lead = vtws_retrieve($wsid, $current_user);
        print_r($lead);

} catch (WebServiceException $ex) {
        echo $ex->getMessage();
}

Revise

include_once 'include/Webservices/Revise.php';
try {
        $wsid = vtws_getWebserviceEntityId('Leads', 'CRMID') // Module_Webservice_ID x CRM_ID
        $data = array('firstname' => 'FIRSTNAME', 'id' => $wsid);
        $lead = vtws_revise($data, $current_user);
        print_r($lead);

} catch (WebServiceException $ex) {
        echo $ex->getMessage();
}

Query

include_once 'include/Webservices/Query.php';
try {
        $q = "SELECT * FROM Leads WHERE lastname LIKE '%LNAME%'";
        $q = $q . ';'; // NOTE: Make sure to terminate query with ;
        $records = vtws_query($q, $current_user);
        print_r($records);

} catch (WebServiceException $ex) {
        echo $ex->getMessage();
}

Delete

include_once 'include/Webservices/Delete.php';
try {
        $wsid = vtws_getWebserviceEntityId('Leads', 'CRMID') // Module_Webservice_ID x CRM_ID
        vtws_delete($wsid, $current_user);
} catch (WebServiceException $ex) {
        echo $ex-
>
getMessage();
}

Package Structure

Entity Module

<MODULENAME>.zip
  manifest.xml
  modules/
    <MODULENAME>/
        <MODULENAME>.php
        views/
        actions/
        models/
  crons/
    MODULENAME.service
  templates/
    .tpl
    resources/

  languages/
    en_us/
      <MODULENAME>.php

  settings/
    views/
    actions/
    models/
    templates/
      .tpl

Extension Module

<MODULENAME>.zip
  manifest.xml
  modules/
    <MODULENAME>/
        <MODULENAME>.php
        views/
        actions/
        models/

  templates/
    .tpl
    resources/

  languages/
    en_us/
      <MODULENAME>.php

Language Pack

<en_us>.zip
  manifest.xml
  modules/
     Vtiger.php
     Accounts.php
     Contacts.php
     Leads.php
     Settings/
       Vtiger.php

Layout Pack

<LAYOUTNAME>.zip
  manifest.xml
  layouts/
      <NAME>/
          libraries/
              jquery/
                  jquery.min.js
          skins/
              application.js
              application.css
          modules/
              Vtiger/
                  Header.tpl
                  Footer.tpl
                  dashboards/
                      DashBoardPreProcess.tpl
                      DashBoardContents.tpl
              Users/
                  Login.tpl
              Settings/
                  Vtiger/
                      ConfigEditorDetail.tpl

Theme Pack

<THEMENAME>.zip
  manifest.xml
  vlayout/
    style.css
  otherlayout/
    style.css

Bundled Module

Note

Yet to be documented - please be patient.