powered by CADENAS

Manual

Manual

5.8.2.1.14.5.  Generate deeplinks

Deep links are often used to directly link products on other pages and lead a user, via this link, to a specific part or part family in a PARTcommunity portal.

The function under Output -> Generate deeplinks provides correct deeplinks and/or deeplinks "packed" in QR code.

Example: Result as deeplink

Example: Result as deeplink

Example: Result as QR code with company logo

Example: Result as QR code with company logo

  • Output:

    Activate the checkbox for CSV and/or QR.

    • CSV:

      • Directories:

      • Unit:

      • Data type:

      • Open file after creation:

      • File name: Name of CSV file which is stored in the directory defined under Save path.

    • QR:

      In order to link to your website not only deeplinks are possible but also QR code. Therefor activate the checkbox QR.

      Then for each deeplink an individual QR image is created and saved in the specified directory.

      • Embed Image:

        Via Embed Image you can place the company logo for example inside the QR code. Specify any image path by clicking on ....

    • Save path: Specify the target path for the directory where to store the CSV file and the QR code images.

  • Input:

    Specify which directories/projects shall be used as input.

  • Name of the PARTcommunity portal:

    • PARTcommunity link :

      Provides special link for PARTcommunity portals.

      Example: Option PARTcommunity Link" with the entry "cadenas"

      Example: Option PARTcommunity Link" with the entry "cadenas"

      Result

      Result

    • Free link :

      Enables the creation of links to any portals.

      Example: Option "Free Link" with the entry "cadenas"

      Example: Option "Free Link" with the entry "cadenas"

      Result

      Result

  • Columns:

    Please enter the columns which should be written in the CSV (e.g. NB,CNS_DEEPLINKPCOMMUNITY)

    Example: Specification of the column "TNR", which shows the part number.

    Example: Specification of the column "TNR", which shows the part number.

  • VARSET or RowID :

    Choose the option VARSET or RowID.

    State all table values needed to assemble the deeplink. Additional variables are only required when using VARSET. Stating variables serves to ensure uniqueness.

    Calculated variables such as the NB should not be used.

    Example: Selection of "VARTSET" with the variable "TNR".

    Example: Selection of "VARTSET" with the variable "TNR".

    The following variables can be entered in columns or in VARSET separated by comma (like table values).

    • CNS_FILENAME

    • CNS_NN

    • CNS_NB (not in VARSET)

    • CNS_NT

    • CNS_DATE

    • CNS_MIDENT

    • CNS_VIRTUALPATH

    • CNS_DEEPLINK

    • CNS_DEEPLINKPCOMMUNITY

    • CNS_ISDIR

    • CNS_KEYWORDS

    • CNS_PRJTYPE

    • CNS_HIDDEN

    • CNS_PUBLISHED

    • CNS_SHOP_LINK

5.8.2.1.14.5.1. Background information on Deep Links
5.8.2.1.14.5.1.1. What are deep links?

With deep links you can perform predefined actions on a PARTcommunity portal, such as for example sign up a user or configure specific parts and assemblies.

Deep links are often used to directly link to products from other pages and direct a user, with this link, to a specific part or part family in a PARTcommunity portal.

5.8.2.1.14.5.1.2. Syntax

Deep links are realized via so-called HTTP request parameters. An HTTP link is usually made up of a domain name and a domain ending. For example: https://www.google.de.

In order to transfer this request parameter to the link, a "?" sign must be added to the link as the first symbol. After the question mark a list of parameters separated by the "&" symbol can follow.

https://www.google.de?param1=wert1

https://www.google.de?param1=wert1&param2=wert2

5.8.2.1.14.5.1.3. Parameters for PARTcommunity

The link for your PARTcommunity portal will be assigned to you by CADENAS. Usually it is made up of your company or catalog name plus .partcommunity.com:

https://[portalname].partcommunity.com

[Note] Note

All values must be encoded using the UTF-8 character set. Please make sure, that the page embedding these deep links uses the UTF-8 character set, too. Otherwise you have to encode the links separately. Special care must be taken when using the + sign in your links. The + sign normally is a placeholder for the space sign, if you are not sure always use %2B instead of the + sign.

The following parameters can be transferred to your portal as deep links:

  • info

    With this parameter, a catalog, catalog sub-folder or a part family can be opened. The value of the parameter is made up of the directory name of the catalog in the $CADENAS_DATA\23d-libs directory:

    • To open a catalog:

      https://[portalname].partcommunity.com?info=amf

    • To open a sub-directory in a catalog:

      https://[portalname].partcommunity.com?info=amf/scsp

    • To open a part family table:

      https://[portalname].partcommunity.com?info=amf/scsp/01_senk/amf6800_assmtab.prj

  • varset

    In combination with the parameter info, this parameter allows to configure variables within a part family. The value of the parameter is made up of variable names and the corresponding values that are to be configured. The variable names and values must be entered in braces, multiple values have to be separated by a comma.

    • Select a characteristic via a variable name:

      https://[portalname].partcommunity.com?
       info=amf/scsp/01_senk/amf6800_assmtab.prj&varset={BESTNR=90068}

    • Select a characteristic and set a value range:

      https://[portalname].partcommunity.com?
       info=amf/scsp/01_senk/amf6800_assmtab.prj&varset={BESTNR=90068},{WB=45}

  • category

    Using this parameter you can directly pre-select a class system. This parameter is only valid for OEM portals. The following values are supported

    • by_country: country classification

    • by_alphabet: alphabetical classification

    • by_classification: categories

    Example:

    https://[portalname].partcommunity.com?category=by_classification

  • search

    This parameter allows you to directly start a full text search request. The results of this search are displayed in the portal’s search portlet or directly inside the navigation search

    • https://[portalname].partcommunity.com?search=schraube

5.8.2.1.14.5.1.4. Direct call to a special portal page

To directly open a defined portal page in PARTcommunity, the page's name has to be passed as parameter page.

page=[page name]

In combination with the portal’s address you will have this request address:

https://[portalname].partcommunity.com?page=[page]

The name of the portal page is the name entered during creation of the page using the PARTcommunity administration tool. All spaces have to be replaced with the + sign.

Do not use the page name translated by the current language, only the original page name will work

Example 1: Open the page „CAD models“:

https://<portalname>.partcommunity.com/?page=CAD+models

Example 2: Open the page „Welcome“:

https://<portalname>.partcommunity.com/?page=Welcome

[Note] Note

There is no need to add the page parameter in combination with the info parameter. When using the info parameter the portal switches automatically to the page presenting the catalog data.

5.8.2.1.14.5.1.5. Force login

To force the user to login when calling a deep link you have to use the authentication link of the portal instead of the standard link.

https://<portalname>.partcommunity.com/3d-cad-models/sso

This link can be combined with all previously mentioned parameters in this document.

This link has to be used for all protected QA portals.

5.8.2.1.14.5.1.6. Showing and hiding portlets

To show or hide portlets when opening the portal page you can use the parameters showPortlets and hidePortlets. The following values are valid for these two parameters:

  • navigation: shows or hides the navigation or table

  • preview: shows or hides all previews

  • generation: shows or hides the CAD download

Multiple occurrences are allowed inside of a link for these parameters. To show the portlets after hiding them with the parameter hidePortlets, you must use showPortlets in the next call, otherwise the portlets will keep their current state.

Example:

http://[portalname].partcommunity.com?
 info=...&hidePortlets=navigation&hidePortlets=generation&showPortlets=preview

=> Only the preview is visible.

5.8.2.1.14.5.1.7. Embedded portals

Embedded portals offer an easier way to get CAD data. There are some special deep links to control the behaviour of an embedded portal.

email

Using the parameter email it’s possible to directly set an email address for CAD download in addition to an info and varset parameter. The user is not able to change this mail address.

  • https://<portalname>.partcommunity.com?email=<E-Mail>

  • https://<portalname>.partcommunity.com?info=<Pfad>&email=<E-Mail>

  • https://<portalname>.partcommunity.com?info=<Pfad>&varset=<Varset>&email=<E-Mail>

[Note] Note

When using the parameter email you can’t pass any additional user data. This will lead to a very poor tracking of downloads in the statistics tool. To pass user data you have to use the remote login transfer

5.8.2.1.14.5.1.8. Integration of embedded portals

An embedded portal can be directly integration into a supplier’s homepage or web shop. A widely used technique for is the usage if an Iframe, with the aid of which external contents can seamlessly be integrated in a page.

Example:

<iframe src="https://[portalname].partcommunity.com?
 info=...&varset=..." frameborder="0" height="800px" width="100%"></iframe>

To ensure a correct functionality for Apple’s Safari browser, which is used on all Apple mobile devices, you have to use the following code.Safari does not allow the usage of third-party cookies per default, but the embedded portal inside the Iframe acts like a third-party for Safari.

<iframe id="pcomiframe" width="100%" height="500px"></iframe>     <script>
    var sessionStatus = window.location.search.substring(13,15);
    if(sessionStatus == "OK"){
        document.getElementById("pcomiframe").src ="https://[portalname].partcommunity.com";
    } 
    else {
        window.location.replace("https://[portalname].partcommunity.com/3d-cad-models/iframe?
       return=https://[name-of-embedding-page]");
    }
</script>