Configuring Additional Fields for Sales Users


First published on 08/10/2023 at 6:54 pm

 

 

Additional fields can be configured for certain pages with Sales User for Employee Portal.

 

Details can be configured for specific pages/sections of Sales User, as described below.

 

1. In SAP Business One, go to SXP Manager AddOn > Manage Additional Fields.

2. Select SXP Employee from the Portal dropdown (marker 1 below) and the desired page (marker 2 below).

 

 

Select SXP Employee from the Portal dropdown (1) and the page (2). Add a new field (3) or edit an existing field (4).

 

 

Available options:

 

Option

Description

URL

OrderPad - Order Header Configured fields appear on the document header. Configuration applies to Order Pad (orders and quotes) for Employee Portal. ~/order/create?cardcode=\<card-code\>

Ex: /order/create?cardcode=C20000
OrderPad - Order Lines Configured fields appear on the line level. Configuration applies to Order Pad (orders and quotes) for Employee Portal. ~/order/create?cardcode=\<card-code\>

Ex: /order/create?cardcode=C20000
SalesUserBusinessPartner - Business Partner Configured fields appear on the business partner details screen for Employee Portal. /salesuser/\#\<card-code\>/details

/salesuser/\#C20000/details
SalesUserBusinessPartner - Business Partner Contacts Configured fields appear on the contact details section of the business partner details screen for Employee Portal. /salesuser/\#\<card-code\>/details

/salesuser/\#C20000/details
SalesUserBusinessPartner - Business Partner Addresses Configured fields appear on the address section of the business partner details screen for Employee Portal. /salesuser/\#\<card-code\>/details

/salesuser/\#C20000/details
SalesUserOpportunity Configured fields appear on the opportunity details tab of the business partner details screen for Employee Portal. ~/salesuser/\#\<card-code\>/opportunities/\<opportunity-number\>

Ex: /salesuser/\#C20000/opportunities/147

 

3. Add a new field using the + icon (marker 3 above), or update an existing field using the golden arrow (marker 4 above). From the "Edit" field screen, configure the field’s details, as outlined below. For specific use cases and examples, see the examples section.

 

 

Set basic details (1,2), default value settings (3-6), properties (7-12), active (13).

 

Field Description
Label (1) This web label is displayed to the user. For hidden fields, this is an admin-only label.
Type (2) Available options:

Standard - Allows a user to choose a value for this configured field. This value is saved in B1.

Read-only - A value is displayed to the user, but the user can't edit it. “Default Value” settings must be configured to ensure a value is assigned to this field. This value is saved in B1.

Display-only - A value is displayed to the user as a non-editable note. “Default Value” settings must be configured to ensure a value is displayed. This value is not saved in B1.

Hidden - This option is not displayed to the user. “Default Value” settings must be configured to ensure a value is assigned to this field. This value is saved in B1.
Default value: Use a query to provide a Default Value on web? (3) If enabled, a query category (4) and query (5) must be selected. The default value is assigned to the field on the web. Depending on other settings, the user may or may not be able to edit this value.
Default value: Default Value Query Category (4) This selects the B1 query category that contains the customized "Default Value" query.
Default value: Default Value Query (5) This selects the customized B1 query used to determine the default value.

This query may use the parameters [%CardCode] (the currently selected business partner’s CardCode) or [%UserID] (the currently logged-in user’s Employee ID - OHEM.EmpID).

This query must supply a single row with a single column containing the value desired.
Default value: Default Value (6) If a query isn't used, a hard-coded default value may be assigned here. If blank when “Use query” is unchecked, no default option will be provided on the web.
Properties: Field Name (7) Any UDF and a subset of core fields may be selected, depending on which page and section are being configured.
Properties: Use a query to provide Valid Values on web? (8) If enabled, a query category (9) and query (10) must be selected. Valid value options appear as a dropdown on the web, so the user can only enter valid options.
Properties: Valid Values Query Category (9) This selects the B1 query category that contains the customized valid values query.
Properties: Valid Values Query (10) This selects the customized B1 query used to determine the list of valid values.

This query may use the parameters [%CardCode] (the currently selected business partner’s CardCode) or [%UserID] (the currently logged-in user’s Employee ID - OHEM.EmpID).

This query must supply a list of value/label pairs. These value/label pairs will be used to display a dropdown of valid options for standard additional field types. For read-only additional field types, these value/label pairs will be used to display the associated label for the automatically assigned value.

The value/label pairs in this query must align with all possible default values. If a default value isn't included in this query, the default value will be displayed “as is”.
Properties: Is Required? (11) When enabled, this forces the user to select/enter details for the configured field. This may be combined with default values where appropriate, or default values may be left blank to force user action.
Properties: Help Text (12) Optional help text gives the user additional information. The recommended use is alerting users to built-in query limits (e.g., “warehouses are restricted based on your sales region”).
Active (13) If enabled, all users with access to the configured feature will see this option.

 

4. Recycle SXP Employee. This will ensure the latest fields are refreshed immediately for all users. 

 

5. Now, users can see the configured fields by accessing the relevant Sales User feature.

 

Examples

The following examples provide walkthroughs of setting up common scenarios. An implementation may require slightly different configuration options. (See details above for available options.)

 

  • Employee changes the warehouse on order lines ("Standard" field example)
  • Query sets the warehouse on order lines ("Read-Only" field example)
  • Query displays the business partner account status details ("Display-Only" field example)
  • Employee changes the warehouse on order lines ("Hidden" field example)

 

Employee changes the warehouse on order lines (Standard field example)

Sometimes, an employee must change the warehouse assigned to the order line. For example, if there’s a surplus of a product in the non-default warehouse, the employee can choose that warehouse instead of the default.

 

  1. In SAP Business One, configure two queries:
    • A query to select a default warehouse. In this example: B1WebAPI_SU/Custom_DefaultWarehouse. This query may optionally use the parameter [%CardCode].
    • A query to list available warehouses. In this example: B1WebAPI_SU/Custom_WarehouseList. This query may optionally use the parameter [%CardCode]. This query must supply a list of value/label pairs, which will be displayed as a dropdown of valid options.
  2. Select SXP Employee > OrderPad - Order Lines from the dropdown (markers 1 & 2 below). Add or update the warehouse field (markers 3 & 4 below).

     

    Select the Portal (1) and page (2); add a new field for warehouse (3) or edit it if it already exists (4).

     

  3. Configure the warehouse details as follows:

     

    Assign web label (1), type (2), default options (3), general properties (4). Ensure the field is active (5).

     

    • Label (1): Set this to Warehouse.
    • Type (2): Select Standard.
    • Default value (3): We're using a custom query to generate the default warehouse. Assign the custom query created in the first step: B1WebAPI_SU/Custom_DefaultWarehouse.
    • Properties (4): We're using the line-level warehouse field with a customized list of available warehouses. Select the field Warehouse, ensure the Valid Values option is enabled, and select the customized query created in the first step: B1WebAPI_SU/Custom_WarehouseList.
    • Active (5): Enable this option to display the field on the web.
  4. Recycle SXP Employee Portal in IIS

  5. To edit the field on the web, log into SXP Employee and add an item to an order.

     

    Add an item to the order.
  6. When prompted, select the desired warehouse. The default and available warehouse options are supplied by the custom queries.

     

    Select the desired warehouse from the available options.
  7. Submit the order. The selected warehouse is saved to the line, as selected by the user (marker 1 below).

     

    Once the order is submitted, the selected warehouse is displayed on the order summary (1).
  8. The selected warehouse setting can also be viewed in SAP Business One. At the document line level, the chosen warehouse is assigned to the line as submitted by the user (marker 1 below).

In B1, the warehouse appears on the order document line (1). 

 

Query sets the warehouse on order lines (Read-only field example)

In this scenario, warehouse assignment is based on custom logic, and the assigned warehouse needs to be displayed to an employee during order placement. For example, a query is configured to determine the “closest” warehouse with surplus stock to the customer.

  1. In SAP Business One, configure two queries:
    • A query to select the warehouse. In this example: B1WebAPI_SU/Custom_DefaultWarehouse. This query may optionally use the parameter [%CardCode].
    • A query to list available warehouses. In this example: B1WebAPI_SU/Custom_WarehouseList. This query may optionally use the parameter [%CardCode]. This query must supply a list of value/label pairs and must include all possible warehouses that can be assigned by the default query.
  2. Select SXP Employee > OrderPad - Order Lines from the dropdown (markers 1 & 2 below). Add or update the warehouse field (markers 3 & 4 below).

     

    Select the Portal (1) and page (2); add a new field for warehouse (3) or edit it if it already exists (4).
  3. Configure the warehouse details as follows:

     

    Assign web label (1), type (2), default options (3), general properties (4). Ensure the field is active (5).
    • Label (1): Set this to Warehouse.
    • Type (2): Select Read-Only.
    • Default value (3): We're using a custom query to generate the default warehouse. Assign the custom query created in the first step: B1WebAPI_SU/Custom_DefaultWarehouse
    • Properties (4): We're using the line-level warehouse field, with a list of warehouse codes/names for display on the web. Select the field Warehouse, ensure the Valid Values option is enabled, then select the customized query created in the first step: B1WebAPI_SU/Custom_WarehouseList.
    • Active: Enable this option to display the field on the web.
  4. Recycle SXP Employee

  5. To see the field on the web, log into SXP Employee and add an item to the order.

     

    Add an item to the order.

  6. The assigned warehouse will be displayed on the line, as supplied by the custom queries.

     

    View the assigned warehouse and edit the quantity.

  7. Submit the order. The selected warehouse is saved to the line, as selected by the user (marker 1 below).

     

    Once the order is submitted, the selected warehouse is displayed on the order summary (1).
  8. The selected warehouse setting can also be viewed in SAP Business One. At the document line level, the chosen warehouse is assigned to the line as submitted by the user (marker 1 below).

    In B1, the warehouse appears on the order document line (1).

     

Query displays BP account status (Display-only field example)

In this scenario, an account status is displayed at the top of the business partner Details or opportunity details screen. This message provides a salesperson with an at-a-glance status message (for our example: “Account is overdue by less than 30 days”).

  1. In SAP Business One, configure a query to select a message based on the customer [%CardCode]. In this example: B1WebAPI_SU/Custom_AccountStatus.

  2. Select SXP Employee Portal > SalesUserBusinessPartner - Business Partner or SXP Employee Portal > SalesUserOpportunity from the dropdown (markers 1 & 2 below). Add or update the 'Account Status' field (markers 3 & 4 below).

     

    Select the Portal (1) and page (2); add a new field for account status (3) or edit it if it already exists (4).

     

  3. Configure account status details as follows:

     

    Assign web label (1), type (2), default options (3). Ensure the field is active (4).

     

    • Label (1): Set this to Warehouse.
    • Type (2): Select Read-Only.
    • Default value (3): We're using a custom query to determine the account status to display. Assign the custom query created in the first step: B1WebAPI_SU/Custom_AccountStatus.
    • Active (4): Enable this option to display the message on the web.
  4. Move the field into the desired position. Here, the account status field has been moved to the top (marker 1 below).

     

    Select the field's row (1); use the arrows to move the field (2).

  5. View the customer details (or opportunity details, as configured) on the web.

     

    Customer details with account status, as generated by a custom query. Status message (1).

     

     

    Opportunity details with account status, as generated by a custom query. Status message (2).

     

Query sets a UDF when an order is placed on the web (Hidden field example)

In this scenario, it’s necessary to identify where an order was placed (on the web, within B1, or through another process, like the phone). To do so, you can create a custom UDF on the order header, which can then be updated from Employee Portal using a hidden field. This type of hidden field can be configured as outlined below.

  1. We'll use a hard-coded default value so no query is required. However, a query may optionally be configured if one is needed. This is outlined in previous examples.

  2. Select SXP Employee > OrderPad - Order Header from the dropdown (markers 1 & 2 below). Add or update the warehouse field (markers 3 & 4 below).

     

    Select the Portal (1) and page (2); add a new field for the order source (3) or edit it if it already exists (4).
  3. Configure the order source details as follows:

     

    Assign web label (1), type (2), default value (3), field name (4). Ensure the field is active (5).
    • Label (1): Set this to Order Source. Because this isn't displayed on the web, it's only visible to admins in SAP Business One.
    • Type (2): Select Hidden.
    • Default value (3): We're using a default value. Set the default value to EP, which identifies Employee Portal as the source.
    • Properties (4): We're using a document header UDF called “Order_Source”. No other details are required.
    • Active: Enable this option to display the field on the web.
  4. Recycle SXP Employee

  5. To see the field in B1, place an order on the web by logging into SXP Employee and adding an item to the order.

    Add an item to the order.

     

    Submit the order.

     

  6. The UDF assignment can be viewed in SAP Business One. On the document, the UDF is set as determined by the custom query (marker 1 below).

    In B1, the order source UDF is set as set on the web (1).

     

Supported Fields

Each page selected in the "Additional Fields" configuration screen has a specific subset of core B1 fields you can configure in addition to any UDF (user-defined field) assigned to that object type. Core fields that come installed with SXP Employee are defined below.

Order Pad - Order Header

To configure an additional field for order document headers on Order Pad (including orders and quotes), select OrderPad - Order Header from the page dropdown. This configuration option is available in version 93.0 and higher.

 

Field Description
Any UDF UDFs that have been applied to document headers are configurable.

Order Pad - Order Lines

To configure an additional field for order document lines on Order Pad (including orders and quotes), select OrderPad - Order Lines from the page dropdown. This configuration option is available in version 93.0 and higher.

 

Field Description
Any UDF UDFs that have been applied to document lines are configurable.
WhsCode Warehouse code.

No valid values are defined.

 

Business Partner - Business Partner Master Data

To configure an additional field for business partner master data, select SalesUserBusinessPartner - Business Partner from the page dropdown.

 

Field Description
Any UDF UDFs that have been applied to business partner master data are configurable.
AddID No valid values are defined.
BP Project Valid values are defined in the query B1WebAPI_SU/_OMAN_BP_PROJECTS.
Cellular No valid values are defined.
E_Mail No valid values are defined.
EmailAddress No valid values are defined.
Fax No valid values are defined.
GroupCode Valid values are defined in the query B1WebAPI_SU/_OMAN_BP_GROUPCODE.
Industry Valid values are defined in the query B1WebAPI_SU/_OMAN_OPPORTUNITY_INDUSTRIES.
IndustryC No valid values are defined.
LangCode No valid values are defined.
ListNum Price list number.

Valid values are defined in the query B1WebAPI_SU/_OMAN_BP_PRICELISTS.
Language Valid values are defined in the query B1WebAPI_SU/_OMAN_LANGUAGES.
Phone1 No valid values are defined.
Phone2 No valid values are defined.
ProjectCod No valid values are defined.
Territory Valid values are defined in the query B1WebAPI_SU/_OMAN_OPPORTUNITY_TERRITORIES.

 

Business Partner - Business Partner Contacts

To configure an additional field for business partner contacts, select SalesUserBusinessPartner - Business Partner Contacts from the page dropdown.

 

Field Description
Any UDF UDFs that have been applied to business partner contacts are configurable.
Address No valid values are defined.
Fax No valid values are defined.
LastName No valid values are defined.
MiddleName No valid values are defined.
Notes2 Remarks 2.

No valid values are defined.
Pager No valid values are defined.
Tel2 Phone 2.

No valid values are defined.
Title No valid values are defined.

 

Business Partner - Business Partner Addresses

To configure an additional field for business partner addresses, select SalesUserBusinessPartner - Business Partner Addresses from the page dropdown.

 

Field Description
Any UDF UDFs that have been applied to business partner addresses are configurable.
Block No valid values are defined.
Building No valid values are defined.
Country No valid values are defined.
GblLocNum Global location number.

No valid values are defined.
StreetNo Street number.

No valid values are defined.

 

Opportunities

To configure an additional field for sales opportunities, select SalesUserOpportunity - Sales Opportunity from the page dropdown.

 

Field Description
Any UDF UDFs that have been applied to opportunities are configurable.
Industry Valid values are defined in the query B1WebAPI_SU/_OMAN_OPPORTUNITY_INDUSTRIES.
IntRate No valid values are defined.
PrcnProf Profit (%).

No valid values are defined.
PrjCode Project code.

Valid values are defined in the query B1WebAPI_SU/_OMAN_OPPORTUNITY_PROJECTS.
Source Information source.

Valid values are defined in the query B1WebAPI_SU/_OMAN_OPPORTUNITY_SOURCES.
SumProfS Profit total.

No valid values are defined.
Territory Valid values are defined in the query B1WebAPI_SU/_OMAN_OPPORTUNITY_TERRITORIES.

 

 

 

Previous

Next


  

Last modified: 09/17/2024/4:22 pm

 

-