Exporting field names and labels for a specific module

Hugo Geyskens 3 months ago

Hi there,

I was wondering if there is an easy way to export all fields and their display labels for a specific module ?

While Sugar uses the field names, a connected external application uses Sugar's labels as field names.

I'm trying to setup a link between the two...

Thanks for getting me in the right direction.

Bye now

Hugo

Parents

0 Francesca Shiekh 3 months ago

That feels like a bit of a headache Hugo Geyskens ,

Labels depend on the language.
You could use the metadata API, for example for the Users Module:

/metadata?type_filter=modules&module_filter=Users
See:

3 Tips for using the Sugar Metadata API

Extract the "fields", and from there the name (the column name) and the vname (the LBL_xxx)

You then have to translate the vname to the appropriate translation, and you could do that using:

https://support.sugarcrm.com/documentation/sugar_developer/sugar_developer_guide_14.0/architecture/languages/module_labels/

Maybe someone has a better idea?

Francesca
0 Hugo Geyskens 3 months ago in reply to Francesca Shiekh

Hi Francesca, I followed the two links, but i'm afraid that's (technically) a bit too far over my head. But thanks anyway for sharing.

Reply

0 Hugo Geyskens 3 months ago in reply to Francesca Shiekh

Hi Francesca, I followed the two links, but i'm afraid that's (technically) a bit too far over my head. But thanks anyway for sharing.

Children

0 Francesca Shiekh 3 months ago in reply to Hugo Geyskens
I built a quick API that pulls all fields, the LBL and the corresponding name.
Would that work for you?

For example, for the Users module (minus my own custom fields), exporting the results to CSV:

https://sugarclub.sugarcrm.com/cfs-file/__key/communityserver-discussions-components-files/54/modulelanguage.csv

The code in case you want it (can be improved with Exceptions for non-existent modules, specific languages etc)

Fullscreen
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
<?php
require_once('include/api/SugarApi.php');
class getModFieldsLangApi extends SugarApi
{
public function registerApiRest() {
return array(
'getModFieldsLang' => array(
'reqType' => 'GET',
'path' => array('getModFieldsLang', '?'),
'pathVars' => array('','module'),
'method' => 'getModFieldsLang',
'shortHelp' => 'CustomWR: Given a module(required) get a list of fields and labels',
'longHelp' => '',
),
);
}
function getModFieldsLang($api, $args){
$module = $args['module'];
$res = array();
$bean = BeanFactory::newBean($module);
foreach ($bean->field_defs as $field => $value){
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
<?php require_once('include/api/SugarApi.php'); class getModFieldsLangApi extends SugarApi { public function registerApiRest() { return array( 'getModFieldsLang' => array( 'reqType' => 'GET', 'path' => array('getModFieldsLang', '?'), 'pathVars' => array('','module'), 'method' => 'getModFieldsLang', 'shortHelp' => 'CustomWR: Given a module(required) get a list of fields and labels', 'longHelp' => '', ), ); } function getModFieldsLang($api, $args){ $module = $args['module']; $res = array(); $bean = BeanFactory::newBean($module); foreach ($bean->field_defs as $field => $value){ $labelKey = $bean->field_defs[$field]['vname']; $labelVal = translate($labelKey, $module); $res[]=array( "field_name"=>$field, "LBL"=>$labelKey, "label"=>$labelVal ); } return($res); } } ?>