Learning Center

Data / Find screen columns ​

Task in alpha phase

This Data Factory task is in phase. You can contact the Product-Live team at contact@product-live.com if you want more details and get an early access.

This task allows to find screen columns. Screen columns define which fields appear as columns in a screen and their display properties (position, width, read-only, fixed).

Task name:

Examples ​

json
{
    "name": "data-screen-column-find",
    "taskReferenceName": "find_screen_columns",
    "description": "Find all columns for a screen section",
    "type": "SUB_WORKFLOW",
    "optional": false,
    "inputParameters": {
        "findMode": "ALL",
        "request": {
            "method": "INLINE",
            "contentType": "application/json",
            "model": "default",
            "json": {
                "context": {
                    "screenSectionId": "18823956"
                },
                "options": {
                    "limit": 100
                }
            }
        }
    }
}
json
{
    "name": "data-screen-column-find",
    "taskReferenceName": "find_screen_columns",
    "description": "Find column for a specific field",
    "type": "SUB_WORKFLOW",
    "optional": false,
    "inputParameters": {
        "findMode": "REQUEST",
        "request": {
            "method": "INLINE",
            "contentType": "application/json",
            "model": "default",
            "json": {
                "context": {
                    "screenSectionId": "18823956"
                },
                "criteria": {
                    "type": "eq",
                    "field": "fieldId",
                    "value": "5678"
                }
            }
        }
    }
}

Definition ​

PropertyTypeRequiredDescription
The name (or type) of the task
The unique name of the task in your job. It is used to reference this task in the workflow.
The functional description of this task in your job.
The type of the task. It must be SUB_WORKFLOW.
:

true: the job continues if there is an error on this task.
false: the job fails.
Input parameters of the task. See below

Inputs Parameters ​

PropertyTypeRequiredDescription
The Product-Live API key
If not provided, an automaticaly generated API key will be used to perform the request on behalf of the current user. If provided, the given API key will be used to perform the request.
ALL: Fetch all elements. REQUEST: Fetch all elements matching certain criteria.
See below
To day, application/json and application/xml are supported.
INLINE: The request body is provided inline in the request object. ATTACHMENT: The request body is provided as an attachment in the request object.

If method == INLINE and contentType == application/json		The request body as a JSON object.
The options of the request. Available options are: limit, sort, sortOrder.
The maximum number of elements to be returned by the task. If not set, the task returns the maximum number of elements available. If the limit property is less than the maximum number of elements that can be returned, the task returns the number of elements specified by the limit property.
The field to sort the elements by.
The order to sort the elements by. Available orders are: ASC, DESC.
The criteria of the request. See examples below

If request.method == ATTACHMENT		The request body as a file.
Default: API. The model/format used in the request. To day, only 'API' is supported.
Default: [{"mediaType": "application/json", "outputMode": "INLINE", "outputKey": "json"}].
The media type of the output. To day, application/json and application/xml are supported.
INLINE: The output is provided inline in the output object. ATTACHMENT: The output is provided as an attachment in the output object. INLINE is only supported for mediaType=application/json
The key of the output.
Either json or xml
Default: DEFAULT. The model/format used in the output. To day, only 'DEFAULT' is supported.

Context requirements ​

PropertyTypeRequiredDescription
The ID of the screen section to search columns in

JSON criteria examples ​

json
{
    "context": {
        "screenSectionId": "18823956"
    },
    "criteria": {
        "type": "eq",
        "field": "fieldId",
        "value": "5678"
    }
}
json
{
    "context": {
        "screenSectionId": "18823956"
    },
    "criteria": {
        "type": "eq",
        "field": "isFixed",
        "value": true
    }
}
json
{
    "context": {
        "screenSectionId": "18823956"
    },
    "options": {
        "sort": "position",
        "sortOrder": "ASC",
        "limit": 100
    }
}

XML criteria examples ​

xml
<?xml version="1.0" encoding="UTF-8"?>
<map xmlns="http://www.w3.org/2005/xpath-functions">
    <map key="context">
        <string key="screenSectionId">18823956</string>
    </map>
    <map key="criteria">
        <string key="field">fieldId</string>
        <string key="type">eq</string>
        <string key="value">5678</string>
    </map>
</map>
xml
<?xml version="1.0" encoding="UTF-8"?>
<map xmlns="http://www.w3.org/2005/xpath-functions">
    <map key="context">
        <string key="screenSectionId">18823956</string>
    </map>
    <map key="options">
        <string key="sort">position</string>
        <string key="sortOrder">asc</string>
        <string key="limit">100</string>
    </map>
</map>

Outputs ​

PropertyTypeDescription
The total number of elements exported by the task
An object containing the result of the task. Each output key is the key of the output defined in the outputs[].outputKey input parameter.

Json output - outputs[].outputMode=INLINE and outputs[].mediaType=application/json ​

  • output.json is an array of objects as defined in the screen columns API.
  • json is the default output key but may be changed by setting the outputKey property.

Example output:

json
[
    {
        "object": "screen-column",
        "id": "342642346",
        "position": 1,
        "width": "MEDIUM",
        "isFixed": true,
        "isReadOnly": false,
        "fieldId": "5678"
    }
]

XML output - outputs[].outputMode=ATTACHMENT and outputs[].mediaType=application/xml ​

Example output:

xml
<?xml version="1.0" encoding="UTF-8"?>
<array xmlns="http://www.w3.org/2005/xpath-functions">
    <map>
        <string key="object">screen-column</string>
        <string key="id">342642346</string>
        <number key="position">1</number>
        <string key="width">MEDIUM</string>
        <boolean key="isFixed">true</boolean>
        <boolean key="isReadOnly">false</boolean>
        <string key="fieldId">5678</string>
    </map>
</array>

Limits and additional notes ​

  • When the outputMode=INLINE is selected, the maximum number of elements returned by this task is limited to 1000. If more elements are to be returned, the task ends with an error. To export up to the maximum of elements, use the limit input parameter to limit the number of elements return.

Additional examples ​

Find screen columns with API key ​

job.json

json
{
    "name": "data-screen-column-find",
    "taskReferenceName": "find_screen_columns",
    "description": "Find screen columns using an API key",
    "type": "SUB_WORKFLOW",
    "optional": false,
    "inputParameters": {
        "apiKey": "${workflow.input.apiKey}",
        "findMode": "ALL",
        "request": {
            "method": "INLINE",
            "contentType": "application/json",
            "model": "default",
            "json": {
                "context": {
                    "screenSectionId": "${workflow.input.screenSectionId}"
                },
                "options": {
                    "sort": "position",
                    "sortOrder": "ASC",
                    "limit": 100
                }
            }
        }
    }
}