ini File Customizing

You can configure ProPTT2 PC client by modification ProPTT2.ini file.

1. ProPTT2.ini

ProPTT2.ini is on {PC client installed directory}.

[Common]
UseRTL=true

[Login]
DisableService=true
ServerAddress=x.x.x.x
UseSecureLogin=true
UseIMEI=true
Domain=aa.com
CompanyLogo=logo_login.png

[Main]
CompanyLogo=logo_main.png
CompanyBigLogo=logo_main.png
ExtMenu1=Menu1,URL,https://www.proptt2.com
ExtMenu2=Menu2,URL,http://www.imptt.com

#String
ChannelList-PTT=Project name
PTTIcon=Project name
BuddyList-Buddy=Buddy
PTTTitle=WalkieTalkie
ChatTitle=Text
VideoTitle=Video
VideoScreenBackground=Project name
ChannelDetail-History=List
EmergencyEnable=Enable Emergency
EmergencyPTT=Emergency
AlertTitle=Alert

[PTTWindow]
DisableVideoPTT=true

[VideoList]
DisableCCTVList=true

#String
VideoListTitle=Emergency

[Map]
ShowAllUsers=false

[Setup]

#String
DefaultMapTitle=OSM Map(Local html files)
ProductName=Project name
CopyRight=Customer name.
CompanyLogo=logo_setup.png
				

2. Common

Common configuration.

fieldtypedescriptionversion
UseRTLUIShow UI with RTL(Right-Tto-Left )
* Beta. There are still UI issues.
3.4.4~

3. Login

Login screen configuration.

fieldtypedescriptionversion
DisableServiceUIDisable service feature in Login screen. ( sign up...)3.0.5~
CompanyLogoUIThe logo in Login screen3.0.5~
ServerAddressStringSet the default server address3.0.5~
UseSecureLoginFunctionSet the log-in option3.1.4~
UseIMEIFunctionSet the log-in option3.1.4~
DomainStringSet the default server domain3.0.5~

4. Main

Main screen configuration.

fieldtypedescriptionversion
CompanyLogoUITop logo in main screen. if CompanyBigLogo is exist, this file would be disabled.3.0.5~
CompanyBigLogoUITop logo in main screen.3.0.5~
PTTIconStringSet string instead of PTT icon.3.0.5~
EmergencyEnableStringSet string of the emergency enable button.3.0.5~
EmergencyPTTStringSet string of the emergency button.3.0.5~
AlertTitleStringSet string of the alert button and dialog title.3.1.0~
ChannelList-PTTStringSet string of PTT in channel list.3.0.5~
BuddyList-BuddyStringSet string of Buddy in buddy list.3.0.5~
PTTTitleStringSet string of PTT.3.0.5~
ChatTitleStringSet string of chat title.3.0.5~
VideoTitleStringSet string of video.3.0.5~
ChannelDetail-HistoryStringSet string of history in channel's detail.3.0.5~
ExtMenu1StringName+','+Type+','+Parameter+','+Auth+','+Width+','+Height
Type=Url, Parameter=Url, Add url menu on menu bar of ProPTT2 PC client. The URL will be appeared on web brawser.
Type=EmbeddedUrl, Parameter=Url, Add url menu on menu bar of ProPTT2 PC client. The URL will be appeared on a popup window.
Auth="" or "SSO", SSO is for log in ProPTT2 adminWeb.(Server 5.1.x~, Cloud server don't support SSO)
Width=Embedded Window's Width, "" or pixels(PCClient 8.1.5~)
Height=Embedded Window's Height, "" or pixels(PCClient 8.1.5~)
4.4.5~
ExtMenu2StringName+','+Type+','+Parameter+','+Auth+','+Width+','+Height
Type=Url, Parameter=Url, Add url menu on menu bar of ProPTT2 PC client. The URL will be appeared on web brawser.
Type=EmbeddedUrl, Parameter=Url, Add url menu on menu bar of ProPTT2 PC client. The URL will be appeared on a popup window.
Auth="" or "SSO", SSO is for log in ProPTT2 adminWeb.(Server 5.1.x~, Cloud server don't support SSO)
Width=Embedded Window's Width, "" or pixels(PCClient 8.1.5~)
Height=Embedded Window's Height, "" or pixels(PCClient 8.1.5~)
4.4.5~

SSO : User authentication on the external page.

(3) View the external page.

http://x.x.x.x/externalPage?yourparameters&Rand=123456&OTP=23ED21FF&UserID=userId@yourdomain.com
Randrandom number for OTP
OTPuser's session OTP
UserIDuser's id

(4) To verify user OTP, you have to use below API.

Check OTP

Check user's OTP in your externalPage.

1) request
Method POST
URL https://{CloudURL or YourServer's URL}:8080/pv/checkOTP

Body :

field nametypedescriptionoption
UserIDstring user's id(email)mandatory
Randnumber random number for OTPmandatory
OTPstring user's session OTPmandatory
ClientIPstring client ip
Please refer to ProPTT2 server's check logic. (link)
mandatory

Example :

{
    "UserID":"userId@yourdomain.com",
    "OTP":"23ED21FF",
    "Rand":"123456",
    "ClientIP":"123.1.2.3"
}					
					
2) response
field nametypedescriptionoption
idstring user idmandatory
dbidnumber user id in DBmandatory
namestring user's namemandatory
typenumber user's typemandatory
levelnumber user's levelmandatory

Available error code :

codedescription
401Token invalid
403Request forbidden. parameter invalid
412Session is not valid
500Server internal error, Parameter is required
506Server internal error, License is required

Example :

{
    "id" : "user1@ourcompany.com",
    "dbid": 2,
    "name": "user name",
    "type": 50,
    "level": 1
}
					

5. PTTWindow

PTT detail screen configuration.

fieldtypedescriptionversion
DisableVideoPTTUIDisable VideoPTT5.1.8~

6. Video list

Video list screen configuration.

fieldtypedescriptionversion
DisableCCTVListUIDisable CCTV list5.1.8~
VideoListTitleUISet window title3.0.5~

7. Map

Map screen configuration.

fieldtypedescriptionversion
ShowAllUsersFunctionfalse, Whether show all user location to a dispatcher.3.1.0~

8. Setup

Setup screen configuration.

fieldtypedescriptionversion
DefaultMapTitleStringSet default map name in location setup screen.When you modify map html, you can set this.4.0.0~
ProductNameStringSet product name in Setup screen.3.0.5~
CopyRightStringSet Copy Right in Setup screen3.0.5~
CompanyLogoUISet the logo in Setup screen3.0.5~