Access Link

What are the access links?

Access links are another way to access to the application in a specific state. That can be on a specific account, contexte, table, comment or with specific filters.

Why and when?

You might need:

To access in a single click, with your bookmarks, to the application on a specific table and with predefined filters.
To sent links in emails helping your users to access to the relevant items in one click.
To add links in items fields to ease the access to related items in another table, ex: logistic units, prices, spare parts...

See below Use cases to discover other possibilities.

How to use it?

Access links look like this :

txt

https://app.product-live.com/redirect?{parameter1}={value1}&{parameter2}={value2}&{parameter3}={value3}

The application displays items and their data based on multiple parameters.

Parameter	Parameter Name	Example	Occurrences	If the value is missing, incorrect or inaccessible, ...
Account	`accountKey`	`2e729b23-f04b-447d-ba7b-4ecb72d804f9`	0..1	... you will be connected to your last connected account
Context	`contextKey`	`26ae9623-2201-4977-b2f6-3b81e8f239a6`	0..1	... you will be connected to your internal context
Table	`tableKey`	`PRODUCTS`	0..1	... you will be connected to your first internal table
Partition	`partitionKey`	`ACTIVE`	0..1	... you will be connected to the table's first partition
Screen Key	`screenKey`	`MEDIA`	0..1	... you will be connected to the table's first screen
Filter	`filters`	`Ww0KICAgIHsNCiA[...]NCl0=`	0..10	... no filter is applied
Items per page	`itemsPerPage`	`25` default: 25 max: 200	0..1	... you will be connected to the 1st page (index 1) with 25 items displayed
Page number	`page`	`0` starting at 1	0..1	... you will be connected to the 1st page (index 1)
Action	`action`	`displayThread`	0..1	... you will be connected to your last connected account, but no comment panel will be opened
Comment thread id	`threadId`	`356`	0..1	... you will be connected to your internal context, but no comment panel will be opened

TIP

Contact your administrator or Product-Live team to get the required values.

Filter

Information

The filters must be provided as a base64 encoded JSON string.

The JSON string is an array of filters.

A maximum of 10 filters can be applied.

A filter is made of 3 parameters:

Parameter	Parameter Name	Description
Field	`fieldKey`	The field, classification, identifier or conditional-formatting key
Operator	`operator`	Depending on the field type, various comparisons can be applied
Criteria	`criteria`	Optional. A value or a list to be compared

To encode your access link filter you can use online tools such as base64encode.org or base64encode.net.

Json filter valueBase64 filter value

json

[
    {
        "fieldKey": "COLOR",
        "operator": "equals",
        "criteria": {
            "list": [
                "BLACK"
            ]
        }
    },
    {
        "fieldKey": "CONDITIONAL-FORMATTING",
        "operator": "equals",
        "criteria": {
            "list": [
                "VALID"
            ]
        }
    }
]

text

Ww0KICAgIHsNCiAgICAgICAgImZpZWxkS2V5IjogIkNPTE9SIiwNCiAgICAgICAgIm9wZXJhdG9yIjogImVxdWFscyIsDQogICAgICAgICJjcml0ZXJpYSI6IHsNCiAgICAgICAgICAgICJsaXN0IjogWw0KICAgICAgICAgICAgICAgICJCTEFDSyINCiAgICAgICAgICAgIF0NCiAgICAgICAgfQ0KICAgIH0sDQogICAgew0KICAgICAgICAiZmllbGRLZXkiOiAiQ09ORElUSU9OQUwtRk9STUFUVElORyIsDQogICAgICAgICJvcGVyYXRvciI6ICJlcXVhbHMiLA0KICAgICAgICAiY3JpdGVyaWEiOiB7DQogICAgICAgICAgICAibGlzdCI6IFsNCiAgICAgICAgICAgICAgICAiVkFMSUQiDQogICAgICAgICAgICBdDQogICAgICAgIH0NCiAgICB9DQpd

All filters examples:

json

// ATTACHEMENT 'equals'
[
    {
        "fieldKey": "ATTACHEMENT",
        "operator": "equals",
        "criteria": { "extension": "xml" }
    }
]

// ATTACHEMENT 'isEmpty'
[
    {
        "fieldKey": "ATTACHEMENT",
        "operator": "isEmpty"
    }
]

// ATTACHEMENT 'isNotEmpty'
[
    {
        "fieldKey": "ATTACHEMENT",
        "operator": "isNotEmpty"
    }
]

json

// CLASSIFICATION 'equals'
[
    {
        "fieldKey": "CLASSIFICATION",
        "operator": "equals",
        "criteria": { "string": "CATEGORY-1-3" }
    }
]

// CLASSIFICATION 'isEmpty'
[
    {
        "fieldKey": "CLASSIFICATION",
        "operator": "isEmpty"
    }
]

// CLASSIFICATION 'isNotEmpty'
[
    {
        "fieldKey": "CLASSIFICATION",
        "operator": "isNotEmpty"
    }
]

json

// CONDITIONAL-FORMATTING 'equals'
[
    {
        "fieldKey": "CONDITIONAL-FORMATTING",
        "operator": "equals",
        "criteria": {
            "list": [
                "VALID"
            ]
        }
    }
]

json

// IDENTIFIER with 'contains'
[
  {
    "fieldKey": "EAN",
    "operator": "contains",
    "criteria": {
      "string": "0365"
    }
  }
]

// IDENTIFIER 'equals'
[
  {
    "fieldKey": "EAN",
    "operator": "equals",
    "criteria": {
      "list": [
        "8710103652700",
        "3159927106542"
      ]
    }
  }
]

// IDENTIFIER 'endsWith'
[
  {
    "fieldKey": "EAN",
    "operator": "endsWith",
    "criteria": {
      "string": "700"
    }
  }
]

// IDENTIFIER with 'isEmpty'
[
  {
    "fieldKey": "EAN",
    "operator": "isEmpty"
  }
]

// IDENTIFIER with 'isNotEmpty'
[
  {
    "fieldKey": "EAN",
    "operator": "isNotEmpty"
  }
]

// IDENTIFIER 'startsWith'
[
  {
    "fieldKey": "EAN",
    "operator": "startsWith",
    "criteria": {
      "string": "87101"
    }
  }
]

json

// IMAGE equals (one or multiple criteria can be applied at once)
[
  {
      "fieldKey": "FRONT_VIEW",
      "operator": "equals",
      "criteria": {
          "widthMin": 1,
          "widthMax": 500,
          "heightMin": 1,
          "heightMax": 500,
          "extension": "jpg",
          "colorSpace" "RGB",
          "colorProfile": "SRGB"
      }
  }
]

// IMAGE 'isEmpty'
[
  {
    "fieldKey": "FRONT_VIEW",
    "operator": "isEmpty"
  }
]

// IMAGE 'isNotEmpty'
[
  {
    "fieldKey": "FRONT_VIEW",
    "operator": "isNotEmpty"
  }
]

json

// DATE 'isEmpty'
[
  {
    "fieldKey": "SHIPPING_DATE",
    "operator": "isEmpty"
  }
]

// DATE 'isNotEmpty'
[
  {
    "fieldKey": "SHIPPING_DATE",
    "operator": "isNotEmpty"
  }
]

// DATE Field with 'range'
[
    {
        "fieldKey": "SHIPPING_DATE",
        "operator": "range",
        "criteria": { 
          "min": "2023-12-08", 
          "max": "2023-12-09" 
        }
    }
]

json

// DATE-TIME 'isEmpty'
[
  {
    "fieldKey": "DELIVERY_DATE_STOREHOUSE",
    "operator": "isEmpty"
  }
]

// DATE-TIME 'isNotEmpty'
[
  {
    "fieldKey": "DELIVERY_DATE_STOREHOUSE",
    "operator": "isNotEmpty"
  }
]

// DATE-TIME 'range'
[
    {
        "fieldKey": "DELIVERY_DATE_STOREHOUSE",
        "operator": "range",
        "criteria": { 
          "min": "2023-12-08T23:00:00.000Z", 
          "max": "2023-12-09T23:00:00.000Z" 
        }
    }
]

// DATE-TIME 'range' and 'showTime'
[
    {
        "fieldKey": "DELIVERY_DATE_STOREHOUSE",
        "operator": "range",
        "criteria": {
          "min": "2023-12-10T23:00:00.000Z",
          "showTime": true
        }
    }
]

json

// HTML-TEXT with 'contains'
[
  {
    "fieldKey": "DESCRIPTION",
    "operator": "contains",
    "criteria": {
      "string": "Optimal Gum Care G2"
    }
  }
]

// HTML-TEXT 'equals'
[
  {
    "fieldKey": "DESCRIPTION",
    "operator": "equals",
    "criteria": {
      "list": [
        "Brush heads <span style="color: #0000ff;"><em>Optimal Gum Care G2</em></span> x4 - <span style="color: #ff0000;"><strong>SyncBrush</strong></span>TM",
        "Brush heads <span style="color: #0000ff;"><em>Optimal Gum Care C2</em></span> x4 - <span style="color: #ff0000;"><strong>SyncBrush</strong></span>TM"
      ]
    }
  }
]

// HTML-TEXT 'endsWith'
[
  {
    "fieldKey": "DESCRIPTION",
    "operator": "endsWith",
    "criteria": {
      "string": "SyncBrushTM"
    }
  }
]

// HTML-TEXT with 'isEmpty'
[
  {
    "fieldKey": "DESCRIPTION",
    "operator": "isEmpty"
  }
]

// HTML-TEXT with 'isNotEmpty'
[
  {
    "fieldKey": "DESCRIPTION",
    "operator": "isNotEmpty"
  }
]

// HTML-TEXT 'startsWith'
[
  {
    "fieldKey": "DESCRIPTION",
    "operator": "startsWith",
    "criteria": {
      "string": "Brush heads"
    }
  }
]

json

// LONG-TEXT with 'contains'
[
  {
    "fieldKey": "DESCRIPTION",
    "operator": "contains",
    "criteria": {
      "string": "Optimal Gum Care G2"
    }
  }
]

// LONG-TEXT 'equals'
[
  {
    "fieldKey": "DESCRIPTION",
    "operator": "equals",
    "criteria": {
      "list": [
        "Brush heads Optimal Gum Care G2 x4 - SyncBrushTM",
        "Brush heads Optimal Gum Care C2 x4 - SyncBrushTM"
      ]
    }
  }
]

// LONG-TEXT 'endsWith'
[
  {
    "fieldKey": "DESCRIPTION",
    "operator": "endsWith",
    "criteria": {
      "string": "SyncBrushTM"
    }
  }
]

// LONG-TEXT with 'isEmpty'
[
  {
    "fieldKey": "DESCRIPTION",
    "operator": "isEmpty"
  }
]

// LONG-TEXT with 'isNotEmpty'
[
  {
    "fieldKey": "DESCRIPTION",
    "operator": "isNotEmpty"
  }
]

// LONG-TEXT 'startsWith'
[
  {
    "fieldKey": "DESCRIPTION",
    "operator": "startsWith",
    "criteria": {
      "string": "Brush heads"
    }
  }
]

json

// MULTIPLE-SELECT 'equals'
[
    {
        "fieldKey": "BODY_AREAS",
        "operator": "equals",
        "criteria": {
            "list": [
                "BEARD",
                "HAIR"
            ]
        }
    }
]

// MULTIPLE-SELECT 'isEmpty'
[
  {
      "fieldKey": "BODY_AREAS",
      "operator": "isEmpty"
  }
]

// MULTIPLE-SELECT 'isNotEmpty'
[
  {
      "fieldKey": "BODY_AREAS",
      "operator": "isNotEmpty"
  }
]

// MULTIPLE-SELECT 'notEquals'
[
    {
        "fieldKey": "BODY_AREAS",
        "operator": "equals",
        "criteria": {
            "list": [
                "SHOULDER"
            ]
        }
    }
]

json

// MULTIPLE-SELECT-QUANTIFIED 'equals'
[
    {
        "fieldKey": "CONNECTORS",
        "operator": "equals",
        "criteria": {
            "list": [
                "USB",
                "HDMI"
            ]
        }
    }
]

// MULTIPLE-SELECT-QUANTIFIED 'isEmpty'
[
  {
      "fieldKey": "CONNECTORS",
      "operator": "isEmpty"
  }
]

// MULTIPLE-SELECT-QUANTIFIED 'isNotEmpty'
[
  {
      "fieldKey": "CONNECTORS",
      "operator": "isNotEmpty"
  }
]

// MULTIPLE-SELECT-QUANTIFIED 'notEquals'
[
    {
        "fieldKey": "CONNECTORS",
        "operator": "equals",
        "criteria": {
            "list": [
                "ETHERNET"
            ]
        }
    }
]

json

// MULTIPLE-SELECT-QUANTIFIED-WITH-COMMENTS 'equals'
[
    {
        "fieldKey": "CONNECTORS",
        "operator": "equals",
        "criteria": {
            "list": [
                "USB",
                "HDMI"
            ]
        }
    }
]

// MULTIPLE-SELECT-QUANTIFIED-WITH-COMMENTS 'isEmpty'
[
  {
      "fieldKey": "CONNECTORS",
      "operator": "isEmpty"
  }
]

// MULTIPLE-SELECT-QUANTIFIED-WITH-COMMENTS 'isNotEmpty'
[
  {
      "fieldKey": "CONNECTORS",
      "operator": "isNotEmpty"
  }
]

// MULTIPLE-SELECT-QUANTIFIED-WITH-COMMENTS 'notEquals'
[
    {
        "fieldKey": "CONNECTORS",
        "operator": "equals",
        "criteria": {
            "list": [
                "ETHERNET"
            ]
        }
    }
]

json

// NUMBER 'isEmpty'
[
    { 
      "fieldKey": "WEIGHT", 
      "operator": "isEmpty"
]

// NUMBER 'isNotEmpty'
[
    { 
      "fieldKey": "WEIGHT", 
      "operator": "isNotEmpty"
]

// NUMBER 'range'
[
    {
        "fieldKey": "WEIGHT",
        "operator": "range",
        "criteria": {
            "min": 1,
            "max": 50
        }
    }
]

// NUMBER 'range' with 'suffixes'
[
    {
        "fieldKey": "WEIGHT",
        "operator": "range",
        "criteria": {
            "min": 1,
            "max": 50,
            "suffixOperator": "in",
            "suffixes": [
                "kg"
            ]
        }
    }
]

json

// SINGLE-LINE-TEXT with 'contains'
[
  {
    "fieldKey": "REF_COM",
    "operator": "contains",
    "criteria": {
      "string": "S5071"
    }
  }
]

// SINGLE-LINE-TEXT 'equals'
[
  {
    "fieldKey": "REF_COM",
    "operator": "equals",
    "criteria": {
      "list": [
        "S5071/57",
        "HF3506/30"
      ]
    }
  }
]

// SINGLE-LINE-TEXT 'endsWith'
[
  {
    "fieldKey": "REF_COM",
    "operator": "endsWith",
    "criteria": {
      "string": "/57"
    }
  }
]

// SINGLE-LINE-TEXT with 'isEmpty'
[
  {
    "fieldKey": "REF_COM",
    "operator": "isEmpty"
  }
]

// SINGLE-LINE-TEXT with 'isNotEmpty'
[
  {
    "fieldKey": "REF_COM",
    "operator": "isNotEmpty"
  }
]

// SINGLE-LINE-TEXT 'startsWith'
[
  {
    "fieldKey": "REF_COM",
    "operator": "startsWith",
    "criteria": {
      "string": "S5071"
    }
  }
]

json

// SINGLE-SELECT 'equals'
[
    {
        "fieldKey": "COLOR",
        "operator": "equals",
        "criteria": {
            "list": [
                "YELLOW",
                "BLUE"
            ]
        }
    }
]

// SINGLE-SELECT 'isEmpty'
[
  {
      "fieldKey": "COLOR",
      "operator": "isEmpty"
  }
]

// SINGLE-SELECT 'isNotEmpty'
[
  {
      "fieldKey": "COLOR",
      "operator": "isNotEmpty"
  }
]

// SINGLE-SELECT 'notEquals'
[
    {
        "fieldKey": "COLOR",
        "operator": "equals",
        "criteria": {
            "list": [
                "BLACK"
            ]
        }
    }
]

Use cases

See a specific context

To add links enabling to display items on a shared table and see items shared with your partner , set the following parameter:

contextKey

Here the specified account context is opened, whether it is your own or your partner context, unless you do not have access to it.

Other parameters are optional. Without them the default table, partition and screen is opened.

txt

https://app.product-live.com/redirect?contextKey=26ae9623-2201-4977-b2f6-3b81e8f239a6

See a screen

To add links enabling to display items on a screen and see specific business values, set the following parameter:

accountKey
tableKey
screenKey

The context is not required if you want to see your table screen.

Other parameters are optional. Without them the default partition is displayed.

txt

https://app.product-live.com/redirect?accountKey=2e729b23-f04b-447d-ba7b-4ecb72d804f9&tableKey=PRODUCTS&screenKey=MEDIA

See a partner screen

To add links enabling to display items on a partner screen and see shared values, set the following parameter:

accountKey
contextKey
tableKey
screenKey

Other parameters are optional. Without them the default partition is displayed.

txt

https://app.product-live.com/redirect?accountKey=2e729b23-f04b-447d-ba7b-4ecb72d804f9&contextKey=26ae9623-2201-4977-b2f6-3b81e8f239a6&tableKey=PRODUCTS&screenKey=REF

See a specific partition

To add links enabling to display items on a partition and see active or archive items, set the following parameter:

accountKey
tableKey
partitionKey

Other parameters are optional. Without them the default screen is displayed.

txt

https://app.product-live.com/redirect?accountKey=2e729b23-f04b-447d-ba7b-4ecb72d804f9&tableKey=PRODUCTS&partitionKey=ARCHIVED

See filtered items

To add links enabling to display some items based on filters and see relevant items, set the following parameter:

tableKey
screenKey if a filter is applied on a Conditional-Formatting field
filters

txt

https://app.product-live.com/redirect?accountKey=2e729b23-f04b-447d-ba7b-4ecb72d804f9&tableKey=PRODUCTS&partitionKey=ARCHIVED

Other parameters are optional. Without them the default partition is displayed.

Set the number of 200 items per page

To add links enabling to display more items at once, set the following parameter:

accountKey
tableKey
itemsPerPage

txt

https://app.product-live.com/redirect?accountKey=2e729b23-f04b-447d-ba7b-4ecb72d804f9&tableKey=PRODUCTS&itemsPerPage=200

Other parameters are optional. Without them the default screen and partition is displayed.

Open a specific page

To add links enabling to display a specific page of items, set the following parameter:

accountKey
tableKey
page

txt

https://app.product-live.com/redirect?accountKey=2e729b23-f04b-447d-ba7b-4ecb72d804f9&tableKey=PRODUCTS&page=5

Other parameters are optional. Without them the default screen and partition is displayed.

Open an item comment thread

To add links enabling to open a Comment Thread on an item, set the following parameter:

action = displayThread
threadId

txt

https://app.product-live.com/redirect?action=displayThread&threadId=1241

Other parameters are optional. Without them the default screen is displayed.

TIP

You cannot open a specific comment thread and apply filters at the same time, as the comment thread filter applies a filter on the commented item.

FAQ

To use the access links, you need first to be logged in the application. Then clicking on the link will open it with predefined configuration.

I have set a filter and none is applied ?

Filters are applied only if they are not empty and valid. Check your access link to see if there are no missing or invalid values.

Access Link ​

What are the access links? ​

Why and when? ​

How to use it? ​

Filter ​

Use cases ​

See a specific context ​

See a screen ​

See a partner screen ​

See a specific partition ​

See filtered items ​

Set the number of 200 items per page ​

Open a specific page ​

Open an item comment thread ​

FAQ ​

When I click on the access link I received, why I am redirected to the login page ? ​

I have set a filter and none is applied ? ​

Access Link

What are the access links?

Why and when?

How to use it?

Filter

Use cases

See a specific context

See a screen

See a partner screen

See a specific partition

See filtered items

Set the number of 200 items per page

Open a specific page

Open an item comment thread

FAQ

When I click on the access link I received, why I am redirected to the login page ?

I have set a filter and none is applied ?