role
For information about developing role SDF custom objects, see Custom Roles as XML Definitions.
Attributes
Name |
Type |
Required / Optional |
Description |
---|---|---|---|
scriptid |
string |
Required |
This attribute value can be up to 40 characters long. The default value is ‘customrole’. |
Fields
Name |
Type |
Required / Optional |
Description |
---|---|---|---|
centertype |
single-select list |
Required |
This field accepts references to the center custom type. For information about other possible values, see role_centertype. |
name |
single-select list |
Required |
This field accepts references to the string custom type. |
tfaduration |
single-select list |
Required (conditionally) |
This field is mandatory when the tfarequired value is not equal to OFF. For information about possible values, see tfaduration. The default value is '0'. |
coreadminpermission |
boolean |
Optional |
For more information about the Core Administration Permission feature, see Core Administration Permissions. The default value is F. |
employeerestriction |
single-select list |
Optional |
For information about possible values, see role_fullrestrictions. |
employeeviewingallowed |
boolean |
Optional |
This field is available when the employeerestriction value is not equal to any of the following lists or values: DEFAULTTOOWN, NONE. The default value is F. |
ispartnerrole |
boolean |
Optional |
The default value is F. |
issalesrole |
boolean |
Optional |
The default value is F. |
issupportrole |
boolean |
Optional |
The default value is F. |
issuerole |
string |
Optional |
If this field appears in the SuiteCloud project, you must reference the ISSUEDB feature in the manifest file to avoid SuiteCloud project warnings. In the manifest file, you can specify whether this feature is required in your account. ISSUEDB must be enabled for this field to appear in your account. |
restricttimeandexpenses |
boolean |
Optional |
The default value is F. |
e |
boolean |
Optional |
The default value is F. |
isinactive |
boolean |
Optional |
The default value is F. |
subsidiaryviewingallowed |
boolean |
Optional |
The default value is F. If this field appears in the SuiteCloud project, you must reference the SUBSIDIARIES feature in the manifest file to avoid SuiteCloud project warnings. In the manifest file, you can specify whether this feature is required in your account. SUBSIDIARIES must be enabled for this field to appear in your account. |
subsidiaryoption |
single-select list |
Optional |
For information about possible values, see rolesubsidiaryoption. The default value is 'ALL'. If this field appears in the SuiteCloud project, you must reference the SUBSIDIARIES feature in the manifest file to avoid SuiteCloud project warnings. In the manifest file, you can specify whether this feature is required in your account. SUBSIDIARIES must be enabled for this field to appear in your account. |
accountingbooksoption |
single-select list |
Optional |
For information about possible values, see roleaccountingbooksoption. The default value is 'PRIMARY'. If this field appears in the SuiteCloud project, you must reference the MULTIBOOK feature in the manifest file to avoid SuiteCloud project warnings. In the manifest file, you can specify whether this feature is required in your account. MULTIBOOK must be enabled for this field to appear in your account. |
issinglesignononly |
boolean |
Optional |
The default value is F. |
iswebserviceonlyrole |
boolean |
Optional |
The default value is F. If this field appears in the SuiteCloud project, you must reference the WEBSERVICES feature in the manifest file to avoid SuiteCloud project warnings. In the manifest file, you can specify whether this feature is required in your account. WEBSERVICES must be enabled for this field to appear in your account. |
restrictbydevice |
boolean |
Optional |
The default value is F. |
restrictip |
boolean |
Optional |
The default value is F. If this field appears in the SuiteCloud project, you must reference the IPADDRESSRULES feature in the manifest file to avoid SuiteCloud project warnings. In the manifest file, you can specify whether this feature is required in your account. IPADDRESSRULES must be enabled for this field to appear in your account. |
tfarequired |
single-select list |
Optional |
For information about possible values, see tfarequired. The default value is 'OFF'. |
Structured Fields
Structured fields are elements that usually contain subfields or groups of fields. They are similar to regular fields but have their own embedded structure. The following structured fields are supported: