This section describes the public JSON formats of exportable Workbench settings.
Export Format for the Preview Tool
The JSON file for the Preview Tool includes the following attributes:
|
Attribute |
Value | |||
|---|---|---|---|---|
|
ecr:type |
configuration-preview (Required) String | |||
|
ecr:createDate |
yyyy-MM-dd'T'HH:mm:ss.SSSX (Optional) Date and time that this item was created. Defaults to creation date of the JCR. | |||
|
linkServiceUrl |
The URL of the link construction service. (Required) String | |||
|
previewURL |
The URL that connects to Preview. (Required) String | |||
|
assemblerServiceUrl |
The URL that exposes the Assembler Service REST API (Required for non-Java applications only.) String | |||
|
devices |
A collection of devices. (REQUIRED) | |||
|
Attribute |
Type |
Required |
Value | |
|
userAgent |
String |
yes |
Agent types supported as a string. | |
|
name |
String |
yes |
The name of the device. | |
|
height |
Integer |
yes |
The view port height of the device, in pixels. | |
|
width |
Integer |
yes |
The view port width of the device, in pixels. | |
|
zoom |
Integer |
no |
The Zoom factor can simulate displays on devices other than the current monitor. For example, the display on a retina display monitor can be simulated by setting the Zoom factor to 30 (that is, 30%). | |
The following example illustrates the exported JSON format for the configuration of a Preview tool:
{
"previewUrl": "http://busgb0109:8006/discover-authoring",
"assemblerServiceUrl": "http://busgb0109:8006/assembler-authoring/json",
"devices": [
{
"width": 400,
"name": "Handheld",
"userAgent": "Mozilla/5.0 (iPhone; U; CPU like Mac OS X; en)
AppleWebKit/420+ (KHTML, like Gecko)
Version/3.0 Mobile/1A537a Safari/419.3",
"height": 680
},
{
"width": 848,
"name": "Tablet",
"userAgent": "Mozilla/5.0 (iPad; U; CPU OS 3_2 like Mac OS X;
en-us) AppleWebKit/531.21.10 (KHTML, like Gecko)
Version/4.0.4 Mobile/7B334b Safari/531.21.10",
"height": 1224
}
],
"linkServiceUrl": "http://busgb0109:8006/discover-authoring/link.json",
"ecr:createDate": "2015-08-11T14:57:34.642Z",
"ecr:type": "configuration-preview"}You can specify Preview settings through the Experience Manager. For information about the Experience Manager, refer to the Assembler Application Developer's Guide.
Public Format for the Experience Manager
The JSON file for Experience Manager includes the following attributes:
|
Attribute |
Value |
|---|---|
|
ecr:type |
"configuration-xmgr" (REQUIRED) String. |
|
ecr:createDate |
yyyy-MM-dd'T'HH:mm:ss.SSSX (Optional) Date and time that this item was created. Defaults to creation date of the JCR. |
|
profileGroupsConnectionUrl |
The URL of the ATG server for profile groups. (REQUIRED) Specify a String or a blank ("") |
|
services |
A collection of services used by the experience manager. (Optional) Name - the name of the service. (REQUIRED) String name Other sub-attributes of services are specific to the particular service. |
The following example illustrates the exported JSON format for Experience Manager configuration; note that two services are defined, each with a different set of sub-attributes:
{
"profileGroupsConnectionUrl":"",
"services": [
{
"name":"endecaBrowserService",
"host":"localhost",
"port":"15002",
"recDisplayNameProp":"product.name",
"recSpecProp":"common.id",
"recAggregationKey":"product.code",
"recFilter":"",
"recImgUrlProp":"product.img_url_thumbnail",
"recDisplayProps": ["product.name","product.price","product.short_desc"],
"textSearchKey":"All",
"textSearchMatchMode":"ALLPARTIAL"},
{
"name":"dataservice",
"port":"20002",
"host":"localhost",
"recordFilter":"",
"recordSpecName":"common.id",
"wildcardSearchEnabled":false,
"aggregationKey":"product.code",
"recordFieldName":"product.name",
"fields": {
"product.short_desc":"",
"product.name":"plain",
"product.id":"",
"product.price":"currency"
}
}
]
"ecr:createDate": "2015-08-11T14:57:34.648Z",
"ecr:type": "configuration-xmgr"
}Export Format for Report Settings
The JSON file for Report Settings includes the following attributes:
|
Attribute |
Type |
Required |
Value |
|---|---|---|---|
|
ecr:type |
String |
yes |
report-settings |
|
ecr:createDate |
yyyy-MM-dd'T'HH:mm:ss.SSSX |
no |
Date and time that this item was created. Defaults to creation date of the JCR. |
|
runDailyReports |
Boolean |
yes |
The possible values are true and false. |
|
runWeeklyReports |
Boolean |
yes |
The possible values are true and false. |
|
dayOfTheWeek |
Integer |
yes |
An integer from 1 to 7, with 1 = Sunday |
The following example illustrates the exported JSON format for Report Settings:
{
"runDailyReports": true, // Possible values are true and false
"runWeeklyReports": true, // Possible values are true and false
"dayOfTheWeek": 1, // An integer value ranging between 1-7
"ecr:createDate": "2015-08-11T14:57:34.645Z",
"ecr:type": "report-settings"
}
For information about how to use the export and import feature to migrate report settings to a newer version of Workbench, refer to the Oracle Commerce Guided Search Tools and Framework Migration Guide.
