Supplier Portal Integration


Prerequisite

Before you can start with this chapter, you need to have finished the following parts:

Setup Product 360 Core Users and Permissions

There are 3 different kinds of Product 360 Core Users for different Product 360 - Supplier Portal use cases:

  • Product 360 Supplier Portal System User

    • This system user is used to authenticate REST requests at Product 360 - Server which are triggered by suppliers (or Product 360 - Supplier Portal background jobs).

  • Product 360 Supplier Portal Administrator Users

    • For all actions in Product 360 - Supplier Portal triggered by a portal administrator, the corresponding credentials of the named user are used at the REST interface.

In order to have an easily maintainable system, it is recommended to create a user group (with the minimal set of common rights) and to assign it to the Product 360 Supplier Portal System User and Product 360 Supplier Portal Administrator Users.

If object rights are used for an object, please keep in mind that all other users implicitly don't have any rights for it. Thus if an object like a supplier, catalog or mapping shall be used in Product 360 - Supplier Portal context (e.g. for the supplier list, to perform uploads, etc.) the corresponding user group for Product 360 - Supplier Portal MUST have full object rights on that object as well.

Create required Users and Groups within Product 360 - Desktop

Create Product 360 Supplier Portal Administrator Users Group

  • The Product 360 Supplier Portal Users Group needs at least the following action rights to perform the basic actions in Supplier Portal web application:

    Rights group

    Permission

    Mandatory

    Note

    Catalogs

    Supplier catalogs, general access

    Yes

    General

    Service Login

    Yes

    Company Management

    Company Management, general access

    Yes

    Items

    Items, general access

    Yes

    Items

    Create Items

    Yes

    Items

    Create Prices

    Yes

    Items

    Create Prices (in the past)

    Yes

    Items

    Delete item

    Yes

    Items

    Delete prices

    Yes

    Items

    Delete prices (in the past)

    Yes

    Items

    Edit items

    Yes

    Items

    Edit prices

    Yes

    Items

    Edit prices (in the past)

    Yes

    Items

    View prices

    Yes

    Import

    Perform import

    Yes

    Suppliers

    Supplier Management, general access

    Yes

    Suppliers

    Edit suppliers

    Yes

    Structures

    Structures, general access

    Yes

    Structure groups

    Structure groups, general access

    Yes

    Users

    Users, general access

    Yes

Create Product 360 - Supplier Portal Item Editor User Group

      1. If not already exists, create a new Product 360 Core User Group, which manages the Product 360 Supplier Portal Item Editor permission within Product 360 Core.

      2. The Product 360 Supplier Portal Item Editor Users Group needs the following rights:

        Action rights

        Rights group

        Permission

        Mandatory

        Note

        Web Permissions

        Log in (Web)

        Yes

        Web Permissions

        Classify objects (Web)

        No

        Catalogs

        Supplier catalogs, general access

        Yes

        Structures

        Structures, general access

        Yes

        Structure groups

        Structure groups, general access

        Yes

        Items

        Items, general access

        Yes

        Items

        Edit items

        Yes

        Item search

        Item search management, general access

        Yes

        Products

        Product management, general access

        Yes

        Products

        Edit products

        Yes

        Variants

        Variant management, general access

        Yes

        Only in 3 tier product paradigm to classify in structure tree.

        Variants

        Edit variants

        Yes

        Only in 3 tier product paradigm to classify in structure tree.

        Tasks

        Task management, general access

        Yes

        Tasks

        Edit tasks

        No

        Document management

        Document management, general access

        No

        Only for assignment and upload of media attachments

        Document management

        Create documents

        No

        Only for assignment and upload of media attachments

        Document management

        Create document categories

        No

        Only for assignment and upload of media attachments

        Document management

        Edit document categories

        No

        Only for assignment and upload of media attachments

        Multimedia attachments

        Add multimedia attachments

        No

        Only for assignment and upload of media attachments

        Merge

        Merge, general access

        No

        Merge

        Perform Merge

        No

        Since Product 360 8.1 it is possible to allow the assignment of Supplier Organizations to tasks setup in the system.
        The Supplier Organizations that are configured to work with tasks can access them similarly as their general catalog data by the item editor integration.
        For this setup at least the field rights for the 'Tasks' data range have to be considered.

        Field rights

        Data range

        Field

        Mandatory

        Note

        Tasks

        Start date (visible + editable)

        Yes

        Tasks

        Estimated start date (visible + editable)

        Yes

        Tasks

        Anticipated completion on (visible + editable)

        Yes

        Tasks

        Progress (visible + editable)

        Yes

        Tasks

        Completed on (visible + editable)

        Yes

        Item

        Item no. (visible + editable)

        Yes

        Item

        GTIN (visible + editable)

        Yes

        Item

        Status (visible + editable)

        Yes

        Field group "Header data"

        Interface visibility

        Category

        Name

        Mandatory

        Note

        Item

        Select the tabs you want to show

        optional

      3. Following rights, permissions and interface visibility MUST be REVOKED:

        Interface visibility

        Category

        Name

        Note

        Context

        Context visibility: Entire Context selection area

        Action rights

        Rights group

        Permission

        Note

        Flexible UI

        Access Flexible UI

        Flex UIs are not supported in context of supplier tasks.

        Field rights

        Data range

        Field

        Note

        Tasks

        Revoke all Tasks related field rights NOT listed as mandatory in the previous section.

        All other Action rights, field rights and all Interface visibility of type 'Web List Definition' and 'Web Tab' not mentioned above have to be defined individuality depending on the scenario and requirements of the project and the individual use case scenarios.
        Here detail tabs, displayed columns and other UI elements needed for the business use case are to be considered.
        For example, if you want to display the short description in the item list view, you have to check the box in the field permissions of the short description for visible.

      Create Product 360 - Supplier Portal Item Viewer User Group

          1. If not already exists, create a new Product 360 Core User Group, which manages the Product 360 Supplier Portal Item Viewer permission within Product 360 Core.

          2. The Product 360 Supplier Portal Item Viewer Users Group needs the following rights:

            Action rights

            Rights group

            Permission

            Mandatory

            Note

            Web Permissions

            Log in (Web)

            Yes

            Catalogs

            Supplier catalogs, general access

            Yes

            Structures

            Structures, general access

            Yes

            Structure groups

            Structure groups, general access

            Yes

            Items

            Items, general access

            Yes

            Item search

            Item search management, general access

            Yes

            Products

            Product management, general access

            Yes

            Variants

            Variant management, general access

            Yes

            Only in 3 tier product paradigm to classify in structure tree.

            Since Product 360 8.1 it is possible to allow the assignment of Supplier Organizations to tasks setup in the system.
            The Supplier Organizations that are configured to work with tasks can access them similarly as their general catalog data by the item editor integration.
            For this setup at least the field rights for the 'Tasks' data range have to be considered.

            Field rights

            Data range

            Field

            Mandatory

            Note

            Tasks

            Start date (visible)

            Yes

            Tasks

            Estimated start date (visible)

            Yes

            Tasks

            Anticipated completion on (visible)

            Yes

            Tasks

            Progress (visible)

            Yes

            Tasks

            Completed on (visible)

            Yes

            Item

            Item no. (visible)

            Yes

            Item

            GTIN (visible)

            Yes

            Item

            Status (visible)

            Yes

            Field group "Header data"

            Interface visibility

            Category

            Name

            Mandatory

            Note

            Item

            Select the tabs you want to show

            optional

          3. Following permissions, rights and interface visibility MUST be REVOKED:

            Interface visibility

            Category

            Name

            Note

            Context

            Context visibility: Entire Context selection area

            Action rights

            Rights group

            Permission

            Note

            Flexible UI

            Access Flexible UI

            Flex UIs are not supported in context of supplier tasks.

            Field rights

            Data range

            Field

            Note

            Tasks

            Revoke all Tasks related field rights NOT listed as mandatory in the previous section.

            All other Action rights, field rights and all Interface visibility of type 'Web List Definition' and 'Web Tab' not mentioned above have to be defined individuality depending on the scenario and requirements of the project and the individual use case scenarios.
            Here detail tabs, displayed columns and other UI elements needed for the business use case are to be considered.
            For example, if you want to display the short description in the item list view, you have to check the box in the field permissions of the short description for visible.

          Create Product 360 Supplier Portal System User

          1. Fill in the user details, keep attention to the following details:

            • the Active checkbox must be checked.

            • Authentication mode has to be set to "Internal"

          2. Add User to the created Product 360 Supplier Portal Administrators User Group

          Add Product 360 Core Users as Product 360 Supplier Portal Administrator

          1. Create a new Product 360 Core user or choose an existing Product 360 Core user to add to the Product 360 Supplier Portal Administrator User Group

          2. Fill in the user details, keep attention to the following details:

            • the Active check-box must be checked.

            • Add User to the created Product 360 Supplier Portal Administrators User Group.

          Setup Product 360 - Web Users and Permissions for Product 360 Supplier Portal Item Editor/Viewer

          The item management within Product 360 - Supplier Portal uses the Product 360 - Web functionality. There a two different use cases within Product 360 - Supplier Portal to take into account.

          Product 360 Supplier Portal Item Editor:

          which means, suppliers are able to edit items within the Product 360 - Supplier Portal.

          Product 360 Supplier Portal Item Viewer:

          which means, suppliers don't have the ability to edit item data within the Product 360 - Supplier Portal.

          Both users need to be referenced by the webfrontend.properties file of the Product 360 server in order to be used by the system as default system users for Item Editor access through the Supplier Portal.

          Create Product 360 Supplier Portal Item Editor System User

          1. Fill in the user details, keep attention to the following details:

            • the Active checkbox must be checked.

            • Authentication mode has to be set to "Internal"

          2. Add User to the created Product 360 Supplier Portal Item Editor User Group.

          Create Product 360 Supplier Portal Item Viewer System User

          1. Fill in the user details, keep attention to the following details:

            • the Active checkbox must be checked.

            • Authentication mode has to be set to "Internal"

          2. Add User to the created Product 360 Supplier Portal Item Viewer User Group

          Setup communication Product 360 Server - Product 360 Supplier Portal

          There is a possibility to configure the communication between Product 360 Server and Product 360 Supplier Portal. E.g. for Supplier Portal Post Export Step which introduces the possibility for Product 360 Core users to send selected catalog data to a specific supplier within Product 360 Supplier Portal. Or to notify the supplier in the Product 360 Supplier Portal about tasks created for suppliers.

          To configure the communication from Product 360 - Server to Product 360 Supplier Portal just make sure you set the following properties in the

          <PIM_SERVER_INSTALLATION_ROOT>\server\configuration\HPM\hsx.properties

          Description

          hsx.enabled

          Enable the Product 360 - Server-> Product 360 - Supplier Portal communication

          hsx.enabled=true
          hsx.server

          The Product 360 - Supplier Portal tomcat application server host name.

          e.g. hsx.server=localhost
          hsx.port

          Port of the Product 360 - Supplier Portal application.

          e.g. hsx.port=9090
          hsx.login.name
          e.g. hsx.login.name=hsx
          hsx.login.password

          Password of the above portal administrator.

          e.g. hsx.login.password=pass

          If you want to encrypt the password please refer to chapter Encryption of secure information in the Server Installation manual.

          hsx.rest.uri
          e.g. hsx.rest.uri=http://localhost:9090/hsx/rest/
          hsx.suppliertasks.enabled 

          Enable tasks for suppliers functionality in the Product 360. Valid values: true and false. Default value: false. Only if both properties hsx.enabled and hsx.suppliertasks.enabled are existing in the configuration file and set to true, the supplier tasks are enabled.

          hsx.suppliertasks.enabled=false
          hsx.suppliertasks.notification.enabled 
          Enable notification about created or changed supplier tasks. Valid values: true and false. Default value: false. Only if all properties hsx.enabled, hsx.suppliertasks.enabled and hsx.suppliertasks.notification.enabled are existing in the configuration file and set to true the notifications about supplier tasks will be sent to the timeline of Supplier Portal. 
          hsx.suppliertasks.notification.enabled=false