modules/CampaignTrackers/vardefs.php

   1 <?php
   2 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
   3 /*********************************************************************************
   4  * SugarCRM Community Edition is a customer relationship management program developed by
   5  * SugarCRM, Inc. Copyright (C) 2004-2012 SugarCRM Inc.
   6  *
   7  * This program is free software; you can redistribute it and/or modify it under
   8  * the terms of the GNU Affero General Public License version 3 as published by the
   9  * Free Software Foundation with the addition of the following permission added
  10  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  11  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  12  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  13  *
  14  * This program is distributed in the hope that it will be useful, but WITHOUT
  15  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  16  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
  17  * details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License along with
  20  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  21  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  22  * 02110-1301 USA.
  23  *
  24  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  25  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  26  *
  27  * The interactive user interfaces in modified source and object code versions
  28  * of this program must display Appropriate Legal Notices, as required under
  29  * Section 5 of the GNU Affero General Public License version 3.
  30  *
  31  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  32  * these Appropriate Legal Notices must retain the display of the "Powered by
  33  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
  34  * technical reasons, the Appropriate Legal Notices must display the words
  35  * "Powered by SugarCRM".
  36  ********************************************************************************/
  37
  38 $dictionary['CampaignTracker'] = array('table' => 'campaign_trkrs',
  39         'comment' => 'Maintains the Tracker URLs used in campaign emails',
  40
  41 'fields' => array (
  42     'id' => array (
  43         'name' => 'id',
  44         'vname' => 'LBL_ID',
  45         'type' => 'id',
  46         'required'=>true,
  47         'reportable'=>false,
  48         'comment' => 'Unique identifier'
  49     ),
  50    'tracker_name' => array (
  51         'name' => 'tracker_name',
  52         'vname' => 'LBL_TRACKER_NAME',
  53         'type' => 'varchar',
  54         'len' => '30',
  55         'comment' => 'The name of the campaign tracker'
  56    ),
  57         'tracker_url' => array (
  58         'name' => 'tracker_url',
  59         'vname' => 'LBL_TRACKER_URL',
  60         'type' => 'varchar',
  61         'len' => '255',
  62         'default' => 'http://',
  63         'comment' => 'The URL that represents the landing page when the tracker URL in the campaign email is clicked'
  64         ),
  65     'tracker_key' => array (
  66         'name' => 'tracker_key',
  67         'vname' => 'LBL_TRACKER_KEY',
  68         'type' => 'int',
  69         'len' => '11',
  70         'auto_increment' => true,
  71         'required'=>true,
  72         'studio' => array('editview' => false),
  73         'comment' => 'Internal key to uniquely identifier the tracker URL'
  74         ),
  75   'campaign_id'=> array(
  76         'name'=>'campaign_id',
  77         'vname'=>'LBL_CAMPAIGN_ID',
  78         'type'=>'id',
  79         'required'=>false,
  80         'reportable'=>false,
  81         'comment' => 'The ID of the campaign'
  82         ),
  83     'date_entered' => array (
  84         'name' => 'date_entered',
  85         'vname' => 'LBL_DATE_ENTERED',
  86         'type' => 'datetime',
  87                 'required' => true,
  88                 'comment' => 'Date record created'
  89         ),
  90         'date_modified' => array (
  91         'name' => 'date_modified',
  92         'vname' => 'LBL_DATE_MODIFIED',
  93         'type' => 'datetime',
  94         'required' => true,
  95                 'comment' => 'Date record last modified'
  96         ),
  97     'modified_user_id' => array (
  98         'name' => 'modified_user_id',
  99         'vname' => 'LBL_MODIFIED_USER_ID',
 100         'dbType' => 'id',
 101         'type'=>'id',
 102                 'comment' => 'User who last modified record'
 103         ),
 104         'created_by' => array (
 105         'name' => 'created_by',
 106         'vname' => 'LBL_CREATED_BY',
 107         'type' => 'assigned_user_name',
 108         'table' => 'users',
 109         'isnull' => 'false',
 110         'dbType' => 'id',
 111                 'comment' => 'User ID who created record'
 112         ),
 113         'is_optout' => array (
 114         'name' => 'is_optout',
 115         'vname' => 'LBL_OPTOUT',
 116         'type' => 'bool',
 117         'required' => true,
 118         'default' => '0',
 119         'reportable'=>false,
 120         'comment' => 'Indicator whether tracker URL represents an opt-out link'
 121         ),
 122         'deleted' => array (
 123         'name' => 'deleted',
 124         'vname' => 'LBL_DELETED',
 125         'type' => 'bool',
 126         'required' => false,
 127         'default' => '0',
 128         'reportable'=>false,
 129         'comment' => 'Record deletion indicator'
 130         ),
 131         'campaign' => array (
 132                 'name' => 'campaign',
 133         'type' => 'link',
 134         'relationship' => 'campaign_campaigntrakers',
 135         'source'=>'non-db',
 136                 'vname'=>'LBL_CAMPAIGN',
 137   ),
 138 ),
 139
 140 'relationships'=>array(
 141
 142   'campaign_campaigntrakers' => array(
 143                 'lhs_module'=> 'Campaigns',
 144                 'lhs_table'=> 'campaigns',
 145                 'lhs_key' => 'id',
 146                 'rhs_module'=> 'CampaignTrackers',
 147                 'rhs_table'=> 'campaign_trkrs',
 148                 'rhs_key' => 'campaign_id',
 149                 'relationship_type'=>'one-to-many'
 150   )
 151 )
 152 ,'indices' => array (
 153       array('name' =>'campaign_trackepk', 'type' =>'primary', 'fields'=>array('id')),
 154       array('name' => 'campaign_tracker_key_idx', 'type'=>'index', 'fields'=>array('tracker_key')),
 155  )
 156 );
 157 ?>