Provident News & Blog

Why use SugarCRM?

bruno — Fri, 24 May 2013 23:15:57 +0000

Provident CRM focuses on delivering you the best user experience possible so you can focus on your customers. We are proud that over a million users around the world trust SugarCRM to manage their customer relationships.

SugarCRM offers a complete solution suite integrating Sales, Marketing and Customer Service. Unlike other CRM products Sugar is compatible with every browser,mobile and tablet and works with social media platforms. You can stay in touch with your company on the go with free apps for tablets and smartphones.

With new SugarCRM 6.5 we are taking a bold step forward in delivering a fantastic user experience and gives you a flexible solution, easy, intuitive and open source. You can access all relevant customer information from a single screen.

Please watch this video and discover all we deliver to your company:

Provident CRM automates your best process in SugarCRM, training your people and deploying your technology with the best price in the market

START A FREE TRIAL TODAY.

Eircom eFibre Cabinet Locations and Coverage

provident — Fri, 24 May 2013 13:55:34 +0000

As a follow-up to previous post we made on Eircom eFibre coverage, we have done some digging to see is it possible to get more detail on Eircom’s Actual eFibre coverage, rather than the Exchange Boundary maps which are currently on the Eircom website.

After some googling, we have found a crowd-sourced google map of enabled cabinets on the Eircom Network. It appears to have much source data from Eircom Wholesale, so it is surprising Eircom do not just publish this information on their website.

Below is a screenshot of the enabled exchanges in the Mullingar area, as you can see they are all close to heavily poplulated areas, and when you zoom out there are not cabinets enabled outside of the town although the Eircom website indicates a large region in the Mullingar hinterland is enabled.

The same story applies to much of the country – be it Dublin, Cork, Sigo, in all cases the only enabled cabinets are adjacent to housing estates etc.

I have also included a screenshot for Dublin Area – as you can see coverage is still fairly patchy:

When Speaking with a representative from Magnet Business who resell Eircom’s eFibre product, they stated that Eircom announce an area as eFibre enabled when 40% of the cabinets are enabled, and they will continue to add cabinets after this time – Lets wait and see how high they go over 40%, only time will tell.

UPDATE: We had a query on our Facebook Page regarding eFibre availability in Howth area, here is a map of the enabled cabinets in Howth/Sutton/Baldoyle/Rahney/Kilbarrack area:

Note: The rollout date for Howth/Sutton/Baldoyle is listed as July-December 2013 on the eircom website, see rollout dates map for Dublin region below from eircom:

Eircom’s eFibre Coverage Maps Misleading

provident — Mon, 20 May 2013 22:42:57 +0000

Eircom Today Launched their long awaited VDSL product – Fibre to the cabinet, offering speeds of up to 70M down and 20M up, to Business and Residential customers.

What everybody want’s to know is – can I get it? At a first glance, everything looks great, however when you dig into the coverage map there are huge sections within the Green Coverage area which actually do not have coverage.

We tested several addresses well inside the indicated coverage, and they all failed testing. It seems only locations in the town centres really have coverage, the map above is very mis-leading.

Eircom’s eFibre Coverage map indicates VDSL coverage in the Middle of Lough Owel and Lough Ennell – certainly it needs to be taken with a grain of salt – Maybe its based on NGB Exchange Boundaries, which just happens to be drawn thru lakes.

Whatever this map is based on, it does not appear to reflect actual coverage. It would be interesting to see if there is a map available of enabled cabinets rather than exchange boundaries. This certainly would be would be more meaningful?

SugarCRM REST API v10 – Connecting to 6.7.0 on Demand

provident — Fri, 17 May 2013 15:05:30 +0000

With the Release of SugarCRM 6.7.0 a new API has been exposed – REST version 10.

This is the first step in the massive leap forward from SugarCRM 6 to 7.

The new REST API is super fast, and from a developers perspective, very well documented. SugarCRM have implemented WSDL like online help. We have posted a copy of this below, or if you would like to try it out for yourself, click on the link below – this is a SugarCRM 6.7.0 instance we spun up for testing:

https://demo.sugaropencloud.eu/provident/mobile/rest/v10/help

Here is a screenshot of a GET REST API call to SugarCRM 6.7.0 using the new v10 interface:

If you are looking for support to develop new integrations with SugarCRM, make sure to use this new API.

Provident CRM are a SugarCRM Gold Partner and provide Support, Hosting and Development Services for customers requiring Business Solutions in the UK, Ireland, Germany, Switzerland and Austria.

Below is full list of the API calls supported in SugarCRM 6.7.0 REST v10

SugarCRM API

GET
/
Search records in this module
6.25

List Records In Module

Summary:

This endpoint lists records in a specific module. Searching, filtering and ordering can be applied to only fetch the records you are interested in. Additionally the set of returned fields can be restricted to speed up processing and reduce download times.

Query Parameters:

Param

DescriptionOptional
qSearch the records by this parameter, if you don’t have a full-text search engine enabled it will only search the name field of the records.Optional
maxResultA maximum number of records to returnOptional
offsetHow many records to skip over before records are returnedOptional
fieldsComma delimited list of what fields you want returned.
The field date_modified will always be addedOptional
order_byHow to sort the returned records, in a comma delimited list with the direction appended to the column name after a colon.
Example: last_name:DESC,first_name:DESC,date_modified:ASCOptional
favoritesOnly fetch favorite recordsOptional
deletedShow deleted records in addition to undeleted recordsOptional

Input Example:

This endpoint does not accept any input

Output Example:

{ "next_offset": 31, This will be set to -1 when there are no more records after this "page" "records": [ { "id":"514eab95-4e5b-63f1-1658-4f8c7675955c", "name":"Nelson Inc", "date_entered":"2012-04-16 19:41:10", "date_modified":"2012-04-16 19:41:10", "modified_user_id":"1", "created_by":"1","description":null, "deleted":"0", "assigned_user_id":"seed_sarah_id", "_search": { "score": "1.0", "highlighted": {"fieldName" : { "text": "My String Is here", "module":"ModuleName", "label":"LBL_AWESOME" }} }, ... additional fields ... }, ... additional records ... ] }

File:clients/base/api/UnifiedSearchApi.php
Method:globalSearch

POST

This method creates a new record of the specified type

6.25

Create a new record of a specified type.

Summary:

This endpoint creates a single record.

Query Parameters:

Param	Description	Optional
This endpoint does not accept any parameters.

Input Example:

{ "name":"Call Test", "date_start":"2012-09-11T13:34:23-07:00", "duration_minutes":"30", "status":"Planned", "direction":"Inbound", ... additional fields ... }

Output Example:

{ "id": "5526df55-d3b5-ccd6-59b1-5058a5b5492c", "name": "Call Test", "date_entered": "2012-09-18T09:46:00-0700", "date_modified": "2012-09-18T09:46:00-0700", "modified_user_id": "1", "modified_by_name": "Administrator", "created_by": "1", "created_by_name": "Administrator", "description": "", "deleted": "0", "assigned_user_id": "", "assigned_user_name": "", "team_name": [ { "id": 1, "name": "Global", "name_2": "", "primary": true } ], "duration_hours": 0, "duration_minutes": "30", "date_start": "2012-09-11T13:34:00-0700", "parent_type": "", "parent_name": "", "status": "Planned", "direction": "Inbound", "parent_id": "", "reminder_checked": false, ... additional fields ... }

File:clients/base/api/ModuleApi.php
Method:createRecord

DELETE

//:record

This method deletes a record of the specified type

7.00

Delete a record of a specified type.

Summary:

This endpoint sets a records field to deleted=1, so it is no longer visible. The record is still in the database.

Query Parameters:

Param	Description	Optional
This endpoint does not accept any parameters.

Input Example:

Output Example:

{ "id": "11cf0d0a-40af-8cb1-9da0-5057a5f511f9" }

File:clients/base/api/ModuleApi.php
Method:deleteRecord

GET

//:record

Returns a single record

7.00

Retrieve records of a specified type.

Summary:

This endpoint returns record(s) within a module.

Query Parameters:

Param	Description	Optional
This endpoint does not accept any parameters.

Input Example:

Output Example:

{ "id": "f384c2b4-6edf-723d-db4e-5057a54a669f", "name": "Randy Woodward", "date_entered": "2012-09-17T15:33:00-0700", "date_modified": "2012-09-17T15:33:00-0700", "modified_user_id": "1", "modified_by_name": "Administrator", "created_by": "1", "created_by_name": "Administrator", "description": "", "deleted": "0", "assigned_user_id": "seed_max_id", "assigned_user_name": "Max Jensen", "team_name": [ { "id": "East", "name": "East", "name_2": "", "primary": false }, ... additional fields ...

File:clients/base/api/ModuleApi.php
Method:retrieveRecord

PUT

//:record

This method updates a record of the specified type

7.00

Update a record of the specified type.

Summary:

This endpoint updates a single record.

Query Parameters:

Param	Description	Optional
This endpoint does not accept any parameters.

Input Example:

{ "name":"New Acct Name", "phone_office":"(555) 888-5555", "website":"www.newsite.com", ... additional fields ... }

Output Example:

{ "id": "21130cb0-df8a-4376-a9b3-5057a5f86104", "name": "New Account Name", "date_entered": "2012-09-17T15:33:00-0700", "date_modified": "2012-09-18T10:11:00-0700", "modified_user_id": "1", "modified_by_name": "Administrator", "created_by": "1", "created_by_name": "Administrator", "description": "", "deleted": "0", "assigned_user_id": "seed_sally_id", "assigned_user_name": "Sally Bronsen", "team_name": [ { "id": "East", "name": "East", "name_2": "", "primary": false }, ... additional fields ...

File:clients/base/api/ModuleApi.php
Method:updateRecord

DELETE

//:record/favorite

This method unsets a record of the specified type as a favorite

8.75

Unfavorite a record of a specified type.

Summary:

This endpoint unsets a records as a favorite for the logged in user.

Query Parameters:

Param	Description	Optional
This endpoint does not accept any parameters.

Input Example:

Output Example:

File:clients/base/api/ModuleApi.php
Method:unsetFavorite

PUT

//:record/favorite

This method sets a record of the specified type as a favorite

8.75

Favorite a record of a specified type.

Summary:

This endpoint sets a records as a favorite for the logged in user.

Query Parameters:

Param	Description	Optional
This endpoint does not accept any parameters.

Input Example:

Output Example:

File:clients/base/api/ModuleApi.php
Method:setFavorite

GET

//:record/file

Gets a listing of files related to a field for a module record.

8.75

Lists attachment fields for a record

Summary:

This endpoint lists all fields of type "file" or of type "image" for a record that contain an attachment.

Query Parameters:

Param	Description	Optional
This endpoint does not accept any parameters.

Input Example:

This endpoint does not accept any input.

Output Example:

{ picture: { content-type: "image/jpeg", content-length: 47249, name: "a9726941-af60-d47c-86cb-4fcebb1a24cf", uri: "http://your.sugarcrm.install/rest/v10/Contacts/10500b19-24ab-c7dd-7757-4fc8f9a63f10/file/picture" } }

File:clients/base/api/FileApi.php
Method:getFileList

GET

//:record/file/:field

Gets the contents of a single file related to a field for a module record.

9.50

Gets a file attached to a field in a record

Summary:

This endpoint retrieves an attached file for a field in a record. The response from this request is an HTTP response with a forced download. This can be used in rendering images through the API or in offering immediate file downloads.

Query Parameters:

Param	Description	Optional
This endpoint does not accept any parameters.

Input Example:

This endpoint does not accept any input.

Output Example:

Cache-Control: no-cache, must-revalidate Connection: keep-alive Content-Encoding: gzip Content-Type: application/octet-stream Date: Mon, 30 Jan 2012 17:00:46 GMT Expires: Mon, 30 Jan 2012 17:00:45 GMT Last-Modified: Thu, 10 Nov 2011 19:01:31 GMT Transfer-Encoding: chunked Vary: Accept-Encoding . . . .

File:clients/base/api/FileApi.php
Method:getFile

POST

//:record/file/:field

Saves a file. The file can be a new file or a file override.

9.50

Attaches a file to a field in a record

Summary:

This endpoint takes a file or image and saves it to a record.

Query Parameters:

Param	Description	Optional
format	sugar-html-json	Required	delete_if_fails	Boolean indicating whether the API is to mark related record deleted if the file upload fails.	Optional (if used oauth_token is also required)	oauth_token	oauth_token_value	Optional (Required if delete_if_fails is true)

Input Example:

POST /rest/v10/Notes/abcd-1234/file/filename?format=sugar-html-json&delete_if_fails=true&oauth_token= HTTP/1.1 Host: localhost Connection: keep-alive Content-Length: 10263 Cache-Control: max-age=0 Content-Type: multipart/form-data; boundary=---WebKitFormBoundarybThnfMCVqnkSxLCl Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 Accept-Encoding: gzip Accept-Language: en-US,en;q=0.8 ------WebKitFormBoundarybThnfMCVqnkSxLCl Content-Disposition: form-data; name="file"; filename="my-awesome-document.xyz" Content-Type: application/document-xyz ...This is where the bin data would be

Output Example:

{ "field": { "content-type": "application/document-xyz", "content-length": "657483", "name": "my-awesome-document.xyz", "uri": "http://your.sugarcrm.install/rest/v10//Notes/abc-1234/file/field" } }

File:clients/base/api/FileApi.php
Method:saveFilePost

DELETE

//:record/file/:field

Removes a file from a field.

9.50

Removes an attachment from a field for a record

Summary:

This endpoint removes an attachment from a field for a record and subsequently removes the file from the file system. Returns the same list as GET //?/file does.

Query Parameters:

Param	Description	Optional
This endpoint does not accept any parameters.

Input Example:

This endpoint does not accept any input.

Output Example:

{ picture: {} }

File:clients/base/api/FileApi.php
Method:removeFile

PUT

//:record/file/:field

Saves a file. The file can be a new file or a file override. (This is an alias of the POST method save.)

9.50

Attaches a file to a field in a record that currently contains an existing attachment

Summary:

This endpoint takes a file or image and saves it to a record that already contains an attachment in the specificed field.

NOTE: The PUT method is very similar to the POST method but differs slightly in how the request is constructed. PUT requests should send the file data as the body of the request. Optionally, a filename query param can be sent with the request.

Query Parameters:

Param	Description	Optional
filename	Filename to save the document as	Optional

Input Example:

PUT /rest/v10/Notes/abcd-1234/file/field/ HTTP/1.1 Host: localhost Connection: keep-alive Content-Length: 23456 Content-Type: application/document-doc ...This is where the bin data would be

Output Example:

{ "field": { "content-type": "application/document-doc", "content-length": "657483", "name": "yourfilename.doc", "uri": "http://your.sugarcrm.install/rest/v10//Notes/abc-1234/file/field" } }

File:clients/base/api/FileApi.php
Method:saveFilePut

POST

//:record/link/:link_name

Create a single record and relate it to this module

9.50

Create a single related record with relationship role information

Summary:

This endpoint creates a single related record including any additional information that is in the relationship record. For example, the Opportunities - Contacts relationship has a role that is placed on the contact, when creating a contact record normally you will not be able to set this role but if you create it through this endpoint you will be able to set the role in addition to the rest of the record.

Query Parameters:

Param

DescriptionOptional

This endpoint does not accept any parameters.

Input Example:

{ "contact_role":"Primary Decision Maker", This information is part of the relationship, and not in the actual related record. "first_name":"Bill", "last_name":"Edwards", "deleted":"0", "assigned_user_id":"seed_sarah_id", ... additional fields ... }

Output Example:

{ "record": { "id":"3141568b-4e5b-63f1-1658-4f8c7675955c", "name":"Yellow boat", "amount": 28999.99, "date_entered":"2012-04-16 19:41:10", "date_modified":"2012-04-16 19:41:10", "modified_user_id":"1", "created_by":"1", "description":"This person wants to buy a yellow boat.", "deleted":"0", "assigned_user_id":"seed_sarah_id", ... additional fields ... }, "related_record": { "id":"514eab95-4e5b-63f1-1658-4f8c7675955c", This is the ID of the related record, not of the intermediate relationship. "contact_role":"Primary Decision Maker", This information is part of the relationship, and not in the actual related record. "first_name":"Bill", "last_name":"Edwards", "date_entered":"2012-04-16 19:41:10", "date_modified":"2012-04-16 19:41:10", "modified_user_id":"1", "created_by":"1", "description":null, "deleted":"0", "assigned_user_id":"seed_sarah_id", ... additional fields ... } }

File:clients/base/api/RelateRecordApi.php
Method:createRelatedRecord

GET

//:record/link/:link_name

List related records to this module

9.50

List related records to this module.

Summary:

This endpoint lists records related to a module.

Query Parameters:

Param	Description	Optional
This endpoint does not accept any parameters.

Input Example:

Output Example:

{ "next_offset": -1, "records": [ { "id": "1ddc9209-444f-56c0-3d8f-5057a50878e3", "name": "Sea Region Inc - 1000 units", "date_entered": "2012-09-17T15:33:00-0700", "date_modified": "2012-09-17T15:33:00-0700", "modified_user_id": "1", "modified_by_name": "Administrator", "created_by": "1", "created_by_name": "Administrator", "description": "", "deleted": "0", "assigned_user_id": "seed_max_id", "assigned_user_name": "Max Jensen", "team_name": [ { "id": "East", "name": "East", "name_2": "", "primary": false }, { "id": "West", "name": "West", "name_2": "", "primary": true } ], "opportunity_type": "", "account_name": "Sea Region Inc", "account_id": "1101ca6f-6bf0-8a90-5750-5057a5a61d6d", "campaign_id": "", "campaign_name": "", "lead_source": "Support Portal User Registration", "amount": "50000", "amount_usdollar": "50000", "currency_id": "-99", "currency_name": "", "currency_symbol": "", "date_closed": "2013-07-05", "next_step": "", "sales_stage": "Value Proposition", "probability": "70", "my_favorite": false }, ... additional fields ...

File:clients/base/api/RelateApi.php
Method:listRelated

POST

//:record/link/:link_name/:remote_id

Relates an existing record to this module

10.25

Create a relationship to an existing record

Summary:

This endpoint is used to create a relationship to a pre-existing record. The input can be left blank if there is no additional relationship information to fill in.

Query Parameters:

Param

DescriptionOptional

This endpoint does not accept any parameters.

Input Example:

{ "contact_role":"Primary Decision Maker", This information is part of the relationship, and not in the actual related record. } This information is only necessary on records where there is additional relationship information.

Output Example:

File:clients/base/api/RelateRecordApi.php
Method:createRelatedLink

GET

//:record/link/:link_name/:remote_id

Fetch a single record related to this module

10.25

Get a single related record with relationship role information

Summary:

This endpoint retrieves a single related record including any additional information that is in the relationship record. For example, the Opportunities – Contacts relationship has a role that is placed on the contact, when fetching a contact record normally you will not get this role but if you fetch it through this relationship you will get the role in addition to the rest of the record.

Query Parameters:

Param

DescriptionOptional

This endpoint does not accept any parameters.

Input Example:

This endpoint does not accept any input

Output Example:

{ "id":"514eab95-4e5b-63f1-1658-4f8c7675955c", This is the ID of the related record, not of the intermediate relationship. "contact_role":"Primary Decision Maker", This information is part of the relationship, and not in the actual related record. "first_name":"Bill", "last_name":"Edwards", "date_entered":"2012-04-16 19:41:10", "date_modified":"2012-04-16 19:41:10", "modified_user_id":"1", "created_by":"1","description":null, "deleted":"0", "assigned_user_id":"seed_sarah_id", ... additional fields ... }

File:clients/base/api/RelateRecordApi.php
Method:getRelatedRecord

PUT

//:record/link/:link_name/:remote_id

Updates relationship specific information

10.25

Update relationship specific information on an existing relationship

Summary:

This endpoint is used to update relationship specific information in an existing relationship. This endpoint is only usful on relationships with additional relationship specific information in them such as the Contact to Opportunity relationship.

Query Parameters:

Param

DescriptionOptional

This endpoint does not accept any parameters.

Input Example:

{ "contact_role":"Technical Advisor", This information is part of the relationship, and not in the actual related record. }

Output Example:

{ "record": { "id":"3141568b-4e5b-63f1-1658-4f8c7675955c", "name":"Yellow boat", "amount": 28999.99, "date_entered":"2012-04-16 19:41:10", "date_modified":"2012-04-16 19:41:10", "modified_user_id":"1", "created_by":"1", "description":"This person wants to buy a yellow boat.", "deleted":"0", "assigned_user_id":"seed_sarah_id", ... additional fields ... }, "related_record": { "id":"514eab95-4e5b-63f1-1658-4f8c7675955c", This is the ID of the related record, not of the intermediate relationship. "contact_role":"Technical Advisor", This information is part of the relationship, and not in the actual related record. "first_name":"Bill", "last_name":"Edwards", "date_entered":"2012-04-16 19:41:10", "date_modified":"2012-04-16 19:41:10", "modified_user_id":"1", "created_by":"1", "description":null, "deleted":"0", "assigned_user_id":"seed_sarah_id", ... additional fields ... } }

File:clients/base/api/RelateRecordApi.php
Method:updateRelatedLink

DELETE

//:record/link/:link_name/:remote_id

Deletes a relationship between two records

10.25

Deletes a relationship between two records

Summary:

This endpoint is used to delete relationships, this endpoint will only delete the relationship between the two records and will not touch either record.

Query Parameters:

Param

DescriptionOptional

This endpoint does not accept any parameters.

Input Example:

This endpoint does not accept any input.

Output Example:

{ "record": { "id":"3141568b-4e5b-63f1-1658-4f8c7675955c", "name":"Yellow boat", "amount": 28999.99, "date_entered":"2012-04-16 19:41:10", "date_modified":"2012-04-16 19:41:10", "modified_user_id":"1", "created_by":"1", "description":"This person wants to buy a yellow boat.", "deleted":"0", This record is not deleted, only the relationship is removed. "assigned_user_id":"seed_sarah_id", ... additional fields ... }, "related_record": { "id":"514eab95-4e5b-63f1-1658-4f8c7675955c", This is the ID of the related record, not of the intermediate relationship. "contact_role":"Technical Advisor", This information is part of the relationship, and not in the actual related record. "first_name":"Bill", "last_name":"Edwards", "date_entered":"2012-04-16 19:41:10", "date_modified":"2012-04-16 19:41:10", "modified_user_id":"1", "created_by":"1", "description":null, "deleted":"0", This record is not deleted, only the relationship is removed. "assigned_user_id":"seed_sarah_id", ... additional fields ... } }

File:clients/base/api/RelateRecordApi.php
Method:deleteRelatedLink

PUT

//:record/unfavorite

This method unsets a record of the specified type as a favorite

8.75

Unfavorite a record of a specified type.

Summary:

This endpoint unsets a records as a favorite for the logged in user.

Query Parameters:

Param	Description	Optional
This endpoint does not accept any parameters.

Input Example:

Output Example:

File:clients/base/api/ModuleApi.php
Method:unsetFavorite

PUT

//config

Update forecasts config

8.00

Long help file not found: include/api/help/ConfigApi.html#configUpdate

File:modules/Forecasts/clients/base/api/ForecastsConfigApi.php
Method:configSave

POST

//config

create forecasts config

8.00

Long help file not found: include/api/help/ConfigApi.html#configCreate

File:modules/Forecasts/clients/base/api/ForecastsConfigApi.php
Method:configSave

GET

//config

forecasts config

8.00

Long help file not found: include/api/help/ConfigApi.html#config

File:modules/Forecasts/clients/base/api/ForecastsConfigApi.php
Method:config

GET

//enum/:field

This method returns enum values for a specified field

8.75

Retreive Enum Field Options for a given Module.

Summary:

This endpoint lists options for a given enum field.

Query Parameters:

Param	Description	Optional
Field	This is the field you want options forNo

Input Example:

Output Example:

{ "key":"value" }

File:clients/base/api/ModuleApi.php
Method:getEnumValues

GET

/Employees

Search Employee records

7.00

List Records In Module

Summary:

Query Parameters:

Param

DescriptionOptional

qSearch the records by this parameter, if you don't have a full-text search engine enabled it will only search the name field of the records.Optional

maxResultA maximum number of records to returnOptional

offsetHow many records to skip over before records are returnedOptional

fieldsComma delimited list of what fields you want returned.
The field date_modified will always be addedOptional

order_byHow to sort the returned records, in a comma delimited list with the direction appended to the column name after a colon.
Example: last_name:DESC,first_name:DESC,date_modified:ASCOptional

favoritesOnly fetch favorite recordsOptional

deletedShow deleted records in addition to undeleted recordsOptional

Input Example:

This endpoint does not accept any input

Output Example:

File:clients/base/api/PersonUnifiedSearchApi.php
Method:globalSearch

GET

/ForecastManagerWorksheets

Returns a collection of ForecastManagerWorksheet models

7.00

Long help file not found: include/api/html/modules/Forecasts/ForecastWorksheetManagerApi.html#forecastWorksheetManager

File:modules/Forecasts/clients/base/api/ForecastsWorksheetManagerApi.php
Method:forecastManagerWorksheet

PUT

/ForecastManagerWorksheets/:record

Update a ForecastManagerWorksheet model

7.75

Long help file not found: include/api/html/modules/Forecasts/ForecastWorksheetManagerApi.html#forecastWorksheetManagerSave

File:modules/Forecasts/clients/base/api/ForecastsWorksheetManagerApi.php
Method:forecastManagerWorksheetSave

GET

/ForecastSchedule

Returns a collection of ForecastSchedule models

7.00

Long help file not found: include/api/html/modules/ForecastSchedule/ForecaseScheduleApi.html#forecastSchedule

File:modules/ForecastSchedule/clients/base/api/ForecastScheduleApi.php
Method:forecastSchedule

PUT

/ForecastSchedule/:record

Updates a ForecastSchedule model

7.75

Long help file not found: include/api/html/modules/ForecastSchedule/ForecastScheduleApi.html#forecastScheduleSave

File:modules/ForecastSchedule/clients/base/api/ForecastScheduleApi.php
Method:forecastScheduleSave

GET

/ForecastWorksheets

Returns a collection of ForecastWorksheet models

7.00

Long help file not found: include/api/html/modules/Forecasts/ForecastWorksheetApi.html#forecastWorksheet

File:modules/Forecasts/clients/base/api/ForecastsWorksheetApi.php
Method:forecastWorksheet

PUT

/ForecastWorksheets/:record

Updates a ForecastWorksheet model

7.75

Long help file not found: include/api/html/modules/Forecasts/ForecastWorksheetApi.html#forecastWorksheet

File:modules/Forecasts/clients/base/api/ForecastsWorksheetApi.php
Method:forecastWorksheetSave

GET

/Forecasts/chart

Retrieve the Chart data for the given data in the Forecast Module

8.75

Retrieve a Forecasting Information In SugarChart Format

Summary:

This endpoint is used to return the json Data for SugarCharts to use to display the needed chart.

Query Parameters:

DescriptionOptional
Show for a specific user, defaults to current user if not definedOptional
Show for a specific time period, defaults to the current time period if one is not passedOptional
Which Forecast dataset to show, valid values are likely, best, worst. Defaults to likely if one is not specifiedOptional
Show Which fields the y-axis shows on the chart. Can be any field in the opportunity module, defaults to Sales StageOptional
Pipeline or Committed are valid values.Optional

Param
user_id	timeperiod_id	dataset	group_by	ranges

File:modules/Forecasts/clients/base/api/ForecastsChartApi.php
Method:chart

POST

/Forecasts/committed

Commit a forecast

8.75

Long help file not found: include/api/html/modules/Forecasts/ForecastWorksheetApi.html#forecastsCommit

File:modules/Forecasts/clients/base/api/ForecastsCommittedApi.php
Method:forecastsCommit

GET

/Forecasts/committed

A list of forecasts entries matching filter criteria

8.75

Long help file not found: include/api/html/modules/Forecasts/ForecastWorksheetApi.html#forecastsCommitted

File:modules/Forecasts/clients/base/api/ForecastsCommittedApi.php
Method:forecastsCommitted

GET

/Forecasts/committed/mgrNeedsCommitted

True or False if the manager worksheet commit is older than the rep worksheet committed date.

10.50

Long help file not found: include/api/html/modules/Forecasts/ForecastWorksheetApi.html#forecastsCommittedDateCheck

File:modules/Forecasts/clients/base/api/ForecastsCommittedApi.php
Method:forecastsCommittedMgrNeedsCommitted

GET

/Forecasts/init

Returns current user data

8.75

Long help file not found: include/api/html/init.html

File:modules/Forecasts/clients/base/api/ForecastsCurrentUserApi.php
Method:forecastsInitialization

GET

/Forecasts/me

Returns current user

8.75

Long help file not found: include/api/html/me.html

File:modules/Forecasts/clients/base/api/ForecastsCurrentUserApi.php
Method:retrieveCurrentUser

GET

/Forecasts/progressManager

Progress Manager data

8.75

Long help file not found: modules/Forecasts/clients/base/api/help/ForecastProgressApi.html#progressRep

File:modules/Forecasts/clients/base/api/ForecastsProgressApi.php
Method:progressManager

GET

/Forecasts/progressRep

Progress Rep data

8.75

Long help file not found: modules/Forecasts/clients/base/api/help/ForecastProgressApi.html#progressRep

File:modules/Forecasts/clients/base/api/ForecastsProgressApi.php
Method:progressRep

GET

/Forecasts/reportees/:user_id

Gets reportees to a user by id

9.50

Long help file not found: include/api/html/modules/Forecasts/ForecastFiltersApi.html#reportees

File:modules/Forecasts/clients/base/api/ForecastsFiltersApi.php
Method:getReportees

GET

/Forecasts/timeperiod

forecast timeperiod

8.75

Long help file not found: include/api/html/modules/Forecasts/ForecastFiltersApi.html#timeperiod

File:modules/Forecasts/clients/base/api/ForecastsFiltersApi.php
Method:timeperiod

GET

/Forecasts/user/:userId

Returns selectedUser object for given user

9.50

Long help file not found: include/api/html/user.html

File:modules/Forecasts/clients/base/api/ForecastsCurrentUserApi.php
Method:retrieveSelectedUser

POST

/Leads/register

This method registers leads

8.75

Endpoint to create leads

Summary:

This endpoint accepts a json payload of lead properties and creates new leads.

Query Parameters:

Param

DescriptionOptional

This endpoint does not accept any parameters.

Input Example:

{ "first_name":"John", "last_name":"Smith" }

Output Example:

{ "id": "ecba9f86-4a4a-def6-359c-505a5b33f014", "name": "John Smith", "date_entered": "2012-09-19T23:54:54+0000", "date_modified": "2012-09-19T23:54:54+0000", "modified_user_id": "1", "created_by": "1", "deleted": 0, "team_id": "1", "team_set_id": "1", "first_name": "John", "last_name": "Smith", "full_name": "John Smith", "do_not_call": false, "converted": false, "lead_source": "Support Portal User Registration", "status": "New", "preferred_language": "en_us", "email": [], "my_favorite": false }

File:clients/base/api/RegisterLeadApi.php
Method:createLeadRecord

GET

/Meetings

Search records in this module

7.00

List Records In Module

Summary:

Query Parameters:

Param

DescriptionOptional

qSearch the records by this parameter, if you don’t have a full-text search engine enabled it will only search the name field of the records.Optional

maxResultA maximum number of records to returnOptional

offsetHow many records to skip over before records are returnedOptional

fieldsComma delimited list of what fields you want returned.
The field date_modified will always be addedOptional

order_byHow to sort the returned records, in a comma delimited list with the direction appended to the column name after a colon.
Example: last_name:DESC,first_name:DESC,date_modified:ASCOptional

favoritesOnly fetch favorite recordsOptional

deletedShow deleted records in addition to undeleted recordsOptional

Input Example:

This endpoint does not accept any input

Output Example:

File:modules/Meetings/clients/base/api/MeetingsApi.php
Method:globalSearch

GET

/Reports

Search Reports

7.00

List Records In Module

Summary:

Query Parameters:

Param

DescriptionOptional

qSearch the records by this parameter, if you don’t have a full-text search engine enabled it will only search the name field of the records.Optional

maxResultA maximum number of records to returnOptional

offsetHow many records to skip over before records are returnedOptional

fieldsComma delimited list of what fields you want returned.
The field date_modified will always be addedOptional

order_byHow to sort the returned records, in a comma delimited list with the direction appended to the column name after a colon.
Example: last_name:DESC,first_name:DESC,date_modified:ASCOptional

favoritesOnly fetch favorite recordsOptional

deletedShow deleted records in addition to undeleted recordsOptional

Input Example:

This endpoint does not accept any input

Output Example:

File:modules/Reports/clients/base/api/ReportsSearchApi.php
Method:globalSearch

GET

/Reports/:record/:export_type

This method exports a record in the specified type

8.50

No additional help.

File:modules/Reports/clients/base/api/ReportsExportApi.php
Method:exportRecord

GET

/Users

Search User records

7.00

List Records In Module

Summary:

Query Parameters:

Param

DescriptionOptional

qSearch the records by this parameter, if you don’t have a full-text search engine enabled it will only search the name field of the records.Optional

maxResultA maximum number of records to returnOptional

offsetHow many records to skip over before records are returnedOptional

fieldsComma delimited list of what fields you want returned.
The field date_modified will always be addedOptional

order_byHow to sort the returned records, in a comma delimited list with the direction appended to the column name after a colon.
Example: last_name:DESC,first_name:DESC,date_modified:ASCOptional

favoritesOnly fetch favorite recordsOptional

deletedShow deleted records in addition to undeleted recordsOptional

Input Example:

This endpoint does not accept any input

Output Example:

File:clients/base/api/PersonUnifiedSearchApi.php
Method:globalSearch

GET

/css

Generate the bootstrap.css file

7.00

Run LessPHP and outputs the compiled css

Summary:

This endpoint allows you to preview what would be the output bootstrap.css after compiling a theme. It interprets the arguments as less variables and run LessPHP based on the set of arguments you furnished.

Query Parameters:

Param	Description	Optional
platform	/themes/clients/*PLATFORM*/themeName/	true	themeName	/themes/clients/platform/*THEMENAME*/	true	min	Compress or not the css	true

Input Example:

{ platform: 'portal', themeName: 'default', min: false }

Output Example:

.article { font-size: 16px; }

File:clients/base/api/ThemeApi.php
Method:previewCSS

GET

/help

Shows Help information

7.00

Fetch Help Documentation

Summary:

This function gives you the help documentation you are looking at right now.

Query Parameters:

Param

DescriptionOptional

This endpoint accepts no parameters.

Input Example:

This endpoint does not accept any input

Output Example:

SugarCRM Auto Generated API Help

`SugarCRM API`

  ... More rows ...   +  GET  /  List records in this module  4.50  
      ... Full help excluded ... File:include/api/listApi.php
 Method:listModule

Note: This endpoint returns contents of type text/html

File:clients/base/api/HelpApi.php
Method:getHelp

GET

/lang/:lang

Returns the labels for the application

7.75

Long help file not found: include/api/html/metadata_all_help.html

File:clients/base/api/MetadataApi.php
Method:getLanguage

GET

/lang/public/:lang

Returns the public labels for the application

9.50

Long help file not found: include/api/html/metadata_all_help.html

File:clients/base/api/MetadataApi.php
Method:getPublicLanguage

GET

/me

Returns current user

7.00

Provides an Current User endpoint

Summary:

This endpoint returns the current user object.

Query Parameters:

Param

DescriptionOptional

This endpoint does not accept any parameters.

Input Example:

Output Example:

{"current_user": { "type":"user", "id":"1", "full_name":"Administrator", "timepref":"h:ia", "timezone":"America/Los_Angles", "user_name":"admin" }} Or, for portal users: {"current_user": { "type":"support_portal", "id":"1234-567", "user_id":"abcd-123", "full_name":"Bill Williamson", "timepref":"h:ia", "timezone":"America/Denver", "user_name":"SupportPortalApi" }}

File:clients/base/api/CurrentUserApi.php
Method:retrieveCurrentUser

PUT

/me

Updates current user

7.00

Provides an Current User endpoint

Summary:

This endpoint returns the current user object.

Query Parameters:

Param

DescriptionOptional

This endpoint does not accept any parameters.

Input Example:

Output Example:

File:clients/base/api/CurrentUserApi.php
Method:updateCurrentUser

POST

/me/password

Verifies current user’s password

8.75

Provides an enpoint to verify the Current User’s password

Summary:

This endpoint allows for verification of the user’s current password. If client type is support_portal, it will check corresponding Contact. Otherwise, it will check corresponding User.

Query Parameters:

Param

DescriptionRequired

Input Example:

{ 'password_to_verify': 'mycurrentpassword' }

Output Example:

{ "valid":true, }

File:clients/base/api/CurrentUserApi.php
Method:verifyPassword

PUT

/me/password

Updates current user’s password

8.75

Provides an enpoint to change Current User’s password

Summary:

This endpoint allows for changes the user’s password. If client type is support_portal, it will update the corrending Contact. Otherwise, it will update User.

Query Parameters:

Param

DescriptionRequired

Input Example:

{ "old_password":"myoldpass", "new_password":"mynewpass", }

Output Example:

{ "valid":true, "expiration":null, }

File:clients/base/api/CurrentUserApi.php
Method:updatePassword

PUT

/me/preference/:preference_name

Update a specific preference for the current user

9.50

Long help file not found: include/api/help/user_preferences.html

File:clients/base/api/CurrentUserApi.php
Method:userPreferenceSave

DELETE

/me/preference/:preference_name

Delete a specific preference for the current user

9.50

Long help file not found: include/api/help/user_preferences.html

File:clients/base/api/CurrentUserApi.php
Method:userPreferenceDelete

POST

/me/preference/:preference_name

Create a preference for the current user

9.50

Long help file not found: include/api/help/user_preferences.html

File:clients/base/api/CurrentUserApi.php
Method:userPreferenceSave

GET

/me/preference/:preference_name

Returns a specific preference for the current user

9.50

Long help file not found: include/api/help/user_preferences.html

File:clients/base/api/CurrentUserApi.php
Method:userPreference

PUT

/me/preferences

Mass Save Updated Preferences For a User

8.75

Long help file not found: include/api/help/user_preferences.html

File:clients/base/api/CurrentUserApi.php
Method:userPreferencesSave

GET

/me/preferences

Returns all the current user’s stored preferences

8.75

Long help file not found: include/api/help/user_preferences.html

File:clients/base/api/CurrentUserApi.php
Method:userPreferences

GET

/metadata

This method will return all metadata for the system

7.00

Long help file not found: include/api/html/metadata_all_help.html

File:clients/base/api/MetadataApi.php
Method:getAllMetadata

POST

/metadata

This method will return all metadata for the system, filtered by the array of hashes sent to the server

7.00

Long help file not found: include/api/html/metadata_all_help.html

File:clients/base/api/MetadataApi.php
Method:getAllMetadata

GET

/metadata/_hash

This method will return the hash of all metadata for the system

8.75

Long help file not found: include/api/html/metadata_all_help.html

File:clients/base/api/MetadataApi.php
Method:getAllMetadataHash

GET

/metadata/public

This method will return the metadata needed when not logged in

8.75

Long help file not found: include/api/html/metadata_all_help.html

File:clients/base/api/MetadataApi.php
Method:getPublicMetadata

POST

/oauth2/logout

OAuth2 logout.

8.75

Long help file not found: include/api/help/oauth2_logout.html

File:clients/base/api/OAuth2Api.php
Method:logout

POST

/oauth2/token

OAuth2 token requests.

8.75

Provides an OAuth 2.0 compliant token endpoint

Summary:

This endpoint provides the token portion of the OAuth 2.0 specification. Currently the only supported grant types are “password” and “refresh_token”. The client_id of “sugar” will automatically create an OAuth Key in the system and can be used for “password” authentication. The client_id of “support_portal” will create an OAuth Key if the portal system is enabled and will allow for portal authentication. Other client_id’s can be created by the administrator in the OAuthKeys section in the Administration section and can be used in the future for additional grant types, if the client secret is filled in, it will be checked to validate use of the client id.

Query Parameters:

Param

DescriptionOptional

This endpoint does not accept any parameters.

Input Example:

For "password" grant types: { "grant_type":"password", "username":"bwayne", "password":"i_am_batman", "client_id":"sugar", "client_secret":"", } For "refresh_token" grant types: { "grant_type":"refresh_token", "refresh_token":"abc123", "client_id":"sugar", "client_secret":"", }

Output Example:

{ "access_token":"993de20f-43d4-fbf7-8fe9-4fc6a6a7bb4b", "expires_in":3600, "token_type":"bearer", "scope":null, "refresh_token":"a39a7c6d-7276-fcf0-da64-4fc6a6976a10" }

File:clients/base/api/OAuth2Api.php
Method:token

GET

/ping

An example API only responds with pong

7.00

Long help file not found: include/api/html/ping_base_help.html

File:clients/base/api/PingApi.php
Method:ping

GET

/ping/whattimeisit

An example API only responds with the current time in server format.

8.75

Long help file not found: include/api/html/ping_whattimeisit_help.html

File:clients/base/api/PingApi.php
Method:ping

GET

/search

Globally search records

7.00

Long help file not found: include/api/help/globalSearch.html

File:clients/base/api/UnifiedSearchApi.php
Method:globalSearch

GET

/theme

Get the customizable variables of a custom theme

7.00

Get the customizable variables of a custom theme

Summary:

It parses variables.less (less file containing customizable vars in the theme folder) and returns the hash of variables

Query Parameters:

Param	Description	Optional
platform	/themes/clients/*PLATFORM*/themeName/	true	themeName	/themes/clients/platform/*THEMENAME*/	true

Input Example:

{ platform: 'portal', themeName: 'default' }

Output Example:

{ primary: '#aaaaaa', secondary: '#bbbbbb', primaryBtn: '#cccccc' }

File:clients/base/api/ThemeApi.php
Method:getCustomThemeVars

POST

/theme

Update the customizable variables of a custom theme

7.00

Update the customizable variables of a custom theme

Summary:

It updates variables.less (less file containing customizable vars in the theme folder) with the set of variables passed as arguments

Query Parameters:

Param	Description	Optional
platform	/themes/clients/*PLATFORM*/themeName/	true	themeName	/themes/clients/platform/*THEMENAME*/	true

Input Example:

{ platform: 'portal', themeName: 'default', primary: 'default', secondary: '#aaaaaa', primaryBtn: '#bbbbbb', }

Output Example:

http://path/to/bootstrap.css (json encoded)

File:clients/base/api/ThemeApi.php
Method:updateCustomTheme

Avoid Changing SugarCRM outlook password with OAuth Login

provident — Tue, 14 May 2013 18:54:35 +0000

Do you regularly change your SugarCRM password, and don’t want the hassle of having to re-configure the Outlook plugin every time?

Following the release of the SugarCRM plugin for Outlook in February 2012 you can now use OAuth so there is only a one-time setup. Below is a list of steps to setup OAuth with your SugarCRM Outlook Plugin

OAuth Login

OAuth login is a new feature of Sugar Plug-in for Microsoft Outlook, Feb 2012 Release. This is a good login option for users who need to change their Sugar login credentials frequently. OAuth enables users to establish a permanent connection between Sugar Plug-in for Microsoft Outlook and the Sugar application and works seamlessly when the user’s login credentials changes in Sugar. Users need to complete a one-time process to retrieve the OAuth token from Sugar and establish this permanent connection.
Follow the steps listed below to retrieve the OAuth token from Sugar and establish a permanent connection between Sugar Plug-in for Microsoft Outlook and the Sugar application:

Open Sugar in your default browser and login using your credentials.
Open Sugar Plug-in for Microsoft Outlook Settings.
Select the Use OAuth login checkbox.

4. Click the Retrieve OAuth access token button.
This displays a new page with two fields – Consumer Key and Consumer Secret.

NB: You might need to resize the window in order to see all the fields!!!

5. Enter the Consumer Key and Consumer Secret

6. You can get these values from your Sugar admin. If you are an admin, get this from Sugar>Admin>System> OAuth Keys.

7. Click Continue.This displays a web page in your default browser with an option to authorize your token.

8. Authorize the token by clicking the Authorize Token button.This displays an authorization code.

9. Copy the authorization code, go to Sugar Plug-in for Microsoft Outlook and paste the authorization code in the input box.

10.Click Ok.

11. This retrieves the permanent OAuth token from Sugar.

12. Ensure that the OAuth token and secret are populated in the corresponding fields.

13. Click the Test connection button and ensure that a connection is established between Sugar Plug-in for Microsoft Outlook and your Sugar application.

14. Click Ok to save the settings and return to Sugar Plug-in for Microsoft Outlook.

For more information and a video on how to install & use the SugarCRM Outlook plugin watch this Video:

SugarCRM and Microsoft SQL Server / FreeTDS with a Linux Webserver

provident — Wed, 24 Apr 2013 18:44:20 +0000

This is the first in a series of posts were we will discuss how best to configure SugarCRM in order to achieve best performance with Microsoft SQL Server.

Provident CRM are recognised by SugarCRM Inc as the leading partner Globally in support for running SugarCRM on the Microsoft Stack.

SugarCRM can be deployed in any number of combinations which involve various aspects of the Microsoft Stack, some of the most common deployments are:

Full Microsoft Stack

Windows Operating System
MSSQL Server
IIS Webserver
Microsoft MSSQL PHP Driver

WAMP Stack

Windows Operating System
MySQL
Apache Webserver

Hybrid

Apache Webserver (most commonly running on Linux for best performance)
MSSQL Server
FreeTDS MSSQL PHP Driver

This Post in concentrating on the Hybrid solution, this is commonly deployed in Enterprise environments were MSSQL is the Database server of choice and enterprise DBA and backup skills/resources are best suited to supporting an MSSQL database. It is lightly customers will also run Enterprise reporting / BI tools against the MSSQL database as integrations such as SSIS (SQL Server Integration Services). Provident CRM regularly support customers on these platforms including developing & supporting such integrations.

The FreeTDS Driver supports numbers modes (for connecting to different Database types including MSSQL, Sybase, ODBC etc), below table describes how to configure using the Version number:

TDS Version	Supported Products
4.2	Sybase SQL Server < 10 and Microsoft SQL Server 6.5
5.0	Sybase SQL Server >= 10
7.0	Microsoft SQL Server 7.0
7.1	Microsoft SQL Server 2000
7.2	Microsoft SQL Server 2005

Watch out for bogus references to other versions such as 8.0 and 9.0, at first there was One Version of TDS common to both vendors but, in keeping with the broad history of private ventures, they soon diverged. Each vendor has subsequently brought out different versions, and neither supports the other’s flavor. That is to say, each vendor’s client libraries use the latest version of TDS offered by that vendor. You can’t reliably use Microsoft’s libraries to connect to Sybase, or Sybase’s libraries to connect to Microsoft. In some cases you’ll get a connection, but pretty soon you’ll bump into some incompatibility.

Versions of the TDS protocol

TDS 4.2 Sybase and Microsoft: The version in use at the time of the Sybase/Microsoft split.
TDS 5.0 Sybase: Introduced for Sybase. Because TDS 5.0 includes negotiated capabilities through which protocol features can be expanded, we are unlikely to see a new TDS version from Sybase.
TDS 7.0 Microsoft: Introduced for SQL Server 7.0. Includes support for the extended datatypes in SQL Server 7.0 (such as char/varchar fields of more than 255 characters). It also includes support for Unicode.
TDS 7.1 Microsoft, was 8.0 [1]: Introduced for SQL Server 2000. Includes support for big integer (64-bit int) and ”variant” datatypes.
TDS 7.2 Microsoft, was 9.0: Introduced for SQL Server 2005. Includes support for varchar(max), varbinary(max), xml datatypes and MARS.

Notes

[1]	Earlier FreeTDS documentation referred to versions 7, 8 and 9. Microsoft subsequently published a protocol specification document denoting 7.1 and 7.2, and one finds scattered references using that scheme elsewhere, too. For that reason, FreeTDS switched to Microsoft’s nomenclature.

We have posted the full TDS protocol Documentation

Also a note on configuring FreeTDS to connect to MSSQL using SSL

And finnaly a full FreeTDS Reference Manual

Also, here is an introduction and getting started guide to FreeTDS:

Introduction
————

This document is intended for people who want to help on the FreeTDS project and/or are interested in how the code works.

TDS is a fairly simple request/response protocol. It comes in three major
flavors: 4.2, 5.0 and 7.0. Microsoft SQL-Server versions through 6.5 still use
the 4.2 version as do Sybase servers before 10.0. MS SQL 7.0 introduced TDS 7.0
which so far is not implemented (but can still be accessed with 4.2). No version
of MS SQL uses 5.0 and Sybase does not use 7.0, but both still support 4.2.
TDS allows for negotiation of quite a few parameters at connection time, many of
these are documented in the cap.txt file in this directory.

+—————————————————————+
| | MS SQL | Sybase ASE | Sybase ASA |
+—————————————————————+
|ver |6.5 |7.0 |2000| <10.x | >11.0 |<5.5.03|5.5*|>6.0|
+—–+—-+—-+—-+———–+————+——-+—-+—-+
| 4.2 | X | X | X | X | X | | | |
| 5.0 | | | | | X | | X | X |
| 7.0 | | X | X | | | | | |
| 8.0 | | | X | | | | | |
+—–+—-+—-+—-+———–+————+——-+—-+—-+

* Sybase ASA 5.5 requires 5.5.03 or better with the OpenServer Gateway
(OSG).
Layers
——

The FreeTDS code is broken down into two layers.

The TDS layer handles the bulk of the processing of the protocol and dealing with the network, etc… Any code dealing with protocol issues should reside in this directory (src/tds). A related directory src/server has routines that are used
only for server side processes. These two directories may eventually be merged.

On top of this layer is a thin layer specific to the ‘Call Level Interface’ (CLI). A CLI is an API intended to be used by client programs. The core FreeTDS
has three CLIs: dblib, the original Sybase API; ctlib, the newer Sybase API; and
ODBC, the non-database specific API.

Currently dblib and ODBC are the most robust CLIs we have, followed by ctlib, which is
quite usable none-the-less. The ODBC CLI is built using a driver manager (either iODBC or
unixODBC), so you will need one of those to build it with.

Outside of these there is also a JDBC driver for Java and a DBI driver for
Perl which do not reside atop the TDS layer. (FreeTDS/JDBC is a pure Java
driver). This document does not currently cover these libraries. Those wishing
to use Perl are also encouraged to look at DBD::Sybase which uses ctlib and works well with the FreeTDS libraries.

The Nitty Gritty
—————-

The first thing a CLI does is allocate a login structure for TDS. Such as:

TDS_LOGIN *login = tds_alloc_login();

It can then call any of the tds_set_*() functions to initialize this TDS_LOGIN
structure. Please refer to src/tds/login.c for a complete listing of options.

Once username, password, server, and other options are set a call can be made to
tds_connect(). This will allocate a TDS_SOCKET structure and open a socket
connection to the specified server (or NULL on failure). The TDS_SOCKET is then
passed as an argument to all future TDS functions.

At this point the only really useful thing to do is to call tds_submit_query()
and then process the returning rows using tds_process_results() and company.

This should get us to the routines in src/tds/token.c which are responsible for
reading the results back from the server and doing something with them. The
logic in these routines should not be hard to follow. The return stream is
broken up into a series of ‘messages’ (not to be confused with actual messages
returned from the server). Each one starts with a marker (marker is my word for
it, not Sybase’s or anyone else’s). include/tds.h defines all the markers and in
general there will be one tds_process_*() function for each marker unless it is
not worth looking at, in which case tds_process_default_tokens() will read past
it.

Misc
—-

Please send fixes and updates to Brian Bruns (brian@bruns.org)

Capabilities
————

The TDS_CAP_TOKEN token (decimal 226) in TDS is sent to the server immediately
after the login sequence in TDS 5.0. It is sent back as part of the login
acknowledgement stream. The client requests which capabilities it wants and
the server sends back which ones it supports.

I’m not certain but I believe a full 5.0 login sequence could be sent to an
MS-SQL or Sybase 4.x server and if the 226 token is absent from the return
stream then the protocol could default back to 4.2. This would eliminate the
need for compiling two versions of the library, of course setting the proto
version manually would not send the capabilities. I need someone to try this
as I only have access to Sybase 11.x servers.

The layout of the capabilities packet is:
1 byte 2 bytes n bytes
+———+—————+———————+
| 226 | size of mask | capabilities field |
+———+—————+———————+

The capabilities field looks like:
1 byte 1 byte n bytes
+——–+——–+—————+
| id | size | bitmask |
+——–+——–+—————+

1) For id 1 seems to signify request capabilities and 2 is response capabilities.
2) The size represents the size of the bitmask (7 for all I’ve seen).
3) The bitmask is is a bitset mask denoting values set by ct_capability()
or similar call. It is packed from the low order bit to high order bit.
The first bit (low order bit…bit 0 of byte 6) is not used for a capability.
It seems to be used by the protocol but its function is presently unknown.

A listing of all known values for the bitmasks follows with its ctlib
constant. Refer to the ctlib documentation for descriptions of these.

REQUEST CAPABILITIES
——————–
byte 0:
default ctlib value: 3
bit 0 (0×01): CS_PROTO_DYNPROC
bit 1 (0×02): CS_DATA_FLTN
bit 2 (0×04): CS_DATA_BITN
bit 3 (0×08): CS_DATA_INT8
bit 4 (0×10): CS_DATA_VOID
bit 5 (0×20): unknown
bit 6 (0×40): unknown
bit 7 (0×80): unknown

byte 1:
default ctlib value: 109
bit 0 (0×01): CS_CON_INBAND
bit 1 (0×02): CS_CON_LOGICAL
bit 2 (0×04): CS_PROTO_TEXT
bit 3 (0×08): CS_PROTO_BULK
bit 4 (0×10): CS_REQ_URGNOTIF
bit 5 (0×20): CS_DATA_SENSITIVITY
bit 6 (0×40): CS_DATA_BOUNDARY
bit 7 (0×80): CS_PROTO_DYNAMIC

byte 2:
default ctlib value: 127
bit 0 (0×01): CS_DATA_MONEYN
bit 1 (0×02): CS_CSR_PREV
bit 2 (0×04): CS_CSR_FIRST
bit 3 (0×08): CS_CSR_LAST
bit 4 (0×10): CS_CSR_ABS
bit 5 (0×20): CS_CSR_REL
bit 6 (0×40): CS_CSR_MULTI
bit 7 (0×80): CS_CON_OOB

byte 3:
default ctlib value: 255
bit 0 (0×01): CS_DATA_NUM
bit 1 (0×02): CS_DATA_TEXT
bit 2 (0×04): CS_DATA_IMAGE
bit 3 (0×08): CS_DATA_DEC
bit 4 (0×10): CS_DATA_LCHAR
bit 5 (0×20): CS_DATA_LBIN
bit 6 (0×40): CS_DATA_INTN
bit 7 (0×80): CS_DATA_DATETIMEN

byte 4:
default ctlib value: 255
bit 0 (0×01): CS_DATA_BIN
bit 1 (0×02): CS_DATA_VBIN
bit 2 (0×04): CS_DATA_MNY8
bit 3 (0×08): CS_DATA_MNY4
bit 4 (0×10): CS_DATA_DATE8
bit 5 (0×20): CS_DATA_DATE4
bit 6 (0×40): CS_DATA_FLT4
bit 7 (0×80): CS_DATA_FLT8

byte 5:
default ctlib value: 255
bit 0 (0×01): CS_REQ_MSG
bit 1 (0×02): CS_REQ_PARAM
bit 2 (0×04): CS_DATA_INT1
bit 3 (0×08): CS_DATA_INT2
bit 4 (0×10): CS_DATA_INT4
bit 5 (0×20): CS_DATA_BIT
bit 6 (0×40): CS_DATA_CHAR
bit 7 (0×80): CS_DATA_VCHAR

byte 6:
default ctlib value: 254
bit 0 (0×01): unknown
bit 1 (0×02): CS_REQ_LANG
bit 2 (0×04): CS_REQ_RPC
bit 3 (0×08): CS_REQ_NOTIF
bit 4 (0×10): CS_REQ_MSTMT
bit 5 (0×20): CS_REQ_BCP
bit 6 (0×40): CS_REQ_CURSOR
bit 7 (0×80): CS_REQ_DYN

RESPONSE CAPABILITIES
———————
byte 0:
default ctlib value: 0
bit 0 (0×01): unknown
bit 1 (0×02): unknown
bit 2 (0×04): unknown
bit 3 (0×08): unknown
bit 4 (0×10): unknown
bit 5 (0×20): unknown
bit 6 (0×40): unknown
bit 7 (0×80): unknown

byte 1:
default ctlib value: 0
bit 0 (0×01): unknown
bit 1 (0×02): unknown
bit 2 (0×04): unknown
bit 3 (0×08): unknown
bit 4 (0×10): unknown
bit 5 (0×20): unknown
bit 6 (0×40): unknown
bit 7 (0×80): unknown

byte 2: (88)
default ctlib value: 10
bit 0 (0×01): CS_DATA_NOBOUNDARY
bit 1 (0×02): CS_DATA_NOTDSDEBUG
bit 2 (0×04): CS_RES_NOSTRIPBLANKS
bit 3 (0×08): CS_DATA_NOINT8
bit 4 (0×10): unknown
bit 5 (0×20): unknown
bit 6 (0×40): unknown
bit 7 (0×80): unknown

byte 3: (89)
default ctlib value: 120
bit 0 (0×01): CS_DATA_NOINTN
bit 1 (0×02): CS_DATA_NODATETIMEN
bit 2 (0×04): CS_DATA_MONEYN
bit 3 (0×08): CS_CON_NOOOB
bit 4 (0×10): CS_CON_NOINBAND
bit 5 (0×20): CS_PROTO_NOTEXT
bit 6 (0×40): CS_PROTO_NOBULK
bit 7 (0×80): CS_DATA_NOSENSITIVITY

byte 4: (90)
default ctlib value: 0
bit 0 (0×01): CS_DATA_NOFLT4
bit 1 (0×02): CS_DATA_NOFLT8
bit 2 (0×04): CS_DATA_NONUM
bit 3 (0×08): CS_DATA_NOTEXT
bit 4 (0×10): CS_DATA_IMAGE
bit 5 (0×20): CS_DATA_NODEC
bit 6 (0×40): CS_DATA_NOLCHAR
bit 7 (0×80): CS_DATA_NOLBIN

byte 5: (91)
default ctlib value: 0
bit 0 (0×01): CS_DATA_NOCHAR
bit 1 (0×02): CS_DATA_NOVCHAR
bit 2 (0×04): CS_DATA_NOBIN
bit 3 (0×08): CS_DATA_NOVBIN
bit 4 (0×10): CS_DATA_NOMNY8
bit 5 (0×20): CS_DATA_NOMNY4
bit 6 (0×40): CS_DATA_NODATE8
bit 7 (0×80): CS_DATA_NODATE4

byte 6: (92)
default ctlib value: 0
bit 0 (0×01): unknown
bit 1 (0×02): CS_RES_NOMSG
bit 2 (0×04): CS_RES_NOEED
bit 3 (0×08): CS_RES_NOPARAM
bit 4 (0×10): CS_DATA_NOINT1
bit 5 (0×20): CS_DATA_NOINT2
bit 6 (0×40): CS_DATA_NOINT4
bit 7 (0×80): CS_DATA_NOBIT

Bulk Copy
———

BCP Data Format

Major Forecasting Upgrade for SugarCRM with 6.7.0 Release at SugarCON 2013

provident — Sun, 14 Apr 2013 02:45:24 +0000

Hot off the press at SugarCON 2013, we are excited to blog about the new features including Enhanced forecasting and supercharged import, and RacerX theme as standard. We have also included below some instructions on how to setup the new forecasting module and also a complete list of bugs fixed in SugarCRM 6.7.0

Forecasting Enhancements

Sugar 6.7.0 features the first phase of the new Forecasting module which includes the following:

Sales representative worksheet : This worksheet contains all Opportunities assigned to the user based on the time period and the Opportunity close date. As a Sales representative, you have the ability to:
- Navigate between time periods to view previous and past opportunities
- Choose to include or exclude each opportunity in the forecasting worksheet
- In-line edit opportunity amounts and probabilities
- Save drafts or commit numbers to your manager
- View previous commits within the time period in the commit log
- Filter information based on time period and forecast range
Sales manager worksheet : This worksheet displays managers’ direct reports’ committed numbers and opportunities as well as the manager’s opportunities. As a Sales manager, you have the ability to:
- Work with your own opportunity records and committed numbers
- Create adjusted numbers based on the committed numbers from direct reports
- Drill down to all the worksheets and opportunities of the employees in your management chain
- Navigate between time periods to view previous and past forecasts and opportunities
- Assign quotas to your reportees for each time period
- Save drafts or commit worksheet numbers to your manager
- View recently updated records and monitor changes to numbers in the commit log
Intelligence pane : Located on the right side of the Forecasting pages, this pane displays additional information such as:
- Projected table : Enables users to assess their numbers and pipeline in comparison to their quota and projected wins. This table is useful to play out what-if scenarios when assessing what is needed to achieve their quota.
- Charts : Visual representation for one’s personal opportunities or, in the case of a manager, one’s team’s committed numbers. The totals are compared to the quota in both the cases which enables users to assess their progress.
Administration : Before the Forecasting module may be use, an administrator user makes several configurations via Admin > Forecast:
- Time Periods : Quickly define forecasting time periods to match your organization’s fiscal year and frequency of quota cycles. Control the number of past and future time periods users may access.
- Ranges : Specify the opportunity probabilities which will cause opportunities to be initially included or excluded on forecasting worksheets.
- Scenarios : Specify if you wish to have opportunity records’ Best Case and/or Worst Case fields available on the forecast worksheets.

Please note that user roles are only able to allow or deny access to the entire Forecasts module. Module and field-level role restrictions for Opportunities, Products, Quotas, Worksheet and TimePeriod modules are not respected in the Forecasts module.

For more information, please refer to the Forecasts documentation in the Application Guide and the Forecast Configuration documentation in the Administration Guide.

Miscellaneous Changes

Additional changes in Sugar 6.7.0 include, but are not limited to, the following:

New RacerX theme : The Classic theme has reached end of life. Instances with “Classic” as the default theme will automatically use the RacerX theme after upgrade.
Improved import performance : Improved import functionality to speed up processing of data.

Known Issues

The following are known issues with Sugar 6.7:

Sorting by opportunity names starting with the same letter in an upper or lower case may result in a different order in the Forecasts module than in the Opportunities module. Associated defect: 61026
Instances utilizing the Pardot integration will need to upgrade to the latest Pardot release (version 35 or later) which is available here.
Renaming the Forecasts module in Admin > Rename Modules does not affect all instances of the word “Forecast”. Associated defect: 59213
Sales managers’ “No Opportunities” checkbox available in User Profile > Advanced is not respected in the Forecasts module. Checking this box will not prevent the user from seeing a row and a worksheet for their own opportunities. Associated defect: 59109
The Forecasting module is not available in Offline Client version 6.7.0. Associated defect: 59189
Exporting opportunity worksheets from the Forecasts module will export all of the current opportunities without respecting any filters being used. Associated defect: 61233
After an opportunitiy is first loaded to the Forecasts module, any updates to the opportunity’s probability will no affect its forecasting range. The opportunity will retain the original range designation throughout the sales cycle according to its original probability. Associated defect: 61232

Overview

Sugar’s Forecasts module incorporates opportunity records to build forecasting worksheets and predict sales. Users can work towards sales quotas at the individual, team, and sales organization level.

Before users can access the Forecasts module to begin building forecasting worksheets, a user with administrator access must configure the Forecasts module with the organization’s desired Time Periods, Ranges, and Scenarios. For more information on setting up the Forecasts module, please refer to the Forecast Configuration documentation in the Administration Guide.

Sales representatives use the Forecasts module to work with their assigned opportunities as the current time period progresses. These users will commit total predictions for their personal sales based on the opportunities they expect to close. For instructions specific to a sales representative’s use of the module, please refer to the Sales Representative section of this documentation.

Sales managers work with their own opportunity records similarly to other sales representatives. In addition, they aggregate their reportee’s committed forecast amounts to predict their total team’s sales and work towards the team’s quota for each time period. For instructions specific to a sales manager’s use of the module, please refer to the Sales Managerssection of this documentation.

Additional insights are offered by the elements of the expandable Intelligence Pane including analysis for an individual’s opportunities worksheet and analysis for a manager’s team worksheets. For more information, please refer to the sales representative Intelligence Pane and the sales manager Intelligence Pane sections of this documentation.

Forecast Fields

The Forecasts module contains the following fields which enable users to work with opportunity records to forecast sales for a given time period:

Field	Description
Forecast	“Included”, “Excluded”, or “Upside” (optional) based on the opportunity’s initial probability and the user’s edits; controls whether the opportunity is counted in the forecast’s totals and allows for filtering; can be edited in-line from the Forecasts module
Name	The opportunity’s name; can be edited from the Opportunities module
Expected Close	The opportunity’s expected date of completion; used to aggregate opportunities to the relevant time period; can be edited from the Opportunities module
Stage	The opportunity’s current sales stage; can be edited from the Opportunities module
Probability	The opportunity’s current probability of being won; can be edited in-line from the Forecasts module
Likely Case	The opportunity’s Opportunity Amount field; can be edited in-line from the Forecasts module
Best Case	(Optional) The opportunity’s most optimistic total amount; can be edited in-line from the Forecasts module
Worst Case	(Optional) The opportunity’s least optimistic total amount; can be edited in-line from the Forecasts module

Forecasts Module Tab

The Forecasts module tab is typically located under the More tab on the navigation bar at the top of any Sugar screen to the right of the home cube icon. Depending on your settings, you may have to click “Show More” in order to see the Forecasts module tab. Click the tab to access the Forecasts module. A user with administrator access must first configure the Forecasts module before it can be accessed and used. For more information on setting up the Forecasts module, please refer to the Forecast Configuration documentation in the Administration guide.

If you do not see the Forecasts module tab in Sugar, please check the following:

The top navigation bar may be filtered based on a specific tab grouping (i.e. Activities, Reports, etc.) of which the Forecasts module is not a member. Click the More tab (last tab on navigation bar) then hover on “Filter Menu By” to check how the navigation bar is grouped. For more information on tab grouping, please refer to the User Interface documentation.
The Forecasts module may be marked as hidden in your user preferences which will prevent the module tab from being displayed. Navigate to your user profile (upper right of Sugar), click the Advanced tab, and check the Layout Options section. If you see the Forecasts module in the Hide Modules list, simply move it to the Display Modules list. For more information on hiding and displaying modules, please refer to the Layout Options section of the Getting Started documentation.
The administrator may have disabled the Forecasts module for your entire Sugar instance. Reach out to your Sugar administrator to have the Forecasts module displayed. For more information on displaying and hiding modules throughout Sugar, please refer to the Developer Tools documentation in the Administration guide.

Forecast Actions

Forecast actions are available at the top of the Forecasts module page and allow users to perform the following operations:

Menu Item	Description
Save Draft	Saves changes to the user’s opportunities worksheet but does not make these changes available to the user’s manager
Commit	Saves changes to the current worksheet and pushes these changes to the user’s manager’s team worksheet or, in the case of a manager committing a personal opportunities worksheet, to his or her own team worksheet
Export CSV	Exports the rows of the current forecasts worksheet
Settings	For users with administrator access, opens the Forecast Configurations wizard
Print	Prints everything currently displayed on your Forecasts page including the worksheet and, if displayed, elements of the Intelligence Pane

Sales Representatives

When you access the Forecasts module as a sales representative, you will see your name at the top left of the screen. Sales representatives who do not have any reportees will only be able to see and work with his or her own opportunities. Below your name, you will see a time period selection, summary and commit history, filter, andopportunities worksheet. On the right side of each page is an expandable Intelligence Pane which offers additional insight into your forecasting worksheet.

Time Periods

Below your name, you will see the current time period for which you are forecasting opportunities to meet a quota. The length and start date of this time period depends on the Time Periods configuration set up by your administrator. Clicking the arrow to the right of the current time period allows you to choose a future or past time period, the availability of which is also determined by the administrator’s Time Periods configuration. Select a past or future time period to work with opportunities and forecast for those periods.

Summary & Commit History

To the right below the Time Period selection, you will see a summary of your current forecasting numbers for the time period currently in view. The large numbers are your current opportunities worksheet’s Likely, Best, and Worst Case predictions. The smaller numbers show your most recent commit’s Likely, Best, and Worst Case predictions. Any red or green arrows next to the large numbers show whether you worksheet’s current (uncommitted) numbers are higher or lower than your most recent commit. Please note that you may or may not see a Best Case and Worst Case depending on your administrator’s Scenarios configuration.

To the left of these summary numbers, you will see the date and time of your most recent commit. There will be no date and time shown if you have not yet committed for this time period. By clicking the arrow to the right of the latest commit date, a dark grey panel will appear showing a history of your commits for this time period along with the changes for each forecasting number from the previous commit.

Filters

Below the summary and commit history, you will see a filter bar which controls what kinds of opportunities are displayed. By default, the “Include” filter will be active, meaning that only the opportunities with a probability falling within the Include range specified during the administrator’s Ranges configuration will be displayed. To add additional filters, click the arrow to the right of the Filters bar and choose additional ranges. Please note the Upside range may or may not be available depending on the administrator’s Ranges configuration. When the Upside range is not available, the Forecast column will display checkbox icons rather than words with the checked box representing “Include” and the unchecked box representing “Exclude”. To remove ranges from the filter, click the “x” for each filter name. Removing all filters will display all of your assigned opportunities.

Opportunities & Totals

Based on the chosen filters, you will see all or some of your assigned opportunities for the currently selected time period listed below the Filters bar. The Forecast column displays an automatic category indicating whether or not the opportunity’s amounts are included in the totals for this time period; this designation can be changed manually. You can work directly with your opportunity records by in-line editing their probabilities and amounts from the Forecasts module or by clicking the Name field to open a record in the Opportunities module where you can make additional edits.

At the bottom of the opportunities list, “Included Total” provides the total amounts for all of your opportunities within this time period marked as “Include” in the Forecast column. The “Overall Total” shows the total amounts regardless of each opportunity’s designation in the Forecast column.

Note: If an administrator configures the Opportunities module’s dropdown options for the Sales Stage field to remove “Closed Won” and “Closed Lost”, the Forecasting module will sum all opportunities when calculating totals.

Editing Forecast Inclusion

The first time an opportunity is loaded to a opportunities worksheet, Sugar will assign it a category of either “Include”, “Exclude”, or “Upside” (optional) based on the Ranges configured by your administrator. Opportunities with a higher probability of being won are typically assigned to the Include range while those with a lower probability of being won are designated for the Exclude range. If your administrator has chosen to use the Upside range, this will usually consist of opportunities with a middle-level probability. If the administrator has chosen to not use the Upside range, the Forecast column will display checkbox icons rather than words with the checked box representing “Include” and the unchecked box representing “Exclude”.

You may wish to alter the category automatically assigned to your opportunities by these adminstrator-configured ranges especially as each opportunity moves forward in the sales process and becomes more likely to be won. To do this, simply click on the opportunity’s current category or checkbox in the Forecast column and choose the desired category from the dropdown menu or click the checkbox to be checked or unchecked.

Changing a opportunity’s Forecast column to “Include” will cause its Likely, Best, and Worst Case fields to be added to your totals while choosing “Exclude” will remove the opportunity’s numbers from your totals. Changing which opportunities are included on your worksheet requires you to save a draft or commit in order to preserved.

Note: Opportunities in a Closed Won stage will be included in the opportunities worksheet and cannot have their Forecast column altered. Opportunities in a Closed Lost stage will be excluded from the opportunities worksheet and cannot have their Forecast column altered.

Editing Opportunity Fields

In addition to editing the inclusion, you can make in-line changes to each opportunity’s fields including Probability, Likely Case, Best Case, and Worst Case. To do so, simply click any field which shows a pencil icon when being hovered over, and enter the new amount. Keep in mind that your worksheet may or may not include “Best Case” and “Worst Case” amounts depending on your administrator’s Scenarios configuration.

Clicking outside the text box or pressing Enter/Return will save your change to the line and update the worksheet’s totals, summary, and Intelligence Pane. Clicking the Save Draft or Commit button will also update the opportunity records themselves and make your changes visible when viewing the opportunity in other places in Sugar. Saving a draft or committing is also required to preserve these changes to your opportunities worksheet and, in the case of committing, make the changes visible in your manager’s Forecasting module.

Note: You will not be able to edit any fields for opportunities in a Closed Lost or Closed Won stage from your worksheet, but they may be edited from the Opportunities module.

Currency Support

If you use a currency different from your Sugar instance’s default currency, your opportunity Likely, Best, and Worst Case amounts will be displayed in the system’s default currency in the Forecasting module. Clicking to edit these amount values will, however, display and allow for editing in your chosen currency.

Intelligence Pane

To the right of the opportunities worksheet you will find an expandable Intelligence Pane which provides additional insights for planning and forecasting. If the pane is hidden, click the double-arrow button to expand it. Clicking the button again will hide it when you wish to see your worksheet at full width.

Projected Table

The Projected table appears in the top of the Intelligence Pane and gives a breakdown of how your opportunities match up to your quota as well as insight into your current pipeline. Keep in mind that your Projected table may or may not include “Best Case” and “Worst Case” amounts depending on your administrator’s Scenarios configuration.

The projected table’s values are calculated based on the most recent updates to your opportunities worksheet even if the changes have not yet been saved as a draft or committed. The values take all of your opportunities into account regardless of any filters currently being used in your worksheet. Their meanings are as follows:

Field	Description
Quota	Your personal quota for this sales time period as assigned by your manager
Likely above/below Quota	The difference between your included opportunities’ Likely Case amounts and your quota as well as the corresponding percentage
Best above/below Quota	(Optional) The difference between your included opportunities’ Best Case amounts and your quota as well as the corresponding percentage
Worst above/below Quota	(Optional) The difference between your included opportunities’ Worst Case amounts and your quota as well as the corresponding percentage
Closed	The total amount of your Closed Won opportunities
Likely above Closed	The difference between your included opportunities’ Likely Case amounts and your Closed Won total as well as the corresponding percentage
Best above Closed	(Optional) The difference between your included opportunities’ Best Case amounts and your Closed Won total as well as the corresponding percentage
Worst above Closed	(Optional) The difference between your included opportunities’ Worst Case amounts and your Closed Won total as well as the corresponding percentage
Pipeline Opportunities	The number of your in-progress included and excluded opportunities which are not yet in a Closed Won or Closed Lost stage
Pipeline Revenue	The total Likely Case amounts of your in-progress included and excluded opportunities which are not yet in a Closed Won or Closed Lost stage
Pipeline Size	The ratio of your in-process opportunities’ total to your “Included” opportunities’ total; a progressive gauge of how much more business is available for you to bring in for this time period: a higher number indicates many more opportunities are available to be pursued and included on your forecast while a lower number indicates you are nearing the end of your available opportunities

Chart

The bottom of the Intelligence Pane provides a configurable chart showing different cuts of your forecasting data over the course of the selected time period. Each opportunity’s Expected Close Date field determines in which sub-period it appears. Only the opportunities currently appearing on your worksheet will appear in your chart meaning that the chart is also respecting your current filters. Throughout all chart configurations, the dotted black line represents your quota for the given time period and can be hovered over to view the quota amount.

Click the gear icon to configure what is displayed in the chart.

When “Likely” is chosen, each purple point represents the total Likely Case amounts for all opportunities regardless of stage or inclusion in the forecast for that month and any previous months falling within the time period. Choosing “Best” or “Worst” shows the same points using the opportunities’ Best Case or Worst Case amounts instead. A purple line connects these points showing the change in your possible cumulative opportunity amounts. Please note that you may or may not see “Best” and “Worst” as options depending on your administrator’s Scenarios configuration.

Choosing “Included in Forecast” in the chart configuration will show bars representing the Likely Case amounts for your opportunities with expected close dates in each sub-period color coded by whether the opportunities are included in or excluded from your opportunities worksheet.

Choosing “Sales Stage” in the chart configuration will show bars representing the Likely Case amounts for your opportunities with expected close dates in each sub-period color coded by the opportunities’ sales stage.

Choosing “Probability” in the chart configuration will show bars representing the Likely Case amounts for your opportunities with expected close dates in each sub-period color coded by the opportunities’ probabilities.

Note: Changes to your opportunities worksheet will need to be saved as a draft or committed before they will be reflected in the chart, however current filters in your worksheet will control what opportunities are included in the chart.

Sales Managers

When you access the Forecasts module as a sales manager, you will see your name at the top left of the page along with an arrow which allows you to drill down into your personal opportunities worksheet, your team worksheet, and your reportee’s opportunities worksheets hierarchically. While working with your personal opportunities worksheet works similarly to how a regular sales representatives works with their opportunities, you will also have options such as time period selection, summary and commit history, and filters when working with your team worksheet and your reportees’ forecasting data. On the right side of each page is an expandable intelligence pane which offers additional insight into your forecasting worksheet.

Forecast Drilldown

Because sales managers are able to see and work with their reportee’s opportunities in addition to their own, these users will see an arrow next to their name at the top left of the Forecasts module. This allows them to drill into team forecasting data and individual sales representatives’ opportunities. By default, Aaron will enter the Forecasts module viewing his team worksheet which includes the total committed amounts and quotas for each immediate reportee and himself.

Own Opportunities

As a manager, Aaron can see and work with his own opportunities by selecting “Opportunities (Aaron Johnson)” from the menu next to his name or from the Name column in his team worksheet below.

While working with his own opportunities, he will have the same options on his opportunities worksheet as a regular sales representative has. For more information on working with a manager’s opportunities worksheet, please refer to the Opportunities & Totals section of this documentation. Aaron will need to commit his new opportunities or changes to his opportunities on his opportunities worksheet before the amounts will be reflected on his team worksheet.

Reportee’s Opportunities

Since Aaron is Ellen’s manager, Aaron also has the ability to work with Ellen’s committed forecast and opportunities. He can navigate to her committed opportunities worksheet by selecting “Ellen Smith” from the menu next to his name or from the Name column in his team worksheet below.

While viewing his reportee’s opportunities worksheet, Aaron will not be able to edit any of the opportunities’ amounts or probabilities. He is able to filter for various ranges, change the time period, and view Ellen’s summary and commit history for each time period.

Team Worksheet

Aaron can return to his team worksheet by choosing his own name from the Drilldown menu.

While viewing his team worksheet, he has the ability to set each team member’s quota as well as to set adjusted Likely, Best, and Worst Case amounts. Please note that your worksheets may or may not include “Best Case” and “Worst Case” amounts depending on your administrator’s Scenarios configuration. To edit an adjusted amount or quota, click on the number, enter a new value, and click outside the text box or press Return/Enter. Clicking “Save Draft” will preserve these changes in the worksheet but will not push the changes to other Sugar users. Upon clicking “Commit”, these adjusted amounts will be pushed to Aaron’s manager thus appearing in Joy’s worksheet as his committed amounts. Any changes to quotas will also be pushed to his reportee’s worksheets.

From the team worksheet, managers will see an “i” icon on the far right of each row where there are newly committed changes. Clicking the “i” opens the most recent commit history for that team member.

Note: Although it is possible for Aaron to set or alter his own personal quota, it is recommended that intermediate managers not make changes to their personal quota. Rather, Aaron’s manager, Joy, should set the quota for his entire team from her team worksheet.

Management Hierarchy

The ability to drill into a reportee’s team worksheet and opportunities continues up the management chain. Joy is Aaron’s manager and views her own team worksheet by default when first opening the Forecasts module. She is also able to drill into her own opportunities by clicking “Opportunities (Joy Miller)”, Aaron’s team worksheet by clicking his name, or her other reportee’s team worksheet.

When Joy navigates to her reportee Aaron’s team worksheet, Aaron’s name now appears and his team worksheet is displayed in read-only mode. Joy can further drill down to see the opportunities worksheets of Aaron’s team’s members in read-only mode. This drilling can continue recursively down through the management chain as needed. Clicking “Parent” will move up one level of hierarchy, bringing Joy back to her own team worksheet.

Time Periods

Below the currently selected drilldown name, you will see the time period for which you are forecasting to meet the time period’s quota for your team. The length and start date of this time period depends on the Time Periodsconfiguration set up by your administrator. At every level of drilldown, sales managers can click the arrow to the right of the current time period and choose a future or past time period, the availability of which is also determined by the administrator’s Time Periods configuration. Select a past or future time period to work with opportunities and forecast for those periods.

Summary & Commit History

To the right below the Time Period selection, you will see a summary of the current forecasting numbers for the time period and drilldown level currently in view. The large numbers are the forecasting worksheet’s Likely, Best, and Worst Case predictions. The smaller numbers show the most recent commit’s Likely, Best, and Worst Case predictions. Any red or green arrows next to the large numbers on a manager’s personal opportunities worksheet or own team worksheet show whether your worksheet’s current (uncommitted) numbers are higher or lower than the most recent commit. Please note that you may or may not see a Best Case and Worst Case depending on your administrator’s Scenarios configuration.

To the left of these summary numbers, you will see the date and time of the most recent commit. On a manager’s personal worksheet and own team’s worksheet, there will be no date and time shown if you have not yet committed for this time period. By clicking the arrow to the right of the latest commit date, a dark grey panel will appear showing a history of the commits for the worksheet currently in view for this time period along with the changes for each forecasting number from the previous commit.

Filters

Below the summary and commit history of each opportunities worksheet, managers will see a filter bar which controls what kinds of opportunities are displayed. By default, the “Include” filter will be active, meaning that only the opportunities with a probability falling within the Include range specified during the administrator’sRanges configuration will be displayed. To add additional filters, click the arrow to the right of the Filters bar and choose additional ranges. Please note the Upside range may or may not be available depending on the administrator’s Ranges configuration. When the Upside range is not available, the Forecast column will display checkbox icons rather than words with the checked box representing “Include” and the unchecked box representing “Exclude”. To remove ranges from the filter, click the “x” for each filter name. Removing all filters will display all of your assigned opportunities. Please note that when viewing your reportee’s opportunity worksheets, only the opportunities they have committed as included will be visible.

Intelligence Pane

To the right of the forecasting worksheet you will find an expandable Intelligence Pane which provides additional insights for planning and forecasting. If the pane is hidden, click the double-arrow button to expand it. Clicking the button again will hide it when you wish to see your worksheets at full width.

Projected Table

The Projected table appears in the top of the Intelligence Pane and gives a breakdown of how the current drilldown’s worksheet totals match up to that worksheet’s quota as well as insight into the pipeline relevant to that worksheet. Keep in mind that your Projected table may or may not include “Best Case” and “Worst Case” amounts depending on your administrator’s Scenarios configuration.

When viewing your own team worksheet and own opportunities worksheet, the Projected table’s values are calculated based on the most recent updates even if the changes have not yet been saved as a draft or committed. The exception to this is changes to your or your reportee’s quotas – these changes must be committed prior to appearing in the Projected table. The values take all of your opportunities into account regardless of any filters currently being used in your worksheet. Their meanings are as follows:

Field	Description
Quota	The worksheet’s quota for this sales time period
Likely above/below Quota	The difference between the worksheet’s included opportunities’ Likely Case amounts and the worksheet’s quota as well as the corresponding percentage
Best above/below Quota	(Optional) The difference between the worksheet’s included opportunities’ Best Case amounts and the worksheet’s quota as well as the corresponding percentage
Worst above/below Quota	(Optional) The difference between the worksheet’s included opportunities’ Worst Case amounts and the worksheet’s quota as well as the corresponding percentage
Closed	The total amount of the worksheet’s Closed Won opportunities
Likely above Closed	The difference between the worksheet’s included opportunities’ Likely Case amounts and the worksheet’s Closed Won total as well as the corresponding percentage
Best above Closed	(Optional) The difference between the worksheet’s included opportunities’ Best Case amounts and the worksheet’s Closed Won total as well as the corresponding percentage
Worst above Closed	(Optional) The difference between the worksheet’s included opportunities’ Worst Case amounts and the worksheet’s Closed Won total as well as the corresponding percentage
Pipeline Opportunities	The number of the worksheet’s in-progress included and excluded opportunities which are not yet in a Closed Won or Closed Lost stage
Pipeline Revenue	The total Likely Case amounts of the worksheet’s in-progress included and excluded opportunities which are not yet in a Closed Won or Closed Lost stage
Pipeline Size	The ratio of the worksheet’s in-process opportunities’ total to the “Included” opportunities’ total; a progressive gauge of how much more business is available to be brought in for this time period: a higher number indicates many more opportunities are available to be pursued and included on the forecast while a lower number indicates nearing the end of the available opportunities

Chart

The bottom of the Intelligence Pane provides a configurable chart showing different cuts of your team members’ forecasting data. Throughout all chart configurations, the dotted black line represents your quota for the given time period and can be hovered over to view the quota amount.

While viewing your or a reportee’s opportunities worksheet, the charts will display the relevant opportunities over the course of the selected time period. In these views, the charts function in the same way as they do for support representatives without reportees. For more information on the meanings and configuration of the chart while viewing your or a reportee’s opportunities worksheet, please refer to the Chart section within the Sales Representative section of this documentation.

While viewing your or a reportee’s team worksheet, the charts will display the current worksheet’s totals in bars grouped according to user. Throughout all chart configurations, the dotted black line represents the worksheet’s quota for the given time period and can be hovered over to view the quota amount.

Click the gear icon to configure what is displayed in the chart.

When “Likely” is chosen, each green bar represents the total committed Likely Case amount for each user within the current team worksheet. Each red bar represents the total adjusted Likely Case amount for each user. The users are ordered from left to right by their adjusted Likely Case amounts in decreasing order. The green dots show the cumulative Likely Case total of the team built user-by-user from left to right with the rightmost point representing the total Likely Case amount for the entire team. The red dots do the same using the adjusted Likely Case team total.

Choosing “Best” shows similar chart elements except that the Best Case and adjusted Best Case amounts are used. Choosing “Worst” does the same with Worst Case and adjusted Worst Case amounts. Please note that you may or may not see “Best” and “Worst” as options depending on your administrator’s Scenariosconfiguration.

Note: Changes to the forecasting worksheet will need to be saved as a draft or committed before they will be reflected in the chart.

Saving Forecast Drafts

Whenever new information is added or changes are made to your current forecasting worksheet, the Save Draft button will become activated. Click this button to save your changes to the current worksheet without submitting these changes to your manager. This provides an opportunity to work with your forecast data before pushing more finalized amounts up the management chain. Clicking “Save Draft” will also cause any changes to your personal opportunities’ amounts and/or probability to alter the opportunity record itself, making these new numbers visible on the opportunity in other areas of Sugar.

Committing Forecasts

Whenever new information is added or changes are made to your current forecasting worksheet, the Commit button will become activated. Click this button to save your changes to the current worksheet and to submit these changes to your manager or to the team worksheet if you are a manager working on your personal opportunities worksheet. Clicking “Commit” will also cause any changes to your personal opportunities’ amounts and/or probability to alter the opportunity record itself, making these new numbers visible on the opportunity in other areas of Sugar.For sales managers, changes to your reportees’ quotas will not appear in their Forecasts module you perform a commit. Changes to your and your reportee’s quotas will also not be reflected in the Projected table of the Intelligence Pane until you perform a commit.

Exporting Forecasts

The Export option is available on every forecasting page and exports every line of the current worksheet. Sugar will export all opportunities belonging to an opportunities worksheet without regard to any filters currently being used to hide opportunities. The resulting CSV file can be used in other programs such as Microsoft Excel to view and manipulate your forecasting data. To export your current worksheet, click “Export CSV” in the Actions menu.

Configuring Forecasts

Users with administrator access will have a Settings option available within the Forecasts module. Choosing “Settings” will open the Forecast Configuration wizard which is also available by navigating to Admin > Forecasts. For more information on configuring the Forecasts module, please refer to the Forecast Configuration documentation in the Administration Guide.

Printing Forecasts

The Print option is available on every forecasting worksheet and prints everything currently displayed on the page. If any filters are being used in the worksheet, only the displayed rows will be printed. Likewise, the Projected table and Chart will only be printed if the Intelligence Pane is currently visible. To print your current page, select “Print” from the dropdown Actions menu.

Configuring Forecasts

Administrator users can access the Forecast configuration settings by navigating to the Administration page and clicking the Forecasts link.

As an alternative, administrators can also access the Forecast configuration settings by navigating to the Forecasts module. Clicking the Forecasts module tab before the module has been configured will automatically redirect administrators to the configuration wizard. After the module has been configured, they are able to choose “Settings” from the Actions menu within the Forecasts module to review their configuration selections and potentially make changes. For more information on making changes to the configuration, please refer to theEditing Forecast Configurations section of this documentation.

The Forecasts Setup wizard will guide you through the various configuration items.

Note: The Forecast Time Periods cannot be changed after initial setup without losing all existing Forecast data. The Forecast Ranges cannot be changed after the first Save Draft or Commit action in the Forecasts module. In order to make changes later, please refer to the Editing Forecast Configurations section of this documentation.

Time Periods

The Time Periods tab allows you to match the Forecasts module’s fiscal year and frequency of quota cycles to your organization’s practices. These settings will control the beginning and duration of your forecasting time periods as well as control the number of past and future time periods users may access.

Use the following steps to configure Forecast Time Periods:

Select the Time Period type which matches your sales organization’s practices. Choose “Yearly” if your sales organization has quarterly quotas which build up to a yearly goal. Choose “Quarterly” if you operate with monthly goals building to quarterly goals instead.
Click the calendar icon to select the start day and month of your organization’s fiscal year from the date picker.
Note: It is not recommended to choose February 29th, though this is possible to do during a leap year. If this date is chosen, non-leap years will have fiscal year start date of March 1st.
Select how many future time periods users will be able to view in their forecast worksheets. This is the number of base Time Periods (years or quarters) as opposed to the sub-periods (quarters or months).
Select how many past time periods users will be able to view in their forecast worksheets. This is the number of base Time Periods (years or quarters) as opposed to sub-periods (quarters or months).
Click “Next”.

Note: The Forecast Time Periods cannot be changed after initial setup without losing all existing Forecast data. In order to make changes after initial setup, please refer to the Editing Forecast Configurations section of this documentation.

Ranges

Forecast Ranges are a method of predefining what opportunity records should likely be included on forecasts and which should not. As the administrator, you will specify the opportunity probabilities which will cause opportunities to be initially included on a user’s forecast. Each user, however, can then manually choose to include or exclude their opportunities no matter how the probabilities line up with these ranges.

In addition to initially including opportunities, these ranges will also be available to users in the Forecasts module as categories for filtering or for grouping in charts.

Choose the Two Ranges radio button for a simple include or exclude model. You will then drag the left slider to specify the minimum opportunity probabilities that qualify an opportunity to be initially included on forecasts. In this two-range model, all opportunities with probabilities falling below the defined range will be initially excluded from forecasts. Choosing “Two Ranges” will cause the categories “Include” and “Exclude” to be available for users in the Forecasts module for filtering opportunities or grouping them in charts.

Choose the Three Ranges radio button to enable an intermediate range. Drag the left Include slider to specify the minimum opportunity probabilities that qualify an opportunity to be predefined as included on forecasts. Then use the Upside sliders to define the range of opportunity probabilities which will be initially excluded from forecasts but which can be viewed independently for consideration for inclusion by the user. All opportunities with probabilities falling outside these two ranges will also be predefined as excluded from forecasts. Choosing “Three Ranges” will cause the categories “Include”, “Upside”, and “Exclude” to be available for users in the Forecasts module for filtering opportunities or grouping them in charts.

Once you are satisfied with your range selections, click “Next”.

Note: The Forecast Ranges cannot be changed after the first Save Draft or Commit action in the Forecasts module without losing all existing Forecast data. In order to make changes after initial setup, please refer to the Editing Forecast Configurations section of this documentation.

Scenarios

The Scenarios tab allows you to specify if you wish to have opportunity records’ Best Case and/or Worst Case fields available on the forecast worksheets. The “Likely” scenario is included automatically because it matches the opportunity record’s required Opportunity Amount field. When “Best” and “Worst” are also selected, users will have the ability to view and modify these additional opportunity values based on their opinion of what values may come about in the sale. This provides a broader range possible sales information when working to make forecasts as predictive as possible. Select the Best and/or Worst checkboxes to enable each in the Forecasts module.

Once you are satisfied with your range selections, click “Finish”.

Note: The Forecast Scenarios configurations may be changed at any time following initial setup by returning to the Admin > Forecasts page.

Editing Forecast Configurations

Once the Forecast Configurations have been completed, Sugar will apply the selected options and do an initial load of opportunities to the Forecasts module. The selected Time Periods are locked at the completion of the Forecast Configuration wizard, and the Ranges are locked once the first Save Draft or Commit action is performed within the Forecasts module. If, at a later time, the selections you made for Time Periods and Ranges need to be changed, the only way this can be accomplished is at the expense of any existing Forecasting data.

Should you choose to lose all forecasting worksheets for the current, past, and previous time periods, a user with administrator access can navigate to:
/index.php?module=Forecasts&action=ResetSettings

Please take caution: navigating to the above URL will remove reset your Forecasts module to as if it had never been used before in addition to enabling you to make fresh selections for all elements within the Forecasts Configuration by navigating to Admin > Forecasts. Your instance’s opportunity records will not be affected.

Supported Platforms

For information on supported platform components, see Sugar 6.7.x Supported Platforms.

Fixed Issues

Below is a complete list of all issues & bugs fixed in SugarCRM 6.7.0 as well as new features:

Number	Found In Release	Name	Priority	Type	Product Category	Last Modified
32064	5.2.0f	Setting a relationship between ProductBundles and Quotes or Products and ProductBundles results in a PHP fatal error	High	Defect	SOAP	03/13/2013 17:12
45395	6.2.0	Deleted emails from a group inbox does not move the emails to the Trash folder for Google Apps	Medium	Defect	Emails	11/19/2012 19:30
47085	6.3.0-Beta6	SI Performance: SubPanelDefinitions::get_available_tabs() takes too long	Urgent	Defect	Performance	01/03/2013 22:13
54512	6.7.0	Problem seeing the drop down in Forecast column	Medium	Defect	Forecasting	07/25/2012 21:53
55219	6.5.0	Defining your own custom Job class requires non-logical customization to be made	High	platform	Schedulers	11/06/2012 13:52
55224		Improve file handling in the application	High	platform	Platform	11/29/2012 01:08
55273	6.7.0	Date invalid on FF browser for commit log	Medium	Defect	Forecasting	08/10/2012 23:14
55526	6.7.0	Tree needs to be fixed to show Opportunities (MgrName) even when the manager has no opportunity	Medium	Defect	Forecasting	08/21/2012 17:08
55611		Use str_format to correctly display formatted strings	Medium	Task		08/21/2012 13:29
55653		refactor forecasts view to be forecasts	Medium	Task	Forecasting	08/22/2012 21:14
55661	6.7.0	Installation of SugarCRM is broken at the part of data population	QABlocked	Defect	Forecasting	08/21/2012 18:47
55669		Currency Bean has mysql specific method calls	Medium	Task	Currencies	08/21/2012 20:15
55732	6.7.0	commit_stage column is shown in sales rep worksheet, even when show_buckets is set to false	Medium	Defect	Forecasting	11/19/2012 18:57
55756	6.7.0	forecastsCommitted re-render causes timeframes field to render the incorrect value.	Medium	Defect	Forecasting	11/08/2012 22:55
55789	6.7.0	Switching from manager worksheet to reporting sales rep worksheet and back makes all numbers in the project panel disappear	High	Defect	Forecasting	08/27/2012 18:57
55804	6.7.0	Not able to install Sugar forecasting build with demo data on Stack 63	Urgent	Defect	Forecasting	08/30/2012 22:03
55816		Opportunity SaveOverload.php Uses Currency Method that is Deprecated	Medium	Task	Forecasting	08/27/2012 14:36
55817	6.7.0	Format TimePeriodTest.php to conform to coding standards	Medium	Task	Forecasting	08/27/2012 14:21
55821	6.7.0	Sales Rep Worksheet Include In forecast checkbox is disabled for opp owner	Urgent	Defect	Forecasting	10/11/2012 22:46
55827	6.7.0	Popup on manager worksheet indicating the FIRST commit is done by NEW sales reps appears empty	High	Defect	Forecasting	08/29/2012 18:31
56000	6.6.0	TMI from the portal config settings on the public API	Urgent	Defect	Mambo Portal	10/08/2012 22:49
56200	6.7.0	Buckets on: sales manager does not see the list of opportunities for sales rep.	QABlocked	Defect	Forecasting	09/11/2012 18:42
56309		Ability to customize the label used in time ago…	Medium	enhancement	Sidecar	11/14/2012 23:38
56331	6.7.0	Opportunity get excluded from forecast right after commit button is pressed	Urgent	Defect	Forecasting	09/11/2012 21:56
56341		Enable Contracts Module for Importing by Default	Medium	enhancement	Import	01/22/2013 19:41
56361	6.7.0	My Forecasts dashlet should be revisited to make sure it works with new Forecasting module	Medium	Defect	Forecasting	11/08/2012 22:42
56383		Mobile views don’t pick up their base object view defs	RelBlocked	Task	Platform	11/29/2012 23:33
56391		Incorrect ACLs for Employees and Users module	Urgent	Task	Platform	12/07/2012 15:03
56455	6.7.0	Currency conversion is broken on forecasts module if change 1000s separator to “.” and Decimal Symbol to “,” in the user prefs.	High	Defect	Forecasting	09/25/2012 01:29
56458		REST API: Fetch system settings	RelBlocked	Task	Platform	02/27/2013 17:59
56505		Incorrect format for propetry “default” in multiselect field’s vardef	High	Task	Platform	11/30/2012 02:18
56665	6.6.0	Sidecar components are evaled and therefore very difficult to debug	Urgent	Defect	Sidecar	10/24/2012 23:31
56699		REST API Metadata: Incorrect format for list of enabled modules	RelBlocked	Task	Platform	12/20/2012 21:56
56710	6.7.0	Message about unsaved changes does not come up in the right time when drill down to sales rep worksheet from manager’s worksheet with some unsaved changes	Medium	Defect	Forecasting	10/16/2012 22:09
56739		REST API: Unable to mark/unmark record as favorite if user doesn’t have edit permission	RelBlocked	Task	Platform	11/30/2012 02:18
56748	6.7.0	Numbers on manager’s chart are not the same numbers committed by sales rep (double converted) if sales rep’s default currency is different from base.	Medium	Defect	Forecasting	10/23/2012 18:54
56755	6.6.0	checkFileFieldsAndProcessUpload function in portal.js needs to be in core sidecar	High	Task	Sidecar	10/11/2012 23:51
56791		FTS: Regular module fetch API returns unsorted results	RelBlocked	Task	Platform	02/27/2013 17:59
56936	6.7.0	Remove references to app.metadata.data	Medium	Task	Sidecar	10/04/2012 20:36
56942	6.6.0	javascript date util errors when non-date value passed	Medium	Defect	Sidecar	10/05/2012 20:38
56986		config metadataTypes sent down as ‘[]‘	Medium	Defect	Mambo Portal	11/19/2012 22:56
56987	6.7.0	Date/Datetime overrides blank with the displayDefault	Medium	Defect	Sidecar	12/13/2012 00:43
56997	6.5.5	Forecast monthly time period set automatically	Medium	enhancement	Forecasting	11/08/2012 17:46
57004	6.7.0	Fix definition removal code for scheduler	Medium	Task		10/08/2012 15:43
57010	6.7.0	opportunity currency update sales_stage logic incorrect	Medium	Task		10/09/2012 14:07
57017	6.7.0	Fix opportunity update to use closed values from admin bean	Medium	Task		10/08/2012 20:54
57035	6.7.0	Cannot commit values for user who does not have previous commit (forecasts) data	Urgent	Defect	Forecasting	11/19/2012 18:55
57154	6.7.0	exchange rate calculation in sidecar utility class	High	Task		10/15/2012 15:49
57213	6.5.6	Reports with data series removed render charts inconsistently	Medium	Defect		01/04/2013 19:02
57317	6.6.0	issues in non-english portal2	Medium	Defect	Mambo Portal	01/07/2013 21:57
57392		REST API: Update Cases record request ignores assigned_user field.	RelBlocked	Defect	Platform	11/29/2012 22:50
57400		REST API: Document update request crashes	High	Task	Platform	11/29/2012 20:41
57432		REST API: Server doesn’t properly populate parent field when creating a related Note	High	Defect	Platform	03/01/2013 19:17
57452		REST API: Creating a meeting should create a related user record	Medium	Task	Platform	11/28/2012 17:01
57467	6.7.0	Resizing the browser causes the collapse button to be disabled	Medium	Defect		11/19/2012 19:20
57474	6.7.0	Only forecasts tab is displays in Sugar when going to forecasts module for the first time	High	Defect	Forecasting	10/20/2012 00:17
57475	6.6.1	Create help HTML for new Favorite / UnFavorite methods	Medium	Defect	Help	03/01/2013 19:18
57478		REST API: Assigned user doesn’t get email notification for a scheduled meeting	High	Task	Platform	03/01/2013 19:18
57507		REST API: Fetch request returns “0″ for int fields that don’t have data	Medium	Task	Platform	12/30/2012 04:02
57514		REST API: Creating a related call should put it on the calender	High	Task	Platform	11/28/2012 07:42
57515		REST API: Creating a meeting should put it on the calendar	High	Task	Platform	11/28/2012 17:13
57542	6.7.0	Time Period drop down does not collapse after selecting any item from it.	Medium	Defect	Forecasting	10/22/2012 21:15
57600	6.7.0	Cancel wizard problem	High	Defect	Forecasting	10/25/2012 17:51
57691	6.6.0	parent_name(Related to) field is not available in Mobile list view for calls/meetings/tasks/notes modules	Medium	Defect	Studio	02/23/2013 01:49
57802		REST API Metadata: vardef len property must be number, not string	High	Task	Platform	11/29/2012 22:57
57816	6.7.0	portal2 broken in nutmeg – login error blocks entry	Urgent	Defect		11/19/2012 22:37
57818	6.7.0	Sliders do not reset to the original values after canceling wizard.	High	Defect	Forecasting	10/29/2012 18:01
57838	6.7.0	Possible typo in FieldViewer.php	Urgent	Defect	Studio	11/20/2012 18:57
57839		REST non-GET API must set no-cache headers in response	RelBlocked	Task	Platform	11/30/2012 02:21
57887		Changes to mobile layouts do not take effect	RelBlocked	Task	Studio	11/27/2012 23:38
57888		REST API: Create related quote must populate billing/shipping contact and account	High	Task	Platform	02/27/2013 17:59
57890		REST API Metadata: vardefs “required” field should be boolean	High	Task	Platform	11/30/2012 02:23
57912	6.7.0	Sugar 6.7 doesn’t run on a LAMP stack	RelBlocked	Defect	Forecasting	11/14/2012 19:03
57930	6.7.0	No default month set in admin wizard	Medium	Defect	Forecasting	11/09/2012 23:16
57935	6.7.0	HTML is covered up by tab bar in wizard setup tool	Medium	Defect	Forecasting	11/09/2012 19:22
57944	6.7.0	First screen of wizard config doesnt work or isnt visible	Medium	Defect	Forecasting	11/09/2012 19:20
57955		REST API: Ability to fetch contract types	High	Task	Platform	02/27/2013 17:59
57968	6.7.0	Unneeded POST to config when committing worksheet	Urgent	Defect	Forecasting	11/09/2012 23:34
57969	6.7.0	Clicking X in Settings Tabbed Modal Should Not Refresh Forecasts Page	Medium	Defect	Forecasting	11/09/2012 19:24
57970	6.7.0	Changing the Timeperiod from #2 does not update leaf options	Medium	Defect	Forecasting	11/12/2012 22:06
57994	6.7.0	oauth_token not working in url params for GET requests	Medium	Task	Platform	02/27/2013 17:59
58030	6.7.0	Changing category of opportunity after it has been committed does not remove it from the worksheet even than it no longer matches the specified filter	High	Defect	Forecasting	11/05/2012 18:44
58074		Debug message on FATAL level in modules/ProductTemplates/TreeData.php	Medium	Task	Products	11/06/2012 04:07
58213	6.7.0	Autoloader changes are breaking sugar field / smarty loading	RelBlocked	Defect	Platform	11/08/2012 04:20
58216	6.7.0	Commit History not updating when changing timeperiods	High	Defect	Forecasting	11/07/2012 22:14
58239		REST API: my_favorite flag value is incorrect	Urgent	Task	Platform	11/30/2012 02:19
58278	6.7.0	Zeros are displayed under best and likely numbers in the worksheet header when loading forecasts module for the first time.	Medium	Defect	Forecasting	11/14/2012 19:09
58280	6.7.0	Change the text of the manager sheet not committed message	Medium	Defect	Forecasting	11/12/2012 22:44
58326	6.7.0	“x” button in the wizard loading dialog can be clicked	Medium	Defect	Forecasting	11/12/2012 18:46
58332	6.7.0	Welcome to Sugar checklist is broken	Medium	Defect	User Interface	11/29/2012 18:55
58355	6.7.0	Can’t configure portal	High	Defect	Mambo Portal	11/30/2012 22:01
58357		Array to string conversion in TimePeriod.php	Medium	Task	Forecasting	11/14/2012 23:23
58435		Studio: Quotes.total_usdollar should be disabled for mobile views	Medium	Task	Studio	12/18/2012 01:00
58563		Metadata: Employees module is not in the module_list	Urgent	Task	Platform	12/10/2012 17:51
58567		Remove Classic Theme	Medium	Defect	Themes	04/03/2013 21:17
58577	6.7.0	Chart is not updated after Save Draft or Commit until browser window is refreshed	Urgent	Defect	Forecasting	11/19/2012 18:09
58641	6.7.0	Can’t add custom field into layouts.	Urgent	Defect	Studio	11/29/2012 18:54
58659	6.7.0	Update Welcome Tour for 6.7	Medium	Defect	User Interface	12/01/2012 02:57
58706		Reinstate updated Oauth key creation UI	High	Defect	Administration	12/04/2012 18:57
58707	6.7.0	RestBug57835Test fails	RelBlocked	Task		11/28/2012 00:17
58753	6.7.0	Regression when forcing to update “assigned_user_id”	High	Defect	Sidecar	12/19/2012 18:18
58769		REST API: Fetch /Users or /Employees should not return reserved users	High	Task	Platform	11/29/2012 22:59
58799	6.7.0	Edit button doesn’t work in Profile	High	Defect	Mambo Portal	12/01/2012 03:40
58831	6.7.0	Fatal error when upgrade Corp from 6.5.7 yo 6.7.0.	QABlocked	Defect	Upgrade	12/05/2012 23:54
58886		Metadata API returns incorrect response for “modules” (mobile)	Urgent	Defect	Platform	12/13/2012 01:02
58926		Metadata/Labels: module names are wrongly escaped	Medium	Defect	Platform	12/06/2012 23:06
58938	6.7.0	Add support for sidecar.lite for Forecasting	QABlocked	platform	Sidecar	12/11/2012 19:25
58964	6.7.0	Module list metadata should exclude Users	Urgent	Defect	Platform	12/07/2012 21:58
58988	6.7.0	User hierarchy is not shown correctly	Urgent	Defect	Forecasting	12/03/2012 17:51
58991	6.7.0	Declaration of component classes is incorrect.	RelBlocked	Defect	Sidecar	12/13/2012 19:08
58992	6.7.0	Sidecar Controller adds a CSS class to the master layout	High	Defect	Sidecar	12/13/2012 17:57
59015		Change Remove action on subpanel to Unlink	Medium	Defect	Other	12/10/2012 19:43
59020		REST API: Fetching related records should return a list sorted by date_modified by default	High	Defect	Platform	12/07/2012 21:46
59021		Long call created via REST API is displayed incorrectly on the calendar	Medium	Defect	Platform	12/27/2012 23:15
59027		Creating a meeting via REST API should add the creator as a related user	Medium	Defect	Platform	12/05/2012 17:58
59041	6.7.0	Detail views throw an error after going to the Profile Page	Medium	Defect	Mambo Portal	01/11/2013 19:19
59089		Theme preview not working in Portal Editor	Low	Defect	Mambo Portal	12/07/2012 19:59
59133	6.7.0	Remove ability to modify bucket language strings in Dropdown Editor	High	Task		02/27/2013 17:59
59177	6.7.0	While Loading, display “Module Name” for modules in the header	Low	Defect	Mambo Portal	12/27/2012 18:45
59189	6.7.0	Forecasts module should not be loading in Offline client	QABlocked	Defect	Offline Client	03/22/2013 01:19
59210		Editing a modules field in Studio does not take affect immediately in metadata API requests	Medium	Defect	Platform	03/01/2013 19:20
59247		Accounts.website is not returned when a record is fetched/updated via REST API	Urgent	Defect	Platform	12/14/2012 17:47
59270	6.7.0	Need to add “pull-right” class to login button	Medium	Defect	Mambo Portal	12/21/2012 00:12
59273		Field name in viewdefs has different char case as in vardefs	High	Defect	Platform	03/01/2013 19:20
59274		REST API: Reports endpoint returns tracker reports for a regular user	High	Defect	Platform	12/14/2012 18:08
59275		Creating a call via REST API with parent specified as a contact doesn’t create a relationship between the call and the contact	High	Defect	Platform	12/14/2012 19:49
59334		FIeld-level ACLs are not returned in the record payload if they are different from the default ACLs	Urgent	Defect	Platform	12/13/2012 20:08
59355	6.7.0	Custom Modules of file type get a Forbidden Error when trying to access from Nomad	Medium	Defect		03/01/2013 19:21
59424		Fetching a report via REST API fails with 500 error	Medium	Defect	Platform	03/01/2013 19:21
59481		Group property is missing in Employees’ address metadata	Medium	Defect	Platform	01/18/2013 00:04
59482		Metadata:Employees.employee_status field has incorrect type	Low	Defect	Platform	01/18/2013 00:08
59483		ACLs: Incorrect “delete” permission for admin’s employee record	High	Defect	Platform	03/01/2013 19:22
59484		The newly created Employee record is not returned in /Employees request	High	Defect	Platform	03/01/2013 19:23
59519	6.7.0	Field level owner ACL’s	Medium	Defect	Roles	03/01/2013 19:24
59548		Metadata: mobile metadata should contain Users module	Urgent	Defect	Platform	03/01/2013 18:36
59571		Metadata: cached language file not found	RelBlocked	Defect	Platform	03/01/2013 18:31
59572	6.7.0	Header is not hidden when printing on Portal	Medium	Defect	Mambo Portal	12/27/2012 18:49
59582	6.7.0	Inconsistent User Font in Navbar	Medium	Defect	Navigation	12/19/2012 23:06
59584	6.7.0	Defect on rendering of dashlets	High	Defect	User Interface	04/09/2013 21:11
59641	6.7.0	Refactor buckets field to be named commitStage	Medium	Task	Forecasting	12/26/2012 23:10
59654		Invalid response when creating a meeting via REST API	High	Defect	Platform	12/27/2012 00:59
59659	6.7.0	Cancel change password form throws an error in console	Low	Defect	Mambo Portal	01/04/2013 23:25
59671		Metadata cache: server_info is cached too aggressively	High	Defect	Platform	03/01/2013 19:25
59675		Contacts.sync_contact is not fetched or updated via REST API	High	Defect	Platform	03/01/2013 19:25
59676		Metadata: parent_name property of a flex-relate field has “len” equal 25	Medium	Defect	Platform	03/01/2013 19:25
59692		REST API: Zero is returned instead of empty value for a decimal field	High	Defect	Platform	01/07/2013 21:42
59694		Notes.contact_name field value is not empty when Notes.contact_id is empty	Medium	Defect	Platform	03/01/2013 19:26
59744		ck_login_id_20 cookie should be http-only	Medium	Defect	Security – external	03/01/2013 19:33
59816	6.7.0	“Right to Left” theme: Show More/Less arrow indicators are not displayed when expand More button with forecasts module selected.	Medium	Defect	Forecasting	01/18/2013 19:44
59840		Invalid JSON due to exception in PHP when creating a related meeting	High	Defect	Platform	03/01/2013 19:41
59841		Invalid JSON due to exception in PHP when deleting an employee	High	Defect	Platform	03/01/2013 19:42
59842		Exception in the main app for a list of related task created using REST API	High	Defect	Platform	03/01/2013 19:42
59844		ACLs have admin=yes when module has delete=owner	Urgent	Defect	Platform	03/01/2013 19:43
59845		Unable to favorite a meeting using REST API when FTS is enabled	High	Defect	Platform	03/01/2013 19:44
59888		“Favorite” flag is not updated in FTS index	High	Defect	Platform	03/01/2013 19:44
59889		Relate ID field is not returned for custom module	High	Defect	Platform	02/19/2013 23:38
59956	6.7.0	autoclose alerts close without caller knowing	Medium	Defect	Sidecar	01/14/2013 22:08
59972	6.7.0	Forecasts Setting Wizard: Chevrons shape doesn’t persist when increasing the zoom level.	Medium	Defect	Forecasting	01/16/2013 22:24
60004		Favorites can’t be saved when module view owner only is set	Urgent	Defect	Platform	01/29/2013 18:51
60053		Can’t find meetings when using regular module REST API with FTS enabled	High	Defect	Platform	03/01/2013 19:31
60055		Failed to retrieve picture file for an employee other than logged in user when not an admin	High	Defect	Platform	03/01/2013 19:30
60161		Incorrect ACLs for Users module	High	Defect	Platform	03/08/2013 00:04
60225		Setting all fields to read-only in a module causes Access Not Authorized error for getting the list of that module	Medium	Defect		03/01/2013 19:30
60228		Get error message when creating a meeting if the user’s meeting view access is None	Medium	Defect	Platform	03/01/2013 19:27
60328		Access denied when fetching employees via legacy REST API	High	Defect	Platform	02/27/2013 22:16
60345		Invalid currency metadata in OD instance	Urgent	Defect	Platform	02/01/2013 23:44
60408		New Nomad Strings should be on server	Medium	Defect	Platform	01/25/2013 19:21
60416		Invalid JSON response for admin login request on CE instance	Low	Defect	Platform	03/01/2013 19:28
60546	6.7.0	Change references to “Closed Won”, “Closed Lost” to use CONST variables in Opportunity.php	High	Task		01/30/2013 16:56
60566		Creating a call via REST API with status “held” should create related user record	Medium	Defect	Platform	03/01/2013 19:29
60594	6.6.0	Highlighted text for FTS Searches only returns 1 field	Medium	Defect	Search	02/20/2013 22:23
60638		Meetings.reminder_checked/email_reminder_checked are not updated via REST API	High	Defect	Platform	02/22/2013 21:39
60662		App.isServerCompatible crashes when data param is undefined	High	Defect	Sidecar	01/30/2013 19:54
60668		Invalid metadata for Contacts.account_id field	Medium	Defect	Platform	03/01/2013 19:30
60698	6.7.0	Products module should not show items from Opportunities	Urgent	enhancement	Products	02/02/2013 02:17
60704	6.4.3	Warning: Creating default object from empty value occured in view.modulefield.php	High	Defect	Studio	03/01/2013 22:16
60789		My_items filter doesn’t work with a search query when FTS is enabled	High	Defect	Platform	02/20/2013 22:08
60809	6.7.0	Forecasts module is not loading at all	QABlocked	Defect	Forecasting	01/31/2013 23:27
60815	6.7.0	RTL theme: (Opportunities (Sarah Smith should – parentesis should be corrected	Medium	Defect	Forecasting	02/04/2013 20:15
60859		update content of tour	Medium	Defect		02/06/2013 18:33
61121	6.6.1	Contact only displays first two words when first column of listview of Tasks	High	Defect	User Interface	02/20/2013 19:39
61406	6.7.0	Inconsistent styling for buttons/panels in 6.7 (RacerX theme)	High	Defect	User Interface	02/23/2013 00:28
61414	6.5.0	ACLRoles Not Respected In Mobile View	Urgent	Defect	Roles	02/28/2013 21:26
61650		Report Charts based on Count do not Display or Sort Correctly	Urgent	Defect	Reports	03/04/2013 23:18
61780	6.7.0	Poor grammar/typo in unsaved changes dialog	Medium	Defect	Forecasting	03/06/2013 00:39
61822	6.7.0	Updates to Admin > Mobile verbiage	Medium	Defect	Wireless	03/07/2013 01:05
61830	6.7.0	SAML $settings not defined in module/Users/authentication/SAMLAuthentication/index.php	Urgent	Defect		03/08/2013 01:17
61881	6.6.2	Quick Search Does Not Locate Matches When Including a Space in Search Term	Urgent	Defect	Quotes	04/08/2013 14:04

SugarCRM Patch List 6.5.12

provident — Sun, 14 Apr 2013 01:46:10 +0000

Just before the big launch of SugarCRM 7.0 at SugarCON 2013, SugarCRM diligently released another patch for the super stable 6.5.x stream. Below is a list of Feature Enhancements and Fixes, as well as a few know issues.

SugarCRM have continued with the theme of adding some nice new Features to the Calendar including iCal for Google Calendar and additional info in the Calls & Meetings pop-up reminder .

This Release also includes some important bug fixes for the Reports Module (Particularly for Microsoft SQL Server Summation Reports, as well as a number of other minor fixes in the Reports module).

Feature Enhancements

Enhancements to existing features for Release 6.5.12 are listed below:

Email marketing sort order : Email marketing records are now listed in reverse chronological order on the Send Test and Send Emails page.
Module specific report search criteria : Viewing reports via module tabs’ “View {Module Name} Reports” option correctly updates the report search criteria.
View tasks in iCal : Option to display tasks in iCal when subscribing to the Sugar calendar.
Google calendar integration : iCal integration now works on Google calendar to sync and view Sugar’s calendar.
Call and meeting popup reminder : Additional information has been added to the call and meeting pop-up reminders.

Known Issues

The following are known issues with Sugar 6.5.12:

Shipping not updating due to Sugar Logic : Shipping field in the Grand Total and Line Items section of quotes does not update as expected when the Shipping field is calculated via Sugar Logic.
Bug associated with this issue: 62064
Double quotes display incorrectly upon edit : Group Name fields with quotation marks display incorrectly when editing a quote after initial save.
Bug associated with this issue: 61817

Fixed Issues

The fixes for Release 6.5.12 are detailed below:

Number	Found In Release	Name	Priority	Type	Product Category	Last Modified
40429	6.0.2	Lead Conversion Overwrites Assigned User and Team Values For Created Records	High	Defect	Leads	02/28/2013 21:18
48127	6.2.3	Order of Campaign Marketing Email items in Send views	Medium	enhancement	Campaign Mgmt	03/08/2013 00:34
48178	6.2.4	Related module name is not selected in “Module” box automatically	Medium	enhancement	Reports	03/08/2013 17:32
49392	6.2.4	IMAP/POP3 gssapi authenticator error	Medium	Defect	InboundEmail	04/12/2013 15:23
49989	6.3.0	Meeting / Call Dashlet returns rtrim error when paginating	High	Defect	Dashlets	03/06/2013 20:17
50136		Type filter is automatically selected when we go to the next page	High	Defect	Search	03/04/2013 22:59
50896	6.3.0	{::past::Contracts::type::} displays contracts.type which is GUID, should display contract_types.name	Medium	Defect	Email Templates	03/01/2013 02:08
52173	6.4.3	Adding relationships (Accounts, Contacts, custom modules) to dashlet filters do not work	High	Defect	Dashlets	04/02/2013 18:25
52879	6.4.1	Name changes impacting different objects	Medium	Defect	Reports	03/07/2013 08:40
53488	6.4.4	Assigned Team does not work for Calls and Meetings Dashlet	Medium	Defect	Calls	03/12/2013 19:00
54929	6.5.2	Search Filtering is Broken when using Numbers as the Item Names in the Sales Stage Dropdown Menu	Medium	Defect	Opportunities	02/28/2013 20:02
56425	6.5.5	see duplicate modules name in Report’s Related Modules box	Medium	Defect	Reports	03/19/2013 20:14
56480		RTC 21454 – DB errors when reinstall with existing database.	Medium	Defect	Other	03/15/2013 04:37
56729	6.5.5	Database failure on reassignment user records	High	Defect	Database	04/09/2013 08:17
57298	6.5.5	Reports return only Owned Records for Admin	High	Defect	Reports	03/20/2013 17:55
58494	6.5.7	The button “Create Opportunity from Quote” in the Quotes module doesn’t respect Studio field settings	Medium	Defect	Quotes	02/28/2013 19:21
58518	6.5.7	iCal isn’t available through Google Calendar	Medium	enhancement	Calendar	03/05/2013 23:20
58936	6.4.4	Member of field (in More Information tab in parent Account) is incorrectly populated if Member Organization records in the parent Account’s sub-panel are edited	Urgent	Defect	Accounts	03/05/2013 18:24
59163	Plugins_Oct2012	Custom currency field in mail merge export with 6 digits	Medium	Defect	Word Add-in (Mail Merge)	03/08/2013 02:17
59416	6.5.5	More Information in Meetings/Calls Reminder Popup	Medium	enhancement	Activities	03/13/2013 21:03
59525	6.5.8	tinymce stripping css styles in webkit browsers	High	Defect	Email Templates	02/28/2013 20:58
60505	6.5.9	Quotation Marks are Improperly Display on Quotes Detail View and PDFs	Medium	Defect	Quotes	03/06/2013 16:04
60579	6.5.7	Summation Report breaks when sorting on dropdown field column on MSSQL	High	Defect	Reports	02/28/2013 21:08
60887	6.5.9	From name of Campaign Email is unreadable characters	Medium	Defect	Campaign Mgmt	03/01/2013 23:42
60973	6.5.10	Calculated values from related record not carrying over with the first related record chosen	Urgent	Defect	Sugar Logic	03/01/2013 18:49
60983	6.4.0	Adding fields to the history subpanel results in layout errors if the field is not a physical field in the Calls module	Medium	Defect	Other	03/11/2013 16:57
61006	6.5.9	Notification pop up window not appearing correctly in IE	Medium	Defect	User Interface	03/12/2013 21:46
61126	6.5.10	search field didn’t fit in the search panel when the window is around 400x 600 pixel	High	Defect	User Interface	03/02/2013 02:23
61149	6.6.1	Please remove the ability to edit elastic_boost_option dropdown	High	Defect	Search	03/14/2013 17:49
61158	6.5.9	Oauth problem when using a SSL Load Balancer	Medium	Defect	Other	03/05/2013 00:25
61341	6.5.9	User DN ignored when checking if a LDAP is a member of a group	Medium	Defect	LDAP	03/01/2013 02:45
61797	6.6.1	The Total in Line Items and Grand Total does not update when Shipping is set to be calculated	High	Defect	Quotes	03/19/2013 22:13
61862	6.5.11	Dependent fields trigger(?) when creating target lists	Urgent	Defect	Target Lists	03/13/2013 17:29
62005	6.5.10	Quick Search Does Not Locate Matches When Including a Space in Search Term	Urgent	Defect	Quotes	04/10/2013 19:39

Screenshots of the new SugarCRM 7.0 at SugarCON 2013 launch

provident — Tue, 09 Apr 2013 13:38:20 +0000

SugarCRM announcements at SugarCON 2013 – New Mobile and SugarCRM 7.0 at SugarCON 2013 in New York City

provident — Mon, 08 Apr 2013 15:25:31 +0000

Larry Augustin announces new Mobile SugarCRM and SugarCRM 7.0 at SugarCON 2013 in New York City

Learn more & follow at: https://mobile.twitter.com/providentcrm

+	GET	/	List records in this module	4.50
	... Full help excluded ... File:include/api/listApi.php Method:listModule