CONTENTS

  1. Overview
  2. Example of Use
  3. Minimum Requirements
  4. Settings
    1. DBAccess
    2. Initial Settings (SETUPTGV)
    3. Appserver
    4. TOTVS Mingle
  5. Technical Data
    1. Login
    2. Initial Load
    3. Version Validation
    4. Exit
  6. Tables
  7. Entry Points
  8. Related Subjects
  9. What's New

01. OVERVIEW

Important

The Sales Management Portal is available from release 12.1.33 onwards.

Important

The Sales Management Portal is not available to the International Market.

Mingle

To configure TOTVS Mingle, the Appserver must have a public IP.


The Sales Management Portal (PGV) is a Web platform for TOTVS Backoffice Protheus Line users who use the Billing module (SIGAFAT) to manage their sales.


The sales representative can use it to query their Sales Indicators, their Customers (including financial status, credit risk, bills pending and delinquency percentage in Protheus), receive Notifications on their Sales Orders and manage their Sales Orders (Add, Edit, Delete and View).

 

Link to the Sales Management Portal: https://bopgestaodevendas.com/

02. EXAMPLE OF USE

Here you can view a practical example of the main features of the Sales Management Portal.


In the Sales Management Portal, you can configure privileges for a user. These privileges are useful to tell the system which PGV menu options the user will be able to access. You may configure them using the options of routine TGVA004, as explained below:

Important

Privileges are loaded to the portal after the sales representative logs in. If you change the privilege, the change is reflected by the PGV only from the next login of the sales representative onwards.

Important

The actions (Add, Edit and Delete) of the Sales Management Portal cannot be restricted.

To configure it, just access the Privileges menu, found in the Configurator module (SIGACFG) → Users → Passwords → Privileges → Add:

  1. In Rules by Transaction/Routine, fill out the field Transaction/Routine with the code of routine TGVA004.
  2. In Features of Transactions/Routine, select whether the user (Sales Representative) will have access Allowed or Denied to Sales Management Portal menu items.


In this example, access to the My Notifications page will be denied.

Access the users register of the Configurator module (SIGACFG) and add the privilege to the user selected.

SIGACFG → Users → Passwords → Users → Find the user desired → Other Actions → Privileges


In Access Restrictions select the previously registered rule (Step 1).

Upon accessing the Sales Management Portal, the Sales Representative will neither have access to the page nor to the menu. In this example, the Sales Representative lacks access to the page My Notifications.



If the Sales Representative tries to access the page using the URL, the browser displays the screen below:



Important

Access permissions are loaded only when accessing the Sales Management Portal.

If the user is already using the Sales Management Portal, they need to login again to receive privilege updates.

Privileges

For further information on privileges, click here.

The Sales Management Portal lets you change the branch used after

Upon login, the system offers a Toolbar at the top. In it, you can find internet connection data (1st icon), notifications received (2nd icon) and logged sales representative (3rd icon).


In the toolbar, click the button with the user icon.

The toolbar is located at the top of the page.

Then, access the menu option Change Branch.


When you access the menu Change Branch, the system displays a window in which the Sales Representative can select the Company and Branch desired.



When clicking Confirm, the Sales Representative is diverted to the Data Load page of the Sales Management Portal.


Only Companies and Branches the Sales Representative can access in TOTVS Protheus Backoffice® are listed.

Access Restriction

To make branch changes possible, the user of the logged sales representative must also have a sales rep link at the target branch.

When accessing the Home Page, you can view you Sales Indicators, which you can filter by period: Yearly or Monthly.



Indicators Filter

  • Upon selecting option Yearly, the Sales Representative can enter a period of up to ten years.
  • Upon selecting option Monthly, the Sales Representative can enter a period of up to twelve months.


  • For further information, click here to access the reference document of the routine.

When you access the My Notifications menu option, you can Query all your Notifications, which you may view in formats Table (Desktop Default) or Card (Mobile Default).



  • For further information, click here to access the reference document of the routine.

When you access the My Customers menu option, you can Query your Customers, viewing their Financial Status and other Details through the option View Details.



Some features become available only if you are Online.


  • For further information, click here to access the reference document of the routine.

When you access the My Orders menu option, you can Query all your Sales Orders and also Add a New Order.



Details

When you access the option View Details, besides Viewing the Sales Order Summary, you can also access options Edit and Delete.


  • For further information, click here to access the reference document of the routine.

When you access the My Quotations menu option, you can Query all your Sales Quotations and also Add a New Quotation.

By clicking View Details, you can view information on the quotation and also Create a PDF, Edit and/or Delete the quotation.

  • For further information, click here to access the reference document of the routine.

03. MINIMUM REQUIREMENTS

The Sales Management Portal requires Microsiga Protheus® Release 12.1.33 or higher and binary files with date of dispatch equal to or after October/2021.

The Sales Management Portal requires the latest package of the Continuous Dispatch of Billing, to keep its version up to date. 

REST 2.0

The Sales Management Portal uses the REST 2.0 Appserver configuration.

TOTVS Mingle Alias

To configure TOTVS Mingle, the Appserver must have a public IP.

04. CONFIGURATIONS

The Sales Management Portal is a web platform integrated with the Billing module (SIGAFAT) of Microsiga Protheus®. To perform this integration, your environment must be correctly configured with the requirements listed below:

License Server

We recommend the use of the License Server dated equal to or after 6/14/2022.

To sync data, the Sales Management Portal APIs use the field S_T_A_M_P_ as a search parameter, which requires adding the key UseRowStamp in TOTVS DBAccess.


ODBC Configuration

For environments using PostgreSQL database, we recommend configuring the ODBC as documented below.

How to create an ODBC data source to use with PostgreSQL

Example dbaccess.ini
[General]
Port=7890

[MSSQL]
environments=environment

[MSSQL/environment]
UseRowStamp=1
memoinquery=1

REST Communication

  • The Sales Management Portal communicates with the Protheus server through HTTP requests. For this communication to occur, you need to set some configurations in the APPServer.
  • For further information on REST, refer to the reference document of the routine.


Security Key

If you do not enter the Security Key in "appserver.ini", or enter the value 0 in it, your access permissions are not validated.

For further information, click here to access the reference document of the routine.

PrepareIn Key

If the PrepareIn key is pointing towards specific companies, in the Branch Change feature, you can only access the companies entered in this key. If you do not need this restriction type, keep it set to "All".

For further information, refer to the documentation by clicking here.

Important

We recommend configuring REST as shown in the example below

example appserver.ini
[ENVIRONMENT]
	SourcePath=\TOTVS\apo\
	RootPath=\TOTVS\Protheus_data\
	StartPath=\system\
	RpoDb=Top
	RpoLanguage=multi
	RegionalLanguage=BRA
	RpoVersion=120
	dbserver=localhost
	dbdatabase=MSSQL
	dbalias=ENVIRONMENT
	dbport=7890
	TOPMemoMega=30

[Drivers]
	Active=TCP
	MultiProtocolPort=1	
	multiprotocolportsecure=0
	Secure=SSL

[HTTPJOB]
	ENVIRONMENT=ENVIRONMENT
	MAIN=HTTP_START

[HTTPREST]
	BUGS=0
	HSM=0	
	MaxQueue=10	
	Port=8282
	SECURITY=1
	SSL2=0
	SSL3=0
	State=0
	TLS1=0
	URIs=HTTPURI
	Verbose=0	

[HTTPURI]
	AllowOrigin=*
	CORSEnable=0
	Instances=1,2
	OnConnect=REST_CONNECT
	OnExit=REST_EXIT
	OnStart=REST_START
	PrepareIn=All
	URL=/rest/
	Stateless=1

[HTTPV11]
	ADVPL=0
	Enable=1
	Sockets=HTTPREST
	TimeOut=120
			
[HTTPSERVER]
	Enable=0
	Servers=HTTP_REST
​
[HTTP_REST]
	hostname=localhost
	port=9995
	locations=HTTP_ROOT
​
[HTTP_ROOT]
	Path=/rest/
	RootPath=root/web
	ThreadPool=THREAD_POOL
	​
[THREAD_POOL]
	Environment=ENVIRONMENT
	MinFreeThreads=1
	MinThreads=1
	MaxThreads=10

[OnStart]
	JOBS=HTTPJOB
	REFRESHRATE=120

TOTVS Mingle Alias

To configure TOTVS Mingle, the Appserver must have a public IP.

  • The Sales Management Portal platform is stored in a TOTVS cloud. For the application to be able to communicate with the Protheus server, you need to configure TOTVS Mingle, which plays the role of a gateway between the application and the Protheus server. Moreover, when you configure TOTVS Mingle, the application begins to use default Protheus Authentication data.
  • To configure TOTVS Mingle, the Appserver must have a public IP.
  • The system Administrator must request an Alias through the page TOTVS MINGLE and inform the app Sales Management Portal.
  • You will receive the access key by e-mail.


Company/Branch

Enter at least one company and branch in the Mingle register.



  • The Alias received must be the same used for accessing the platform and you must enter it with your Login data.



05. TECHNICAL DATA

To access the Sales Management Portal, the Sales Representative must enter the same User and Password used in TOTVS Backoffice (Protheus Line), besides entering the Alias used by the company.



For further information on the Alias, access the minimum requirements session.

After clicking the button Enter, the Sales Representative is diverted to the Initial Data Load page, which loads some settings used by the Sales Management Portal.



This load is executed only in first access or if the user is changed.

When you log onto the Sales Management Portal, the system checks whether the Protheus server version is the same found in the User Portal. If the Sales Representative (user) receives the message below, it means the Repository (RPO) must be updated by applying the latest continuous dispatch package found HERE. The user will be unable to login until the repository is updated to its most recent version.


In the toolbar, click the button with the user icon.

The toolbar is located at the top of the page.

Then, access the menu option Exit.




06. TABLES

07. ENTRY POINTS


08. RELATED TOPICS

Risk Alert

Be careful when using the configuration parameter with the key "Security=0" because, that way, integrations (APIs) will not require authentication. Consequently, data from your environment can be queried without any authorization control.