empty
| 
Sugar Community Edition 5.1 Documentation
Sugar Community Edition Installation and Administration Guide
Version 5.1
|
|
|
|
Chapter 2 Administering Sugar : Developer Tools
The Developer tools sub-panel displays options to build new modules and customize existing ones. The Module Builder enables you to build custom modules and Studio enables you to customize existing modules. To create relationships between modules, see “Creating Relationships” on page 80.
After you build a module in Module Builder, you can deploy the module directly within the current instance or you can use the Module Loader to install it in another Sugar instance. For more information, see “Module Loader” on page 85.
|
1.
|
Basic. This template provides basic fields such as ID, Date Entered, and Created By. Use this template to create a module from scratch.
Company. This template provides organization-specific fields such as Company Name, Industry, and Billing Address. Use this template to create a module that is similar to the Accounts module.
File. This template provides document-specific fields such as File Name and Document Type. Use this template to create a module that is similar to the Documents module.
Issue. This template provides case and bug-specific fields such as ID, Description, and Created By. Use this template to create a module that is similar to the Cases module or Bug Tracker module.
Person. This template provides individual-specific fields such as salutation, title, name, address, and phone number. Use this template to create a module that is similar to the Contacts module or the Leads module.
Sale. This template provides opportunity-specific fields such as Lead-Source and Probability. Use this template to create a module that is similar to the Opportunities module.
|
Note:
|
The Sale template is a replacement for the Chance template, which existed in 5.1RC. Before you upgrade to 5.1GA, you need to delete all Chance-based modules. You can re-create them as Sale-based modules after the upgrade.
|
|
Note:
|
Apart from field names, you cannot edit other field properties in a template. However, you can duplicate the fields and save them with a different name to customize them. You can choose which fields appear in the module layouts.
|
|
4.
|
Customize page layouts for List View, Edit View, Detail View, Sub-panels, Search form, and Sugar Dashlets, if necessary.
|
|
5.
|
Create relationships between the new module and other modules, if needed. A Sugar module, typically, has multiple relationships with other Sugar modules. When you create a custom module, you can define its relationship with other Sugar modules.
|
|
•
|
Publish. This option is designed for distribution to specific users or customers. The system creates a zip file, which you can save on your local machine. You can then email it to one or more individuals who can use the Module Loader to upload the zip file into their Sugar instance.
|
After the module is installed through Studio, you can add or remove fields and make other changes to a published module.
|
•
|
Deploy. This option is designed to install the custom module on your Sugar instance and make it available to users in your organization. Through Studio, you can add or remove fields and make other changes to a deployed module.
|
|
•
|
Export. This option is designed for distribution to developers. The system creates a zip file, which you can save on your local machine and email to other developers. Using the Module Loader, developers can install it on their Sugar instance and customize it further in Module Builder if necessary. The package is visible only in Module Builder and, hence, only administrators can access it until it has been deployed.
|
|
1.
|
|
2.
|
Click New Package.
|
The Package page displays on the screen.
The system refreshes the page and displays options to duplicate, publish, deploy, export, and delete the package.
Author. Enter your name as the creator of the package.
Key. Enter an alphanumeric key to distinguish modules with similar names. The system will prefix all class names, directories and tables names with this key.
Description. Enter a brief description of the package.
|
5.
|
|
7.
|
|
9.
|
Click Export to save the package as a zip file on your local machine.
|
|
1.
|
Click the New Module icon on the Package page.
|
Module Name. Enter a name for the module.
Label. Enter a name for the module that you want displayed in the Sugar User Interface.
Importing. Selecting this option to allow data import into the module.
Navigation Tab. By default, this option is enabled to create a tab for the module that is identical to other Sugar module tabs.
Type. Click a template to select it for your module
|
3.
|
Click Save to save the module and add it to the package.
|
The system refreshes the page to display the selected template. The new module is nested within the package listed in the Packages panel on the Module Builder home page. 
The Packages panel on the left lists all the modules you create within a package. Default fields, labels, layouts, sub-panels, and relationships from the selected template are nested under the module. You can click them to view their details. You can also edit the default layouts, add new fields, and create relationships with other Sugar modules.
For information on customizing a layout or the Search form, see “Editing the Layouts” on page 71. For information on creating new fields, see “To add custom fields” on page 68. For information on defining relationships, see “Creating Relationships” on page 80.
|
1.
|
On the custom module page, click View Layouts. Alternatively, click Layouts in the Packages panel on the left.
 |
|
2.
|
|
3.
|
To edit the List View, click Sugar Dashlet List View and follow the procedure described in “To edit List View” on page 73.
|
To edit the Search form, click Sugar Dashlet Search and follow the procedure described in “To edit the Search form” on page 75.
|
1.
|
When you select Publish or Export, the system saves it as a zip file that you can export to your local machine and distribute as needed. When you select Deploy, the system installs all the custom modules in the package on your Sugar instance.
|
2.
|
Use the Module Loader to upload the file from your machine into Sugar and install the module. For more information, see “Module Loader” on page 85.
You can delete a package if necessary. When you delete a package, all the files that it contains are also deleted. If you delete a package after it has been deployed, you can uninstall the deployed package using the Module Loader. When you uninstall a package, you have the option of retaining or removing the database tables.
You do not need to delete a package before you install a newer version. The files from the new version will override any existing files from the earlier package. That is, any updates that you made to the package before re-deploying will override files from the earlier package.
Studio enables you to customize modules by adding new fields, editing existing fields, field labels, page layouts, sub-panels, and Quick Create forms. You can export a customized module to your local machine and upload in into another Sugar instance using the Module Loader.
The Studio home page displays a list of existing modules in the left panel. These include the default Sugar modules as well as any custom modules that have been deployed. The associated fields, labels, layouts, and sub-panels for each module are grouped within the module. You can click the Plus sign (+) preceding the module name to view them. The right panel displays the same information in the form of icons. You can click a module in either panel to drill down to its fields, labels, layouts, and sub-panels.
The bottom of the page displays buttons to the Developer Tools’ Home, Studio, Module Builder, and the Dropdown Editor.
You can create and edit custom fields, drop-down lists, and field labels. You can also edit the default layout and sub-panels. After you complete editing the module, the updated version will not available to other user until you publish it. You can use Studio to make changes to a published module.
.Labels: Select this option to edit field labels. For more information, see “Editing Field Labels” on page 67.
Fields: Select this option to create and edit custom fields. For more information, see “To add custom fields” on page 68. Select this option to edit and create drop-down lists. For more information, see “Creating and Managing Drop-down Lists” on page 77.
Layouts: Select this option to edit the List View, Detail View, Edit View, Search form, and Quick Create form. For more information, see “Editing the Layouts” on page 71.
Relationships: Select this option to view existing relationships and create new ones between modules. After you create a relationship, you will need to deploy it to make it available to users. For more information, see “Creating Relationships” on page 80.
Subpanels: Select this option to edit one or more of the module’s sub-panels. For more information, see “To edit a sub-panel” on page 79.
|
3.
|
Click Save to save your changes.
|
Every field in a module has an label that displays in the Sugar User Interface. You can change the default field labels for all the language packs that you have installed.
|
1.
|
Select the module and click Labels.
|
|
2.
|
If you want to select a different language pack, select the appropriate one from the list of pre-installed language packs in the Language drop-down menu.
|
|
4.
|
Click Save.
|
|
5.
|
To navigate back to a different module or to Studio, click the appropriate breadcrumb above the Save button.
|
You can add custom fields to any module in Sugar. When you add a custom field, the application adds the field to the appropriate database table and stores the generated metadata. You can then add the fields to the desired layout, such as Edit View and Detail View. For custom modules, you can create fields in the Module Builder. Use Studio to edit a custom module after it has been published.
The page displays the current default fields that Sugar provides as well as any existing custom fields.
|
2.
|
Click Add Fields.
|
|
3.
|
In the Field Editor, enter values for the following:
|
Data Type. From the drop-down list, select one of the data types listed below.
|
•
|
Text Field. Creates a text field for fields such as first name and last name.
|
|
•
|
Address. Creates fields for street, city, postal, state, and country.
|
|
•
|
Checkbox. Creates a checkbox.
|
|
•
|
Currency. Creates a field to enter an currency. The system automatically creates a field of the currency type if the field does not exist.
|
|
•
|
Date. Creates a field to enter a date.
|
|
•
|
Encrypt. Creates a field, for example, a Password field, whose value is stored in an encrypted format in the Sugar database.
|
|
•
|
DropDown. Creates a drop-down list. For more information on drop-down lists, see “Creating and Managing Drop-down Lists” on page 77.
|
|
•
|
Decimal. Creates a field to specify the precision past the decimal point.
|
|
•
|
HTML. Creates an HTML field to display HTML snippets.
|
|
•
|
IFrame. Creates an IFrame field. For more information, see “Embedding Links and IFrames in a Layout”.
|
|
•
|
Integer. Creates a field to specify positive or negative numbers. You can specify a range with the min and max value fields.
|
|
•
|
MultiSelect. Creates a drop-down list to select multiple values.
|
|
•
|
Flex Relate. Creates a field and a drop-down list from which you can associate a related record. You can add only one Flex Relate field to a module. Hence, this option does not display in the Data Type drop-down list if you attempt to add it to a module that already contains a Flex Relate field.
|
|
•
|
Phone. Creates a field to enter a phone number.
|
|
•
|
Radio. Creates a radio button.
|
|
•
|
Relate. Creates a field to associate a record with another record. You can add multiple Relate fields to a module.
|
|
•
|
Text Area. Creates a field for a block of text.
|
|
•
|
Link. Creates a field that links to a URL. For more information, see “Embedding Links and IFrames in a Layout”.
|
Depending on the data type that you select, you will need to specify values for some of the fields listed below.
|
•
|
Field Name. Enter a name for the field. The system adds it to the Sugar database.
|
|
•
|
Display Label. The system uses the field name as the label that will display in the Sugar User Interface. You can enter a new value if needed.
|
|
•
|
System Label. The system automatically creates and displays the value that will be stored in the Sugar database.
|
|
•
|
Help Text. Enter descriptive text for the field. This text displays when the user points the cursor at the field.
|
|
•
|
Comment Text. Enter additional comments, if needed, about the field.
|
|
•
|
Default Value. Enter a default value for the field, if necessary.
|
|
•
|
HTML. This box display when you select the HTML data type. Enter the HTML code in this box.
|
|
•
|
Max Size. Enter the maximum number of characters that the field can contain.
|
|
•
|
Mass Update. This box displays when you select the DropDown data type or the Date data type. For information on creating a drop-down list, see “To create a drop-down field” on page 77.
|
|
•
|
Min Value. This field displays if you select the Integer data type. Enter a minimum value during data input.
|
|
•
|
Max Value. This field displays when you select the Integer data type. Enter a maximum value during data input.
|
|
•
|
Precision. This field displays when you select the Decimal data type. Enter the number of digits you want to express the precision for the fractional part of the number.
|
|
•
|
Required Field. Check this box to specify that users must enter a value for the field when creating a record.
|
|
•
|
|
•
|
Importable. From the drop-down list, select one of the following:
|
Select Yes to enable users to import a value into the field.
Select No to prevent users from importing a value into the field.
Select Required to make it a required field during import.
|
•
|
Duplicate Merge. From the drop-down list, specify one of the following options for the Duplicate Merge functionality on a record’s detail page.
|
|
•
|
Filter Only: This field can be selected as a filter to search for identical fields during a duplicate merge operation. However, you cannot merge the values into a single field.
|
|
4.
|
Click Save to create the field.
|
The new field is listed in the Custom section. The system appends the field name with ‘_c’ to indicate that it is a custom field.
|
2.
|
|
3.
|
|
4.
|
To delete the field, click Delete.
|
|
5.
|
Click Save to update the field.
|
You can edit the layouts for List View, Detail View, Edit View, sub-panels, Search form, and Quick Create form. You can remove existing fields and add new ones to a layout. You can also rearrange the current layout and change the tabbing order of the fields.
When you select List View, the system displays separate columns of fields that are currently displayed in the view, fields that are available for display, and hidden fields. You can click and drag a field from one column to the other depending on what you want to display to users.
When you select Edit View or Detail View, the system displays the various sections of the current layout, along with the fields in each section. You can click and drag a field to a different location within the layout.
The Quick Create form enables users to create a related record from the detail page of a record. For example, you can create a contact from the Contacts sub-panel on an account’s detail page. In Studio, you can customize the Quick Create form by removing some fields. You can also add additional fields, if necessary.
In the Edit View, Detail View, and Quick Create forms, you can also change the order in which the user can tab from field to field on a page. For example, when users create a new account, they can tab from the Account Name field to the Website field and so on. You can change the tabbing order to so that users tab from Account Name to email.
The breadcrumbs to navigate back to Studio display above. The Toolbox stores fields that are not currently displayed in the layout. It also provides new rows to add to the view and a list of available fields that you can add.
|
1.
|
The List View page displays on the screen. The Default column lists fields that are currently displayed in the User Interface. The Available column lists fields that are available to users through advanced search. Users can search for and add any of these fields that they want to view in the search results. The Hidden column lists fields that you do not want users to view when they perform an advanced search.
|
2.
|
To display a field in List View, select and drag the field from the Available or Hidden columns and drop it into the Default column.
|
|
3.
|
To remove a field from List View, select and drag the field from the Default column and drop it in the Available column.
|
|
4.
|
To hide a field from users, drag it from the Default or Available column and drop it in the Hidden column.
|
|
5.
|
Click Save & Deploy to display the updated List View in the User Interface.
|
|
6.
|
Click View History to view a list of previous changes along with the date and time of each change.
|
|
a.
|
|
b.
|
|
2.
|
Select Layouts from the list of module components.
|
|
3.
|
|
5.
|
To replace an existing row in the layout with another one, drag the new field from Available Fields and drop it on the field that you want to replace.
|
|
6.
|
To add placeholders for additional fields or to replace fields with blank fields, drag the filler row under New Row and drop it into the view. You can then drag a field from the Toolbox into the filler row.
|
|
7.
|
A new panel or a new row contain two blanks fields. To add additional fields to the panel or row, drag New Panel or New Row into the panel.
|
8.
|
To enter or edit a field label, click the Edit icon within the field and enter the label in the Properties panel; click Save to create the label.
|
|
10.
|
To edit the tabbing order, click the Edit icon within the field and enter a numeric value in the Tab Order field of the Properties panel; click Save.
|
The tabbing order for each field is represented by numbers such as 1, 2, and 3. You can change one or more numbers to change the order in which users tab to those fields.
|
11.
|
Click Save to save your changes.
|
|
12.
|
Click Save & Deploy to display the updated view in the Sugar User Interface.
|
|
13.
|
Click View History to view a list of previous changes along with the date and time of each change.
|
|
a.
|
|
b.
|
To restore the previous version of the view, click the adjacent Restore button.
|
|
1.
|
In Layouts, click Search.
|
|
2.
|
To edit the Basic Search form, click Basic Search; to edit the Advanced Search form, click Advanced Search.
|
The fields in the current Search form are listed in the Default column and the available fields are listed in the Hidden column.
|
3.
|
|
4.
|
|
5.
|
To save your changes, click Save & Deploy.
|
|
1.
|
Click View History to view a list of timestamps for changes that were made to a layout, a Search form, or a sub-panel.
 |
|
2.
|
To preview the changes for a timestamp, click the adjacent Preview button.
|
The Preview page provides a Restore button that you can use to restore the layout. Alternatively, click a timestamp to restore the layout that existed before the changes made at that time.
A Link field allows you to store a URL in a record such as a customer's Website or a link to a related internal or external system. The URL can either be entered as a normal field in an edit view, or it can be dynamically generated based on other fields in the record.
For example, you could automatically generate a link to a google map of an accounts address. To do this, click the Generate URL check box and insert the following in the Default Value field:
Next, select billing_address_postalcode from the drop down above the Default Value field and click the Insert Field button.
http://maps.google.com/?q={billing_address_postalcode}
You can also embed a view of the Website itself in the layout rather than as a link by using the IFrame field. IFrames support regular URLs as well as generated URLs.
You cannot edit generated URLs in a record’s Edit View. You can only change them in the Module Builder or Studio. You can edit regular URLs in a record’s Edit view.
|
1.
|
|
5.
|
Click Save to create the field.
|
|
1.
|
|
3.
|
Click the Generate URL checkbox.
|
|
4.
|
Insert the base URL into the Default Value field.
|
|
6.
|
Click Save to create the field.
|
Most modules display at least one drop-down field containing a list of values from which users can make a choice. For example, when users create an account, they can choose a specific industry type and an account type in the respective drop-down fields.
As the administrator, you can create and edit values in all of the drop-down fields in the system to suit your organization’s needs. You can also create new drop-down fields for a module.
|
1.
|
Select the module and click Fields.
|
|
2.
|
Click Add Field.
|
|
1.
|
Field Name. Enter a name for the drop-down list.
Display Label. Enter a label name for the field to display in Sugar.
System Label. The field label in the Sugar database displays in this field.
Help Text. Enter descriptive text for the field. This text displays when the user points the cursor at the field.
Comment Text. Optionally, enter a descriptive comment about the new field. The comment displays only in Studio and Module Builder.
Drop Down List. The available drop-down lists are displayed here. You can select an existing drop-down list and edit it to suit your needs.
|
a.
|
Click Add.
|
The system displays the Dropdown Editor tab in the Field Editor.
The display label appears in the User Interface and the item name is stored in the Sugar database.
|
b.
|
The Dropdown Name field displays the name that you specified.
|
|
c.
|
From the Dropdown Language list, select a pre-installed language pack of your choice.
|
|
d.
|
Enter an item for the drop-down list in the Item Name field.
|
To add additional items, click Add and repeat the process.
|
f.
|
Click Save to save the list.
|
The system displays the new drop-down list on the Properties tab.
|
g.
|
On the Properties tab, click Save to save the drop-down list.
|
|
b.
|
|
c.
|
To change an item’s display label, click the corresponding Edit icon and enter the new label.
|
|
d.
|
To remove an item, click the corresponding Delete icon.
|
|
e.
|
|
f.
|
Click Save to save your changes.
|
|
g.
|
|
h.
|
|
i.
|
The creation of the drop-down list and its values is now complete. The new drop-down is now listed in the Drop-down Editor.
Default Value. Select an existing value from the drop-down list as the default for this drop-down list.
Mass Update. Checkmark this box to enable users to use the Mass Update functionality to update this field value.
Required Field. Checkmark this box to make this a required field.
Audit. Check this box to track changes to the field values and display the changes when a user clicks the View Change Log link.
Importable. From the drop-down list, select whether the field value can be imported or not.
Duplicate Merge. From the drop-down list, specify one of the following for the duplicate record merging functionality in modules such as contacts and accounts:
|
3.
|
Click Save.
|
Every record’s Detail View display sub-panels listing related records from other modules. You can add or remove fields for these sub-panels depending on the information that you want to display to users.
|
1.
|
Select the module and then click Subpanels.
|
|
3.
|
To add a field to the sub-panel, select it from the Hidden column and drag it to the Default column.
|
|
4.
|
To remove a field from the sub-panel, select it from the Default column and drag it to the Hidden column.
|
|
5.
|
To save and display your changes in the module, click Save & Deploy.
|
|
6.
|
To view a list of timestamps for changes that were made to the sub-panel, click View History. For more information, see “To preview and restore changes” on page 75.
|
Typically, a Sugar module has relationships with other Sugar modules. For example, Accounts is related to Contacts, Leads, Opportunities, and several other modules. Related records from these modules display in fields or sub-panels on an account’s detail page. You cannot edit these pre-defined relationships.
In Module Builder, you can create relationships between undeployed modules, and between undeployed modules and deployed modules. However, you cannot create relationships between deployed modules. If you want to change a relationship after you have deployed the module, you can redefine or delete the relationship and then re-deploy the module package.
In Studio, you can create relationships only between deployed modules. After you deploy a relationship in Studio, you cannot change it.
You can create one relationship at a time. When you create a relationship for a module, it is considered to be the primary module and the module that you relate it with is the related module. Depending on the relationship type, the relationship is expressed with sub-panels and Related-to fields. When you create a new relationship between two modules, the system automatically creates the necessary sub-panels, related-to fields, and metadata relationships.
You can also create a relationship between a module and itself. In this case, the relationship becomes a parent-child relationship. For example, you can create a relationship from Accounts to Accounts in order to create sub-accounts within the primary account.
In Module Builder, you can select Activities as the related module but not its sub-modules such as Tasks, Calls, and Meetings. The relationship is automatically reflected in these sub-modules.
In Studio, you can select a sub-module of Activities when you create a relationship. So, when you select Activities as a related module in the Module Builder, you can use Studio to further define the relationship for its sub-modules.
One-to-one: In this relationship, records in the primary module and the related module are uniquely related to each other. For example, an account can be associated with only one contact and a contact can be associated with only one account. This account value will display in the contact’s detail page and the contact value will display on the account’s detail page.
One-to-many: In this relationship, records in the primary module can have relationships with many records in the related module. For example, an account can be associated with many contacts, and many contacts can be associated with the same account. The Detail View of Accounts will display a Contacts sub-panel, and the Detail View of Contacts will display a Related-to field containing a link to the related account.
Many-to-many: In this relationship, records in both the primary module and the related module can have relationships with multiple records in each module. For example, an account can be associated with many bugs, and a bug can be associated with many accounts. The Accounts Detail View will display a Bugs sub-panel. Similarly, the Bugs Detail View will display an Accounts sub-panel.
The type of relationship that you can create depends on your choice of primary and related modules. This is because only a module with sub-panels can have a one-to-many or a many-to-many relationship with another module. A sub-panel is needed to show all the related records from the other module.
For example, with Accounts as the primary module and Knowledge Base as the related module, you can create only a one-to-one relationship between them. This is because Knowledge Base lacks a sub-panel and, therefore, Accounts cannot display related records from Knowledge Base. However, if Knowledge Base is the primary module and Accounts is the related module, you can create a one-to-many relationship between them because Accounts has sub-panels and, therefore, Knowledge Base can display related records from Accounts.
If you are creating a relationship between a custom module and a Sugar module, then you can choose any relationship type because all custom module types include at least one sub-panel.
Sugar provides many sub-panel types for your use. When you create a relationship that involves sub-panels, Sugar displays all sub-panel types available for that module for your selection. A sub-panel can display different sets of fields depending on the primary module to which it is related. For example, there are several different types of Contacts sub-panels. The Contacts sub-panel that appears under Accounts contains different fields than the Contacts sub-panel that appears under Cases.
The Default type of sub-panel contains the most commonly used fields in the module. Every module has a Default type that contains a set of fields to display as a sub-panel. Select Default if you want to display the most commonly used fields in the sub-panel in the relationship that you create.
For example, if you create a one-to-many type of relationship between Calls and Accounts, you can select a sub-panel type for the Accounts sub-panel in the Calls Detail View. To use a sub-panel consisting of the most commonly used fields from Accounts, select the Default sub-panel type; to use the Accounts sub-panel from the email’s Detail View, select ForEmails.
You can create relationships in Module Builder as well as in Studio. However, there are some differences, which are noted in the table below:
|
You can create relationships with other Sugar modules as well as other modules within any undeployed package.
|
In Studio, you can create relationships only between deployed modules.
|
|
If you want to change a relationship after you have deployed the module, you can redefine or delete the relationship and then re-deploy the module package.
|
You cannot change a relationship after you deploy it.
|
|
You can select Activities as the related module but not its sub-modules such as Tasks, Calls, and Meetings. But the relationship is automatically reflected in these sub-modules.
|
You can select a sub-module of Activities when you create a relationship.
So, when you select Activities as a related module in the Module Builder, you can use Studio to further define the relationship for its sub-modules.
|
|
1.
|
On the module’s page, click View Relationships.
|
|
2.
|
To create a relationship, click Add Relationship.
|
|
3.
|
Select the relationship type from the Type drop-down list.
|
If you select a One-to-Many relationship, you will have the option to choose a sub-panel for the primary module. This is the sub-panel of the related module that will display on the detail page of the primary module.
The options in the Subpanel drop-down list varies depending on the related module that you select.
If you select a Many-to-Many relationship, shown below, you will have the option to select sub-panels for the primary module as well as the related module.
|
4.
|
From Related Module drop-down list, select the module you want to relate to the primary module.
|
|
5.
|
From the Subpanel field for the related module, select the sub-panel type that you want displayed on the detail page of the primary module.
|
|
6.
|
From the Subpanel field for the primary module, select the sub-panel that you want displayed on the detail page of the related module.
|
|
7.
|
Click Save to create the relationship.
|
The new relationship displays under the Add Relationship button in the middle panel. It is appended with an asterisk to denote that it is a custom relationship.
|
1.
|
To edit a relationship in Module Builder, click its name in the Relationships list to view it in the Edit Relationship tab; make the necessary changes and save it.
|
|
2.
|
In Module Builder, to delete a relationship, click the Delete button.
|
To publish a module after you customize it in Studio, you will need to export it as a zip file to your local machine and then upload it from your machine into Sugar using the Module Loader.
|
1.
|
On the Studio home page, click Export Customizations.
|
The Export Customizations page displays the customized modules and indicates the area of customization. The screen shown below indicates that Opportunities module contains one or more customized fields
.
.Package Name. Enter a name for the export package. The package will contain the customized modules that you select.
Author. Enter your name as the author.
Description. Enter a brief description of the package.
|
4.
|
Click Export.
|
The system creates a zip file and displays a dialog box that allows you to open the file or save it to a disk.
|
5.
|
On MS Windows, the system saves it in the Downloads directory.
You can upload the file into Sugar using the Module Loader. For more information, see “Module Loader” on page 85.
Use the Module Loader to install Sugar modules, custom modules, upgrades, language packs, Sugar Dashlets, and themes.
You can create custom modules in the Module Builder. A custom module is contained within a package. When you deploy the package, it becomes available to other users in your organization. When you publish or export the package, you can save it as a zip file on your local machine and then use the Module Loader to upload them it into Sugar. For more information on creating packages, see “Module Builder” on page 61.
If you delete a package in Module Builder after it is already installed or deployed, you can uninstall the deployed module in the Module Loader. You can also disable installed modules through the Module Loader.
|
1.
|
If you deployed the package, it is listed in the top panel and has already been made available to other users in your organization. You can uninstall it or disable it by clicking the appropriate button.
|
2.
|
.|
3.
|
|
4.
|
Click Upload.
|
|
5.
|
Click Install.
|
|
6.
|
If the installation is successful, the system displays a message stating that the module installed successfully.
|
7.
|
To go back to the Module Loader page, click Back to the Module Loader.
|
|
1.
|
To disable a module, click the Disable button adjacent to the module’s name.
|
|
2.
|
Click Accept to accept the agreement.
|
|
3.
|
Click Commit.
|
After the module has been disabled, Sugar displays a message stating that the module has been disabled.
|
4.
|
Click Back to Module Loader.
|
|
5.
|
To enable the module, click Enable.
|
|
1.
|
In the Module Loader, click the Uninstall button corresponding to the module’s name.
|
The system displays a message stating that the module is ready to be uninstalled and displays options to remove or retain the database tables that were created for the new module.
|
2.
|
|
3.
|
|
4.
|
To remove an existing field, drag it to the Recycling bin.
|
|
5.
|
To replace an existing row in the view with another one, drag the new field from the left panel and drop it on the field that you want to replace.
|
|
6.
|
To add placeholders for additional fields, drag New Row and drop it into the view. You can then drag a field from the Available Fields into the empty row.
|
|
7.
|
Click Save to save your changes.
|
|
8.
|
Click Save and Deploy to make it available to all users in your organization.
|
By default, all the module tabs are displayed when a user logs into Sugar. However, you can choose which module tabs to display when users log into Sugar. You can also choose the order in which these tabs are arranged in the Sugar User Interface.
By default, users can also configure module tabs on their My Account page. However, the user cannot display module tabs that the administrator hides. Administrators can deselect the Allow users to configure tabs check box if they do not want users to make any changes.
|
1.
|
In Developer Tools, select Configure Tabs.
|
|
2.
|
To hide a tab, select it in the Display Tabs column, and drag and drop it into the Hide Tabs column.
|
|
3.
|
To rearrange the order in which the tabs are displayed, drag and drop the tabs to the desired positions.
|
|
4.
|
|
5.
|
|
1.
|
The tab labels and the corresponding database values display on the page. From the drop-down list displayed above the tab labels, you can select the language to display the tab.
|
3.
|
Click Save to save your changes; click Undo to revert to the previous value; click Redo to go back to your change.
|
By default, the system displays individual module tabs when users log into Sugar. However, you can use the Configure Group Tab option to organize specific individual tabs as a group tab. For example, you can group contacts, leads, and opportunities under Sales and cases, bug tracker, under Support. You can add the same module to multiple group tabs. For example, Contacts can be part of Sales as well as Marketing. When users click a group tab, they can access the module tabs associated with it.
|
•
|
|
•
|
|
•
|
|
•
|
The following screenshot illustrates group tabs and the module tabs grouped under the Activities group tab.
Users have the ability to change to grouped tab or ungrouped tab configuration on their My Account page.
|
1.
|
In Developer Tools, click Configure Group Tabs.
|
The default group tabs display on the page. The associated module tabs are listed below each group tab
|
2.
|
To edit the name of a group tab, click the Edit icon, enter the new name in the text field, and click Save.
|
|
3.
|
To remove a module tab from a group tab, place the cursor on the name and drag it to the Delete Module box on the left.
|
|
4.
|
To add a module to a group tab, select it from the Modules list on the left, drag it, and place it just below the Edit and Delete icons.
|
Under a group tab, you can rearrange the order of the module tabs by selecting a tab name and dragging it to a different location in the list.
|
5.
|
To save your changes and make it available for users in the Sugar User Interface, click Save & Deploy.
|
|
1.
|
Click Add Group.
|
A New Group box displays on the page.
|
2.
|
|
3.
|
To add a module tab under the new group tab, select it from the Modules list and drop it in the group, below the Edit and Delete icons.
|
To save your changes and make it available for users in the Sugar User Interface, click Save & Deploy.
Adding portal sites in Sugar enables the system to provide a single interface for multiple applications and Web sites. You can add new module tabs that can link to any Website you choose, thus enabling Sugar to become a single interface focus for its users. This is commonly used to include emails, forums, or other Web-based applications.
A portal site can be either of two types: Personal or Global. While both administrators and users can create portals, there are some differences that are noted below:
|
•
|
Users can only create personal portals that are not shared with other users, while administrators can create both personal and global portals. Global portals can be viewed by all users in the organization.
|
|
•
|
Users can display portal sites only in the Shortcuts menu, but administrators can display portals as a tab and in the Shortcuts menu.
|
|
•
|
Any personal portal that a user creates is listed on the administrator’s Portal Home page, but an administrator’s personal portal is not listed on the user’s Portal Home page.
|
|
|
|
|
|
Copyright 2004-2008 SugarCRM Inc.
Product License
