Sei sulla pagina 1di 97

4

2013
vtDZiner Studio

vTigress, the purr-fect companion to your vTiger.

S.T. Prasad
9-Apr-2013

www.vTigress.com

vtDZiner Studio Usage Guide

vtDZiner Studio Usage Guide

Copyright
All rights reserved. No part of this publication may be reproduced, stored in a retrieval system, or transmitted in any form or by any means, electronic, mechanical, photocopying, recording, or otherwise, without the prior permission in writing of the author/publisher.

Disclaimer
All the ideas, techniques, information, instruction and advice in this book are to be used entirely at your own risk.

This publication is distributed with the expressed and implied understanding that the author and publisher are not engaged in rendering legal, psychological, health, medical or other professional advice. If legal, psychological, health, medical or other professional advice or other expert assistance is required, the services of a qualified professional should be sought.

Neither the author nor the publisher makes any representation or warranty of any kind with regard to the information contained in the book. No liability shall be accepted for any actions caused, or alleged to have been caused, directly or indirectly from using the information contained in this book.

While enough care has been taken by our team to make this product code error free and virus free, we do not offer any kind of warranty that this could be 100% error free. You are advised to exercise due care when installing these modules and keep your computer systems virus free.
Copyright 2011-2012 . All rights reserved. Various trademarks held by their respective owners are acknowledged. We provide top notch services in installing, maintaining, customizing and extending CRM solutions that better adapt to our customer needs.

vtDZiner Studio Usage Guide

CONTENTS
0. 1. Preface: ................................................................................................................................................................. 7 Introduction: ......................................................................................................................................................... 9 1.1 Objective ............................................................................................................................................................. 9 1.2 vTigress and its benefits. ................................................................................................................................. 10 2. Pre-Installation Check ......................................................................................................................................... 13 2.1 System requirements for vtDZIner on vtiger..................................................................................................... 13 2.2 CRM requirements ............................................................................................................................................ 14 3. vtDZiner Studio ................................................................................................................................................... 15 3.1 About vtDZiner studio ....................................................................................................................................... 15 4. 5. 6. vtDZiner pre-installation - what happens? ......................................................................................................... 16 vtDZiner support details ..................................................................................................................................... 17 vtDZiner usage .................................................................................................................................................... 18 6.1 How to install vtDZiner studio ........................................................................................................................... 18 6.2 How to register vtDZiner studio ........................................................................................................................ 22 6.3 understand the vtDZiner Studio screen ............................................................................................................ 26 6.4 How to create a module .................................................................................................................................... 32 6.5 How to Delete/disable a module ...................................................................................................................... 36 6.6 How to change the layout of a module ............................................................................................................. 39 6.61 How to add blocks to a module .................................................................................................................. 39 6.62 How to move field within a block and between blocks? ............................................................................ 42 6.63 How to rename a block within a module? .................................................................................................. 42 6.64 How to create fields within a block? ........................................................................................................... 43

vtDZiner Studio Usage Guide 6.66 How to add panels into your module?........................................................................................................ 47 6.67 How to add pick blocks into the module?................................................................................................... 49 6.67 How to create Views within a module? ...................................................................................................... 51 6.7 How to relate two modules............................................................................................................................... 55 6.71 Creating a child relation using Module DZiner (While creating a module) ................................................. 57 6.72 Creating a child relation using Quick field create option ............................................................................ 59 6.72 Creating a parent relation using relation DZiner ........................................................................................ 61 6.73 Creating a multi relation field - Multirel ..................................................................................................... 63 6.7 How to DZine widgets in module list view and detail views ............................................................................. 64 6.8 How to change the language settings for the curret module ........................................................................... 68 6.9 How to change module configuration and advanced settings .......................................................................... 68 6.10 How to export a module ................................................................................................................................. 69 6.11 How to use the extra link - test drive module ................................................................................................. 69 7. 8. 9. 10. 11. 12. 13. 14. 15. vtDZiner changes since the previous release ...................................................................................................... 70 vtDZIner modified files in vtiger5.4..................................................................................................................... 72 FAQ ..................................................................................................................................................................... 75 Glossary: ......................................................................................................................................................... 80 Final Thoughts: ............................................................................................................................................... 83 Contact Sources:............................................................................................................................................. 84 Appendix A ..................................................................................................................................................... 85 Appendix B: Installation of vTiger 5.4.0 .......................................................................................................... 87 Appendix C: Major Open Source Components ............................................................................................... 88

15.1 For Windows ................................................................................................................................................... 88 15.2 For Linux .......................................................................................................................................................... 90 15.3 For Others ....................................................................................................................................................... 92 16. Appendix D: README.TXT .............................................................................................................................. 93

vtDZiner Studio Usage Guide

IMPORTANT
MAKE SURE YOU READ THE README.TXT IN THE APPENDIX AND THE PROCEED WITH THE INSTALLATION.

vtDZiner Studio Usage Guide

0. PREFACE:

vtDZiner was born out of need to be able to easily extend various components of the vTiger framework and make it easy to use for business analysts who could deploy open source CRM in a variety of scenarios. The dearth and cost of PHP programmers, and general impatience on the part of end users, makes for more expensive solutions over all. These simple tools will help the common business analyst be able to develop extensions on the core CRM and map on new business processes onto the vTiger Framework An internal need to build custom modules for vTiger started it all. The most common extension to vTiger which was felt needed was the ability to elegantly create a module that would plug in to the framework effortlessly. This simple usage of the built in vtlib functions thru a GUI frontend led to need of building inter module relationships using the Module Manager infrastructure. Re-organizing the default menu was the easiest, and a blessing to those who went on a module designing frenzy, with the new tools. The next most obvious was the ability to create a UIType 10 field as a custom field. Addressing these two objects was the initial goal which was realized in June 2011 and published on the vTiger forums shortly thereafter. Next stop, pulling related values into the target was a desirable feature, but deferred initially, in the light of paying work that the team encountered. Along the way, newer UI types like color, attachment, audio/video/picture/gallery, grid/table blocks, FOREX with auto lookup, autocompletion of related fields, postcode, and more were found necessary, which we developed as we encountered use cases in our day to day. Reading the forge, we came across an older project, which had not been maintained called Lang Pack Wizard from Gatan KRONEISEN (http://forge.vTiger.com/users/goofy/) and Pius Tschmperlin(http://forge.vTiger.com/users/jopit/), (http://forge.vTiger.com/projects/langpackwizard/), to which we made some small enhancements and Module Manager installable. Enhancing the Layout Editor for some ergonomics and UI type selections on fields, along with an older visualization by Joe Bordes on the forge, produced an enhanced Layout designer.

vtDZiner Studio Usage Guide

Full circle. 360 degrees. Browser Compatibility Version Variances Please visit http://www.vTigress.com for the more details.

The journey has been fun. Heartfelt thanks are due to the community and the vTiger team, for all the support and feedback, and some timely guidance received. We have made good progress, but today, we discover that there is a lot more to be done. We are also extremely grateful to the paying customers, who helped feed the programmers for this cause. The response was very encouraging, in terms of filling the development bridge between Business Analysts and End Users, without the need for programming or development effort. Subs equent suggestions and initial weaknesses were overcome and thanks to the whole community, vtDZiner 1.2 is what it is today. I must in particular thank Sreenivas Kanumuru, Varma Namburi, Asha and others I did not have the privilege of interacting with, from the vTiger team for all their help and support. From the community, Joe Bordes, Bernhard Bailey, Milind Wagh, Antonio Sanchez Huertas (Atril Sistemas), Balduin, who have provided the feedback, guidance, as well as the rescue efforts when we were sometime in dire straits. Gratitude is also due to our paying clients, who by engaging us, helped make this labor of love pay for itself! I must mention my appreciation for my freelance programming team, Mohammad Hamaydeh, Vivek Mahatma, Code Fusion, Sunny Chevli, K. Sireesha, and a few others who sought anonymity, who, in their own way have helped me to forge this venture. Last but not least, and certainly the greatest, from Lt Gen (Retd) K R Rao Garu, PVSM, AVSM, Indian Army, who with his unwavering and untiring usage of vTiger, and Shri K Umesh Garu, my good friend, who stands by me, despite all the hardships he undergoes, were the real forces behind this venture. The feedback given, encouragement and shelter were the bedrock for this effort. This is dedicated to all of them. S.T. Prasad, Hyderabad, Tuesday, April 9, 2013

vtDZiner Studio Usage Guide

1. INTRODUCTION:

1.1 OBJECTIVE
This document is a user guide to use vtDZiner Studio modules which is an add-on module used to enhance the functionality of the open source CRM vTiger (from www.vTiger.com). This module has been developed using vTiger 5.4.0 as the base version of the CRM. At the end of this manual, you will be able to 1. Appreciate the usefulness of modules of vtDZiner 2. Use vtDZiner to customize VTiger software. 3. Use and implement all modules of vtDZiner on vTiger 5.3.0 with ease At the end of reading this manual you will also be able to 4. Understand vTiger software. 5. Install vTiger in your PC on Windows/ Linux/ Mac. You may view information and instructions with respect to both the above details in Appendix A and Appendix B respectively. 6. Understand the advantages of vtDZiner Studio modules. 7. Use vTDZiner Studio to customize vTiger software.

*Contact info@vtigress.com for more details

vtDZiner Studio Usage Guide

1.2 VTIGRESS AND I TS BENEFITS.

vTigress is the purr-fect mate for vTiger. It is a fortified vTiger with all the loose ends tightened, all known/unknown errors fixed. vTigress is base vTiger fortified to perform better plus customization modules developed by vTigress team. The base vTiger code is strengthened and cohesive now. Sufficient attempts have been made to ensure that the client has a smooth CRM experience. It is currently compa tible with vTiger version 5.30 and soon going to be compatible with vTiger version 5.4. A team of Information Technology professionals who are passionate about making Open source work for you. The big deal in this is we make it work for you. Every company will have its unique requirement irrespective of the provided provisions on the base vTiger. It may be a need of an extra menu, renaming a menu, disabling a menu etc. All such facilities can be availed with vTigress modules without you having to go into technical and coding details. We help you do exactly that. We help you customize open source and make it work for you in your own way without bothering about the intricacies of programming and testing that goes into it. We are experts in molding vTiger to such an extent that it can do anything you want. How did it all start? An internal need to build custom modules for vTiger started it all. This simple usage of the built in vtlib functions through a GUI frontend led to need of building inter module Relationships using the Module Manager infrastructure. Re-organizing the default menu was the easiest, and a blessing to those who became module designing savvy, with the new tools. Next stop, pulling related values into the target was a desirable feature, but deferred initially. Along the way, newer UI types like color, attachment, audio/video/picture/gallery, grid/table blocks, forex with auto lookup, auto-completion of related fields, postcode, and more were

10

vtDZiner Studio Usage Guide

found necessary, which we developed as we encountered with the necessity day after day. Lang Pack Wizard and Module manager were enhanced in the due course of time. We hav e tested most of the modules functionalities from vTiger 5.1.0onwards, in GC 15.0.874.121 m, FF 7.0.1, IE 8.0. Some testing has been done on Safari and Opera. We believe, all of them function well. The 5.3.0 GA release of vTiger has been also tested upon. The earlier set of three modules (Module DZiner, Layout DZiner, Relation DZiner ) released in vtDZiner Studio , are today integrated as a single vtDZiner module.

Please visit http://www.vTigress.com for the download link or email info@vtigress.com for more details. These installations require you to overwrite some files to work properly . These modules are accessed through the option Settings (represented by Hammer Tool). . These modules install into the Settings > Studio Conceptualized We are looking forward to develop modules using our tools targeted towards SME functional areas like finance, personnel, manufacturing and supply chain. With our ERP experience, and vTiger expertise we can compile and extend it for spec ific establishments like Hotels, Hospitals/Clinics, Restaurants, Ad Agencies, Manufacturing, Distribution, Logistics, Travel and other sectors.

Finally, the summary of the story is, vTigress / vTiger Support Annual subscription brings to you Incident based (registered), Non paying Module customizations Theme customizations 3rd party integrations Data migration Remote Installation

11

vtDZiner Studio Usage Guide

Component Upgrade Service

** Documentation free

Technical Support

Access to Customer Portal to report issues and questions We fix Bugs within your system Web meeting with support engineer if required to troubleshoot the issue Monthly news letter (yet to be launched) Access to customer portal which includes well documented FAQ and related free documentation.

vTigress Training (All online)

12

vtDZiner Studio Usage Guide

2. PRE-INSTALLATION CHECK

2.1 SYSTEM REQUIREMENTS FOR VTDZINER ON VTIGER

Windows: Linux: Hosted:

XAMP (vtiger.exe install) LAMP vtiger install required

System Requirements to install Vtiger : Hardware Recommended: Intel X86 or X64, 2GB RAM and 5 GB free disk space(Minimum). Operating System: Windows XP, Windows 2003, Windows 7, Debian 4.0/5.0, Centos up-to 5.2, Fedora Core 6/9 Browser Support 1. Internet Explorer (we are testing IE) 2. Firefox 3.6, 5.0, 7.0 3. Google Chrome 15 4. Opera 11 5. Safari MySQL Requirements Please make sure to review MySQL configuration (my.cnf or server start parameters) SQL_MODE Should not have STRICT_TRANS_TABLE ENGINE=InnoDB Should be available. (Turn off --skip-innodb)

13

vtDZiner Studio Usage Guide

2.2 CRM REQUIREMENTS

vTiger CRM version: Existing Customization:

This version of vtDZiner540 Studio works with vtiger5.4 only. vtDZiner Studio works best with no customizations on your CRM. While you are always free to choose to do a separate installation of vtiger for vtDZiner Studio version, If you feel like topping vtDZiner on your CRM with existing customization, please contact info@vtigress.com with the details of the customization. You can get a check done on your CRM to find out if any existing code in terferes with vtDZiner code or not. Since we at vtigress team do custom development for vtiger projects also, it could be a good idea to get a quote for a fixed price or an hourly job for your requirements.

14

vtDZiner Studio Usage Guide

3. VTDZINER STUDIO

3.1 ABOUT VTDZINER STUDIO

vtDZiner Studio (for vtiger5.4) is a suite of applications built on open source CRM vtiger which will help you customize vtiger in your own way for your business requirements. You can develop extensions to the core CRM and improve your business processes. vtDZiner is the one and only tool for extending vTiger easily with new modules that better describe and represent the users' business entities and cases with extended UI characteristics and data types. vtDZiner requires activation that will be prompted the first time it is used Mainly vtDZiner Studio addresses the following business requirements. Create your own modules Change/Edit the layout of any module using drag and drop features Build relation between fields of any module (Parent, child and two-way reciprocated relations) Multiple field relations - Multirel field Use PickBlocks and GridBlocks Panel view for blocks within a module Widgets Views for any module vtDebug - integrated debugging tool for developers

15

vtDZiner Studio Usage Guide

4. VTDZINER PRE-INSTALLATION - WHAT HAPPENS?

Once you purchase vtDZiner through PayPal You will get a registration key for activating vtDZiner. The registration key is needed to activate and deactivate your copy of vtDZiner for your vtiger instance. It is also your initial password to the vTigress User Portal at http://customers.vtigress.com You will get a download link to a zip file containing the modules. You will also get a reset key. In the event of your vtiger system or server crashing, you might need to RESET the installation. When you purchase through UBAN, you will need to wait for payment realization and then the team at info@vtigress.com will mail you the download link.

16

vtDZiner Studio Usage Guide

5. VTDZINER SUPPORT DETAILS

For any assistance, you may please contact Email: Skype: info@vtigress.com vtigress_for_vtiger

Skype/Chat Timings: Mondays through Friday 9.00am to 6.00pm (IST) Weekends Only Email support on best effort basis

Check out our FAQ section on our customer portal at customers@vtigress.com Please mail info@vtigress.com for your customer portal login details.

IMPORTANT: Remember to read the readme.txt file and other documentation carefully before proceeding with
installation and usage.

17

vtDZiner Studio Usage Guide

6. VTDZINER USAGE

6.1 HOW TO INSTALL VTDZINER STUDIO


vtDZiner installs itself as a Module Manager installable file. When you have paid by PayPal, you would have got a link to download the zip file. Download the file and save it in a suitable location in your Harddisk.

Note

Login as vTiger Administrator user and then do the installation. Only the admin user can do an installation

Once you are logged in as admin, go to CRM Settings -> Module Manager -> Custom modules->

Choose the location of the file where you have saved the zip file.

18

vtDZiner Studio Usage Guide

Click on Install/Accept after you have read the entire readme.txt file there.

19

vtDZiner Studio Usage Guide

There is a command to be executed in the root directory of your CRM which is as follows. cp -r modules/vtDZiner/resources/540/* .;

Without this, the installation is not complete. If you are using a Windows based system, you need to go to the following directory Go to vtiger root directory/modules/vtdziner/resources/540 directory and copy the file manually. If you are using a hosted instance with a cPanel, you need to use file manager of the cPanel.
You can seek help from the technical team at www.vtigress.com by sending them an email or on Skype. Check vtDZiner Support details section for more info on this.

Note

20

vtDZiner Studio Usage Guide

Once installed, you will find a 'vtDZiner' option available under the Studio option in the CRM settings screen.

You can launch vtDZiner by clicking on this menu.

21

vtDZiner Studio Usage Guide

6.2 HOW TO REGISTER VTDZINER STUDIO


Once you have successfully installed vtDZiner studio, it is time to activate it now. Activate your vtDZiner license To register vtDZiner studio, check your mail which you would have got from purchases@vtigress.com Look for the complex looking key like this
jsGOV7V7th6s5T2355FM2XChjhfsy7vWSP2

Paste the registration key here and click on 'Activate Now' as shown in the screen. You will get a message to show that vtDZiner is activated successfully.

22

vtDZiner Studio Usage Guide

Press CTRL+F5 to refresh the page and affect the installation in your system files. Now you are ready to create custom modules, change the layout of modules as well as relate any two modules and fields within them.

De-activate your vtDZiner license To deactivate your vtDZiner license, go to any module, say Contacts here.

Look for the orange colored vtDZiner icon and click on it.

All modules have a Deactivate button as shown in the screen shot. Click on the button to Deactivate your vtDZiner license so that you can use it on another instance of your choice.

23

vtDZiner Studio Usage Guide

Give your Activation key when prompted and Click on OK button. Wait for a message to say that vtDZiner is deactivated from your system/instance.

Note

You can do this Activation/Deactivation for up to 5 machines/instances

Reset your vtDZiner license key Once you activate your vtDZiner license key and you lose the vTiger instance for any reason, your key will need to be reset. You can do this in the following way.

You will get a message that 'vtDZiner key is already in use'. Now your key needs a reset.

24

vtDZiner Studio Usage Guide

When you click on Reset installation link as shown above, you will get a screen to allow you to reset the key. Look for the reset key/code in your mail from purchases@@vtigress.com when you initially for the registration key. Use it as follows.

25

vtDZiner Studio Usage Guide

6.3 UNDERSTAND THE VTDZINER STUDIO SCREEN


Let us take some time to understand the vtDZiner Studio screen. Module DZiner 2. Relation DZiner 3. Layout DZiner
1.

26

vtDZiner Studio Usage Guide

These are the three main form screens of vtDZiner. 1. Module DZiner form
Module Control pane

Module Details pane

Standard fields pane

Custom field pane

27

vtDZiner Studio Usage Guide

2. Relation DZiner form

Module Control pane

Existing Relations pane

Parent Relations pane

Child Relations pane

28

vtDZiner Studio Usage Guide

3. Layout DZiner form


Module Control pane

Module Navigation pane

Layout design pane

29

vtDZiner Studio Usage Guide

The module Navigation pane within the vtDZiner screen which is explained here.

Debugging settings for vTiger by vtDebug

Add standard and custom blocks to module

Internationalize this module labels and captions

Create a block dependent on a Picklist

Module configurations and advanced settings

DZine widgets in module List and Detail views

Export this module as a vTiger installable

Module Relationships Manager

Disable this module from this vTiger instance

Create custom list views with filters, sort orders and widgets

Module DZiner for new vTiger modules

Organize blocks as panels in Module views

30

vtDZiner Studio Usage Guide

The Module Control pane is explained here.

You can shift to the vtDZiner settings screen of any module from any other module. Just click on the vtDZiner change current module link and choose from the dropdown, which modules you want to change to.

You can choose from All modules, Standard modules, Inventory modules and vtDZiner designed modules as shown here.

31

vtDZiner Studio Usage Guide

6.4 HOW TO CREATE A MODULE


Launch vtDZiner from CRM Settings-> Module Manager-> vtDZiner Studio or from the vtDZiner shortcut icon for vtDZiner launch in any module.

Let us choose Organizations module to start with. In the following Module DZiner screen, You can create a new module under available category or you can add a new category.

32

vtDZiner Studio Usage Guide

Let us say we create a category called Human Resources by clicking on the New category.

1. Now, the category you just created will appear in the list. 2. You can add the auto sequence prefix if you wish for the default fields created with every module. 3. Note that the Primary block name is automatically created along with fields Employee id and Employee name. 4. Employee number field is what we created in the block. WE will discuss the UI category separately in the next section. 5. Each field that is created has certain attributes - Include or not, Required or not, Hidden or not, To be included in Search or not and Info field for remarks.

33

vtDZiner Studio Usage Guide

Click on Generate to create the module. This will appear under Settings -> Module manager -> Custom Modules -> Employee

The module we just created also appears under the More menu option -> HR category >Employee module.

34

vtDZiner Studio Usage Guide

The just created module looks like this. Now you can add data here.

Note the Module name and the Module navigation bar in red box. 1. Settings option for the module 2. vtDZiner launch shortcut icon 3. vtDebug launch icon

35

vtDZiner Studio Usage Guide

A module with records will look like this.

6.5 HOW TO DELETE/DISABLE A MODULE


To delete a module in vtDZiner, first you need to disable it. To disable a module in vTiger, please go to the module and click on the Disable module button as shown in the screen.

Note

It is not advisable and recommended to delete a module in vtiger. However, due to the inconvenience it causes, we have provided a feature to do so. We also advice you to use it with caution.

36

vtDZiner Studio Usage Guide

You will get the following message

Once the module is disabled, it will be marked as Disabled in the CRM Settings-> Module Manager-> Custom Modules screen. You can further delete the module by clicking on the Remove button as shown above. To remove a module you need to disable it first.

37

vtDZiner Studio Usage Guide

To enable the disabled module again, click on the Enable button as shown in the screen shot and the module will be enabled again and available for use Once disabled, You will also not be able to locate the module in the More menu option as shown below.

Once the module is deleted, it will not appear in the More menu option as well as it will vanish from the CRM settings->Module manager->Custom Modules screen.

Note

You can only enable a module that is previously disabled using vtDZiner vtDziner actually hides the module and removes it from the active points of use/access After enabling again, the previously created module becomes available and accessible with the previous data.

38

vtDZiner Studio Usage Guide

6.6 HOW TO CHANGE THE LAYOUT OF A MODULE


To change the layout of a module, you need to visit the orange icon within the module or launch it from the CRM Settings-> Module Manager -> vtDZiner Studio. Let us say you just created a new module Employee under a new category called HR.
6.61 HOW TO ADD BLOCKS TO A MODULE

Let us try to change the layout of the module. Launch the vtDZiner from the Module Manager or the shortcut icon and click on Blocks button as shown. Notice that the default block which was used while creating the module is highlighted in the screen shot.

Choose a Standard block as block type, name the block and click on Save.

39

vtDZiner Studio Usage Guide

Note that a block by the name Employee Contact Information is created. Once you create a module with say grid block also, it will look like this. This is a record view

40

vtDZiner Studio Usage Guide

This is a detailed view/edit view.

The other types of blocks available are relation block, grid block for use within a module. Note: To know whether the other listed block types are available for you to use in this version, please contact info@vtigress.com

41

vtDZiner Studio Usage Guide

6.62 HOW TO MOVE FIELD WITHIN A BLOCK AND BETWEEN BLOCKS?

Now let us say you want to move the fields within the block. Just click the field and drag it to a new location and drop it. Your field has moved to a new position. If you want to move the fields to a different position, you can drag the field on to a new block and there. You have moved it to another block.

See the screen shot for the moved field.

Note

Once you have more blocks in a module, you can also drag and drop the blocks to a new position within the modue

6.63 HOW TO RENAME A BLOCK WITHIN A MODULE?

Now, let us say you want to rename the block names once they are created.

42

vtDZiner Studio Usage Guide

Just click the block name as shown above to edit it and click on Update. Your block name will be edited to the new name.

Note

You can only change the block names of the blocks you have created afger a module is created. The first block you created during the module creation cannot be renamed. You also cannot have 2 blocks with the same name

6.64 HOW TO CREATE FIELDS WITHIN A BLOCK?

To create multiple fields in a module, use the Quick field create shortcut as shown below.

43

vtDZiner Studio Usage Guide

You can create upto 8 fields at a time.

You can create fields of many UI types as shown below. You can also add many rows in the Module field creator. 1. Text: Text is alphabetical data. It can be measure with number of characters. So Length is the unit of measuring Text. 2. Number: From the name itself you can see that its pointing to a n umeric value. Number can be of any magnitude. So its attribute is length. The numeric value can be a decimal value also. So mention the number of decimal places also. 3. Percent: Percentage is a just a number. So the field data is likely to be a number. 4. Currency: Currency denotes the amount of money. Its also a numeric value. So the attributes of Currency are Length and Decimal points. 5. Date: Date is a combination of digits. Its a very often used data type. So no particular attribute to it. In other words, the UI type itself specifies the attribute. 6. Time: Similar to date is a universal data type. So, no specific attributes to it. 7. Email: Email is a combination of alphabets, numeric and symbols (all in lowercase). No specific attribute because its self -explanatory.

44

vtDZiner Studio Usage Guide

8. Phone: Phone number is a numeric data. The field allows you to store digits usually of length 10 to 15 depending on the length of the country codes. 9. Check box: Its a small 2mm by 2mm box which allows user to select/ not select a pa rticular option. Generally used for dual arguments like Yes/No, Accept/Reject etc, 10. Text Area: This data type allows some space to type information from the keyboard. It allows all characters in the keyboard. Generally used for filling complaints, proposal for a change etc, 11. Picklist: This UI type allows you to enter some options which will appear in the drop down while accessing the particular field. Only one option out of the given must be chosen. 12. MS Combo box: This is also similar to Picklist but multiple options can be chosen from the provided ones. 13. Attachment: This provision allows the user to attach a file (for example: photo, document) from the hard disc into the application. Similar to attaching file in Gmail/ Yahoo mailing application 14. Button: It is similar to the check box. It allows the user to redirect in another sub-form. Used widely while creating widgets etc,. 15. URL: Its a link provided for some refer ence. It is generally underlined, highlighted and colored. Certain characters like @,.,com are used to identify the data type. 16. Color: Colors of all ranges will be presented with a slide. Scroll the slide to choose required color and map it on to the field. 17. Picture: A picture (only one) can be uploaded. 18. Audio: Audio clipping can be uploaded using this UI type.When its chosen to play say with VLC player, a browser plugin connects to VLCand plays online. 19. Video: Video (mp4 format) can be uploaded using this UI type. 20. Gallery: Gallery of pictures can also be uploaded (more than one picture). 21. Skype: This field allows you to store Skype username. Further it allows you to log in to Skype consequently retrieve information from the records or send information to the particular client. 22. Yahoo: Yahoo application can be accessed from this application directly using this option similar to Twitter. 23. Twitter: It allows you to store Twitter Username of the client. One can directly reach out to Twitter application from Vtiger. You can post comments to your clients on Twitter. For example twittering about a certain product or activity. It helps in advertising programs also since you are directed to social networking sites. 24. Youtube: 25. Relation: 2 modules can be related. Mandatory field of the related module can be seen with current fields of module. Note that only one of the fields (generally the mandatory

45

vtDZiner Studio Usage Guide

field) can be seen along with others unlike Relation Dziner which enables to show all the fields of both modules in the present module itself. You will be provided with a drop down to choose between the modules you want the present one to relate with. 26. Multirel: Multirel is a relation where one can choose the different source modules, like in trouble tickets, can be related to Accounts/Contacts 27. RichText: RichText is the Rich HTML type textbox

46

vtDZiner Studio Usage Guide

6.66 HOW TO ADD PANELS INTO YOUR MODULE?

By default, the vtiger standard modules have 2 panels - One Main panel and More information panel. All related information to the main block will appear in the More information tab. This is the only thing you can do with standard vtiger, vtDZiner lets you do much more in this regard to enable sorting of information in required panels.

Note

You can enable single pane view in vtiger CRM settings if you wish

. If you want to add a panel to your block, click on the panel button to open the panel creation screen.

Type a panel name and click on Add button to add that panel to the module.

47

vtDZiner Studio Usage Guide

See that the just added panel name appears in the screen. Now, open the Panel DZiner again and select the panel name and drag the required blocks from Modules list in to the panel. Like this you can go on adding panels to the module and blocks to the panel.

See here that the panels we just added have appeared. This is the create view of the module view with all panels and assigned blocks.

48

vtDZiner Studio Usage Guide

If you want to delete the panels, go to Panel Block designer screen and choose the panel and click on Clear button. If you confirm, all panels in the module will be deleted.

6.67 HOW TO ADD PICK BLOCKS INTO THE MODULE?

To be able to use pick blocks in a module, you should have pick list fields. For example, in our Employee module, we have previously defined the Country field as a pick-list field.

49

vtDZiner Studio Usage Guide

Click on the Picklist button to open the Pickblock DZiner popup. It will show you any existing Picklist fields. Else you can create a new Picklist field using the Quick field create and use it in PickBlocks. Let us say, we add a new field of Picklist type and we assign Experienced and SkillSet as Picklist values. We would also need Experience and SkillSet as two blocks within the module. So, when you select any Picklist field say Employee type (The field values are Experienced and Fresher) within a block in the Employee module, you can choose that whenever the Employee type field value is chosen as Experienced, the Experience block opens up in the module create view and whenever the Fresher value is selected in the Employee type field, the SkillSet block opens up in the module create view.

50

vtDZiner Studio Usage Guide

6.67 HOW TO CREATE VIEWS WITHIN A MODULE?

Views are basically List view filters set for each module. To use a view, click on the View button in the vtDZiner screen.

If you choose a module say Contacts and click on View button in vtDZiner, then it will show the existing filters available for that module as follows.

To add a new view, click on the Add button in the View DZiner like this.

51

vtDZiner Studio Usage Guide

Name the view and choose your View parameters (Default/Metrics/Public) and click on Save.

Once a View is created it appears in the existing Views' list as shown here. Look at the Edit button in the above screen to edit the view settings and change the fields in the view.

52

vtDZiner Studio Usage Guide

When you try to Edit a View, the above screen will appear. Select a column, click on Add column so that the column name comes in the Selected columns list .

53

vtDZiner Studio Usage Guide

To delete columns in the view, select the column name in the Selected Columns list, then the Remove button will appear. Click on Remove to remove the column. Use Up and Down arrow buttons to move the fields up and down. You can add (Simple and Advanced) filters also.

54

vtDZiner Studio Usage Guide

6.7 HOW TO RELATE TWO MODULES

Click on the Relation DZiner icon as shown in the below screen to build relation between modules within your vtiger instance.

Clicking on this Relations DZiner icon will take you to the Relation DZiner screen.

55

vtDZiner Studio Usage Guide

Here you will find details of all parent and child relations within your instance. You can find standard modules relations as well as custom modules relations. The dropdown highlighted will allow you to choose from the available list of modules. Let us choose Organizations module from the list of Standard modules for our relations building activity.

56

vtDZiner Studio Usage Guide

You can see that there are 2 types of relations - Parent relation and Child relation. Our chosen Organization module has 4 parent relations and many child relations. In the child relations, there are some related back to parent module also (reciprocated relation) - example Potentials module.
6.71 CREATING A CHILD RELATION USING MODULE DZINER (WHILE CREATING A MODULE)

Now let us Create a new module with a Relation field. Let us create a new module called Training and try to link the Employee module with it. For this we will define a field in the new module called Trainer name and link it to the Employee name in the Employee Module.

57

vtDZiner Studio Usage Guide

So now we have tried to establish a relation while creating the module using UI type - Related to. In the module create view, the field looks like this. The PLUS green symbol highlighted in the screen is an indication that the field is a Related-to field.

58

vtDZiner Studio Usage Guide

6.72 CREATING A CHILD RELATION USING QUICK FIELD CREATE OPTION

Let us try to create a relation using Quick field creator. Here, we have created a new module called Employee Vacation with only 2 fields - Vacation start date and Vacation end date.

We can go to the Layout DZiner and add a field called Employee name there and make it a related to field as shown in the screen shot. Notice here that we have used the Relation UI type. Now, if you open the Employee module and click on the More Information tab, you will find the related modules there. See screen shot below.

59

vtDZiner Studio Usage Guide

Here Employee is the parent module and Employee vacation is a child relation.

See this Relation DZiner screen. Let us try to understand this. This is Relation DZiner screen for Employee module. See the related modules of Employee module where the child relations are defined. Training is a module where the relation is reciprocated with Trainer name field. Then, any record created in Employee module is available in More Information tab of Training module and any record created in Training module is available in More Information tab of Employee module.

60

vtDZiner Studio Usage Guide

The Employee vacation module has no reciprocal field defined and hence the record created in Employee Vacation child module will appear in the parent module Employee.
6.72 CREATING A PARENT RELATION USING RELATION DZINER

Let us use Employee Module Relation DZiner screen and click on Create New Parent Relation button.

Choose the Account module to establish relation with and choose the fields from the next box as relation fields. Then click on Create button.

61

vtDZiner Studio Usage Guide

See the relation established in the Relation DZiner screen of Employee module.

This is Employee module create record screen. Notice that the Organization field has a PLUS symbol. When you select the value from the Organization field, the associated values are populated in the fields chosen from the Organization module.

62

vtDZiner Studio Usage Guide

The Employee module will be available within More Information tab of Organization module.

6.73 CREATING A MULTI RELATION FIELD - MULTIREL

Now, you can also create what is called multi relation using a Multirel field in vtDZiner.

Let us start with Layout DZiner of Employee Vacation module and define two fields Accounts - relation

Employee - multirel (Employee and Training ) -> Employee field in Employee vacation module is related o two fields from two modules (Employee field in Employee module and Employee field in training module) The create record view of the Employee Vacation module looks like this.

63

vtDZiner Studio Usage Guide

The Organizations field is a Relation field and hence the PLUS green symbol opens up Accounts(Organizations module). The Employee field is a Multirel field and hence based on the choice of the field, the PLUS green symbol opens up either Employee module records or Training Module records.

6.8 HOW TO DZINE WIDGETS IN MODULE LIST VIEW AND DETAIL VIEWS
Click on the Widgets link to DZine widgets in module list view and detail views.

64

vtDZiner Studio Usage Guide

Click on Add to setup a widget.

In the module Widgets DZiner screen, select the widget type.

65

vtDZiner Studio Usage Guide

These are the available widget types.

Note

This is an advaced feature of vtDZiner. Please use with caution as it needs an advanced level of PHP and vtiger knowledge.

Let us say you select Detail View action link.

66

vtDZiner Studio Usage Guide

Please note the following. The DV Action Link with setup a link in the Actions tab of the module. The label can be anything that is meaningful. The URL can be obtained by typing the URK that comes in the browser window if you select the detailed view of any record in that module. You can get this by actually going to the detailed view of any record and copy-pasting the detailed view link from the browser window. Note that here the default record number which may be the actual record number may need to be replaced by the variable for that value - $RECORD$ You can add an icon if you wish by choosing the path of the image icon from the vtiger images folder which is fixed for any instance. Click on Save to save the widget.

67

vtDZiner Studio Usage Guide

Notice that the widget we just created has appeared as an action link in the Actions tab.

6.9 HOW TO CHANGE THE LANGUAGE SETTINGS FOR THE CURRET MODULE
This feature is still under development. With this feature we can internationalize the language settings for the current module. This will be available during our next release. Please check with info@vtigress.com for more details.

6.10 HOW TO CHANGE MODULE CONFIGURATION AND ADVANCED SETTINGS


This feature is still under development. With this feature we can change the settings for the current module configuration and its advanced settings also. This will be available during our next release. Please check with info@vtigress.com for more details.

68

vtDZiner Studio Usage Guide

NOTE: This feature is for advanced programmers of PHP and vtiger. Use with caution.

6.11 HOW TO EXPORT A MODULE


This feature is still under development. With this feature we can export the current module and import into another vtiger5.4 instance. This will be available during our next release. Please check with info@vtigress.com for more details. NOTE: This feature is for advanced programmers of PHP and vtiger. Use with caution.

6.12 HOW TO USE THE EXTRA LINK - TEST DRIVE MODULE

Test driving the module views works on existing module records. Separate tabs/windows will be opened for each selected view to be displayed NOTE: This feature is for advanced programmers of PHP and vtiger. Use with caution.

69

vtDZiner Studio Usage Guide

7. VTDZINER CHANGES SINCE THE PREVIOUS RELEASE

Summary of all previous releases till now on vtDZiner Drag and drop UI for Panel DZiner Pickblox Gridblox Widgets Headerscripts WYSIWYG preview Add Relation bug fixed Detail View Block Panels Feature Fixed repeated header bug. Grid blocks now fully supported Bug fixes, and cleanup of Rapidfields Implementation of Grid block and Relation fields, Video, Captcha UI types Implementation of Auto Suggester extension to in module fields Implementation of Dependant Blocks UI Type WYSIWYG Grid Layout Composer Jump to form preview button Field Label editing allowed for taking care of any misspellings Multiple Fields at one time to assist the custom field definitions * - Support for more UI Types * - File attachments

70

vtDZiner Studio Usage Guide

* - Color picklist * - Pictures * - Youtube / Web Video * - Video from uploaded file * - Audio * - Verified URL * - Verified Email * - Embed * - Related Fields & additional field values from linkage * - Form Preview Grid Blocks Create a grid wise entry of fields when there is a 1 : M Reuse of More Information functionality Associates multiple values to a data table called vtiger_{} vtiger_{current_module}_{blockname}_subtable

Dependant Blocks Linked to a picklist field in the module Selecting a picklist value displays the corresponding block and hides the others

71

vtDZiner Studio Usage Guide

8.

VTDZINER MODIFIED FILES IN VTIGER5.4

Certain files which contain some handlers for UI Types and vtDZiner functionality need to be updated, depending upon the version you are using. All the updated files are in modules/LayoutDZiner/resources/540 for vtiger 5.4.0 and modules/LayoutDZiner/resources/600 for vtiger 6.0.0 5.4.0 Users If you are on a fresh 5.4.0 install, make sure you have the vtiger security patch deployed before you install vtDZiner. Read about this important security update at https://www.vtiger.com/blogs/?p=1467 The following files will need to be updated in your 5.4.0 instance to enable vtDZiner enhanc ements. If you have any modifications or customisations on your existing system, you may verify that thy exists by performing a file compare operation (separate video / note ) between your instance and the original distribution of vtiger which is available at modules/LayoutDZiner/resources/540originals. If there are changes, use win merge to assist in visual merge and protect your existing changes. Smarty/templates: Buttons_List.tpl DetailView.tpl DetailViewFields.tpl EditViewHidden.tpl Inventory Buttons_List1.tpl DetailViewActionsPanel.tpl DetailViewSubPanels.tpl EditViewUI.tpl salesEditView.tpl CreateView.tpl DetailViewDefaultPanel.tpl

72

vtDZiner Studio Usage Guide

DetailViewUI.tpl Header.tpl

Smarty/templates/Inventory: InventoryActions.tpl InventoryDetailView.tpl InventoryEditView.tpl ProductDetailsEditView.tpl InventoryCreateView.tpl InventoryDetailViewSubPanels.tpl ProductDetails.tpl

include/ListView: ListViewController.php

include/js: vtlib.js

include/utils: CommonUtils.php DetailViewUtils.php EditViewUtils.php ListViewUtils.php qrcode.php utils.php

modules/Vtiger: EditView.php Settings.php

73

vtDZiner Studio Usage Guide

Other files resident in the cp -r path are brand new files not distributed by vtiger 6.0.0 Users Vtiger 6.0.0 is still experimental and vtDZiner works partially under this circumstance.

74

vtDZiner Studio Usage Guide

9. FAQ

1. What system requirements do I need to have vtDZiner Studio installed? To install vtDZiner Studio, you need to have the following system configuration a. OS - Windows ( version 7 or higher) or Ubuntu/Linux (version ccc or higher) b. RAM - 2GB or higher c. HDD 2. What is the current version of vtDZiner Studio? The current version of vtDZiner Studio is 540. 3. With what versions does vtDZiner studio 540 work? vtDZiner Studio 540 works with vtiger5.4. Take care to ensure that your vtiger5.4 instance has no other customization done on it. vtDZiner works best on a fresh install of vtiger5.4. If you have any other customization and would still like to keep it, please contact the vtigress team at info@vtigress.com to find out whether any research could be carried out on your CRM as a custom development work and then find out whether vtDZiner may be installed on it or not. 4. Is vtDZiner available for other versions of vtiger CRM? No. Not anymore. 5. I read in vtiger forums that vtDZiner1.2 is free and is available for download vtDZiner1.2 used to be free. We no longer support it. 6. vtDZiner Studio works with any vtiger version? No. vtDZiner Studio works with only vtiger5.4

75

vtDZiner Studio Usage Guide

7. I understand that vtiger 6 is round the corner. It may be released any time now. Is vtDZiner compatible with vtiger 6.0? As of now, vtDZiner is not compatible with vtiger 6 because vtiger 6.0 is not yet released officially. Once vtiger 6.0 is released, vtDZiner will also be available as an upgradable version. 8. I already have vtDZiner 1.2. How do I install vtDZiner Studio 540? First things first. vtDZiner1.2 works for vtiger 5.3 and below. vtDZiner Studio540 works for vtiger5.4 only. You need to purchase vtDZiner Studio 540 from www.vtigress.com and use a fresh vtiger install without any customizations and then install vtDZiner Studio on it. For any other queries please email info@vtigress.com for more details. 9. What are the features of vtDZiner? vtDZiner will mainly help you build modules, change the layout of modules and build relation between modules through fields. grid blocks, pick blocks panel blocks widgets drag and drop UI interface within layout dziner new UI types (twitter, gallery, video, attachment) View dziner build child and parent relationships between modules with optional reciprocal fields 10. What are the current modules available in vtDZiner540U? Module DZiner, Layout DZiner and Relation DZiner are the modules available in vtDZiner Studio 540. 11. What if I get a white screen after I install vtDZiner?

76

vtDZiner Studio Usage Guide

You can mail info@vtigress.com with the error screen shot. The team will guide you to fix it. It has mainly to do with a wrong way of module creation or relation building. 12. How do I delete a module using vtDZiner540? It is not advisable and recommended to delete a module in vtiger. However, due to the inconvenience it causes, we have provided a feature to do so. We also advice you to use it with caution. This feature is built-in in the latest version of vtDZiner. Check with info@vtigress.com for more details. 13. What is the current price of vtDZiner? The current price of vtDZiner is 499USD +5%PayPal fees 14. Can I resell vtDZiner in my country within my leads? Yes, you can resell vtDZiner. Please contact info@vtigress.com for more details. 15. How do I become a reseller for vtDZiner? You can becoming a reseller of vtDZiner by getting into an agreement with the vtigress team. Please contact info@vtigress.com for more details. 16. What/Who is vTigress? How are vtDZiner and vTigress CRM different? vTigress is our version of vTiger CRM and vtDZiner Studio is our tool that works on vTiger 5.4.0. 17. Can I move the fields up and down using Layout DZiner? Yes, you can very much move the fields in each module using Layout DZiner. However, the tab order does not yet change. 18. Can I build relations in vtDZiner designed modules? Yes, you can very much build relations. Make sure you follow the rules as given in the documentation. 19. Why are all the products (like chart DZiner, Cockpit DZiner) listed in your Products page not available for sale or built in vtDZiner?

77

vtDZiner Studio Usage Guide

The other products mentioned in our Products page are under development and should be released soon. We will keep all our customers posted on the developments in this regard and offer them a reasonable discount if they are interested to buy. 20. Do you give vTiger development training? Yes we do. Please contact info@vtigress.com for more details and rates. 21.Do you help clients with maintenance and support contracts in vTiger CRM? Yes we do. Please contact info@vtigress.com for more details and rates. 22. If I am not using vTiger and wish to migrate from other CRM, will you help? Yes we can. Please contact info@vtigress.com for more details and rates. 23. What is vtDZiner Reset key? When do I use it? vtDZiner reset key is the one which you would have got in your initial mail from purchases@vtigress.com If your vtDZiner registration key fails for some reason, you can use reset key to start using your vtDZiner system again 24. When will my vtDZiner registration fail? Your vtDZiner registration will fail only in one of the following cases. 1. You kill the instance without deactivating vtDZiner 2. Your Firewall/hosting service provider does not allow to do so 3. You have used the vtDZiner system wrongly Please contact info@vtigress.com for help. 25. What if I pay more / less than the actual price of vtDZiner? If you pay more than the specified price for vtDZiner we are happy to refund you using PayPal after deducting any charges applicable OR You can buy any custom development work or any maintenance service contract for the difference.

78

vtDZiner Studio Usage Guide

If you pay less than the specified price of vtDZiner kindly pay the difference as soon as possible so that we can send you the download link to the code and the related documentation

79

vtDZiner Studio Usage Guide

10.

GLOSSARY:

1. VTiger CRM: Its is Customer Relationship Management software which is Open Source. 2. vTigress : It is a customized base vTiger software which is more adaptable. 3. Operating System: A set of software that manages computer hardware resources and provides common services for computer programs. The operating system is a vital component of the system software in a computer system. Application programs require an operating system to function. 4. Php: PHP is a general purpose server-side scripting language originally designed for Web development to produce dynamic web pages. It is one of the first developed server-side scripting languages to be embedded into an HTML source document rather than calling an external file to process data. 5. Apache: The Apache HTTP Server commonly referred to as Apache, is web server software notable for playing a key role in the initial growth of the World Wide Web. Apache supports a variety of features, many implemented as compiled modules which extend the core functionality. These can range from server-side programming language support to authentication schemes. 6. MySQL: It is the world's most used open source Relational Database system (RDBMS) that runs as a server providing multi-user access to a number of databases.

80

vtDZiner Studio Usage Guide

7. Processors: A microprocessor incorporates the functions of a computer's CPU on a single IC or at most a few integrated circuits. It is a multipurpose, programmable device that accepts digital data as input, processes it according to instructions stored in its memory, and provides results as output. It is an example of sequential digital logic, as it has internal memory. Microprocessors operate on numbers and symbols represented in the binary numeral system. 8. License Agreement: A set of rules to furnish by the firm that produced the product for copy right. 9. Copy left: Copy left is to describe the practice of using copyright law to offer the right to distribute copies and modified versions of a work and requiring that the same rights be preserved in modified versions of the work. In other words, copy left is a general method for making a program (or other work) free, and requiring all modified and extended versions of the program to be free as well. 10. Destination folder: Place to store is a folder. Destination folder is a place where a file is stored at a particular destination. 11. Local host: In computer networking, localhost (meaning this computer) is the standard hostname given to the address of the loopback network interface. The name is also a reserved top level domain name. To avoid confusion with the narrower definition as a hostname. Local host is specified where one would otherwise use the hostname of a computer. 12. Port number: In computer networking a port is an application-specific or process-specific software construct serving as a communications endpoint in a computer's host operating system. A port is associated with an IP address of the host, as well as the type of protocol used for communication

81

vtDZiner Studio Usage Guide

13. Linux: It is a Unix like computer operating system assembled under the model of free and open source development and distribution. The defining component of Linux is the Linux Kernel, an operating system kernel. Linux was originally developed as a free operating system for Intel x86 based personal computers. It has since been ported to more computer hardware platforms than any other operating system.

14. winRAR.ZIP: WinRAR is shareware file achiever and data compression utility software. It is one of the few applications that are able to create RAR archives natively, because the encoding method is held to be proprietary. *Compiled from Internet Wiki Pedia and other web sites*

82

vtDZiner Studio Usage Guide

11.

FINAL THOUGHTS:

We help you identify your requirements and define them. We then help you identify the best suiting open source CRM for your requirements. We customize almost all of the open source CRM packages for you. Especially, we will help you discover the strengths of vTiger.

Our easily customizable modules will make your life further easier by installing and using only such modules which are absolutely necessary for your business. You can shut off all the remaining modules as per your convenience without disturbing the core functionality of vTiger. You can also define and add any new module as per your convenience and business needs.

83

vtDZiner Studio Usage Guide

12.

CONTACT SOURCES:

Chief architect: ST Prasad stprasad@stprasad.com Email ID: Website: Skype ID: info@vTigress.com www.vTigress.com vTigress_for_vTiger

84

vtDZiner Studio Usage Guide

13.

APPENDIX A

What is VTiger Software? vTiger CRM is an application which is and open source CRM. It is fully open source and can be downloaded literally for zero price. Source code is available. It offers few modules as a free edition. There are other functions which are paid versions. In its most recent version 5.3.0 (current as of November 11, 2011), vTiger offers all the usual CRM functions:

Sales automation (customizable product entries, inventory management, quotations, billing, and trouble ticketing)

Customer support & service functions, including a customer self-service portal Marketing automation (lead generation, campaign support, knowledge bases) Inventory Management Analysis and reporting

It is written in PHP. The non open source CRM software available cost the clients a huge maintenance and installation charges. So a set of expert and passionate coders created a revolution by making CRM software and releasing it on net. Anybody who is interested to use them can download the source that is freely available and modify it to their unique requirements. Since its a open source software, it may be error prone. The loosened ends can be tightened and errors can be rectified to meet ones needs. People who use it might fund for having provided them the base. This is how open source coders get revenue. Its a drastic and far-reaching change in ways of thinking and behaving towards the Information Technology world.

85

vtDZiner Studio Usage Guide

Its the base software for a lot of business personals who wish to customize it for different cu stomers. The key here is that skilled labor is benefited. One such idea is the motivation for the creation of vTigress. Check up with www.vTiger.com to learn more about it.

86

vtDZiner Studio Usage Guide

14.

APPENDIX B: INSTALLATION OF VTIGER 5.4.0

This section is now covered in a separate document. Please refer to the online documentation guide at http://www.vtigress.com/documents

87

vtDZiner Studio Usage Guide

15.

APPENDIX C: MAJOR OPEN SOURCE CO MPONENTS

This software is based on vTiger, which is a collective work consisting of the following major Open Source components:

15.1 FOR WINDOWS


1. Apache Web server software used under the Apache License available at <vTiger CRM Home>/vTigerCRM/apache/LICENSE.txt 2. MySQL database software used under the GPL License available at <vTiger CRM Home>/vTigerCRM/mysql/README.txt 3. PHP software used under the PHP License version 3.0 available at <vTiger CRM Home>/vTigerCRM/php/license.txt 4. SugarCRM software used under the SugarCRM Public License SPL 1.1.2 available at <vTiger CRM Home>/vTigerCRM/LICENSE.txt 5. gdwin32 software used under the GNU GPL available at gdwin32 <vTiger CRM Home>/vTigerCRM/gdwin32/gd-license.txt 6. nusoap software used under GNU LGPL from http://sourceforge.net/projects/nusoap 7. PHPMailer software used under the GNU LGPL downloaded from http://adodb.sourceforge.net available at <vTiger CRM Home>/vTigerCRM/modules/Emails/PHPMailer_LICENSE.txt 8. ADOdb software used under BSD license downloaded from http://adodb.sourceforge.net available at <vTiger CRM Home>/vTigerCRM/adodb/license.txt 9. phpSysinfo software used under GNU GPL downloaded from http://phpsysinfo.sourceforge.net/ available at <vTiger CRM Home>/vTigerCRM/modules/System/COPYING 10. MagpieRSS software used under GNU GPL downloaded from http://magpierss.sourceforge.net/ available at http://magpierss.sourceforge.net 11. FCKeditor software used under GNU LGPL downloaded from http://www.fckeditor.net/download/default.html available at <vTiger CRM Home>/vTigerCRM/includes/FCKeditor/license.txt

88

vtDZiner Studio Usage Guide

12. Mailfeed used under GNU GPL downloaded from http://wiki.wonko.com/software/mailfeed/ available at http://wiki.wonko.com/software/mailfeed/#copyright 13. Smarty Template Engine for PHP used under the GNU LGPL available at available at <vTiger CRM Home>/vTigerCRM/Smarty/COPYING.lib 14. freetag is used under dual license BSD and GNU LGPL downloaded from http://www.getluky.net available at <vTiger CRM Home>/vTigerCRM/include/freetag/license.txt 15. Image_Canvas is used under GNU LGPL downloaded from http://pear.php.net/pepr/peprproposal-show.php?id=212 available at http://www.gnu.org/copyleft/lesser.html 16. Image_Color is used under PHP license 3.0 downloaded from http://pear.php.net/package/Image_Color available at http://www.php.net/license/3_0.txt 17. Graph is used under GNU LGPL downloaded from http://pear.php.net/package/Image_Graph available at http://www.gnu.org/copyleft/lesser.html 18. log4php is used under GNU LGPL downloaded from http://www.vxr.it/log4php/ available at http://www.vxr.it/log4php/ 19. jscalendar is used under GNU LGPL downloaded from http://www.dynarch.com/projects/calendar/ available at http://www.gnu.org/licenses/lgpl.html 20. script.oculo.us scripts used under MIT Style license from http://script.aculo.us available under http://script.aculo.us/# 21. NOCC scripts used under GNU GPL downloaded from http://nocc.sourceforge.net available at http://nocc.sourceforge.net/page.php?file=COPYING 22. PHP Class mimetype under BSD License from http://www.phpclasses.org/browse/package/834.html 23. In addition to the above mentioned Open Source components, vTiger provides additional functionality, which is dual-licensed under Mozilla Public License (MPL 1.1) as well as the GNU Public License (GPL). 24. htmlpurifier is used under GNU LGPL (v2.1+) from http://htmlpurifier.org/

89

vtDZiner Studio Usage Guide

15.2 FOR LINUX

1. Apache Web server software used under the Apache License available at <vTiger CRM Home>/vTigerCRM_linux/apache/LICENSE.txt 2. MySQL database software used under the GPL available at <vTiger CRM Home>/vTigerCRM_linux/mysql/README.txt 3. PHP software used under the PHP License version 3.0 available at <vTiger CRM Home>/vTigerCRM_linux/php/license.txt 4. SugarCRM software used under the SugarCRM Public License (SPL 1.1.2) available at <vTiger CRM Home>/vTigerCRM/LICENSE_linux.txt 5. gd 2.0.28 software used "AS IS" available at <vTiger CRM Home>/vTigerCRM_linux/gd-2.0.28/ 6. nusoap software used under GNU LGPL from http://sourceforge.net/projects/nusoap 8. PHPMailer software used under the GNU LGPL available at <vTiger CRM Home>/vTigerCRM/modules/Emails/PHPMailer_LICENSE.txt 9. ADOdb software used under BSD license available at <vTiger CRM Home>/vTigerCRM/adodb/license.txt 10. MagpieRSS software used under GNU GPL downloaded from http://magpierss.sourceforge.net/ available at http://magpierss.sourceforge.net/ 11. phpSysinfo software used under GNU GPL available at <vTiger CRM Home>/vTigerCRM/modules/System/COPYING 12. FCKeditor software used under LGPL downloaded from http://www.fckeditor.net/download/default.html available at <vTiger CRM Home>/vTigerCRM/includes/FCKeditor/license.txt 13. Mailfeed used under GNU GPL downloaded from http://wiki.wonko.com/software/mailfeed/ available at http://wiki.wonko.com/software/mailfeed/#copyright 14. Smarty Template Engine for PHP used under the GNU LGPL available at available at <vTiger CRM Home>/vTigerCRM/Smarty/COPYING.lib 15. freetag is used under dual license BSD and LGPL downloaded from http://www.getluky.net available at <vTiger CRM Home>/vTigerCRM/include/freetag/license.txt 16. Image_Canvas is used under GNU LGPL downloaded from http://pear.php.net/pepr/peprproposal-show.php?id=212 available at http://www.gnu.org/copyleft/lesser.html

90

vtDZiner Studio Usage Guide

17. Image_Color is used under PHP license 3.0 downloaded from http://pear.php.net/package/Image_Color available at http://www.php.net/license/3_0.txt 18. Image_Graph is used under GNU LGPL downloaded from http://pear.php.net/package/Image_Graph available at http://www.gnu.org/copyleft/lesser.html 19. log4php is used under GNU LGPL downloaded from http://www.vxr.it/log4php/ available at http://www.vxr.it/log4php/ 20. jscalendar is used under GNU LGPL downloaded from http://www.dynarch.com/projects/calendar/ available at http://www.gnu.org/licenses/lgpl.html 21. script.oculo.us scripts used under MIT Style license from http://script.aculo.us available under http://script.aculo.us/# 22. NOCC scripts used under GNU GPL downloaded from http://nocc.sourceforge.net available at http://nocc.sourceforge.net/page.php?file=COPYING 23. PHP Class mimetype under BSD License from http://www.phpclasses.org/browse/package/834.html 24. html purifier is used under GNU LGPL (v2.1+) from http://htmlpurifier.org/

91

vtDZiner Studio Usage Guide

15.3 FOR OTHERS

1. ExcelReader package to read the xls files. We have taken the utility from the following Web site: http://freshmeat.net/projects/phpexcelreader/ The product is available as GNU General Public License (GPL). 2. E-mail Client to handle attachments with PHP. We have taken the ideas from the article by Kevin Steffer available at the http://www.linuxscope.net/articles/mailAttachmentsPHP.html 3. FPDF package to create PDF reports and documents. We have downloaded package from http://www.fpdf.org 4. Prototype (Object-Oriented JavaScript framework) package to ease development of dynamic web applications. We have downloaded package from http://prototype.conio.net 5. class_http to cache scraped content. We http://www.troywolf.com/articles/php/class_http/ have downloaded package from

6.Carousel Slideshow package to display large images as thumbnails. We have downloaded package from http://www.dynamicdrive.com/dynamicindex14/carousel2.htm 7. Ajax Popup Chat for enabling instant messaging for vTiger CRM users. We have downloaded package from http://www.os-solution.com/demo/ajaxcsspopupchat/index.php 8. Image Crossfade Redux for enabling fade effect to images. We have downloaded package from http://slayeroffice.com/code/imageCrossFade/xfade2.html 9. Calculator for enabling calculations in vTiger CRM. We have downloaded package from http://www.hmhd.com/steve 10. TCPDF package to create PDF reports and documents. We have downloaded package from http://tcpdf.sourceforge.net

92

vtDZiner Studio Usage Guide

16.

APPENDIX D: README.TXT

******************************************************************************** vtDZiner Studio : vtDZiner plus vtDebug in one installable ******************************************************************************** PLEASE SCROLL DOWN TILL THE END AND READ CAREFULLY BEFORE PROCEEDING. ******************************************************************************** This readme.txt file covers release notes, terms of service and license agreement ******************************************************************************** Product Name: vtDZiner541 version U Release Date : 27-Jan-2013 ******************************************************************************** READ CAREFULLY BEFORE PROCEEDING. VTDZINER WORKS BEST WITH VTIGERCRM VERSION 5.4 WITH NO CUSTOMIZATIONS OR OTHER THIRD PARTY MODULES/PLUGINS IMPLEMENTED. TO ENSURE THAT VTDZINER WORKS WITH EXISTING CUSTOMIZATIONS, ADEQUATE TIME/BUDGETARY PROVISIONS MUST BE MADE BY THE USER FOR EFFICIENT FUNCTIONING OF VTDZINER CODING. ******************************************************************************** PLEASE CONSULT info@vtigress.com for more info & instructions on how to correctly install and setup vtDZiner540 for your vtiger540 instance. ******************************************************************************** DISCLAIMER ******************************************************************************** All modules of vtDziner540 are distributed on an 'as is basis', with an implied understanding that vtDZiner is installed on the compatible vtiger instance where no other customizations are implemented. There is no explicit warranty of any kind supplied along with the product to make sure that vtDZiner will work with any existing customizations to vtiger. We do not supply warranty of any kind either explicit or implied, including, without limitation, warranties that the covered code is bug free, fit for a particular purpose or non-infringing.

93

vtDZiner Studio Usage Guide However, on actuals basis, we can carry out custom development and testing assignments based on clients' requests. ******************************************************************************** THIS MODULE IMPROVES VTIGER BUT REQUIRES CERTAIN CARE DURING INSTALL THE FOLLOWING FILES & DIRECTORIES NEED READ WRITE (766) PERMISSIONS PLEASE ENSURE THAT THEY ARE SET CORRECTLY. Paths referred are relative to your install root

modules/Vtiger/Settings.php This code is based upon the vTiger base and is an enhancement effort

One database tables are altered One database table is inserted

The new directories are modules/LayoutDZiner and its sub directories

TPL, js and ViewUtils files are necessary for this module. They are provided in separate folders for 5.1.x/5.2.x and for 5.3.0 From the CRM root for 5.1.x and 5.2.x cp -r modules/LayoutDZiner/resources/521/* .

for vtiger 530 cp -r modules/LayoutDZiner/resources/530/* . ******************************************************************************** Release notes The distribution of Layout DZiner, Module DZiner and Relation DZiner which were packaged as 3 separate script sets, has been integrated into one single distribution for better maintenance and extendibility. The presentation and usage GUI remains the same. With this release are included the following fixes/features

94

vtDZiner Studio Usage Guide Module DZiner fixes 1. Cleanup of module name validation 2. Compound fields 3. UI Type 10 creates a relation. Allow a custom script for selection 4. Merge in Relation DZiner into Layout DZiner , Module DZiner with full editability 5. View DZiner, Widget DZiner to be completely tested 6. Pickblocks enhancements and fixes 7. Panel blocks UI improvements 8. Grid blocks, more UI types, bring back in the combobox work done for DLMS 9.Upgraded the select all feature using the most recent module.php

Earlier enhancements fixes 1. Module Category Creation 2. Time UI 3. Bug fixes in UI Types Layout DZiner fixes 1. Views 2. Widgets 3. Panels 4. Pickblocks 5. Gridblocks ******************************************************************************** Summary of all previous releases till now on vtDZiner Drag and drop UI for Panel DZiner Pickblox Gridblox Widgets

95

vtDZiner Studio Usage Guide Headerscripts WYSIWYG preview Add Relation bug fixed Detail View Block Panels Feature Fixed repeated header bug. Grid blocks now fully supported Bug fixes, and cleanup of Rapidfields Implementation of Grid block and Relation fields, Video, Captcha UI types Implementation of Auto Suggester extension to in module fields Implementation of Dependant Blocks UI Type WYSIWYG Grid Layout Composer Jump to form preview button Field Label editing allowed for taking care of any misspellings Multiple Fields at one time to assist the custom field definitions * - Support for more UI Types * - File attachments * - Color picklist * - Pictures * - Youtube / Web Video * - Video from uploaded file * - Audio * - Verified URL * - Verified Email * - Embed * - Related Fields & additional field values from linkage * - Form Preview Grid Blocks

96

vtDZiner Studio Usage Guide Create a grid wise entry of fields when there is a 1 : M Reuse of More Information functionality Associates multiple values to a data table called vtiger_{} vtiger_{current_module}_{blockname}_subtable

Dependant Blocks Linked to a picklist field in the module Selecting a picklist value displays the corresponding block and hides the others ******************************************************************************** IMPORTANT - PLEASE READ CAREFULLY ******************************************************************************** The contents of this file are subject to the vtiger CRM Public License Version 1.1 ("License"); You may not use this file except in compliance with the License The Original Code is: vtiger CRM Open Source The Initial Developer of the Original Code is vtiger. Portions created by vtiger are Copyright (C) vtiger. All Rights Reserved. ******************************************************************************** Refund policy ******************************************************************************** ALL SALES ARE FINAL AND NO REFUNDS ARE GIVEN. THE USER AGREES US TO INDEMNIFY MYENTERPRISE OR VTIGRESS TEAM AGAINST ANY CLAIMS AND CAUSES BROUGHT ABOUT BY INSTALLING AND USING THE SOFTWARE. ********************************************************************************

97

Potrebbero piacerti anche