Configuration

Max number of copy per run

The maximum number to copy per run

OpenContent ContentProvider

The name of the content provider to use

Effingo API url

The url to Effingo, the API that Page Hub utilizes to handle the copying

Page Hub API url

The url to Page Hub, the API that Page Hub utilizes to handle pages

Page Hub web socket url

The web socket url to Page Hub, to get live information from Page Hub API

IC Publisher ID (optional)

Use this it you want to notify other applications, needs IC Token as well.

IC Token (optional)

Use this it you want to notify other applications, needs IC Publisher ID as well.

Image content provider config (JSON)

Key
Type
Description

provider

string

The ICP provider to use

function

string

The function to use

width

number

The width of the image

height

number

The height of the image

Example

{
    "provider": "${DBKS:ICP_PROVIDER}",
    "function": "noCrop",
    "width": 60,
    "height": 40
}

Suggest search config (JSON)

Key
Type
Description

suggestFields

array of objects

An object has two keys, name, OC property and order, the sort order

suggestLabels

object

An object with the same keys that you want to translate from suggestFields

freeTextOrder

number

Sort order for free text

searchOptions

object

An object with key defaultQuery, the query to use if nothing is searched for, can be empty ""

Example

{
    "suggestFields": [
        {
            "name": "WriterAuthors",
            "order": 10
        },
        {
            "name": "WriterPubStatus",
            "order": 0
        },
        {
            "name": "WriterHeadlines",
            "order": 30
        },
        {
            "name": "ArticleMetaChannels",
            "order": 0
        },
        {
            "name": "ArticleMetaSections",
            "order": 0
        },
        {
            "name": "ArticleMetaNewsValue",
            "order": 0
        },
        {
            "name": "Status",
            "order": 0
        }
    ],
    "suggestLabels": {
        "WriterAuthors": "Author",
        "Status": "Status",
        "WriterHeadlines": "Headline",
        "ArticleLanguage": "Language",
        "ArticleMetaChannels": "Channel",
        "ArticleMetaSections": "Section",
        "ArticleMetaServices": "Service",
        "ArticleMetaNewsValue": "News value",
        "MainChannel": "Main channel",
        "_all": "Free text"
    },
    "freeTextOrder": 40,
    "searchOptions": {
        "defaultQuery": "*"
    }
}

Suggest search filters (JSON)

Key
Type
Description

id

string

Must be a unique value

label

string

The label used for this filter

sortable

boolean

If true, value will be filtered with the given property

displayType

string

Supported types are: checkbox, date and select

query

string

Only for displayType checkbox! Will add this query when selected

propertyToFilter

string

The OC property to filter on

[
    {
        "id": "1",
        "label": "Not marked as print",
        "sortable": false,
        "displayType": "checkbox",
        "query": "NOT ArticleSubType:x-im/print"
    },
    {
        "id": "2",
        "label": "Created",
        "sortable": false,
        "displayType": "date",
        "propertyToFilter": "ObjectCreated"
    }
]

Type name for page status (from Status Map)

The named type from Status Map and if used will allow users to change status for a page, otherwise the option to change status will not appear. Example name: pagehub Example config to use in Status Map:

{
    "statusConfig": {
        [Other configuration for other types]
        "pagehub": {
            "statuses": {
                "Not Initiated": {
                    "icon": "",
                    "label": "",
                    "striped": false,
                    "textColor": "",
                    "backgroundColor": "#ff2e82"
                },
                "In Production": {
                    "icon": "",
                    "label": "",
                    "striped": false,
                    "textColor": "",
                    "backgroundColor": "#ff8c2e"
                },
                "Export Error": {
                    "icon": "",
                    "label": "",
                    "striped": false,
                    "textColor": "",
                    "backgroundColor": "#5bff2e"
                }
            }
        }
    }
}